Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added some more deployment documentation #118

Merged
merged 3 commits into from
Jan 12, 2022
Merged

Added some more deployment documentation #118

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2a21529
Added deployment documentation
Jan 12, 2022
45a9cd6
Typos
Jan 12, 2022
d6b54d0
Typos
Jan 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 31 additions & 1 deletion doc/deployment/external.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,4 +163,34 @@ Setting up your environment
---------------------------

Now it's time to set up your environment. This is done by through the use of a
:code:`dotenv` file.
:code:`dotenv` file.

In the root directory of the project, you can find a :code:`.env.sample` file. It's strongly recommended that you use this as a starting point:

::

cp .env.sample .env

Inside of this file you will find a number of environment variables:

* :code:`FLASK_CONFIG=` A choice between :code:`deployment` and :code:`production`. :code:`production` disables debugging and stops SQLAlchemy spamming the console.
* :code:`POSTGRES_USER=` The username of your PostgreSQL user. If you are using the :code:`docker-compose` file then this will be used within the :code:`db` container.
* :code:`POSTGRES_PASSWORD=` The password of your PostgreSQL user. If you are using the :code:`docker-compose` file then this will be used within the :code:`db` container.
* :code:`POSTGRES_HOST=` The database host address of your PostgreSQL server. If you are deploying the project through :code:`docker-compose` then ensure that the name matches what is found within the :code:`docker-compose.yml` file (this is usually :code:`db`).
* :code:`POSTGRES_DB=` The database name for of your PostgreSQL server. If you are deploying the project through :code:`docker-compose` then ensure that the name matches what is found within the :code:`docker-compose.yml` file (this is usually :code:`limbus`).
* :code:`SECRET_KEY=` A secret key to protect you against XSS. Please change this.
* :code:`WTF_CSRF_SECRET_KEY=` A secret key to protect forms against XSS. Please change this.
* :code:`DOCUMENT_DIRECTORY=` Where you want your encrypted document store to be located. If you are using the :code:`docker-compose` file, then please ensure that you mount your location appropriately.
* :code:`TEMPLATES_DIRECTORY=` Where you want your templates store to be located. If you are using the :code:`docker-compose` file, then please ensure that you mount your location appropriately.
* :code:`DEBUG=` If you require debug information. In most deployments this should be set to False.
* :code:`DOID_PATH=` Where you want your DOID file to be located. If you are using the :code:`docker-compose` file, then please ensure that you mount your location appropriately.


.. note::
Please ensure that all secret keys and passwords are secure.


Do it for me
------------

No.