Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/davidegalilei/markinim
Markinim Telegram bot source code
https://github.com/davidegalilei/markinim
bot markov-chain nim telegram
Last synced: about 1 month ago
JSON representation
Markinim Telegram bot source code
- Host: GitHub
- URL: https://github.com/davidegalilei/markinim
- Owner: DavideGalilei
- License: mit
- Created: 2022-01-16T12:34:15.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-21T19:07:42.000Z (8 months ago)
- Last Synced: 2024-04-22T12:01:04.739Z (8 months ago)
- Topics: bot, markov-chain, nim, telegram
- Language: Nim
- Homepage:
- Size: 1.06 MB
- Stars: 72
- Watchers: 2
- Forks: 16
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Markinim
This is the @MarkinimBot Telegram bot's source code. It's a bit messy (it was never meant to be open source at the beginning) so it needs a cleanup, but it works. Memory usage and performance are pretty good. It uses sqlite.
# Deploy
> For docker instructions, [skip here](#deploy-with-docker)
Install required dependencies:
```shell
$ nimble install
```
Then create a `secret.ini` file which looks like this, where admin is your Telegram user id, and token is the bot token obtainable from @BotFather.
```ini
[config]
token = "1234:abcdefg"
admin = 123456
logging = 1
```
You can also add a `keeplast = 1500` parameter to the configuration, to avoid ram overloads by processing a maximum of keeplast messages per session (default: `1500`)
```shell
$ nim c -o:markinim src/markinim.nim
$ ./markinim
```
## Deploy (with docker)
- Copy `.env.sample` to `.env`
- Edit `BOT_TOKEN` and `ADMIN_ID`
- If needed, edit `KEEP_LAST` (default: `1500`. Read above)
- Build and run the image with `docker compose up -d --build`
- Run the bot with `docker compose up -d`
### Old instructions
> ⚠️ **WARNING**: deprecated. Use the docker compose instructions above instead.
- Build the image with `docker build -t markinim .`
- Run the bot using `docker run -itd -v="${pwd}/data":/code/data:z --env-file=.env --restart=unless-stopped --name=markinimbot markinim`
## Backups
> ⚠️ **WARNING**: This is an experimental backup script. It's not well-tested yet. Use it at your own risk. I am not responsible for any data loss. I don't know if it works.
- Setup [`syncthing`](https://syncthing.net/) if you want to sync the backups to another device
- Copy `tools/backup_script.example.sh` to `tools/backup_script.sh` and edit it to set the correct values for `root_dir`, `backup_directory` and `backup_filename`
- Optionally, edit `TELEGRAM_ID` to receive a notification when the backup is done
- Copy `tools/backup.example.sh` to `tools/backup.sh` and edit it if you want to change the container name
- Run a cronjob to run `tools/backup.sh` every 4h (or whatever you want)
- Open crontab with `crontab -e`
- Add `0 */4 * * * /path/to/markinim/tools/backup.sh`
- Save and exit
- Done! Now you should have a backup every 4h in the specified directory