From f1053fbee234f5ae08c5415aa96d472c32fc9c43 Mon Sep 17 00:00:00 2001 From: Timothy Hobbs Date: Tue, 10 Sep 2024 15:22:56 +0200 Subject: [PATCH] Update standalone docs --- docs/standalone.rst | 20 +++++++------------- standalone/README.md | 2 ++ 2 files changed, 9 insertions(+), 13 deletions(-) diff --git a/docs/standalone.rst b/docs/standalone.rst index cee28582..fa8f22b2 100644 --- a/docs/standalone.rst +++ b/docs/standalone.rst @@ -3,6 +3,8 @@ Standalone Installation You can find standalone docker images at `djangohelpdesk/standalone:latest `_. +You will also find an alternative `standalone-extras `_ image with extra libraries needed to use the standalone image on cloud platforms such as AWS. You can find a full list of extra packages included in the extra's image `here `_. + Installation using docker-compose ------------ @@ -30,6 +32,7 @@ Installation using docker-compose docker-compose up + Creating an Admin User ---------------------- @@ -86,6 +89,8 @@ Configuration for Production Use AWS SES Email Configuration --------------------------- +You will need to use the standalone-extras image for SES support. + An example `local_settings` configuration for utilizing AWS SES for email: .. code-block:: python @@ -101,18 +106,14 @@ An example `local_settings` configuration for utilizing AWS SES for email: AWS_SES_REGION_ENDPOINT = "email.eu-west-1.amazonaws.com" AWS_SECRET_ACCESS_KEY = os.environ.get("AWS_SECRET_ACCESS_KEY") -To integrate `django-ses`, bindmount a file to `/opt/extra-dependencies.txt` containing: - -.. code-block:: text - - django-ses - Make sure you update the `docker.env` file with the necessary secrets. S3 base attachment support --------------------------- +You will need to use the standalone-extras image for S3 support. + Working from the previous SES example we add the following to `local_settings`: .. code-block:: python @@ -126,10 +127,3 @@ Working from the previous SES example we add the following to `local_settings`: AWS_DEFAULT_ACL = "private" DEFAULT_FILE_STORAGE = "storages.backends.s3boto3.S3Boto3Storage" - -To integrate `django-ses`, bindmount a file to `/opt/extra-dependencies.txt` containing: - -.. code-block:: text - - django-storages - boto3 diff --git a/standalone/README.md b/standalone/README.md index 7b68fbe7..3421ea75 100644 --- a/standalone/README.md +++ b/standalone/README.md @@ -5,3 +5,5 @@ This is a standalone installation of Django-helpdesk allowing you to run django- For installation instructions see [the documentation](../docs/standalone.rst) +For development and testing purposes, the `docker-compose-dev.yml` file will build the standalone docker images from source. +