-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy path.env.example
More file actions
63 lines (54 loc) · 2.62 KB
/
.env.example
File metadata and controls
63 lines (54 loc) · 2.62 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
60
61
62
63
# Data Directory — base path for all persistent volumes (mysql, redis, ips, logs, backups, etc.)
DATA_DIR=/srv/docker-data/ips4
# Database Configuration
MYSQL_PASSWORD=change_me_to_strong_password
MYSQL_ROOT_PASSWORD=change_me_to_strong_root_password
# Port Configuration
HTTP_PORT=80
HTTPS_PORT=443
# Profile Configuration
# http = HTTP only (default)
# https = HTTPS with SSL certificates (run ./scripts/init-ssl.sh first)
# tunnel = Cloudflare Tunnel for external access without open ports (set CLOUDFLARE_TUNNEL_* below)
# tunnel-devmode = Cloudflare Development Mode watcher (bypasses caching for debugging)
# cron = IPS4 task scheduler (set IPS_TASK_KEY below)
# backup = automated database backups (configure settings below)
COMPOSE_PROFILES=http,cron,backup
# Domain for SSL certificate
DOMAIN=example.com
CERTBOT_EMAIL=admin@example.com
# DNS Challenge Configuration (for Cloudflare)
# Get your API token from: https://dash.cloudflare.com/profile/api-tokens
# Required permissions: Zone:DNS:Edit
# Leave empty to use HTTP challenge instead (requires port 80 accessible from internet)
CLOUDFLARE_API_TOKEN=
# Cloudflare Tunnel (optional; enable with --profile tunnel)
# Auto-provisions a named tunnel on boot. No manual setup needed.
# CLOUDFLARE_TUNNEL_API_TOKEN: CF API token (Account:Tunnel:Edit + Zone:DNS:Edit)
# CLOUDFLARE_TUNNEL_TOKEN: Pre-provisioned tunnel token (skips auto-provisioning if set)
CLOUDFLARE_TUNNEL_API_TOKEN=
#CLOUDFLARE_TUNNEL_TOKEN=
# Tunnel name (default: ips4)
#CLOUDFLARE_TUNNEL_NAME=ips4
# Primary subdomain and zone for DNS (required for auto-provisioning)
#CLOUDFLARE_TUNNEL_SUBDOMAIN=
CLOUDFLARE_TUNNEL_ZONE=
# Origin Host header sent by tunnel to nginx — must match IPS4 base_url hostname
#CLOUDFLARE_TUNNEL_ORIGIN_HOST=
# Extra subdomains, comma-separated "sub=service" pairs
# Example: api=http://nginx:80,status=http://status:8080
#CLOUDFLARE_TUNNEL_EXTRA_ROUTES=
# Cloudflare Development Mode (optional; enable with --profile tunnel-devmode)
# Keeps Development Mode ON so Cloudflare doesn't cache during debugging.
# Requires Zone:Settings:Edit permission on the API token.
# Falls back to CLOUDFLARE_TUNNEL_API_TOKEN if not set.
#CF_DEVMODE_ZONE_ID=
#CF_DEVMODE_API_TOKEN=
# Database Backup Configuration
# BACKUP_INTERVAL_HOURS = hours between backups (default: 1)
# BACKUP_RETENTION_DAYS = delete backups older than N days (default: 7)
#BACKUP_INTERVAL_HOURS=1
#BACKUP_RETENTION_DAYS=7
# IPS4 Task Scheduler (optional; enable with --profile cron)
# Copy the key from ACP > System > Advanced Configuration > Tasks (the hex string at the end of the cron command)
IPS_TASK_KEY=