Skip to content

Commit 29b01bb

Browse files
committed
webui configs
1 parent 0876226 commit 29b01bb

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

docs/server-docs/configuration.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,17 @@ This page describes the various configuration properties used in the application
3131
| `SERVER_ADMIN_USERNAME` | Used for role recovery of existing users. The server grants Admin Role to an existing User with this username on register or startup. **⚠️ This won't register a new account!** | - | Any username |
3232
| `SERVER_ADMIN_PASSWORD` | Used for password recovery of existing users. Resets the password of the existing user with the username set in `SERVER_ADMIN_USERNAME` to this password on startup. **⚠️ This won't register a new account!** | - | Any password (No Length Validation) |
3333
| `SERVER_API_DOCS_ENABLED` | Enables the API Documentation on `/api/docs`, `/api/docs-json` & `/api/docs/yaml`. | `false` | `true`, `false` |
34-
| `SERVER_WEB_UI_ENABLED` | Whether or not the web ui should be used. | `true` | `true`, `false` |
3534
| `SERVER_MAX_DOWNLOAD_BANDWIDTH_IN_KBPS` | Maximum bandwidth for downloads on this server in KB/s. | - (Unlimited) | Any Number |
3635
| `SERVER_ONLINE_ACTIVITIES_DISABLED` | Whether or not the server should listen to online activities like "ONLINE", "BUSY", "PLAYING" etc. If this is set to true, all users will always be shown as offline. | `false` | `true`, `false` |
3736
| `SERVER_STACK_TRACE_LIMIT` | Configures the maximum number of stack frames to display in error stack traces, with a higher value providing more detailed debugging information. | `10` | Any Number |
3837

38+
## WEB UI
39+
40+
| Property | Description | Default | Possible Values |
41+
| ---------------- | ------------------------------------------------------------ | ------- | --------------- |
42+
| `WEB_UI_ENABLED` | Whether or not the web ui should be used. | `true` | `true`, `false` |
43+
| `WEB_UI_VERSION` | You can force a specific web ui version using this property. | - | `e.g. 16.0.0` |
44+
3945
## VOLUMES
4046

4147
| Property | Description | Default | Possible Values |
@@ -144,3 +150,4 @@ This page describes the various configuration properties used in the application
144150
| `TESTING_MOCK_FILES` | If `true`, the server will mock all files or ignore filesystem functionalities. Useful for testing without real files. | `false` | `true`, `false` |
145151
| `TESTING_IN_MEMORY_DB` | If `true`, the server will use an in-memory database. Useful for testing without creating an actual database. Only works with SQLITE. | `false` | `true`, `false` |
146152
| `TESTING_MOCK_PROVIDERS` | If `true`, the server will create two mock providers. (-9999 and 9999 Priority) Useful for testing metadata-merges. | `false` | `true`, `false` |
153+
| `TESTING_WEB_UI_UNSTABLE` | If `true`, the server will download and use the unstable pre-release of the Web UI on every startup. Useful for testing the web UI. | `false` | `true`, `false` |

0 commit comments

Comments
 (0)