add systemd service information
This commit is contained in:
23
README.md
23
README.md
@@ -2,6 +2,7 @@
|
|||||||
### shitty (half-)vibecoded discord bot
|
### shitty (half-)vibecoded discord bot
|
||||||
## overall
|
## overall
|
||||||
you can use this as a base for your discord bot by writing your own [cogs](/cogs/), or as is.
|
you can use this as a base for your discord bot by writing your own [cogs](/cogs/), or as is.
|
||||||
|
keep in mind that [systemd_service.sh](systemd_service.sh) is ONLY for systemd.
|
||||||
|
|
||||||
|
|
||||||
## installation
|
## installation
|
||||||
@@ -22,6 +23,28 @@ CAT_API_KEY=live_abc123abc
|
|||||||
```
|
```
|
||||||
you can then edit the [config.py](/config.py) to your liking.
|
you can then edit the [config.py](/config.py) to your liking.
|
||||||
|
|
||||||
|
## usage
|
||||||
|
the bot is running when the main.py script is running.
|
||||||
|
|
||||||
|
### systemd service
|
||||||
|
you can configure a systemd service for this bot.
|
||||||
|
*tested on Ubuntu 24.04*
|
||||||
|
|
||||||
|
simply do:
|
||||||
|
```
|
||||||
|
chmod +x systemd_service.sh
|
||||||
|
./systemd_service.sh
|
||||||
|
```
|
||||||
|
the systemd service will now start and auto start on reboot.
|
||||||
|
|
||||||
|
### updating with systemd service
|
||||||
|
keep in mind that after updating with the systemd service enabled, you will need to restart the service.
|
||||||
|
so the update workflow looks something like this:
|
||||||
|
```
|
||||||
|
git pull origin main
|
||||||
|
sudo systemctl restart muzovkantv2
|
||||||
|
```
|
||||||
|
|
||||||
## contacting
|
## contacting
|
||||||
if you have any feedback, contact me on github issues or/and discord. if you want to add any functions to this bot, make a PR.
|
if you have any feedback, contact me on github issues or/and discord. if you want to add any functions to this bot, make a PR.
|
||||||
when submitting a bug report, make sure to attach the bot.log files. they generate automatically in root directory.
|
when submitting a bug report, make sure to attach the bot.log files. they generate automatically in root directory.
|
||||||
|
|||||||
Reference in New Issue
Block a user