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

docs: document the new demoAllowAdminLogin option (#6902)

Browse Source 
This PR adds docs for the new `demoAllowAdminLogin` option, including
how to use it and what it does.

Documents the changes introduced in https://github.com/Unleash/unleash/pull/6808
This commit is contained in:
Thomas Heartman 2024-04-23 09:08:07 +02:00 committed by GitHub
parent 131e9dd6d6
commit e7fe31ec6a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -82,7 +82,7 @@ unleash.start(unleashOptions);
- `initialAdminUser`: `{ username: string, password: string} | null` — whether to create an admin user with default - `initialAdminUser`: `{ username: string, password: string} | null` — whether to create an admin user with default
password - Defaults to using `admin` and `unleash4all` as the username and password. Can not be overridden by password - Defaults to using `admin` and `unleash4all` as the username and password. Can not be overridden by
setting the `UNLEASH_DEFAULT_ADMIN_USERNAME` and `UNLEASH_DEFAULT_ADMIN_PASSWORD` environment variables. setting the `UNLEASH_DEFAULT_ADMIN_USERNAME` and `UNLEASH_DEFAULT_ADMIN_PASSWORD` environment variables.
- `initApiTokens` / `INIT_ADMIN_API_TOKENS`, `INIT_CLIENT_API_TOKENS`, - `initApiTokens` / `INIT_ADMIN_API_TOKENS`, `INIT_CLIENT_API_TOKENS`,
and `INIT_FRONTEND_API_TOKENS`: `ApiTokens[]` — Array of API tokens to create on startup. The tokens will only and `INIT_FRONTEND_API_TOKENS`: `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. Example: be created if the database doesn't already contain any API tokens. Example:
@ -107,6 +107,8 @@ unleash.start(unleashOptions);
in `INIT_ADMIN_API_TOKENS`, `INIT_CLIENT_API_TOKENS`, and `INIT_FRONTEND_API_TOKENS` will be created as admin, in `INIT_ADMIN_API_TOKENS`, `INIT_CLIENT_API_TOKENS`, and `INIT_FRONTEND_API_TOKENS` will be created as admin,
client, and frontend tokens respectively, and Unleash will assign usernames automatically. client, and frontend tokens respectively, and Unleash will assign usernames automatically.
- `demoAllowAdminLogin` / `AUTH_DEMO_ALLOW_ADMIN_LOGIN`: `boolean` — Allows you to log in as the admin user when running Unleash with the `demo` auth type. To log in as the admin user, use `admin` as your email. Defaults to `false`.
- **databaseUrl** - (_deprecated_) the postgres database url to connect to. Only used if _db_ object is not specified, - **databaseUrl** - (_deprecated_) the postgres database url to connect to. Only used if _db_ object is not specified,
and overrides the _db_ object and any environment variables that change parts of it (like `DATABASE_SSL`). Should and overrides the _db_ object and any environment variables that change parts of it (like `DATABASE_SSL`). Should
include username/password. This value may also be set via the `DATABASE_URL` environment variable. Alternatively, if include username/password. This value may also be set via the `DATABASE_URL` environment variable. Alternatively, if