Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update twitch section #61

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update twitch section #61

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f43f278
Update Twitch docs
LukasW1337 Sep 3, 2024
0a7f2fc
.
LukasW1337 Sep 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/nodecg-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,10 @@ NodeCG is configured via a `cfg/nodecg.js`, `cfg/nodecg.yaml`, or `cfg/nodecg.js
- `allowedIds` _Array of strings_ Which 64 bit Steam IDs to allow. Can be obtained from [https://steamid.io/](https://steamid.io/). This option is required when `login.steam.enabled = true`! [NO DEFAULT!]
- `twitch` _Object_ Contains twitch login configuration properties.
- `enabled` _Boolean_ Whether to enable Twitch authentication. [DEFAULT: `false`]
- `clientID` _String_ A Twitch application ClientID [http://twitch.tv/kraken/oauth2/clients/new](http://twitch.tv/kraken/oauth2/clients/new). This option is required when `login.twitch.enabled = true`! [NO DEFAULT!]
- `clientSecret` _String_ A Twitch application ClientSecret [http://twitch.tv/kraken/oauth2/clients/new](http://twitch.tv/kraken/oauth2/clients/new). This option is required when `login.twitch.enabled = true`! [NO DEFAULT!]
- `clientID` _String_ A Twitch application ClientID [https://dev.twitch.tv/console/apps/create](https://dev.twitch.tv/console/apps/create). This option is required when `login.twitch.enabled = true`! [NO DEFAULT!]
- `clientSecret` _String_ A Twitch application ClientSecret [https://dev.twitch.tv/console/apps/create](https://dev.twitch.tv/console/apps/create). This option is required when `login.twitch.enabled = true`! [NO DEFAULT!]
- _Note:_ Configure your Twitch OAuth credentials with a Redirect URI to `{baseURL}/login/auth/twitch`
- `scope` _String_ A space-separated string of Twitch application [permissions](https://dev.twitch.tv/docs/authentication/#scopes). [DEFAULT: `"user_read"`]
- `scope` _String_ A space-separated string of Twitch scopes [permissions](https://dev.twitch.tv/docs/authentication/#scopes). [DEFAULT: `"user:read:email"`]
- `allowedUsernames` _Array of strings_ Which Twitch usernames to allow. Either this option or `allowedIds` is required when `login.twitch.enabled = true`! [NO DEFAULT!]
- `allowedIds` _Array of strings_ Which Twitch IDs to allow. Can be obtained from [https://twitchinsights.net/checkuser](https://twitchinsights.net/checkuser). Either this option or `allowedUsernames` is required when `login.twitch.enabled = true`! [NO DEFAULT!]
- `discord` _Object_ Contains discord login configuration properties.
Expand Down Expand Up @@ -92,9 +92,9 @@ module.exports = {
},
twitch: {
enabled: true,
clientID: 'your_app_id',
clientSecret: 'your_app_key',
scope: 'user_read',
clientID: 'your_twitch_app_client_id',
clientSecret: 'your_twitch_app_client_secret',
scope: 'user:read:email',
allowedUsernames: ['some_username'],
allowedIds: ['11111111111111111', '22222222222222222'],
},
Expand Down