Skip to content

Commit

Permalink
docs: add keep-passwd-login option to README
Browse files Browse the repository at this point in the history
  • Loading branch information
@kuoruan
kuoruan committed Jan 20, 2025
1 parent f3cfa65 commit 8fc5eaa
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ Now you can use the openid-connect auth in the webUI.
| <details><summary>provider-type</summary>The provider type to get groups from the provider. Supported values: `gitlab`</details> | string | | No | `gitlab` |
| <details><summary>store-type</summary>The store type to store the OIDC state and caches.</details> | "in-memory" \| "redis" \| "file" | `in-memory` | No | `file` |
| <details><summary>store-config</summary>The store configuration.</details> | string \| object | `{ ttl: 60000 }` | No | `./store` |
| <details><summary>keep-passwd-login</summary>Keep the htpasswd login dialog. If set to `true`, the htpasswd login dialog will be kept.</details> | boolean | `undefined` | No | `true` |
| <details><summary>authorized-groups</summary>The groups that are allowed to login. Use `true` to ensure the user has at least one group, `false` means no groups check</details> | string \| string \| boolean | `false` | No | `true` |
| <details><summary>group-users</summary>The custom group users. If set, `groups-claim` and `provider-type` take no effect</details> | object | | No | `{"animal": ["Tom", "Jack"]}` |

Expand All @@ -107,7 +108,7 @@ When using the `in-memory` store, the `store-config` is an object with the follo

| Config key | Description | Value Type | Default | Required | Example |
| ---------- | ------------------------------------------------------------------------------------------------------------- | ---------------- | ------- | -------- | ------- |
| ttl | The TTL of the OIDC state (ms). | number \| string | 60000 | No | 1m |
| ttl | The TTL of the OIDC state (ms). | number \| string | `60000` | No | `1m` |
| ... | All options are passed to the [@isaacs/ttlcache](https://www.npmjs.com/package/@isaacs/ttlcache) constructor. | any | | No | |

2. redis
Expand All @@ -116,9 +117,11 @@ When using the `redis` store, the `store-config` is a string with the Redis conn

| Config key | Description | Value Type | Default | Required | Example |
| ---------- | ------------------------------------------------------------------------------------------- | ------------------------------ | ------- | -------- | ------------------------------------- |
| ttl | The TTL of the OIDC state (ms). | number \| string | 60000 | No | 1m |
| ttl | The TTL of the OIDC state (ms). | number \| string | `60000` | No | `1m` |
| username | The username of the Redis connection. | string | | No | `your-username` |
| password | The password of the Redis connection. | string | | No | `your-password` |
| host | The host of the Redis connection. | string | | No | `localhost` |
| port | The port of the Redis connection. | number | | No | `6379` |
| nodes | The nodes of the Redis Cluster connection. | (object \| string \| number)[] | | No | `[{ host: 'localhost', port: 6379 }]` |
| ... | All options are passed to the [ioredis](https://www.npmjs.com/package/ioredis) constructor. | any | | No | |

Expand All @@ -145,7 +148,7 @@ auth:
port: 6379
```
When using Redis Cluster, the `nodes` config is required.
When using Redis Cluster, you should use the `nodes` property:

```yaml
auth:
Expand All @@ -170,7 +173,7 @@ When using the `file` store, the `store-config` is a string with the file path t

| Config key | Description | Value Type | Default | Required | Example |
| ---------- | ----------------------------------------------------------------------------------------------------- | ---------------- | ------- | -------- | --------- |
| ttl | The TTL of the OIDC state (ms). | number \| string | 60000 | No | 1m |
| ttl | The TTL of the OIDC state (ms). | number \| string | `60000` | No | `1m` |
| dir | The directory to store the OIDC state. | string | | No | `./store` |
| ... | All options are passed to the [node-persist](https://www.npmjs.com/package/node-persist) constructor. | any | | No | |

Expand All @@ -192,6 +195,16 @@ auth:
dir: ./store
```

#### keep-passwd-login

If you want to keep the htpasswd login dialog, set the `keep-passwd-login` to `true`.

By default, if `auth.htpasswd.file` is set, the htpasswd login dialog will be keep.

With this, you can use both the htpasswd login and the OIDC login.

![Login Dialog](./images/login-dialog.png)

### Environment Variables

You can set each config with environment variables to avoid storing sensitive information in the config file.
Expand Down
Binary file added images/login-dialog.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8fc5eaa

Please sign in to comment.