Skip to content

Commit

Permalink
Docker - update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
SamR1 committed Dec 28, 2024
1 parent 54da32e commit b572908
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 5 deletions.
3 changes: 2 additions & 1 deletion .env.docker.example
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

# Docker volumes
# export UPLOAD_DIR=
# export LOG_DIR=
# export DATABASE_DIR=
# export REDIS_DIR=

Expand All @@ -15,7 +16,7 @@ export UPLOAD_FOLDER=/usr/src/app/uploads

# PostgreSQL
export POSTGRES_USER=fittrackee
export POSTGRES_PASSWORD=fittrackee
export POSTGRES_PASSWORD=
export POSTGRES_DB=fittrackee
export DATABASE_URL=postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@fittrackee-db:5432/${POSTGRES_DB}
# export DATABASE_DISABLE_POOLING=
Expand Down
58 changes: 54 additions & 4 deletions docsrc/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -260,6 +260,48 @@ deployment method.

.. versionchanged:: 0.7.26 ⚠️ replaces ``VUE_APP_API_URL``

**FitTrackee** API URL, only needed in dev environment.

Docker
^^^^^^

.. versionadded:: 0.8.13

Environment variables for ``docker-compose.yml``

.. envvar:: DATABASE_DIR

Host directory for PostgreSQL data volume


.. envvar:: POSTGRES_USER

User for PostgreSQL database


.. envvar:: POSTGRES_PASSWORD

Password for PostgreSQL user


.. envvar:: POSTGRES_DB

Database name for FitTrackee application


.. envvar:: REDIS_DIR

Host directory for redis data volume


.. envvar:: LOG_DIR

Host directory for logs volume


.. envvar:: UPLOAD_DIR

Host directory for uploaded files volume


Emails
Expand Down Expand Up @@ -842,13 +884,17 @@ Docker
Production
^^^^^^^^^^

An image is available on `DockerHub <https://hub.docker.com/r/fittrackee/fittrackee>`_ or `Github registry <https://github.com/SamR1/FitTrackee/packages>`_.
Images are available on `DockerHub <https://hub.docker.com/r/fittrackee/fittrackee>`_ or `Github registry <https://github.com/SamR1/FitTrackee/packages>`_.

.. note::

Images are available for ``linux/amd64`` and ``linux/arm64`` platforms. Only ``linux/amd64`` image has been tested.

- create a ``docker-compose.yml`` file as needed (see the example in the repository):

- the minimal set up requires at least the database and the web application.
- to activate the rate limit, redis is required.
- to send e-mails, redis and workers are required and EMAIL_URL must be set in ``.env``.
- the minimal set up requires at least the database and the web application
- to activate the rate limit, redis is required
- to send e-mails, redis and workers are required and a valid ``EMAIL_URL`` variable must be set in ``.env``

.. note::
The same image is used by the web application and workers.
Expand All @@ -861,6 +907,10 @@ An image is available on `DockerHub <https://hub.docker.com/r/fittrackee/fittrac
$ docker compose up -d
.. warning::

Migrations are executed at startup. Please backup data before updating FitTrackee image version.

- to run a CLI command, for instance to give admin rights:

.. code:: bash
Expand Down

0 comments on commit b572908

Please sign in to comment.