Merge pull request #528 from robotichead/documentation

Adding in system variables documentation
nearbeach · Oct 30, 2023 · b27755a · b27755a
2 parents bbfb7ac + df35efb
commit b27755a
Show file tree

Hide file tree

Showing 2 changed files with 51 additions and 1 deletion.
diff --git a/docs/003-administration-tasks/index.rst b/docs/003-administration-tasks/index.rst
@@ -8,7 +8,8 @@ There are a few things to do as administrator
 
 
 .. toctree::
-    :maxdepth: 3
+    :maxdepth: 1
     :caption: 🎣 Administration Tasks
 
     First Time Setup </003-administration-tasks/first-time-setup>
+    System Variables </003-administration-tasks/system-variables>
diff --git a/docs/003-administration-tasks/system-variables.rst b/docs/003-administration-tasks/system-variables.rst
@@ -0,0 +1,49 @@
+.. _system-variables:
+
+================
+System Variables
+================
+
+--------------------
+MAX_FILE_SIZE_UPLOAD
+--------------------
+
+Max file size upload determines how large a file a user can upload. By default it is set at 100MB.
+
+Examples of different values
+
++----------------------+-----------------+---------------+
+| Human Readable Value | MAX_FILE_UPLOAD | Notes         |
++======================+=================+===============+
+| 100MB                | 104857600       | Default Value |
++----------------------+-----------------+---------------+
+| 10MB                 | 10485760        |               |
++----------------------+-----------------+---------------+
+| 1GB                  | 1048576000      |               |
++----------------------+-----------------+---------------+
+
+------------------
+SESSION_COOKIE_AGE
+------------------
+
+Sesseion cookie age is a Django setting attribute - https://docs.djangoproject.com/en/4.2/ref/settings/#std-setting-SESSION_COOKIE_AGE
+Use this setting to automatically log a user out after x amount of seconds
+
+Example values
+
++----------------------+-----------------+-------------------+
+| Human Readable Value | MAX_FILE_UPLOAD | Notes             |
++======================+=================+===================+
+| 2 weeks              | 1209600         | Default Value     |
++----------------------+-----------------+-------------------+
+| 1 hour               | 3600            | Recommended Value |
++----------------------+-----------------+-------------------+
+| 30 min               | 1800            |                   |
++----------------------+-----------------+-------------------+
+
+--------------------------
+SESSION_SAVE_EVERY_REQUEST
+--------------------------
+
+A django setting attribute - https://docs.djangoproject.com/en/4.2/ref/settings/#session-save-every-request
+Used to determine if the cookies are refreshed every single time the user utilises NearBeach. We recommend True