Skip to content
Closed
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion getting-started/installation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Docker Compose is the recommended platform.

#### Core

<table><thead><tr><th width="225">Name</th><th>Description</th></tr></thead><tbody><tr><td><code>PUID</code><br><br>(required)</td><td>Used to set the user the container should run as. To find your UID run <code>id username</code> on the host machine.<br><br>- Default: <code>1000</code></td></tr><tr><td><code>PGID</code><br><br>(required)</td><td>Used to set the group the container should run as. To find your GID run <code>id username</code> on the host machine.<br><br>- Default: <code>1000</code></td></tr><tr><td><code>APP_KEY</code></td><td>Key used to encrypt and decrypt data. To create a key to persist follow the directions in the <a href="../../help/faqs.md#i-get-a-warning-on-container-start-up-that-the-app_key-is-missing">FAQ</a>.<br><br><em>Currently not used and generated at random on startup of the container</em>.</td></tr><tr><td><code>APP_DEBUG</code></td><td>Used to help narrow down issues in a running container, see <a href="../../help/faqs.md#im-getting-a-500-or-server-error-error">FAQ</a> for when to use it.<br><br>- Default: <code>false</code></td></tr><tr><td><code>DB_CONNECTION</code><br><br>(required)</td><td>Type of database to be used for storing data. Accepted values are <code>sqlite</code>, <code>mysql</code> and <code>pgsql</code>.</td></tr><tr><td><code>DB_HOST</code><br><br>(required)</td><td>FQDN or container name where the database is located.</td></tr><tr><td><code>DB_PORT</code></td><td>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.<br><br>- Default: <code>3306</code> when using MySQL or MariaDB<br>- Default: <code>5432</code> when using Postgresql</td></tr><tr><td><code>DB_DATABASE</code><br><br>(required)</td><td>Name of the database.</td></tr><tr><td><code>DB_USERNAME</code><br><br>(required)</td><td>Database user used to connect to the database. Needs <code>read/write</code> access.</td></tr><tr><td><code>DB_PASSWORD</code><br><br>(required)</td><td>Password for the user specified to connect to the database.</td></tr><tr><td><code>FORCE_HTTPS</code></td><td>Enforces the user of <code>https</code> protocol when viewing the UI, port 443 must be mapped to the container for this to work.<br><br>- Default: <code>false</code></td></tr></tbody></table>
<table><thead><tr><th width="225">Name</th><th>Description</th></tr></thead><tbody><tr><td><code>PUID</code><br><br>(required)</td><td>Used to set the user the container should run as. To find your UID run <code>id username</code> on the host machine.<br><br>- Default: <code>1000</code></td></tr><tr><td><code>PGID</code><br><br>(required)</td><td>Used to set the group the container should run as. To find your GID run <code>id username</code> on the host machine.<br><br>- Default: <code>1000</code></td></tr><tr><td><code>APP_KEY</code></td><td>Key used to encrypt and decrypt data. To create a key to persist follow the directions in the <a href="../../help/faqs.md#i-get-a-warning-on-container-start-up-that-the-app_key-is-missing">FAQ</a>.<br><br></td></tr><tr><td><code>APP_DEBUG</code></td><td>Used to help narrow down issues in a running container, see <a href="../../help/faqs.md#im-getting-a-500-or-server-error-error">FAQ</a> for when to use it.<br><br>- Default: <code>false</code></td></tr><tr><td><code>DB_CONNECTION</code><br><br>(required)</td><td>Type of database to be used for storing data. Accepted values are <code>sqlite</code>, <code>mysql</code> and <code>pgsql</code>.</td></tr><tr><td><code>DB_HOST</code><br><br>(required)</td><td>FQDN or container name where the database is located.</td></tr><tr><td><code>DB_PORT</code></td><td>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.<br><br>- Default: <code>3306</code> when using MySQL or MariaDB<br>- Default: <code>5432</code> when using Postgresql</td></tr><tr><td><code>DB_DATABASE</code><br><br>(required)</td><td>Name of the database.</td></tr><tr><td><code>DB_USERNAME</code><br><br>(required)</td><td>Database user used to connect to the database. Needs <code>read/write</code> access.</td></tr><tr><td><code>DB_PASSWORD</code><br><br>(required)</td><td>Password for the user specified to connect to the database.</td></tr><tr><td><code>FORCE_HTTPS</code></td><td>Enforces the user of <code>https</code> protocol when viewing the UI, port 443 must be mapped to the container for this to work.<br><br>- Default: <code>false</code></td></tr></tbody></table>

#### Functional

Expand Down