Hein-Pieter van Braam-Stewart 7f19d68721 Noodling with readme
2021-01-24 23:37:25 +01:00
2021-01-24 23:35:56 +01:00
2021-01-24 23:35:56 +01:00
2021-01-24 23:35:56 +01:00
2021-01-24 23:37:25 +01:00

Godot Issuebot

Simple bot to ferry between rocket.chat and Github. If you want to run one for yourself you can build the container. The following environment variables are supported:

  • BOT_DEBUG - Turn on exessive debug messages when set
  • DEFAULT_AVATAR_URL - required url to some image if gh can't provide an avatar
  • ROCKET_WS_URL - required url to the rocket.chat server (wss://chat.godotengine.org/websocket)
  • ROCKET_USERNAME - required username of the rocket.chat user to login as
  • ROCKET_PASSWORD - required password of the rocket.chat user
  • GITHUB_PROJECT - required github project to search in
  • GITHUB_USERNAME - required username to use for the github APIs
  • GITHUB_TOKEN - required github user token to authenticate to the APIs with

Running without a container

Requirements are pretty small, only python-requests and python-websockets are required. After that make sure you set the above env variables and you're good to go!

Running the bot through podman

Docker users can probable just replace podman with docker

  • clone the repostiory
  • podman build . -t issuebot:latest
  • podman run -it --env-file=env issuebot:latest

example env file:

BOT_DEBUG=true
DEFAULT_AVATAR_URL=https://chat.godotengine.org/avatar/github
GITHUB_PROJECT=godotengine
ROCKET_WS_URL=wss://chat.godotengine.org/websocket
ROCKET_USERNAME=github
ROCKET_PASSWORD=supersecret
GITHUB_USERNAME=hpvb
GITHUB_TOKEN=verysecret
Description
Issuebot for chat.godotengine.org
Readme 198 KiB
Languages
Python 50.1%
Shell 40.5%
PowerShell 8.7%
Dockerfile 0.7%