-
-
Notifications
You must be signed in to change notification settings - Fork 301
Expand file tree
/
Copy path.env.example
More file actions
59 lines (53 loc) · 2.9 KB
/
Copy path.env.example
File metadata and controls
59 lines (53 loc) · 2.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
### - Server
SCANOPY_DATABASE_URL=postgresql://postgres:password@localhost:5432/scanopy
SCANOPY_PUBLIC_URL=http://your-domain.com:60072
SCANOPY_LOG_LEVEL=info
# SCANOPY_DISABLE_REGISTRATION=true
# SCANOPY_DISABLE_PASSWORD_LOGIN=true
## - uncomment below when using HTTPS
# SCANOPY_USE_SECURE_SESSION_COOKIES=true
### - SMTP (optional - for password reset and notifications)
## - Every SMTP connection is encrypted; there is no plaintext mode and no setting to
## - turn encryption on. The PORT selects which kind: 465 (the default when
## - SCANOPY_SMTP_PORT is unset) is implicit TLS, and any other port uses STARTTLS,
## - which is what submission ports like 587 and 25 expect. STARTTLS is required, not
## - opportunistic: if the upgrade fails, the send is aborted rather than downgraded.
## - All four of RELAY, USERNAME, PASSWORD and EMAIL must be set or email stays off.
## - Set EMAIL to the same mailbox as USERNAME unless that account has been granted
## - permission to send as another address; most providers reject a mismatch.
# SCANOPY_SMTP_RELAY=smtp.gmail.com
# SCANOPY_SMTP_USERNAME=your-email@gmail.com
# SCANOPY_SMTP_PASSWORD=your-app-password
# SCANOPY_SMTP_EMAIL=scanopy@yourdomain.com
# SCANOPY_SMTP_PORT=587
##
## - Microsoft 365 accepts submission ONLY on 587 with STARTTLS - it does not listen on
## - 465, so the default port fails to connect. Set the port explicitly:
# SCANOPY_SMTP_RELAY=smtp.office365.com
# SCANOPY_SMTP_PORT=587
# SCANOPY_SMTP_USERNAME=scanopy@yourdomain.com
# SCANOPY_SMTP_PASSWORD=your-password
# SCANOPY_SMTP_EMAIL=scanopy@yourdomain.com
## - 365 also requires tenant-side setup that Scanopy cannot do for you: SMTP AUTH must
## - be enabled for the mailbox (off by default for tenants created after January 2020),
## - security defaults must be off, and the account must not require MFA.
### - Brevo (optional - hosted email API)
## - Takes precedence over SMTP: when this is set, the SCANOPY_SMTP_* values above are
## - ignored entirely.
# SCANOPY_BREVO_API_KEY=your-brevo-api-key
### - Email logging (LOCAL TESTING ONLY - never set this in production)
## - Sends nothing. Logs every email at INFO and writes the rendered message
## - (.html + .txt) to this directory so it can be reviewed in a browser.
## - Takes precedence over Brevo and SMTP: when set, no mail is delivered even
## - if credentials are configured.
## - The written files contain full email bodies IN PLAINTEXT, including
## - password-reset and verification tokens. Anyone who can read the directory
## - can take over an account.
# SCANOPY_EMAIL_LOG_DIR=/tmp/scanopy-emails
### - To configure OIDC (optional), use the oidc.toml.example file
### - Metrics (optional - for Prometheus/Grafana)
# SCANOPY_METRICS_TOKEN=your-secure-token-here
## - Restrict metrics access to specific IPs/CIDRs (comma-separated)
# SCANOPY_EXTERNAL_SERVICE_PROMETHEUS_ALLOWED_IPS=192.168.1.0/24,10.0.0.1
### - Daemon
# SCANOPY_DAEMON_API_KEY=<autogenerated>