Skip to content

Commit 3c8ef6a

Browse files
committed
add TLS config
1 parent 0c2cd14 commit 3c8ef6a

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

docs/server-docs/configuration.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -43,18 +43,23 @@ This page describes the various configuration properties used in the application
4343
| `VOLUMES_LOGS` | Folder inside container used for logs. | `/logs` | Any valid folder path |
4444
| `VOLUMES_SQLITEDB` | Folder inside container used for `SQLITE` database. (Not needed if `DB_SYSTEM` is set to `POSTGRESQL`) | `/db` | Any valid folder path |
4545

46-
## DB
47-
48-
| Property | Description | Default | Possible Values |
49-
| ---------------- | ---------------------------------------------------------------------------------------------- | ------------ | ----------------------- |
50-
| `DB_SYSTEM` | The database system used (POSTGRESQL or SQLITE). | `POSTGRESQL` | `POSTGRESQL`, `SQLITE` |
51-
| `DB_HOST` | The host of the database (not needed for SQLITE). | `localhost` | Any valid host name |
52-
| `DB_PORT` | The port of the database (not needed for SQLITE). | `5432` | Any valid port number |
53-
| `DB_USERNAME` | The username for the database (not needed for SQLITE). | `default` | Any valid username |
54-
| `DB_PASSWORD` | The password for the database (not needed for SQLITE). | `default` | Any valid password |
55-
| `DB_DATABASE` | The database name (not needed for SQLITE). | `gamevault` | Any valid database name |
56-
| `DB_SYNCHRONIZE` | Force synchronizes the database with the entities. ⚠️ CAUTION: This could break your database! | `false` | `true`, `false` |
57-
| `DB_DEBUG` | Log all SQL Statements sent to the database. | `false` | `true`, `false` |
46+
Sure, here's the filled-in table:
47+
48+
| Property | Description | Default | Possible Values |
49+
| ------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------------------------------------- |
50+
| `DB_SYSTEM` | The database system used (POSTGRESQL or SQLITE). | `POSTGRESQL` | `POSTGRESQL`, `SQLITE` |
51+
| `DB_HOST` | The host of the database (not needed for SQLITE). | `localhost` | Any valid host name |
52+
| `DB_PORT` | The port of the database (not needed for SQLITE). | `5432` | Any valid port number |
53+
| `DB_USERNAME` | The username for the database (not needed for SQLITE). | `default` | Any valid username |
54+
| `DB_PASSWORD` | The password for the database (not needed for SQLITE). | `default` | Any valid password |
55+
| `DB_DATABASE` | The database name (not needed for SQLITE). | `gamevault` | Any valid database name |
56+
| `DB_SYNCHRONIZE` | Force synchronizes the database with the entities. ⚠️ CAUTION: This could break your database! | `false` | `true`, `false` |
57+
| `DB_DEBUG` | Log all SQL Statements sent to the database. | `false` | `true`, `false` |
58+
| `DB_TLS_ENABLED` | Enable TLS encryption for the Database connection. (not needed for SQLITE). | `false` | `true`, `false` |
59+
| `DB_TLS_REJECT_UNAUTHORIZED_ENABLED` | Whether or not to reject connections if the Database server's certificate is not signed by a trusted CA. (not needed for SQLITE). | `false` | `true`, `false` |
60+
| `DB_TLS_CA_CERTIFICATE_PATH` | The file path to the root certificate authority (CA) certificate. If using Docker, you need to mount it there. (not needed for SQLITE). | - | `/path/to/server-certificates/root.crt` |
61+
| `DB_TLS_KEY_PATH` | The file path to the client's private key for TLS authentication. If using Docker, you need to mount it there. (not needed for SQLITE). | - | `/path/to/client-key/database.key` |
62+
| `DB_TLS_CERTIFICATE_PATH` | The file path to the client's TLS certificate. If using Docker, you need to mount it there. (not needed for SQLITE). | - | `/path/to/client-certificates/database.crt` |
5863

5964
## RAWG_API
6065

0 commit comments

Comments
 (0)