Skip to content

Commit 61cf38b

Browse files
Joel GerberJoel Gerber
authored andcommitted
Document some known configuration settings
1 parent ecb15cb commit 61cf38b

1 file changed

Lines changed: 18 additions & 1 deletion

File tree

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,9 +126,13 @@ Here's an example of configuring these through the _pybot.env_ file:
126126

127127
```bash
128128
SLACK_BOT_SIGNING_SECRET=APP-SIGNING-SECRET
129-
SLACK_TOKEN=BOT-USER-OAUTH-TOKEN
129+
BOT_OATH_TOKEN=BOT-USER-OAUTH-TOKEN
130130
```
131131

132+
**NOTE**: More configuration settings than these may be specified. Please see
133+
the _Known Configuration Settings_ section near the bottom of this document
134+
for details on other settings that can be set.
135+
132136
### 4 - Attach Your pybot Instance to the Public Internet
133137

134138
With an instance of pybot running, you now need to expose this instance to the
@@ -222,5 +226,18 @@ Name | Description | Callback ID
222226
---- | ----------- | -----------
223227
Report Message | Report this message to admins | report_message
224228

229+
## Known Configuration Settings
230+
231+
This application has a number of environment variables that can be set when
232+
launching to alter the behaviour of the application. The list below is an
233+
incomplete description of a number of them. Please feel free to update this
234+
list with more details via a PR:
235+
236+
Name | Description | Example
237+
---- | ----------- | -------
238+
SLACK_BOT_SIGNING_SECRET | The unique signing secret used by Slack for a specific app that will be validated by pybot when inspecting an inbound API request | f3b4d774b79e0fb55af624c3f376d5b4
239+
BOT_OATH_TOKEN | The bot user specific OAuth token used to authenticate the bot when making API requests to Slack | xoxb-800506043194-810119867738-vRvgSc3rslDUgQakFbMy3wAt
240+
MENTOR_CHANNEL | Slack unique identifier (not the same as the channel name) for a workspace channel that mentors should be added to | G1DRT62UC
241+
225242
## License
226243
This package is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

0 commit comments

Comments
 (0)