Skip to content

Commit 024e691

Browse files
docs: add documentation for DISABLE_ENCRYPTION (#50)
* docs: add documentation for OVERRIDE_ENCRYPTION * chore: rename OVERRIDE_ENCRYPTION to DISABLE_ENCRYPTION * fix: DISABLE_ENCRYPTION callout list
1 parent d7d3fe2 commit 024e691

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

docs/self-hosting/configuration.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ The installation guides also explain where to find most of the environment varia
2424
```bash title=".env"
2525
DB_CONNECTION_URL="mysql://bots:VerySecurePassword123@localhost/tickets0"
2626
DB_PROVIDER=mysql
27+
DISABLE_ENCRYPTION=
2728
DISCORD_SECRET=rUpDU2T8K4ZXie8kdpzYsMTLbUhvmBRd
2829
DISCORD_TOKEN=ODcwOTg1TY0NjI0NODI2Mzc0.DNg0e0.UYVof7V1v0kRA0HHtGwXKA3URxwANAZhQiA
2930
ENCRYPTION_KEY=445940dbed49eff55df56dd646fa1cb4b686df4cb9ac004a
@@ -68,6 +69,20 @@ The type of database the bot will use; one of:
6869
- `#!yaml postgresql`
6970
- `#!yaml sqlite`
7071

72+
### `DISABLE_ENCRYPTION`
73+
74+
<small>:octicons-question-16: Optional</small>
75+
76+
When set to `#!yaml true` (must be lowercase), encryption/decryption calls will return the input data as-is, disabling data encryption for the instance.
77+
78+
!!! danger
79+
**Important!**
80+
Changing this option after initial setup requires a full database reset or migration.
81+
The migration process needs to **encrypt or decrypt all relevant data fields accordingly** to avoid errors.
82+
83+
- If you enable it after it was previously disabled or unset, the bot won't be able to decrypt some existing encrypted data properly.
84+
- If you disable it after it was previously enabled, the bot will error when trying to decrypt existing unencrypted data.
85+
7186
### `DISCORD_SECRET`
7287

7388
Your Discord application's secret key, used for OAuth2.

docs/self-hosting/installation/docker.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,7 @@ services:
103103
# https://discordtickets.app/self-hosting/configuration/#environment-variables
104104
environment:
105105
DB_CONNECTION_URL: mysql://tickets:insecure@mysql/tickets # (4)!
106+
DISABLE_ENCRYPTION: null
106107
DISCORD_SECRET: # (5)!
107108
DISCORD_TOKEN: # (6)!
108109
ENCRYPTION_KEY: # (7)!

0 commit comments

Comments
 (0)