From 4e9aa16d05e511498319da290da064be16e67b59 Mon Sep 17 00:00:00 2001
From: Jocelyn Delalande <jocelyn@crapouillou.net>
Date: Sun, 10 Jun 2018 22:51:24 +0200
Subject: [PATCH] Better document MUSIC_DIRECTORY_PATH
---
changes/changelog.d/298.doc | 1 +
deploy/env.prod.sample | 2 +-
deploy/nginx.conf | 1 +
docs/configuration.rst | 6 ++++++
4 files changed, 9 insertions(+), 1 deletion(-)
create mode 100644 changes/changelog.d/298.doc
diff --git a/changes/changelog.d/298.doc b/changes/changelog.d/298.doc
new file mode 100644
index 00000000..d8db45d6
--- /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 42659a0d..64ff3d4d 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 e86424d0..b403f438 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 46756bb2..af69379a 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``
--
GitLab