Better document MUSIC_DIRECTORY_PATH

changes/changelog.d/298.doc

@@ -0,0 +1 @@
+Improved documentation about in-place imports setup (#298)

deploy/env.prod.sample

@@ -113,4 +113,4 @@ RAVEN_DSN=https://44332e9fdd3d42879c7d35bf8562c6a4:0062dc16a22b41679cd5765e5342f
 # You can safely leave those settings uncommented if you don't plan to use
 # in place imports.
 # MUSIC_DIRECTORY_PATH=
-# MUSIC_DIRECTORY_SERVE_PATH=
+# MUSIC_DIRECTORY_SERVE_PATH=  # docker-only

deploy/nginx.conf

@@ -83,6 +83,7 @@ server {
         # this is an internal location that is used to serve
         # audio files once correct permission / authentication
         # has been checked on API side
+        # Set this to the same value as your MUSIC_DIRECTORY_PATH setting
         internal;
         alias   /srv/funkwhale/data/music;
     }

docs/configuration.rst

@@ -97,6 +97,12 @@ for this value. For non-docker installation, you can use any absolute path.
 
 .. note:: This path should not include any trailing slash
 
+.. warning::
+
+   You need to adapt your :ref:`reverse-proxy configuration<reverse-proxy-setup>` to
+   serve the directory pointed by ``MUSIC_DIRECTORY_PATH`` on
+   ``/_protected/music`` URL.
+
 .. _setting-MUSIC_DIRECTORY_SERVE_PATH:
 
 ``MUSIC_DIRECTORY_SERVE_PATH``