blob: 7b6ad107c7029c4e5a94ccacbb54ee99575eca4e [file] [log] [blame]
giolekvaeb590282021-10-22 17:31:40 +04001# This is the nebula example configuration file. You must edit, at a minimum, the static_host_map, lighthouse, and firewall sections
2# Some options in this file are HUPable, including the pki section. (A HUP will reload credentials from disk without affecting existing tunnels)
3
4# PKI defines the location of credentials for this node. Each of these can also be inlined by using the yaml ": |" syntax.
5pki:
6 # The CAs that are accepted by this node. Must contain one or more certificates created by 'nebula-cert ca'
7 ##ca: /etc/nebula/ca/ca.crt
8 ca: /etc/nebula/lighthouse/ca.crt
9 cert: /etc/nebula/lighthouse/host.crt
10 key: /etc/nebula/lighthouse/host.key
11 #blocklist is a list of certificate fingerprints that we will refuse to talk to
12 #blocklist:
13 # - c99d4e650533b92061b09918e838a5a0a6aaee21eed1d12fd937682865936c72
14
15# The static host map defines a set of hosts with fixed IP addresses on the internet (or any network).
16# A host can have multiple fixed IP addresses defined here, and nebula will try each when establishing a tunnel.
17# The syntax is:
18# "{nebula ip}": ["{routable ip/dns name}:{routable port}"]
19# Example, if your lighthouse has the nebula IP of 192.168.100.1 and has the real ip address of 100.64.22.11 and runs on port 4242:
20static_host_map:
21 "111.0.0.1": ["46.49.35.44:4242"]
22
23
24lighthouse:
25 # am_lighthouse is used to enable lighthouse functionality for a node. This should ONLY be true on nodes
26 # you have configured to be lighthouses in your network
27 am_lighthouse: false
28 # serve_dns optionally starts a dns listener that responds to various queries and can even be
29 # delegated to for resolution
30 #serve_dns: false
31 #dns:
32 # The DNS host defines the IP to bind the dns listener to. This also allows binding to the nebula node IP.
33 #host: 0.0.0.0
34 #port: 53
35 # interval is the number of seconds between updates from this node to a lighthouse.
36 # during updates, a node sends information about its current IP addresses to each node.
37 interval: 60
38 # hosts is a list of lighthouse hosts this node should report to and query from
39 # IMPORTANT: THIS SHOULD BE EMPTY ON LIGHTHOUSE NODES
40 # IMPORTANT2: THIS SHOULD BE LIGHTHOUSES' NEBULA IPs, NOT LIGHTHOUSES' REAL ROUTABLE IPs
41 hosts:
42 - "111.0.0.1"
43
44 # remote_allow_list allows you to control ip ranges that this node will
45 # consider when handshaking to another node. By default, any remote IPs are
46 # allowed. You can provide CIDRs here with `true` to allow and `false` to
47 # deny. The most specific CIDR rule applies to each remote. If all rules are
48 # "allow", the default will be "deny", and vice-versa. If both "allow" and
49 # "deny" rules are present, then you MUST set a rule for "0.0.0.0/0" as the
50 # default.
51 #remote_allow_list:
52 # Example to block IPs from this subnet from being used for remote IPs.
53 #"172.16.0.0/12": false
54
55 # A more complicated example, allow public IPs but only private IPs from a specific subnet
56 #"0.0.0.0/0": true
57 #"10.0.0.0/8": false
58 #"10.42.42.0/24": true
59
60 # local_allow_list allows you to filter which local IP addresses we advertise
61 # to the lighthouses. This uses the same logic as `remote_allow_list`, but
62 # additionally, you can specify an `interfaces` map of regular expressions
63 # to match against interface names. The regexp must match the entire name.
64 # All interface rules must be either true or false (and the default will be
65 # the inverse). CIDR rules are matched after interface name rules.
66 # Default is all local IP addresses.
67 #local_allow_list:
68 # Example to block tun0 and all docker interfaces.
69 #interfaces:
70 #tun0: false
71 #'docker.*': false
72 # Example to only advertise this subnet to the lighthouse.
73 #"10.0.0.0/8": true
74
75# Port Nebula will be listening on. The default here is 4242. For a lighthouse node, the port should be defined,
76# however using port 0 will dynamically assign a port and is recommended for roaming nodes.
77listen:
78 # To listen on both any ipv4 and ipv6 use "[::]"
79 host: "[::]"
80 port: 4247
81 # Sets the max number of packets to pull from the kernel for each syscall (under systems that support recvmmsg)
82 # default is 64, does not support reload
83 #batch: 64
84 # Configure socket buffers for the udp side (outside), leave unset to use the system defaults. Values will be doubled by the kernel
85 # Default is net.core.rmem_default and net.core.wmem_default (/proc/sys/net/core/rmem_default and /proc/sys/net/core/rmem_default)
86 # Maximum is limited by memory in the system, SO_RCVBUFFORCE and SO_SNDBUFFORCE is used to avoid having to raise the system wide
87 # max, net.core.rmem_max and net.core.wmem_max
88 #read_buffer: 10485760
89 #write_buffer: 10485760
90
91# EXPERIMENTAL: This option is currently only supported on linux and may
92# change in future minor releases.
93#
94# Routines is the number of thread pairs to run that consume from the tun and UDP queues.
95# Currently, this defaults to 1 which means we have 1 tun queue reader and 1
96# UDP queue reader. Setting this above one will set IFF_MULTI_QUEUE on the tun
97# device and SO_REUSEPORT on the UDP socket to allow multiple queues.
98#routines: 1
99
100punchy:
101 # Continues to punch inbound/outbound at a regular interval to avoid expiration of firewall nat mappings
102 punch: true
103
104 # respond means that a node you are trying to reach will connect back out to you if your hole punching fails
105 # this is extremely useful if one node is behind a difficult nat, such as a symmetric NAT
106 # Default is false
107 #respond: true
108
109 # delays a punch response for misbehaving NATs, default is 1 second, respond must be true to take effect
110 #delay: 1s
111
112# Cipher allows you to choose between the available ciphers for your network. Options are chachapoly or aes
113# IMPORTANT: this value must be identical on ALL NODES/LIGHTHOUSES. We do not/will not support use of different ciphers simultaneously!
114cipher: chachapoly
115
116# Local range is used to define a hint about the local network range, which speeds up discovering the fastest
117# path to a network adjacent nebula node.
118#local_range: "172.16.0.0/24"
119
120# sshd can expose informational and administrative functions via ssh this is a
121#sshd:
122 # Toggles the feature
123 #enabled: true
124 # Host and port to listen on, port 22 is not allowed for your safety
125 #listen: 127.0.0.1:2222
126 # A file containing the ssh host private key to use
127 # A decent way to generate one: ssh-keygen -t ed25519 -f ssh_host_ed25519_key -N "" < /dev/null
128 #host_key: ./ssh_host_ed25519_key
129 # A file containing a list of authorized public keys
130 #authorized_users:
131 #- user: steeeeve
132 # keys can be an array of strings or single string
133 #keys:
134 #- "ssh public key string"
135
136# Configure the private interface. Note: addr is baked into the nebula certificate
137tun:
138 # When tun is disabled, a lighthouse can be started without a local tun interface (and therefore without root)
139 disabled: false
140 # Name of the device
141 dev: nebula1
142 # Toggles forwarding of local broadcast packets, the address of which depends on the ip/mask encoded in pki.cert
143 drop_local_broadcast: false
144 # Toggles forwarding of multicast packets
145 drop_multicast: false
146 # Sets the transmit queue length, if you notice lots of transmit drops on the tun it may help to raise this number. Default is 500
147 tx_queue: 500
148 # Default MTU for every packet, safe setting is (and the default) 1300 for internet based traffic
149 mtu: 576
150 # Route based MTU overrides, you have known vpn ip paths that can support larger MTUs you can increase/decrease them here
151 routes:
152 #- mtu: 8800
153 # route: 10.0.0.0/16
154 # Unsafe routes allows you to route traffic over nebula to non-nebula nodes
155 # Unsafe routes should be avoided unless you have hosts/services that cannot run nebula
156 # NOTE: The nebula certificate of the "via" node *MUST* have the "route" defined as a subnet in its certificate
157 unsafe_routes:
158 #- route: 172.16.1.0/24
159 # via: 192.168.100.99
160 # mtu: 1300 #mtu will default to tun mtu if this option is not sepcified
161
162
163# TODO
164# Configure logging level
165logging:
166 # panic, fatal, error, warning, info, or debug. Default is info
167 level: info
168 # json or text formats currently available. Default is text
169 format: text
170 # Disable timestamp logging. useful when output is redirected to logging system that already adds timestamps. Default is false
171 #disable_timestamp: true
172 # timestamp format is specified in Go time format, see:
173 # https://golang.org/pkg/time/#pkg-constants
174 # default when `format: json`: "2006-01-02T15:04:05Z07:00" (RFC3339)
175 # default when `format: text`:
176 # when TTY attached: seconds since beginning of execution
177 # otherwise: "2006-01-02T15:04:05Z07:00" (RFC3339)
178 # As an example, to log as RFC3339 with millisecond precision, set to:
179 #timestamp_format: "2006-01-02T15:04:05.000Z07:00"
180
181#stats:
182 #type: graphite
183 #prefix: nebula
184 #protocol: tcp
185 #host: 127.0.0.1:9999
186 #interval: 10s
187
188 #type: prometheus
189 #listen: 127.0.0.1:8080
190 #path: /metrics
191 #namespace: prometheusns
192 #subsystem: nebula
193 #interval: 10s
194
195 # enables counter metrics for meta packets
196 # e.g.: `messages.tx.handshake`
197 # NOTE: `message.{tx,rx}.recv_error` is always emitted
198 #message_metrics: false
199
200 # enables detailed counter metrics for lighthouse packets
201 # e.g.: `lighthouse.rx.HostQuery`
202 #lighthouse_metrics: false
203
204# Handshake Manager Settings
205#handshakes:
206 # Handshakes are sent to all known addresses at each interval with a linear backoff,
207 # Wait try_interval after the 1st attempt, 2 * try_interval after the 2nd, etc, until the handshake is older than timeout
208 # A 100ms interval with the default 10 retries will give a handshake 5.5 seconds to resolve before timing out
209 #try_interval: 100ms
210 #retries: 20
211 # trigger_buffer is the size of the buffer channel for quickly sending handshakes
212 # after receiving the response for lighthouse queries
213 #trigger_buffer: 64
214
215
216# Nebula security group configuration
217firewall:
218 conntrack:
219 tcp_timeout: 12m
220 udp_timeout: 3m
221 default_timeout: 10m
222 max_connections: 100000
223
224 # The firewall is default deny. There is no way to write a deny rule.
225 # Rules are comprised of a protocol, port, and one or more of host, group, or CIDR
226 # Logical evaluation is roughly: port AND proto AND (ca_sha OR ca_name) AND (host OR group OR groups OR cidr)
227 # - port: Takes `0` or `any` as any, a single number `80`, a range `200-901`, or `fragment` to match second and further fragments of fragmented packets (since there is no port available).
228 # code: same as port but makes more sense when talking about ICMP, TODO: this is not currently implemented in a way that works, use `any`
229 # proto: `any`, `tcp`, `udp`, or `icmp`
230 # host: `any` or a literal hostname, ie `test-host`
231 # group: `any` or a literal group name, ie `default-group`
232 # groups: Same as group but accepts a list of values. Multiple values are AND'd together and a certificate would have to contain all groups to pass
233 # cidr: a CIDR, `0.0.0.0/0` is any.
234 # ca_name: An issuing CA name
235 # ca_sha: An issuing CA shasum
236
237 outbound:
238 # Allow all outbound traffic from this node
239 - port: any
240 proto: any
241 host: any
242
243 inbound:
244 - port: any
245 proto: any
246 host: any