Merge pull request #469 from robotichead/documentation

Adding minio documentation & fixing documentation issues
nearbeach · Sep 23, 2023 · cbe4012 · cbe4012
2 parents aa31d90 + 35765c4
commit cbe4012
Show file tree

Hide file tree

Showing 3 changed files with 58 additions and 2 deletions.
diff --git a/docs/001-installation/different-blob-storage/minio.rst b/docs/001-installation/different-blob-storage/minio.rst
@@ -4,4 +4,59 @@
 Use Minio Blob Storage
 ======================
 
-Currently testing Minio solution
+.. note::
+
+    It is assumed that you have a Minio account.
+
+NearBeach uses Boto3 to connect to Minio. To find more information about Boto3 please go to `their documentation <https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3.html>`_
+
+------------
+Instructions
+------------
+
+Modify your docker-compose file to include the fields
+
+* AWS_ACCESS_KEY_ID
+* AWS_SECRET_ACCESS_KEY
+* AWS_STORAGE_BUCKET_NAME
+* AWS_S3_ENDPOINT_URL
+
+The following is an example snippet of code
+
+.. code-block:: bash
+
+    version: '3'
+
+    services:
+        ...
+        nearbeach:
+            image: robotichead/nearbeach:latest
+            container_name: nearbeach
+            environment:
+            - SECRET_KEY=<<Please fill>>
+            - SMTP_EMAIL_HOST=<<Please fill>>
+            - SMTP_EMAIL_PORT=<<Please fill>>
+            - SMTP_EMAIL_HOST_USER=<<Please fill>>
+            - SMTP_EMAIL_HOST_PASSWORD=<<Please fill>>
+            - DB_DATABASE=<<Please fill>>
+            - DB_USER=<<Please fill>>
+            - DB_PASSWORD=<<Please fill>>
+            - DB_HOST=nearbeach-db
+            - DB_ENGINE=mysql
+            - DB_PORT=3306
+            - ADMIN_USERNAME=<<Please fill>>
+            - ADMIN_EMAIL=<<Please fill>>
+            - CSRF_TRUSTED_URLS=<<https://yourdomain.com.au>>
+            - AWS_ACCESS_KEY_ID=<<Please fill>>
+            - AWS_SECRET_ACCESS_KEY=<<Please fill>>
+            - AWS_STORAGE_BUCKET_NAME=<<Please fill>>
+            - AWS_S3_ENDPOINT_URL=<<Please fill>>
+            volumes:
+        ...
+
+
+Please follow any Minio instructions on how to obtain the Access Key and Secret Access Key.
+
+The storage bucket name should match the bucket name created in the minio client.
+
+The S3 endpoint url is the API endpoint for minio. i.e. localhost:9000
diff --git a/docs/005-procedures/deployment/deployment.rst b/docs/005-procedures/deployment/deployment.rst
@@ -65,6 +65,7 @@ Checklist and Method
 
 #. Update any virtualenv packages using the following commands
     `pip list --outdated`
+
     `pip install --upgrade <<package_name>>`
 
 #. Run the following command to setup the dists file

diff --git a/docs/005-procedures/index.rst b/docs/005-procedures/index.rst
@@ -7,7 +7,7 @@ Procedures
 The following documents cover procedures around NearBeach.
 
 .. toctree::
-    :maxdepth: 3
+    :maxdepth: 2
     :caption: Procedures
 
     Deployment of NearBeach </005-procedures/deployment/deployment>