summaryrefslogtreecommitdiffstats
path: root/README.MD
blob: 0672ba53421fbbb6a29e65ecbb9a8cd5f22c7f96 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# Python XMPP Chatbot

## beforehand
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)
- query xmpp server contact addresses [XEP-0157](https://xmpp.org/extensions/xep-0157.html)
- display help output
- respond to username being mentioned

### todo
- [ ] Github Webhook

### install
#### requirements
- slixmpp
- configparser
- datetime
- random
- validators

#### configuration
`bot.cfg` replace dummy file with correct credentials/ parameters
````cfg
[Account]
jid=nick@domain.tld/querybot-0.1
password=super_secret_password
[MUC]
rooms=room_to_connect_to@conference.domain.tld,another_room@conference.domain.tld
nick=mucnickname
[ADMIN]
admins=admins ( ! muc nick and not the jid nickname)
````

##### 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 &`.