diff --git a/changes/changelog.d/298.doc b/changes/changelog.d/298.doc new file mode 100644 index 0000000000000000000000000000000000000000..d8db45d6b3482e34c10659bba9fcccf96852df03 --- /dev/null +++ b/changes/changelog.d/298.doc @@ -0,0 +1 @@ +Improved documentation about in-place imports setup (#298) diff --git a/deploy/env.prod.sample b/deploy/env.prod.sample index 42659a0dabc33cf2da439b21f06f77163c544722..64ff3d4dfb7c1bdeaf7841a24c19aa668f9ad2f3 100644 --- a/deploy/env.prod.sample +++ b/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 diff --git a/deploy/nginx.conf b/deploy/nginx.conf index e86424d0b3a4ab1f47d36b48f64e5cb489471d03..b403f4388f9bf69399ed3479715c778fc1b837e6 100644 --- a/deploy/nginx.conf +++ b/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; } diff --git a/docs/configuration.rst b/docs/configuration.rst index 46756bb266ccf918314f57b8ef8b01dcb68409ce..af69379a4c3dd97378f52beba0eb9ca7a31232de 100644 --- a/docs/configuration.rst +++ b/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``