diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 20 |
1 files changed, 10 insertions, 10 deletions
@@ -65,21 +65,21 @@ If set, logs will be written to the specified file. Otherwise, logs are written ## User Perms -### `LFME_WHITELIST_MODE` (Default: `"open"`) +### `LFME_ALLOWLIST_MODE` (Default: `"open"`) The following(case-insensitive) values are supported: - `open`: Allow requests for all users. -- `exclusive`: Only allow requests for users in `LFME_WHITELIST`, returning HTTP 403 for all others. `LFME_WHITELIST` _must_ be set if this mode is enabled. +- `exclusive`: Only allow requests for users in `LFME_ALLOWLIST`, returning HTTP 403 for all others. `LFME_ALLOWLIST` _must_ be set if this mode is enabled. If the user requested has their listen history private, a 403 will be returned. -### `LFME_WHITELIST` (Default: `""`) +### `LFME_ALLOWLIST` (Default: `""`) This is expected to be a sequence of comma-separated usernames. Leading/trailing whitespace will be stripped, and unicode is fully supported. -### `LFME_WHITELIST_REFRESH` (Default: `"1m"`) -The amount of time to cache whitelisted user info for. +### `LFME_ALLOWLIST_REFRESH` (Default: `"1m"`) +The amount of time to cache allowlisted user info for. It is interpreted as a sequence of `<num><suffix>` values, where `num` is a positive integer, and `suffix` is one of `y`,`mon`,`w`,`d`,`h`,`m`,`s`, `ms`, `µs`, or `ns`, each of which corresponds to a self-explanatory unit of time. @@ -87,8 +87,8 @@ For most practical applications, one should only use `m` and `s`, as caching you Parsing is delegated to the [`duration_str`](https://docs.rs/duration-str/latest/duration_str/) crate, and further info may be found there. ### `LFME_DEFAULT_REFRESH` (Default: `"5m"`) -The amount of time to cache non-whitelisted user info for. -See `LFME_WHITELIST_REFRESH` for more info. +The amount of time to cache non-allowlisted user info for. +See `LFME_ALLOWLIST_REFRESH` for more info. ## Themes @@ -139,9 +139,9 @@ LFME_API_KEY=0123456789abcdef0123456789abcdef LFME_LOG_LEVEL=error LFME_PORT=3000 -LFME_WHITELIST_REFRESH=30s -LFME_WHITELIST_MODE=exclusive -LFME_WHITELIST=a_precious_basket_case, realRiversCuomo, Pixiesfan12345 +LFME_ALLOWLIST_REFRESH=30s +LFME_ALLOWLIST_MODE=exclusive +LFME_ALLOWLIST=a_precious_basket_case, realRiversCuomo, Pixiesfan12345 ``` # Theming {#theming} |