diff --git a/README.md b/README.md index 9f557f0..e9d3ee2 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,8 @@ cp nxy/files/{.env,config.json} . vim .env config.json ``` +## Running as Service + Enable linger for the bot user (so it starts at boot and keeps running), install and activate systemd unit: ```sh sudo loginctl enable-linger nxy @@ -46,3 +48,23 @@ Install and activate timer for database dumps: ln -fs $HOME/nxy/files/nxy-db-dump.{timer,service} $HOME/.config/systemd/user systemctl --user enable --now nxy-db-dump.timer ``` + +## Running as Standalone in Development Mode + +For development set the BOT_DEV variable: + +``` +export BOT_DEV= +``` + +Then add the current git repository to your python path: + +``` +export PYTHONPATH=:$PYTHONPATH +``` + +Finally run nxy: + +``` +python3 -m bot +```