diff options
| author | nico <nico.wellpott@uni-oldenburg.de> | 2018-07-20 16:12:53 +0200 |
|---|---|---|
| committer | nico <nico.wellpott@uni-oldenburg.de> | 2018-07-20 16:12:53 +0200 |
| commit | c3596c3b847285e882fea1affcf669acee0c0eb3 (patch) | |
| tree | c2bdc6330b92e68d3ed3e939604454c0c53042f1 /README.MD | |
| parent | faf2c428bf07aa69693bb20cc554095ac59720da (diff) | |
+ first release with basic functionality
+ added systemd service file
+ added README with instructions
Diffstat (limited to 'README.MD')
| -rw-r--r--[-rwxr-xr-x] | README.MD | 15 |
1 files changed, 11 insertions, 4 deletions
diff --git a/README.MD b/README.MD index 4fc3196..32e5add 100755..100644 --- a/README.MD +++ b/README.MD @@ -6,12 +6,11 @@ Do not opperate this bot on foreign servers. ### functions
- query xmpp server software and version [XEP-0092](https://xmpp.org/extensions/xep-0092.html)
- query xmpp server uptime [XEP-0012](https://xmpp.org/extensions/xep-0012.html)
-- displaying a help output
+- display help output
- respond to username being mentioned
### todo
-- [ ] query xmpp server contact addresses [XEP-0157](https://xmpp.org/extensions/xep-0157.html)
- - [x] iq is being catched but the answer needs to be extracted out of it
+- [ ] extract xmpp server contact addresses [XEP-0157](https://xmpp.org/extensions/xep-0157.html) from result
- [ ] Github Webhook
### install
@@ -20,6 +19,7 @@ Do not opperate this bot on foreign servers. - configparser
- datetime
- random
+- validators
#### configuration
`bot.cfg` replace dummy file with correct credentials/ parameters
@@ -33,4 +33,11 @@ nick=mucnickname [ADMIN]
admins=admins ( ! muc nick and not the jid nickname)
````
- If done correctly `./main.py &` and enjoy your bot.
\ No newline at end of file +
+##### systemd
+Copy the systemd dummy file into systemd service folder.
+`systemdctl daemon-reload` and `systemctl start magicbot.service` to start the bot.
+If it is neccecary to start the bot automatically when the system boots do `systemctl enable magicbot.service`.
+
+#### starting the bot without systemd
+Got to the bots directory and run `./main.py &`.
\ No newline at end of file |