Skip to content

Latest commit

 

History

History
36 lines (26 loc) · 1.24 KB

README.md

File metadata and controls

36 lines (26 loc) · 1.24 KB

OBS Support Bot

This repo contains the source code for the OBSProject's Discord support bot.

While the bot is open source, batteries are not included, and there is no support for third party users. Please do not open issues for such use cases.

Pull requests that do not fix issues or are making changes deemed undesireable or unnecessary for the OBS Project are likely to be rejected.

Setup

  1. Setup PostgreSQL server version 10+
  2. Create database with schema provided in data/db_schema.sql
  3. Create a Github webhook. See below
  4. Setup a webserver passing the hooks. Example nginx configurations in data/nginx.example.conf
  5. Install Python 3.8+ and dependencies in requirements.txt
  6. Create configuration file (example in data/config.example.toml)
  7. Run python3.8 runner.py -c path/to/your/config-file.toml
  8. ???
  9. Profit!

Webhooks

Create the webhook for your Github project and use the following settings

  • Payload URL: https://my.server.com/github
  • Secret: leave empty
  • Content type: application/json
  • SSL verification: Enable SSL verification (depending on your webserver)
  • Let me select individual events: Issues, Pull requests

License

The OBS Bot source code is licensed under the GNU General Public License v3.