-
-
Notifications
You must be signed in to change notification settings - Fork 229
Configuration
Besides the settings that can be configured through the client itself (by clicking the user profile image at the top left), which are described in the interface itself, there are internal settings mostly meant for admins and advanced users to further configure the behaviour of the client.
-
Default servers: Jellyfin servers that will be always available through the server selection menu. Before setting this value, test if the server URL is accesible and valid for Jellyfin Vue by adding the server manually.
-
Router mode: Whether to use the hash or history mode. Hash adds a shebang (#) to the URL routes, while history does not. More information at Vue Router's docs.
⚠️ History mode requires additional configuration in your webserver, specially if you're serving it in a subpath likehttps://domain.tld/vue
. See this as an starting point.
If you're not running Jellyfin Vue in our official Docker container (regardless if server is running through Docker or not), you must edit the config.json
file that it's located at the root of the directory where you deployed Jellyfin Vue.
Property | Type | Default value | Example |
---|---|---|---|
defaultServerURLs |
Array | [] |
['demo.jellyfin.org', '192.168.0.5:8096'] |
routerMode |
String: hash | router
|
hash |
"hash" |
The default value of hash
for the Vue Router provides a sane default for all the environments, as it doesn't require any additional configuration.
Configuration is performed by using environment variables. Under the hood, those environment variables are going to be written into config.json
in a way the frontend can understand, as explained in the section above
Environment variable | Description | Example |
---|---|---|
DEFAULT_SERVERS |
Comma separated string with server urls | demo.jellyfin.org,192.168.0.5:8096 |
HISTORY_ROUTER_MODE |
Either 0 (hash) or 1 (history) |
1 |
By default, the webserver inside the Docker image is preconfigured to work with history mode. Hence, history mode is enabled by default.