ameliabot/README.adoc

32 lines
893 B
Plaintext

= AMELIABOT
:url-owncast: https://owncast.online
:url-hatbot: https://codeberg.org/hatniX/hatbot
:url-hatnix: https://hatnix.net
= ameliabot
A chatbot for owncast, inspiration from {url-hatbot}[hatbot] by {url-hatnix}[hatniX].
Code attributions can be found in `ATTRIBUTION.adoc`
== Requirements
* {url-owncast}[Owncast] server
* Python 3
* Flask
== Setup
* Install Flask (`pip --user install Flask`)
* Create an Owncast webhook url pointing to your bot's location
** http://localhost:5000/webhook/owncast if bot and owncast are on the same machine
* Run ameliabot the first time to generate a minimal configuration file
** Or copy `config.example.ini` to `config.ini` and fill out the information required
Ameliabot can be run by executing `start.sh` or:
```
FLASK_APP=bot.py python3 -m flask run
```
Please use a proper uWSGI proxy if the bot is not on the same machine as owncast.