PlaguPoster/README.md

28 lines
857 B
Markdown
Raw Normal View History

2022-09-09 16:59:49 +00:00
# PlaguPoster
2022-08-18 11:56:55 +00:00
2022-09-09 16:59:49 +00:00
This is a posting system for the Telegram based on usage of three chats:
2022-08-18 11:56:55 +00:00
2022-09-09 16:59:49 +00:00
* Target chat where the posts will be published to
* Source chat where the posts will be stored, available for management and ratings
* Cache chat where sometimes will appear your posts to be cached in memory of bot
2022-08-18 11:56:55 +00:00
2022-09-09 16:59:49 +00:00
And different plugins. Sample config is presented in the root of this repository.
Each plugin describes its own format of subconfig. Anyway, most of config parts will be stored in one
file `config.json` (you may name it anyhow).
2022-08-18 11:56:55 +00:00
2022-09-09 16:59:49 +00:00
## How does it work
2022-08-18 11:56:55 +00:00
2022-09-09 16:59:49 +00:00
1. You are sending post to __source__ chat
2. Bot register it
3. (Optionally) bot attaching ratings poll
2022-08-18 11:56:55 +00:00
2022-09-09 16:59:49 +00:00
## How to launch the bot
2022-08-18 11:56:55 +00:00
2022-09-09 16:59:49 +00:00
There are several ways to launch the bot:
2022-08-18 11:56:55 +00:00
2022-09-09 16:59:49 +00:00
* With Docker (and `docker-compose`)
* With using of `gradle` and `run` command
* Using `zip`/`tar` after project building
2022-08-18 11:56:55 +00:00