Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Dedicated reverse proxy documentation #159

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
Open

Dedicated reverse proxy documentation #159

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
bb21f02
Dedicated reverse proxy documentation
crazygolem Apr 28, 2024
872fcf8
Move security stuff back to the security page
crazygolem May 1, 2024
f22aadf
Move subsonic for the navidrome webapp to its own section
crazygolem May 1, 2024
285c305
Add traefik example
crazygolem May 2, 2024
53cb9fb
Add Caddy example with subsonic response rewriting
crazygolem May 5, 2024
18057cd
Rephrasing, moving info around
crazygolem May 5, 2024
5aa822a
Add links in the main options page
crazygolem May 5, 2024
06417bd
Clarifications for the Navidrome Web App
crazygolem May 5, 2024
803d3f3
Merge branch 'master' into reverse-proxy-auth-doc
crazygolem May 5, 2024
5e0d908
Merge branch 'master' into reverse-proxy-auth-doc
crazygolem Sep 30, 2024
d1736bd
Update documentation for explicit socket auth config
crazygolem Sep 30, 2024
cb9fc13
Fix words in the wrong order
crazygolem Sep 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 15 additions & 14 deletions content/en/docs/Usage/configuration-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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...) | `"<DataFolder>/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...) | `"<DataFolder>/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, IPv6 or a UNIX socket file (`unix:/path/to/file`) | `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

Expand All @@ -136,7 +136,7 @@ make it all uppercase. Ex: `ND_LOGLEVEL=debug`. See below for all available opti
| EnableArtworkPrecache | `ND_ENABLEARTWORKPRECACHE` | Enable image pre-caching of new added music | `true` |
| EnableCoverAnimation | `ND_ENABLECOVERANIMATION` | Controls whether the player in the UI will animate the album cover (rotation) | `true` |
| EnableDownloads | `ND_ENABLEDOWNLOADS` | Enable the option in the UI to download music/albums/artists/playlists from the server | `true` |
| EnableExternalServices | `ND_ENABLEEXTERNALSERVICES`. | Set this to `false` to completely disable ALL external integrations | `true` |
| EnableExternalServices | `ND_ENABLEEXTERNALSERVICES` | Set this to `false` to completely disable ALL external integrations | `true` |
| EnableFavourites | `ND_ENABLEFAVOURITES` | Enable toggling "Heart"/"Loved" for songs/albums/artists in the UI (maps to "Star"/"Starred" in Subsonic Clients) | `true` |
| EnableGravatar | `ND_ENABLEGRAVATAR` | Use [Gravatar](https://gravatar.com/) images as the user profile image. Needs the user's email to be filled | `false` |
| EnableLogRedacting | `ND_ENABLELOGREDACTING` | Whether or not sensitive information (like tokens and passwords) should be redacted (hidden) in the logs | `true` |
Expand Down Expand Up @@ -170,8 +170,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 (or when listening on a UNIX socket the special value `@`) 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` |
Expand Down Expand Up @@ -208,7 +208,8 @@ make it all uppercase. Ex: `ND_LOGLEVEL=debug`. See below for all available opti
[spotify-integration]: /docs/usage/external-integrations/#spotify
[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-auth]: /docs/usage/security/#reverse-proxy-authentication "Reverse Proxy Authentication"
[reverse-proxy-config]: /docs/usage/reverse-proxy
[albumcoverart]: /docs/usage/artwork/#albums
[artistcoverart]: /docs/usage/artwork/#artists
[mediafilecoverart]: /docs/usage/artwork/#mediafiles
Expand Down
Loading