@@ -102,15 +102,27 @@ This limitation only applies to `.env` files. Environment variables set directly
102102
103103</Warning >
104104
105- ### Database Variables (Required)
105+ ### Required Variables
106106
107107| Variable | Description |
108108| ------------- | ----------------------------------------------------------- |
109109| ` DB_HOST ` | PostgreSQL host (e.g., ` localhost ` or ` db.yourcompany.com ` ) |
110110| ` DB_PORT ` | PostgreSQL port (e.g., ` 5432 ` ) |
111111| ` DB_USER ` | Database username (e.g., ` postgres ` ) |
112112| ` DB_PASSWORD ` | Database password (e.g., ` postgres ` ) |
113- | ` SECRET_KEY ` | Secret key for encryption (generate a random string) |
113+ | ` SECRET_KEY ` | Secret key for encryption (generate with command below) |
114+
115+ ** Generate SECRET_KEY:**
116+
117+ ``` bash
118+ openssl rand -base64 32
119+ ```
120+
121+ <Warning >
122+ ** IMPORTANT** : Never change your ` SECRET_KEY ` after initial setup. It encrypts all workspace
123+ integration secrets (email provider API keys, SMTP passwords, etc.). Changing it will permanently
124+ destroy all encrypted credentials.
125+ </Warning >
114126
115127### Application Variables (Optional with Setup Wizard)
116128
@@ -131,12 +143,14 @@ These variables can be configured via the Setup Wizard on first launch, or set a
131143
132144| Variable | Description | Default |
133145| ----------------------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------ |
146+ | |
134147| ** Server Configuration** |
135148| ` SERVER_PORT ` | Port for the server to listen on (e.g., ` 8080 ` ) | ` 8080 ` |
136149| ` SERVER_HOST ` | Host address to bind to (e.g., ` 0.0.0.0 ` ) | ` 0.0.0.0 ` |
137150| ` CORS_ALLOW_ORIGIN ` | CORS allowed origins (e.g., ` https://yourapp.com,https://admin.yourapp.com ` ) | ` * ` |
138151| ` ENVIRONMENT ` | Environment mode (e.g., ` production ` ) | ` production ` |
139152| ` LOG_LEVEL ` | Logging level (e.g., ` debug ` or ` warn ` ) | ` info ` |
153+ | |
140154| ** Database Configuration** |
141155| ` DB_PREFIX ` | Database table prefix (e.g., ` notifuse ` ) | ` notifuse ` |
142156| ` DB_NAME ` | Database name (e.g., ` notifuse_system ` ) | ` ${DB_PREFIX}_system ` |
@@ -145,13 +159,16 @@ These variables can be configured via the Setup Wizard on first launch, or set a
145159| ` DB_MAX_CONNECTIONS_PER_DB ` | Max connections per workspace database (e.g., ` 3 ` ) | ` 3 ` |
146160| ` DB_CONNECTION_MAX_LIFETIME ` | Maximum lifetime of a connection (e.g., ` 10m ` ) | ` 10m ` |
147161| ` DB_CONNECTION_MAX_IDLE_TIME ` | Maximum idle time before closing connection (e.g., ` 5m ` ) | ` 5m ` |
162+ | |
148163| ** Task Scheduler Configuration** |
149164| ` TASK_SCHEDULER_ENABLED ` | Enable internal task scheduler (e.g., ` true ` or ` false ` ) | ` true ` |
150165| ` TASK_SCHEDULER_INTERVAL ` | Task execution interval in seconds (e.g., ` 30 ` ) | ` 30 ` |
151166| ` TASK_SCHEDULER_MAX_TASKS ` | Maximum concurrent tasks (e.g., ` 10 ` ) | ` 10 ` |
167+ | |
152168| ** Privacy Settings** |
153169| ` TELEMETRY ` | Send anonymous usage statistics (e.g., ` true ` or ` false ` ) | ` true ` |
154170| ` CHECK_FOR_UPDATES ` | Check for new versions (e.g., ` true ` or ` false ` ) | ` true ` |
171+ | |
155172| ** Tracing Configuration** |
156173| ` TRACING_ENABLED ` | Enable tracing (e.g., ` true ` ) | ` false ` |
157174| ` TRACING_SERVICE_NAME ` | Service name for tracing (e.g., ` notifuse-production ` ) | ` notifuse-api ` |
0 commit comments