Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2025-04-10 01:16:39 +02:00
Code Issues Projects Releases Wiki Activity

docs(fix): add description of open-source authentication type.

Browse Source
This commit is contained in:
Thomas Heartman 2022-01-05 11:21:55 +01:00
parent 66d4aa61de
commit e73f3c6aa7
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
website/docs/deploy/configuring-unleash.md
View File

@ -95,10 +95,10 @@ unleash.start(unleashOptions);
- **authentication** - (object) - An object for configuring/implementing custom admin authentication - **authentication** - (object) - An object for configuring/implementing custom admin authentication
- enableApiToken (boolean) - Should unleash require API tokens for access? Defaults to `true` - enableApiToken (boolean) - Should unleash require API tokens for access? Defaults to `true`
- type (string) What kind of authentication to use. Possible values - type (string) What kind of authentication to use. Possible values
- `open-source` - - `open-source` - Sign in with username and password. This is the default value.
- `custom` - If implementing your own authentication hook, use this - `custom` - If implementing your own authentication hook, use this
- `none` - Turn off authentication all together - `none` - Turn off authentication all together
- `demo` - Only requires an email to sign-in (was default in v3) - `demo` - Only requires an email to sign in (was default in v3)
- customAuthHandler: (function) - custom express middleware handling authentication. Used when type is set to `custom` - customAuthHandler: (function) - custom express middleware handling authentication. Used when type is set to `custom`
- createAdminUser: (boolean) - whether to create an admin user with default password - Defaults to `true` - createAdminUser: (boolean) - whether to create an admin user with default password - Defaults to `true`
- initApiTokens: (ApiTokens[]) - Array of API tokens to create on startup. The tokens will only be created if the database doesn't already contain any API tokens. - initApiTokens: (ApiTokens[]) - Array of API tokens to create on startup. The tokens will only be created if the database doesn't already contain any API tokens.