Bot to manage a xmpp ejabberd local node from a Mastodon server, by posting keywords to it.
Anar al arxiu
spla d7ad1bbfa2 Firs release (WIP) 2022-08-18 10:03:27 +02:00
LICENSE Firs release (WIP) 2022-08-18 10:03:27 +02:00
README.md Firs release (WIP) 2022-08-18 10:03:27 +02:00
ejabberdapi.py Firs release (WIP) 2022-08-18 10:03:27 +02:00
mastodonbot.py Firs release (WIP) 2022-08-18 10:03:27 +02:00

README.md

xmpp bot for Mastodon

Bot to manage a xmpp ejabberd node from a Mastodon server, by posting keywords to it.

The bot only listen keywords from your Mastodon server local users. They can register themselves to your ejabberd xmpp server, unregister, check your xmpp node stats and more!.
The keywords that they can issue against the bot are the following:

@your_bot register
@your_bot unregister
@your_bot stats
@your_bot status
@your_bot sessions

The bot will process any of the above keywords thanks to the wrapper for ejabberd API (ejabberdapi.py, coded by me (WIP)) and the excellent wrapper for Mastodon API coded by halcy 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 (ejabberd server's API listen port)
  • 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
  • bot's replies language (ca or en)

Requirements

  • Mastodon server bot account
  • xmpp ejabberd node with admin privileges

Before running python xmpp.py:

  1. git clone https://git.mastodont.cat/spla/xmppbot.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!