aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEvgeny Zinoviev <me@ch1p.io>2021-05-16 02:15:15 +0300
committerEvgeny Zinoviev <me@ch1p.io>2021-05-16 02:15:15 +0300
commit3b1aab54515dd7c158db39d37d79430545de20ce (patch)
treeb183ebb2b60d2db2c889f36630ccdc8821c6f4d7
parentd268a3ddfa348fb4a91d59057c19d802c55f64bf (diff)
fix
-rw-r--r--README.md33
1 files changed, 18 insertions, 15 deletions
diff --git a/README.md b/README.md
index 1274408..abc44a0 100644
--- a/README.md
+++ b/README.md
@@ -15,23 +15,26 @@ It requires Python 3.6+ or so.
## Configuration
-Configuration is stored in `config.ini` file in `~/.config/inverter-bot`.
+The bot accepts following parameters:
-Config example:
-```
-token=YOUR_TOKEN
-admins=
- 123456 ; admin id
- 000123 ; another admin id
-isv_bin=/path/to/isv
-use_sudo=0
-```
-
-Only users in `admins` are allowed to use the bot.
+* ``--token`` — your telegram bot token (required)
+* ``--users-whitelist`` — space-separated list of IDs of users who are allowed
+ to use the bot (required)
+* ``--inverterd-host`` (default is `127.0.0.1`)
+* ``--inverterd-port`` (default is `8305`)
## Launching with systemd
-Create a service file `/etc/systemd/system/inverter-bot.service` with the following content (changing stuff like paths):
+This is tested on Debian 10. Something might differ on other systems.
+
+Create environment configuration file `/etc/default/inverter-bot`:
+```
+TOKEN="YOUR_TOKEN"
+USERS="ID ID ID ..."
+OPTS="" # here you can pass other options such as --inverterd-host
+```
+
+Create systemd service file `/etc/systemd/system/inverter-bot.service` with the following content (changing stuff like paths):
```systemd
[Unit]
@@ -39,10 +42,11 @@ Description=inverter bot
After=network.target
[Service]
+EnvironmentFile=/etc/default/inverter-bot
User=user
Group=user
Restart=on-failure
-ExecStart=python3 /home/user/inverter-bot/main.py
+ExecStart=python3 /home/user/inverter-bot/inverter-bot --token $TOKEN --users-whitelist $USERS $PARAMS
WorkingDirectory=/home/user/inverter-bot
[Install]
@@ -51,7 +55,6 @@ WantedBy=multi-user.target
Then enable and start the service:
```
-systemctl daemon-reload
systemctl enable inverter-bot
systemctl start inverter-bot
```