-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add basic seabird-discord-backend docs
- Loading branch information
Showing
4 changed files
with
47 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
Common settings: | ||
|
||
- `SEABIRD_ID` (optional, defaults to `seabird`) - (TODO: determine what this is | ||
and why it's not supported everywhere) | ||
- `SEABIRD_HOST` (required) - this is the URL of the `seabird-core` instance. | ||
Most users should use `https://core.seabird.chat` | ||
- `SEABIRD_TOKEN` (required) - the seabird token |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# seabird-discord-backend | ||
|
||
[![Static Badge](https://img.shields.io/badge/repository-blue?logo=git&label=%20&labelColor=grey&color=blue)](https://github.com/seabird-chat/seabird-discord-backend) | ||
[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/seabird-chat/seabird-core/docker-publish.yml)](https://github.com/seabird-chat/seabird-discord-backend/actions/workflows/docker-publish.yml) | ||
|
||
## Dependencies | ||
|
||
- `seabird-core` | ||
|
||
## Configuration | ||
|
||
### Environment Variables | ||
|
||
{{#include _common_settings.md}} | ||
|
||
Discord-specific settings | ||
|
||
- `DISCORD_TOKEN` (required) - Both an | ||
[application](https://discord.com/developers/docs/quick-start/getting-started) | ||
and a [bot user](https://discord.com/developers/docs/topics/oauth2#bot-users) | ||
must be set up in Discord, and connected to the relevant Discord server by an | ||
admin on that server. The correct OAuth URL has been lost to time, but make | ||
sure priviledged intents (presence, server members, and message content) are | ||
enabled. Note that tokens must be prefixed with `Bot ` in order for Discord to | ||
use them as a bot token. | ||
- `DISCORD_COMMAND_PREFIX` (optional, defaults to `!`) | ||
- `DISCORD_CHANNEL_MAP` (optional, defaults to empty) - a comma separated list | ||
of Discord voice channels, followed by a `:` and then a channel which should | ||
be notified when someone joins. | ||
|
||
## Known Issues | ||
|
||
- There is not true Discord "command" support, so all commands need to be | ||
prefixed by the `DISCORD_COMMAND_PREFIX` setting. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters