From cdccbbb01d499bc5ce2753c956e4dd67c5d134eb Mon Sep 17 00:00:00 2001
From: Rosarch <rosarch@users.noreply.github.com>
Date: Sat, 8 Jun 2024 20:15:43 +0100
Subject: [PATCH] Update README.md

Updated APP_KEY section to reflect recent changes
---
 getting-started/installation/README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

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