diff --git a/getting-started/installation/README.md b/getting-started/installation/README.md index d54bcb5..16841b7 100644 --- a/getting-started/installation/README.md +++ b/getting-started/installation/README.md @@ -10,7 +10,7 @@ Docker Compose is the recommended platform. #### Core -
| Name | Description |
|---|---|
PUID(required) | Used to set the user the container should run as. To find your UID run id username on the host machine.- Default: 1000 |
PGID(required) | Used to set the group the container should run as. To find your GID run id username on the host machine.- Default: 1000 |
APP_KEY | Key used to encrypt and decrypt data. To create a key to persist follow the directions in the FAQ. Currently not used and generated at random on startup of the container. |
APP_DEBUG | Used to help narrow down issues in a running container, see FAQ for when to use it. - Default: false |
DB_CONNECTION(required) | Type of database to be used for storing data. Accepted values are sqlite, mysql and pgsql. |
DB_HOST(required) | FQDN or container name where the database is located. |
DB_PORT | Port used to connect to the host where the database is located. Only needs to be defined if the database is running on a different port. - Default: 3306 when using MySQL or MariaDB- Default: 5432 when using Postgresql |
DB_DATABASE(required) | Name of the database. |
DB_USERNAME(required) | Database user used to connect to the database. Needs read/write access. |
DB_PASSWORD(required) | Password for the user specified to connect to the database. |
FORCE_HTTPS | Enforces the user of https protocol when viewing the UI, port 443 must be mapped to the container for this to work.- Default: false |
| Name | Description |
|---|---|
PUID(required) | Used to set the user the container should run as. To find your UID run id username on the host machine.- Default: 1000 |
PGID(required) | Used to set the group the container should run as. To find your GID run id username on the host machine.- Default: 1000 |
APP_KEY | Key used to encrypt and decrypt data. To create a key to persist follow the directions in the FAQ. |
APP_DEBUG | Used to help narrow down issues in a running container, see FAQ for when to use it. - Default: false |
DB_CONNECTION(required) | Type of database to be used for storing data. Accepted values are sqlite, mysql and pgsql. |
DB_HOST(required) | FQDN or container name where the database is located. |
DB_PORT | Port used to connect to the host where the database is located. Only needs to be defined if the database is running on a different port. - Default: 3306 when using MySQL or MariaDB- Default: 5432 when using Postgresql |
DB_DATABASE(required) | Name of the database. |
DB_USERNAME(required) | Database user used to connect to the database. Needs read/write access. |
DB_PASSWORD(required) | Password for the user specified to connect to the database. |
FORCE_HTTPS | Enforces the user of https protocol when viewing the UI, port 443 must be mapped to the container for this to work.- Default: false |