Repository navigation
Expand file tree
/
Copy pathconfig.sample.yaml
More file actions
117 lines (112 loc) · 3.99 KB
/
Copy pathconfig.sample.yaml
File metadata and controls
117 lines (112 loc) · 3.99 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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
# Health Check and DNS Update Configuration
# How often to perform health checks
interval: 30s
# List of domains to manage
domains:
- recordName: "service.example.com"
provider: "example-provider-1"
ttl: 120
healthChecks:
timeout: "2s"
attempts: 3
# Consecutive successes needed to re-add an endpoint that was removed (default 1)
recoverAfter: 3
# Request method: GET (default) or HEAD
method: "HEAD"
# Status code that means healthy: an exact code or "2xx" (default "2xx")
expectStatus: "204"
endpoints:
- name: "server1"
url: "http://192.168.1.100:8080/health"
ip: "192.168.1.100"
# IPv6 endpoints are published as AAAA records
- name: "server2-ipv6"
url: "http://[2001:db8::101]:8080/health"
ip: "2001:db8::101"
- recordName: "foo.example.com"
provider: "example-provider-1"
ttl: 120
healthChecks:
timeout: "5s"
attempts: 2
endpoints:
- name: "foo1"
url: "http://192.168.1.200:9000/health"
ip: "192.168.1.200"
- name: "foo2"
url: "http://192.168.1.201:9000/health"
ip: "192.168.1.201"
- recordName: "app.example.com"
provider: "example-provider-1"
ttl: 120
endpoints:
# Endpoints have priority 0 by default, and lower values are preferred
# DNS only contains the healthy endpoints with the lowest priority value
- name: "primary"
url: "http://192.168.1.50:8080/health"
ip: "192.168.1.50"
# Backup, published only while "primary" is unhealthy
- name: "backup"
url: "http://203.0.113.10:8080/health"
ip: "203.0.113.10"
priority: 1
- recordName: "tunnel.example.com"
provider: "example-provider-1"
ttl: 120
endpoints:
- name: "vps"
url: "http://192.0.2.10:8080/health"
ip: "192.0.2.10"
# Last resort when "vps" is unhealthy, published as a CNAME record
# A CNAME record can't coexist with other records, so this endpoint is alone in its priority
# The health check goes through its own url
- name: "tunnel"
url: "https://tunnel-health.example.com/health"
cname: "0a1b2c3d.cfargotunnel.com"
priority: 1
# Options for a specific provider, which must be the one used by the domain
# All endpoints with the same priority must use the same value for proxied
providerOptions:
cloudflare:
# Cloudflare proxies the record (default false)
proxied: true
# Provider Configuration
providers:
example-provider-1:
cloudflare:
apiToken: "your-cloudflare-api-token"
zoneId: "your-zone-id"
# Notifications (optional)
notifications:
# Webhooks, with the format "plain" (default), "slack", "discord", or "ntfy"
webhooks:
- name: "chat"
format: "slack"
url: "https://hooks.slack.com/services/your-webhook-path"
events: ["dns_update_failed", "all_unhealthy"]
- name: "alerts"
format: "ntfy"
# For ntfy, the URL includes the topic name
url: "https://ntfy.example.com/ddup"
# Optional token, sent as "Bearer <token>"
token: "your-ntfy-token"
events: ["dns_updated", "dns_update_failed", "all_unhealthy"]
# Allow sending to private addresses, such as a ntfy server in your LAN or cluster (default: false)
allowPrivateDestinations: true
# Optional delivery settings. Defaults: timeout 20s, maxAttempts 3 (including the first), retryInterval 20s
timeout: "10s"
maxAttempts: 3
retryInterval: "20s"
# Email
emails:
- name: "ops"
# Connection string for SMTP (smtp://user:password@host:587?fromAddress=...&tls=starttls), AWS SES, SendGrid, Resend
connectionString: "smtp://user:password@host:587/?fromAddress=ddup@example.com&tls=starttls"
# One email is sent to each recipient
to: ["postmaster@example.com"]
events: ["dns_update_failed", "all_unhealthy"]
# Enable the web server
server:
enabled: true
bind: "127.0.0.1"
port: 7401