Added note to docs about the default location of filepond_uploads dir…

… if the UPLOAD_TMP variable is not set.
ImperialCollegeLondon · Mar 26, 2019 · 6441584 · 6441584
1 parent af9e5b3
commit 6441584
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/docs/conf.py b/docs/conf.py
@@ -20,7 +20,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'django-drf-filepond'
-copyright = '2018, Jeremy Cohen, Imperial College London'
+copyright = '2019, Jeremy Cohen, Imperial College London'
 author = 'Jeremy Cohen'
 
 # The short X.Y version

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -43,6 +43,17 @@ variable to your settings file, e.g.::
 	DJANGO_DRF_FILEPOND_UPLOAD_TMP = os.path.join(BASE_DIR, 'filepond-temp-uploads')
 	...
 
+.. note:: It is strongly recommended that you set 
+	``DJANGO_DRF_FILEPOND_UPLOAD_TMP``. If you do not set this variable, the 
+	app will set a default location for the storage of temporary uploads. 
+	This is ``BASE_DIR/filepond_uploads`` where ``BASE_DIR`` is the variable 
+	defined by default in an auto-generated Django settings file pointing to 
+	the top-level directory of your Django project. If your settings do not 
+	contain ``BASE_DIR`` the app will default to storing the 
+	``filepond_uploads`` directory in the ``django-drf-filepond`` app  
+	directory, wherever that is located. Note that this may be within the  
+	``lib`` directory of a virtualenv.
+
 3. Include the app urls into your main url configuration
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^