From 5aa822ae4d3b0d71c84cb0d9763420e11bb2a075 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jeremiah=20Men=C3=A9trey?= Date: Sun, 5 May 2024 18:04:06 +0200 Subject: [PATCH] Add links in the main options page --- .../en/docs/Usage/configuration-options.md | 27 ++++++++++--------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/content/en/docs/Usage/configuration-options.md b/content/en/docs/Usage/configuration-options.md index 3e5781e..03d1556 100644 --- a/content/en/docs/Usage/configuration-options.md +++ b/content/en/docs/Usage/configuration-options.md @@ -105,16 +105,16 @@ make it all uppercase. Ex: `ND_LOGLEVEL=debug`. See below for all available opti ### Basic configuration -| In config file | As an env var | Description | Default Value | -|----------------|------------------|-------------------------------------------------------------------------------------------------------------------|------------------------------| -| | `ND_CONFIGFILE` | Load configurations from an external config file | `"./navidrome.toml"` | -| MusicFolder | `ND_MUSICFOLDER` | Folder where your music library is stored. Can be read-only | `"./music"` | -| DataFolder | `ND_DATAFOLDER` | Folder to store application data (DB) | `"./data"` | -| CacheFolder | `ND_CACHEFOLDER` | Folder to store cache data (transcoding, images...) | `"/cache"` | -| LogLevel | `ND_LOGLEVEL` | Log level. Useful for troubleshooting. Possible values: `error`, `warn`, `info`, `debug`, `trace` | `"info"` | -| Address | `ND_ADDRESS` | Address the server will bind to. Can be an IPv4 or IPv6. Also supports `unix:/path/to/file` for Unix socket files | `0.0.0.0` and `::` (all IPs) | -| BaseUrl | `ND_BASEURL` | Base URL to configure Navidrome behind a proxy (examples: `/music`, `https://music.example.com`) | _Empty_ | -| Port | `ND_PORT` | HTTP port Navidrome will use | `4533` | +| In config file | As an env var | Description | Default Value | +|----------------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------|------------------------------| +| | `ND_CONFIGFILE` | Load configurations from an external config file | `"./navidrome.toml"` | +| MusicFolder | `ND_MUSICFOLDER` | Folder where your music library is stored. Can be read-only | `"./music"` | +| DataFolder | `ND_DATAFOLDER` | Folder to store application data (DB) | `"./data"` | +| CacheFolder | `ND_CACHEFOLDER` | Folder to store cache data (transcoding, images...) | `"/cache"` | +| LogLevel | `ND_LOGLEVEL` | Log level. Useful for troubleshooting. Possible values: `error`, `warn`, `info`, `debug`, `trace` | `"info"` | +| Address | `ND_ADDRESS` | Address the server will bind to. Can be an IPv4 or IPv6. Also supports `unix:/path/to/file` for Unix socket files[\*][reverse-proxy-auth] | `0.0.0.0` and `::` (all IPs) | +| BaseUrl | `ND_BASEURL` | Base URL to configure Navidrome behind a proxy (examples: `/music`, `https://music.example.com`) | _Empty_ | +| Port | `ND_PORT` | HTTP port Navidrome will use | `4533` | ### Advanced configuration @@ -166,8 +166,8 @@ make it all uppercase. Ex: `ND_LOGLEVEL=debug`. See below for all available opti | Prometheus.Enabled | `ND_PROMETHEUS_ENABLED` | Enable extra endpoint with [Prometheus](https://prometheus.io/docs/introduction/overview/) metrics. | `false` | | Prometheus.MetricsPath | `ND_PROMETHEUS_METRICSPATH` | Custom path for Prometheus metrics. Useful for blocking unauthorized metrics requests. | `"/metrics"` | | RecentlyAddedByModTime | `ND_RECENTLYADDEDBYMODTIME` | Uses music files' modification time when sorting by "Recently Added". Otherwise use import time | `false` | -| ReverseProxyUserHeader[\*][reverse-proxy-auth] | `ND_REVERSEPROXYUSERHEADER` | HTTP header containing user name from authenticated proxy | `"Remote-User"` | -| ReverseProxyWhitelist[\*][reverse-proxy-auth] | `ND_REVERSEPROXYWHITELIST` | Comma separated list of IP CIDRs which are allowed to use reverse proxy authentication, empty means "deny all" | _Empty_ | +| ReverseProxyUserHeader[\*][reverse-proxy-auth] | `ND_REVERSEPROXYUSERHEADER` | HTTP header containing user name from authenticated proxy. Click [here][reverse-proxy-config] for details | `"Remote-User"` | +| ReverseProxyWhitelist[\*][reverse-proxy-auth] | `ND_REVERSEPROXYWHITELIST` | Comma separated list of IP CIDRs which are allowed to use reverse proxy authentication, empty means "deny all". Click [here][reverse-proxy-config] for details | _Empty_ | | Scanner.Extractor[\*][extractors] | `ND_SCANNER_EXTRACTOR` | Select metadata extractor implementation. Options: `taglib` or `ffmpeg` | `"taglib"` | | Scanner.GenreSeparators | `ND_SCANNER_GENRESEPARATORS` | List of separators to split genre tags | `";/,"` | | Scanner.GroupAlbumReleases | `ND_SCANNER_GROUPALBUMRELEASES` | "true" groups albums with the same Artist + Album Title as one album; "false" splits re-issues (=different Release Date) into separate albums | `false` | @@ -203,8 +203,9 @@ make it all uppercase. Ex: `ND_LOGLEVEL=debug`. See below for all available opti [lastfm-integration]: /docs/usage/external-integrations/#lastfm [encrypt-passwords]: /docs/usage/security/#encrypted-passwords [reverse-proxy-auth]: /docs/usage/security/#reverse-proxy-authentication +[reverse-proxy-config]: /docs/usage/reverse-proxy [albumcoverart]: /docs/usage/artwork/#albums -[artistcoverart]: /docs/usage/artwork/#artists +[artistcoverart]: /docs/usage/artwork/#artists [mediafilecoverart]: /docs/usage/artwork/#mediafiles [jukebox-mode]: /docs/usage/jukebox [jukebox-config]: /docs/usage/jukebox/#configuration