Skip to content

Commit 3a8d410

Browse files
committed
env vars
1 parent 26ac17d commit 3a8d410

1 file changed

Lines changed: 41 additions & 14 deletions

File tree

README.md

Lines changed: 41 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -111,33 +111,60 @@ Notifuse can be configured through environment variables or configuration files:
111111

112112
```env
113113
# Server configuration
114-
SERVER_PORT=4000
115-
SERVER_HOST=127.0.0.1
116-
ROOT_EMAIL=your@email.com
114+
SERVER_PORT=8080
115+
SERVER_HOST=0.0.0.0
116+
ROOT_EMAIL=your-email@example.com
117+
CORS_ALLOW_ORIGIN=*
117118
ENVIRONMENT=production
118-
API_ENDPOINT=https://your_endpoint.website.com
119-
LOG_LEVEL=info
119+
API_ENDPOINT=notifuse.your_website.com
120120
121121
# Database configuration
122122
DB_HOST=localhost
123123
DB_PORT=5432
124-
DB_USER=postgre
124+
DB_USER=postgres
125125
DB_PASSWORD=
126126
DB_PREFIX=notifuse
127127
DB_NAME=${DB_PREFIX}_system
128-
DB_SSLMODE=disable
128+
DB_SSLMODE=require
129129
130-
# System email configuration
130+
# Other configurations can be added here
131131
SMTP_HOST=smtp.example.com
132132
SMTP_PORT=587
133133
SMTP_USERNAME=your-username
134134
SMTP_PASSWORD=your-password
135-
SMTP_FROM=noreply@example.com
136-
137-
# Security configuration
138-
PASETO_PRIVATE_KEY="generated_private_key_here"
139-
PASETO_PUBLIC_KEY="generated_public_key_here"
140-
SECRET_KEY="your_complex_secret_key_here"
135+
SMTP_FROM_EMAIL=noreply@example.com
136+
SMTP_FROM_NAME=Notifuse
137+
138+
# Security
139+
PASETO_PRIVATE_KEY="base64:your-private-key"
140+
PASETO_PUBLIC_KEY="base64:your-public-key"
141+
SECRET_KEY="your_secret_key_for_db_secrets_encryption"
142+
143+
# Tracing
144+
TRACING_ENABLED=true
145+
TRACING_SERVICE_NAME=notifuse
146+
TRACING_SAMPLING_PROBABILITY=
147+
# Trace exporter configuration: jaeger | zipkin | stackdriver | datadog | xray | none
148+
TRACING_TRACE_EXPORTER="none"
149+
# Jaeger settings
150+
TRACING_JAEGER_ENDPOINT="http://localhost:14268/api/traces"
151+
# Zipkin settings
152+
TRACING_ZIPKIN_ENDPOINT="http://localhost:9411/api/v2/spans"
153+
# Stackdriver settings
154+
TRACING_STACKDRIVER_PROJECT_ID=""
155+
# Azure Monitor settings
156+
TRACING_AZURE_INSTRUMENTATION_KEY=""
157+
# Datadog settings
158+
TRACING_DATADOG_AGENT_ADDRESS="localhost:8126"
159+
TRACING_DATADOG_API_KEY=""
160+
# AWS X-Ray settings
161+
TRACING_XRAY_REGION="us-west-2"
162+
# General agent endpoint (for exporters that support a common agent)
163+
TRACING_AGENT_ENDPOINT="localhost:6831"
164+
# Metrics exporter configuration: stackdriver | prometheus | datadog
165+
TRACING_METRICS_EXPORTER="prometheus"
166+
# Prometheus settings
167+
TRACING_PROMETHEUS_PORT=9464
141168
```
142169

143170
## 📚 Documentation

0 commit comments

Comments
 (0)