mirror of
https://github.com/HugeFrog24/go-telegram-bot.git
synced 2026-04-30 23:32:19 +00:00
HugeFrog24
150 lines
4.2 KiB
Markdown
150 lines
4.2 KiB
Markdown
# Go Telegram Multibot
|
|
|
|
A scalable, multi-bot solution for Telegram using Go, GORM, and the Anthropic API.
|
|
|
|
## Design Considerations
|
|
|
|
- AI-powered (Anthropic Claude)
|
|
- Voice message support (ElevenLabs STT + TTS) — optional, enabled per bot via config
|
|
- Supports multiple bot profiles
|
|
- Uses SQLite for persistence
|
|
- Implements rate limiting and user management
|
|
- Modular architecture
|
|
- Comprehensive unit tests
|
|
|
|
## Usage
|
|
|
|
### Docker Deployment (Recommended)
|
|
|
|
1. Clone the repository:
|
|
|
|
```bash
|
|
git clone https://github.com/HugeFrog24/go-telegram-bot.git
|
|
cd go-telegram-bot
|
|
```
|
|
|
|
2. Copy the default config template and edit it:
|
|
```bash
|
|
cp config/default.json config/mybot.json
|
|
nano config/mybot.json
|
|
```
|
|
|
|
> [!IMPORTANT]
|
|
> Keep your config files secret and do not commit them to version control.
|
|
|
|
3. Create data directory and run:
|
|
```bash
|
|
mkdir -p data
|
|
docker-compose up -d
|
|
```
|
|
|
|
### Native Deployment
|
|
|
|
1. Install using `go get`:
|
|
|
|
```bash
|
|
go get -u github.com/HugeFrog24/go-telegram-bot
|
|
cd go-telegram-bot
|
|
```
|
|
|
|
2. Configure as above, then build:
|
|
```bash
|
|
go build -o telegram-bot
|
|
```
|
|
|
|
## Systemd Unit Setup
|
|
|
|
To enable the bot to start automatically on system boot and run in the background, set up a systemd unit.
|
|
|
|
1. Copy the systemd unit template and edit it:
|
|
|
|
```bash
|
|
sudo cp examples/systemd/telegram-bot.service /etc/systemd/system/telegram-bot.service
|
|
```
|
|
|
|
Edit the service file:
|
|
|
|
```bash
|
|
sudo nano /etc/systemd/system/telegram-bot.service
|
|
```
|
|
|
|
Adjust the following parameters:
|
|
|
|
- WorkingDirectory
|
|
- ExecStart
|
|
- User
|
|
|
|
2. Enable and start the service:
|
|
|
|
```bash
|
|
sudo systemctl daemon-reload
|
|
```
|
|
|
|
```bash
|
|
sudo systemctl enable telegram-bot
|
|
```
|
|
|
|
```bash
|
|
sudo systemctl start telegram-bot
|
|
```
|
|
|
|
3. Check the status:
|
|
|
|
```bash
|
|
sudo systemctl status telegram-bot
|
|
```
|
|
|
|
For more details on the systemd setup, refer to the [demo service file](examples/systemd/telegram-bot.service).
|
|
|
|
## Logs
|
|
|
|
### Docker
|
|
|
|
```bash
|
|
docker-compose logs -f telegram-bot
|
|
```
|
|
|
|
### Systemd
|
|
|
|
```bash
|
|
journalctl -u telegram-bot -f
|
|
```
|
|
|
|
## Commands
|
|
|
|
| Command | Access | Description |
|
|
| --------------------------------- | ----------- | ------------------------------------------------------------ |
|
|
| `/stats` | All users | Show global bot statistics (total users and messages) |
|
|
| `/stats user` | All users | Show your own message statistics |
|
|
| `/stats user <user_id>` | Admin/Owner | Show statistics for a specific user |
|
|
| `/whoami` | All users | Show your Telegram ID, username, and role |
|
|
| `/clear` | All users | Soft-delete your own chat history |
|
|
| `/clear <user_id>` | Admin/Owner | Soft-delete all messages for a user across every chat |
|
|
| `/clear <user_id> <chat_id>` | Admin/Owner | Soft-delete a user's messages in a specific chat |
|
|
| `/clear_hard` | All users | Permanently delete your own chat history |
|
|
| `/clear_hard <user_id>` | Admin/Owner | Permanently delete all messages for a user across every chat |
|
|
| `/clear_hard <user_id> <chat_id>` | Admin/Owner | Permanently delete a user's messages in a specific chat |
|
|
| `/set_model <model-id>` | Admin/Owner | Switch the AI model live without restarting |
|
|
|
|
> **Note:** In private DMs each user's `chat_id` equals their `user_id`. The scoped `<chat_id>` form is mainly useful for group chat moderation.
|
|
|
|
## Testing
|
|
|
|
The GitHub actions workflow already runs tests on every commit:
|
|
|
|
> [](https://github.com/HugeFrog24/go-telegram-bot/actions/workflows/go-ci.yaml)
|
|
|
|
However, you can run the tests locally using:
|
|
|
|
```bash
|
|
go test -race -v ./...
|
|
```
|
|
|
|
## Storage
|
|
|
|
At the moment, a SQLite database (`./data/bot.db`) is used for persistent storage.
|
|
|
|
Remember to back it up regularly.
|
|
|
|
Future versions will support more robust storage backends.
|