https://github.com/kukume/tgbot
kuku's telegram bot
https://github.com/kukume/tgbot
kotlin mongodb spring spring-boot telegram telegram-bot
Last synced: 5 months ago
JSON representation
kuku's telegram bot
- Host: GitHub
- URL: https://github.com/kukume/tgbot
- Owner: kukume
- License: agpl-3.0
- Created: 2022-08-25T15:11:07.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2025-06-07T02:12:31.000Z (about 1 year ago)
- Last Synced: 2025-06-07T03:21:26.556Z (about 1 year ago)
- Topics: kotlin, mongodb, spring, spring-boot, telegram, telegram-bot
- Language: Kotlin
- Homepage:
- Size: 31.4 MB
- Stars: 137
- Watchers: 3
- Forks: 27
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: License
Awesome Lists containing this project
README
## TelegramBot
[SpringBoot](https://spring.io/projects/spring-boot) + [Spring-Data-Mongodb-Reactive](https://spring.io/projects/spring-data-mongodb) + [Java-Telegram-Bot-Api](https://github.com/pengrad/java-telegram-bot-api)
Demo：https://t.me/kukume_bot （可能不稳定）
## Environment
JDK21 + Mongodb
## Commands
| 指令 | 说明 | 参数 |
|---------------|------------------------|--------|
| /login | 登陆账号 | 无 |
| /exec | 手动执行签到 | 无 |
| /manager | 管理自动签到状态，默认全为关 | 无 |
| /delete | 删除登陆的账号 | 无 |
| /switch | 切换身份以支持多账号 | 无 |
| /log | 自动签到日志 | 无 |
| /oci | oracle cloud 管理 | 无 |
| /config | 用户的配置和不需要登陆的推送 | 无 |
| /setting | 机器人的配置（creatorId可用） | 无 |
| /push | 通过http api进行消息推送 | 无 |
| /ygo | 游戏王查卡 | 卡片名称 |
| /update | 更新程序 | 无 |
| /updatelog | github提交信息 | 无 |
| /bv | 获取bv视频 | bv开头id |
| /x | 获取x帖子的详情 | 链接或id |
| /neteasesmall | 添加网易云小号（（creatorId可用）） | 无 |
## Docker
https://hub.docker.com/r/kukume/tgbot
## Jar
https://pan.kuku.me/tgbot
## Config
### application.yml
```yaml
kuku:
telegram:
# @BotFather获取到的token
token:
# 机器人管理员的id
creatorId: 0
# 代理地址
proxyHost:
# 代理端口
proxyPort: 0
# 代理类型，可选 DIRECT（不设置代理）、HTTP、SOCKS
proxyType: DIRECT
# 自建的api服务器的地址（包含http://或者https://），如果不填，动态推送将不能推送50M以上的视频
url:
# 填写自建telegram的api服务器的配置目录，该机器人程序和自建api必须在一台服务器上
# 如果是https://www.kuku.me/archives/41/的搭建api，且docker-compose.yml在/root/telegram-bot-api目录下
# 该参数为 /root/telegram-bot-api/data
# 如果不是使用docker，该参数为 /
localPath:
# 填写自建api，用于无头浏览器执行的签到，见custom api项
api:
```
### docker-compose.yml
```yaml
version: "3"
services:
tgbot:
image: kukume/tgbot
container_name: tgbot
# 如果不需要使用http api进行消息推送，可不需要
ports:
- 8080:8080
environment:
# @BotFather获取到的token
KUKU_TELEGRAM_TOKEN:
# 机器人管理员的id
KUKU_TELEGRAM_CREATOR_ID: 0
# 代理地址
KUKU_TELEGRAM_PROXY_HOST:
# 代理端口
KUKU_TELEGRAM_PROXY_PORT: 0
# 代理类型，可选 DIRECT（不设置代理）、HTTP、SOCKS
KUKU_TELEGRAM_PROXY_TYPE: DIRECT
# 自建的tg服务器的地址（包含http://或者https://），如果填了，
# 上传文件到机器人的功能均会失效，如果不填，动态推送将不能推送50M以上的视频
KUKU_TELEGRAM_URL:
# 自建的api，用于无头浏览器执行签到或者加密参数
KUKU_API:
depends_on:
- mongo
mongo:
image: mongo:4
volumes:
- ./db:/data/db
- ./dump:/dump
```
## Custom api
https://hub.docker.com/r/kukume/sk
## Message Push
url: `/push`
method: get or post
params: key(get from commands /push) and text, parseMode (optional)
## Features
*
## Log
* `/info`可查看发送人的`id` ，设置`creatorId`，`/setting`中可下载日志
* `/log`中可查看失败任务日志
* 如果为`docker compose`安装方式，请在其目录下执行`docker-compose logs`查看日志
## LICENSE
`AGPLv3`
[](https://dartnode.com "Powered by DartNode - Free VPS for Open Source")