holm/django-helpdeskmig
1
0
Fork 0
mirror of https://gitea.mueller.network/extern/django-helpdesk.git synced 2024-11-25 01:13:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update standalone docs

Browse Source
This commit is contained in:
Timothy Hobbs 2024-09-10 15:22:56 +02:00
parent 6073324bc7
commit f1053fbee2
2 changed files with 9 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/standalone.rst
View File

@ -3,6 +3,8 @@ Standalone Installation
You can find standalone docker images at `djangohelpdesk/standalone:latest <https://hub.docker.com/r/djangohelpdesk/standalone/tags>`_. You can find standalone docker images at `djangohelpdesk/standalone:latest <https://hub.docker.com/r/djangohelpdesk/standalone/tags>`_.
You will also find an alternative `standalone-extras <https://hub.docker.com/r/djangohelpdesk/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 <https://github.com/django-helpdesk/django-helpdesk/blob/main/standalone/requirements-extras.txt>`_.
Installation using docker-compose Installation using docker-compose
------------ ------------
@ -30,6 +32,7 @@ Installation using docker-compose
docker-compose up docker-compose up
Creating an Admin User Creating an Admin User
---------------------- ----------------------
@ -86,6 +89,8 @@ Configuration for Production Use
AWS SES Email Configuration 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: An example `local_settings` configuration for utilizing AWS SES for email:
.. code-block:: python .. 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_SES_REGION_ENDPOINT = "email.eu-west-1.amazonaws.com"
AWS_SECRET_ACCESS_KEY = os.environ.get("AWS_SECRET_ACCESS_KEY") 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. Make sure you update the `docker.env` file with the necessary secrets.
S3 base attachment support 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`: Working from the previous SES example we add the following to `local_settings`:
.. code-block:: python .. code-block:: python
@ -126,10 +127,3 @@ Working from the previous SES example we add the following to `local_settings`:
AWS_DEFAULT_ACL = "private" AWS_DEFAULT_ACL = "private"
DEFAULT_FILE_STORAGE = "storages.backends.s3boto3.S3Boto3Storage" 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

2
standalone/README.md
View File

@ -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 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.