xmpp/README.md

# xmpp Akkoma bot
bot to manage an xmpp ejabberd node by posting keywords to it from your Akkoma account.  

The bot only listen keywords from your Akkoma instance local users. They can register themselves to your ejabberd xmpp server, unregister or also get your xmpp node stats.  
The keywords that your Akkoma instance local users can issue against the bot are the following:  

@your_bot register  
@your_bot unregister  
@your_bot stats  

The bot will process any of the above keywords thanks to the wrapper for ejabberd API (included) and the wrapper for Akkoma API (also included) but, first time you run `python xmpp.py`, it will ask you for the needed parameters like:  

- api_base_url: http://127.0.0.1:5280
- local_vhost: your local ejabberd vhost  
- admin_account: the ejabberd admin account, in exemple admin@ejabberd.server  
- admin_pass: ejabberd admin account password  
- Akkoma hostname: in ex. akkoma.host  

Before running `python xmpp.py`:  

1. git clone https://git.mastodont.cat/spla/xmpp.git target_dir.   
2. `cd target_dir`  
3. create the Python Virtual Environment with `python3.x -m venv .`  
4. activate it with `source bin/activate`  
5. run `pip install -r requirements.txt` to install required libraries.  
6. set up your contrab to run `python xmpp.py` every minute.  

Enjoy!