Discord bot for the Sollumz server. Its functionality:
- Show answers from the wiki FAQ (
/faq). - Open GitHub issues from Discord messages ("Report Issue").
- Prepare wiki pull requests that add new FAQ entries ("Add to FAQ").
Secrets and repository names are read from the environment, falling back to a .env file
in the working directory; everything else comes from config.json.
| Variable | Purpose |
|---|---|
SOLLUMZ_BOT_DISCORD_TOKEN |
Bot token. |
SOLLUMZ_BOT_GITHUB_APP_ID |
GitHub App the bot authenticates as. |
SOLLUMZ_BOT_GITHUB_APP_PRIVATE_KEY |
The App's PEM private key itself. Contents are accepted either verbatim or base64-encoded. |
SOLLUMZ_BOT_GITHUB_APP_PRIVATE_KEY_FILE |
Path to that key instead, if a file is handier. |
SOLLUMZ_BOT_USER_AGENT |
Sent to the GitHub API. |
SOLLUMZ_BOT_GITHUB_ISSUES_REPO |
owner/name that "Report Issue" files into, e.g. Sollumz/Sollumz. |
SOLLUMZ_BOT_GITHUB_WIKI_REPO |
owner/name that "Add to FAQ" opens pull requests against, e.g. Sollumz/wiki. |
SOLLUMZ_BOT_CONFIG_FILE |
Path to a config.json other than the one next to the binary. |
SOLLUMZ_BOT_WIKI_PUBLIC_URL |
Optional. A public base URL for the wiki repository's files, e.g. https://raw.githubusercontent.com/Sollumz/wiki/HEAD/, for a wiki repository that is private: Discord fetches the screenshots in a /faq answer itself. Unset, the repository's own raw URL is used. |