https://github.com/3cky/telegram-uploader-bot
Telegram bot watches new files and uploads them to chats.
https://github.com/3cky/telegram-uploader-bot
telegram telegram-bot
Last synced: 5 months ago
JSON representation
Telegram bot watches new files and uploads them to chats.
- Host: GitHub
- URL: https://github.com/3cky/telegram-uploader-bot
- Owner: 3cky
- License: apache-2.0
- Created: 2023-08-04T12:51:08.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-01T10:53:47.000Z (over 2 years ago)
- Last Synced: 2024-06-21T17:57:19.161Z (about 2 years ago)
- Topics: telegram, telegram-bot
- Language: Go
- Homepage:
- Size: 50.8 KB
- Stars: 9
- Watchers: 3
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# telegram-uploader-bot
[](https://github.com/3cky/telegram-uploader-bot/actions/workflows/docker-publish.yml)
[](https://github.com/3cky/telegram-uploader-bot/releases/latest)
[](https://hub.docker.com/r/3cky/telegram-uploader-bot/tags)
[](https://hub.docker.com/r/3cky/telegram-uploader-bot)
[](https://hub.docker.com/r/3cky/telegram-uploader-bot)
Telegram bot written in Go that monitors directories for new files and uploads them to chats.
## Features
- Monitors specified directories for new files and uploads them to Telegram chats.
- Supports multiple directories and chats configuration.
- Can add custom tags to uploaded files using plain text tags, regexps, or [expr](https://github.com/antonmedv/expr) language.
- File filtering using file masks.
## Prerequisites
- Go (v1.20 or higher) installed on your Linux system.
- A Telegram bot token obtained by creating a new bot using [BotFather](https://core.telegram.org/bots#how-do-i-create-a-bot).
## Installation
```bash
git clone https://github.com/3cky/telegram-uploader-bot.git
cd telegram-uploader-bot
make install
```
## Configuration
The bot uses a YAML config file set by `-c` or `--config-file` flags. The default config file is "/usr/local/etc/telegram-uploader-bot.cfg".
To use a custom configuration file, run the bot with the `-c` flag followed by the path to your config file:
```bash
telegram-uploader-bot -c /path/to/custom_config.cfg
```
Example configuration:
```yaml
telegram:
token: "my-telegram-bot-token"
uploads:
- directory: "/path/to/watch/dir"
files:
- "*.jpg" # file name match by the mask is case insensitive
document: false # set to true to upload files as documents (without reencoding)
min_size: 0 # min file size limit to upload (default is 0 - no limit)
max_size: 50 MB # max file size limit to upload (default is 50 MB)
chat: 1234567
tags:
plain:
- "work"
- "important"
regexp:
- ".*/(?P.*)\\.jpg" # matched groups will be used as tags prefixed by group names
expr:
- "(file.Size() > 1024 * 1024) ? 'big' : ''" # tag files bigger than 1 megabyte
```
## Docker
You can launch the **telegram-uploader-bot** in Docker container with the following command:
```shell
docker run -d \
--name=telegram-uploader-bot \
-v /path/to/config.cfg:/usr/local/etc/telegram-uploader-bot.cfg \
-v /path/to/watch/dir:/path/to/watch/dir \
3cky/telegram-uploader-bot
```
Where:
- `/path/to/config.cfg`: path to telegram-uploader-bot config file in the local filesystem.
- `/path/to/watch/dir`: directory to monitor by telegram-uploader-bot, must match uploads directory in config file.
Make sure config file and watched directory are readable by user `nobody`:`nogroup`.
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
## License
telegram-uploader-bot is released under the Apache 2.0 license. See the [LICENSE](https://github.com/3cky/telegram-uploader-bot/blob/main/LICENSE) file for more info.