Skip to content

Commit

Permalink
better readme
Browse files Browse the repository at this point in the history
  • Loading branch information
aiexz committed Jan 6, 2025
1 parent f626efa commit 8f4db2b
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,13 @@ cd telebackup
go build cmd/telebackup/main.go
```

### Run in Docker
```bash
docker run -v /path/to/config.yml:/config.yml -v /path/to/dir:/dr ghcr.io/aiexz/telebackup:master
```



## Usage
1. Create a Telegram bot using [BotFather](https://t.me/botfather) and get bot token
2. Get APP ID & API Hash from [my.telegram.org](https://my.telegram.org) or use provided in example
Expand All @@ -39,6 +46,38 @@ targets:
> It is recommended to create a group or channel with the bot to not spam your personal messages
## Real-world example
Here is our minecraft server
```yaml
services:
mc:
image: itzg/minecraft-server
ports:
- "25565:25565"
environment:
EULA: "TRUE"
volumes:
- ./data:/data
telebackup:
container_name: telebackup_mc
image: ghcr.io/aiexz/telebackup:master
depends_on:
- mc
environment:
APP_ID: 6
APP_HASH: 123
BOT_TOKEN: 123:abc
TARGET: 123
TARGETS: |
/data
volumes:
- ./data:/data:ro
```
We also add a cron job to backup the server every day
```bash
0 0 * * * docker start telebackup_mc
```

## Roadmap
- [ ] Handle files larger than 2GB
- [x] Support for forums (chats with topics)
Expand Down

0 comments on commit 8f4db2b

Please sign in to comment.