config.yml 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544
  1. # 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. # PKI defines the location of credentials for this node. Each of these can also be inlined by using the yaml ": |" syntax.
  4. pki:
  5. # The CAs that are accepted by this node. Must contain one or more certificates created by 'nebula-cert ca'
  6. ca: /etc/nebula/ca.crt
  7. cert: /etc/nebula/host.crt
  8. key: /etc/nebula/host.key
  9. # blocklist is a list of certificate fingerprints that we will refuse to talk to
  10. #blocklist:
  11. # - c99d4e650533b92061b09918e838a5a0a6aaee21eed1d12fd937682865936c72
  12. # disconnect_invalid is a toggle to force a client to be disconnected if the certificate is expired or invalid.
  13. #disconnect_invalid: true
  14. # initiating_version controls which certificate version is used when initiating handshakes.
  15. # This setting only applies if both a v1 and a v2 certificate are configured, in which case it will default to `1`.
  16. # Once all hosts in the mesh are configured with both a v1 and v2 certificate then this should be changed to `2`.
  17. # After all hosts in the mesh are using a v2 certificate then v1 certificates are no longer needed.
  18. # initiating_version: 1
  19. # The static host map defines a set of hosts with fixed IP addresses on the internet (or any network).
  20. # A host can have multiple fixed IP addresses defined here, and nebula will try each when establishing a tunnel.
  21. # The syntax is:
  22. # "{nebula ip}": ["{routable ip/dns name}:{routable port}"]
  23. # 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:
  24. static_host_map:
  25. "192.168.100.1": ["100.64.22.11:4242"]
  26. # The static_map config stanza can be used to configure how the static_host_map behaves.
  27. #static_map:
  28. # cadence determines how frequently DNS is re-queried for updated IP addresses when a static_host_map entry contains
  29. # a DNS name.
  30. #cadence: 30s
  31. # network determines the type of IP addresses to ask the DNS server for. The default is "ip4" because nodes typically
  32. # do not know their public IPv4 address. Connecting to the Lighthouse via IPv4 allows the Lighthouse to detect the
  33. # public address. Other valid options are "ip6" and "ip" (returns both.)
  34. #network: ip4
  35. # lookup_timeout is the DNS query timeout.
  36. #lookup_timeout: 250ms
  37. lighthouse:
  38. # am_lighthouse is used to enable lighthouse functionality for a node. This should ONLY be true on nodes
  39. # you have configured to be lighthouses in your network
  40. am_lighthouse: false
  41. # serve_dns optionally starts a dns listener that responds to various queries and can even be
  42. # delegated to for resolution
  43. #serve_dns: false
  44. #dns:
  45. # The DNS host defines the IP to bind the dns listener to. This also allows binding to the nebula node IP.
  46. #host: 0.0.0.0
  47. #port: 53
  48. # interval is the number of seconds between updates from this node to a lighthouse.
  49. # during updates, a node sends information about its current IP addresses to each node.
  50. interval: 60
  51. # hosts is a list of lighthouse hosts this node should report to and query from
  52. # IMPORTANT: THIS SHOULD BE EMPTY ON LIGHTHOUSE NODES
  53. # IMPORTANT2: THIS SHOULD BE LIGHTHOUSES' NEBULA IPs, NOT LIGHTHOUSES' REAL ROUTABLE IPs
  54. hosts:
  55. - "192.168.100.1"
  56. # remote_allow_list allows you to control ip ranges that this node will
  57. # consider when handshaking to another node. By default, any remote IPs are
  58. # allowed. You can provide CIDRs here with `true` to allow and `false` to
  59. # deny. The most specific CIDR rule applies to each remote. If all rules are
  60. # "allow", the default will be "deny", and vice-versa. If both "allow" and
  61. # "deny" IPv4 rules are present, then you MUST set a rule for "0.0.0.0/0" as
  62. # the default. Similarly if both "allow" and "deny" IPv6 rules are present,
  63. # then you MUST set a rule for "::/0" as the default.
  64. #remote_allow_list:
  65. # Example to block IPs from this subnet from being used for remote IPs.
  66. #"172.16.0.0/12": false
  67. # A more complicated example, allow public IPs but only private IPs from a specific subnet
  68. #"0.0.0.0/0": true
  69. #"10.0.0.0/8": false
  70. #"10.42.42.0/24": true
  71. # EXPERIMENTAL: This option may change or disappear in the future.
  72. # Optionally allows the definition of remote_allow_list blocks
  73. # specific to an inside VPN IP CIDR.
  74. #remote_allow_ranges:
  75. # This rule would only allow only private IPs for this VPN range
  76. #"10.42.42.0/24":
  77. #"192.168.0.0/16": true
  78. # local_allow_list allows you to filter which local IP addresses we advertise
  79. # to the lighthouses. This uses the same logic as `remote_allow_list`, but
  80. # additionally, you can specify an `interfaces` map of regular expressions
  81. # to match against interface names. The regexp must match the entire name.
  82. # All interface rules must be either true or false (and the default will be
  83. # the inverse). CIDR rules are matched after interface name rules.
  84. # Default is all local IP addresses.
  85. #local_allow_list:
  86. # Example to block tun0 and all docker interfaces.
  87. #interfaces:
  88. #tun0: false
  89. #'docker.*': false
  90. # Example to only advertise this subnet to the lighthouse.
  91. #"10.0.0.0/8": true
  92. # advertise_addrs are routable addresses that will be included along with discovered addresses to report to the
  93. # lighthouse, the format is "ip:port". `port` can be `0`, in which case the actual listening port will be used in its
  94. # place, useful if `listen.port` is set to 0.
  95. # This option is mainly useful when there are static ip addresses the host can be reached at that nebula can not
  96. # typically discover on its own. Examples being port forwarding or multiple paths to the internet.
  97. #advertise_addrs:
  98. #- "1.1.1.1:4242"
  99. #- "1.2.3.4:0" # port will be replaced with the real listening port
  100. # EXPERIMENTAL: This option may change or disappear in the future.
  101. # This setting allows us to "guess" what the remote might be for a host
  102. # while we wait for the lighthouse response.
  103. #calculated_remotes:
  104. # For any Nebula IPs in 10.0.10.0/24, this will apply the mask and add
  105. # the calculated IP as an initial remote (while we wait for the response
  106. # from the lighthouse). Both CIDRs must have the same mask size.
  107. # For example, Nebula IP 10.0.10.123 will have a calculated remote of
  108. # 192.168.1.123
  109. #10.0.10.0/24:
  110. #- mask: 192.168.1.0/24
  111. # port: 4242
  112. # Port Nebula will be listening on. The default here is 4242. For a lighthouse node, the port should be defined,
  113. # however using port 0 will dynamically assign a port and is recommended for roaming nodes.
  114. listen:
  115. # To listen on only ipv4, use "0.0.0.0"
  116. host: "::"
  117. port: 4242
  118. # Sets the max number of packets to pull from the kernel for each syscall (under systems that support recvmmsg)
  119. # default is 64, does not support reload
  120. # Note: on Linux with UDP GRO (kernel 5.10+), each receive slot is sized for a full 64KiB coalesced
  121. # superpacket, so the receive scratch is batch * 64KiB per listening socket (~4MiB per routine at the
  122. # default of 64). Lower this to trade peak per-syscall throughput for memory on constrained hosts.
  123. #batch: 64
  124. # Configure socket buffers for the udp side (outside), leave unset to use the system defaults. Values will be doubled by the kernel
  125. # Default is net.core.rmem_default and net.core.wmem_default (/proc/sys/net/core/rmem_default and /proc/sys/net/core/rmem_default)
  126. # Maximum is limited by memory in the system, SO_RCVBUFFORCE and SO_SNDBUFFORCE is used to avoid having to raise the system wide
  127. # max, net.core.rmem_max and net.core.wmem_max
  128. #read_buffer: 10485760
  129. #write_buffer: 10485760
  130. # On Windows only
  131. # When true, Nebula installs a WFP (Windows Filtering Platform) PERMIT filter scoped to UDP at the listener port.
  132. # WFP sits below Windows Defender Firewall, so this lets peer handshakes reach Nebula's outside socket regardless
  133. # of WDF's inbound rules.
  134. # Default true; set to false to leave WDF in charge of inbound decisions on the listener port. Not reloadable.
  135. #windows_bypass_wdf: true
  136. # On macOS only
  137. # macOS scopes the udp socket to the interface it was created on, so moving between networks (wifi to wired,
  138. # office to home) leaves Nebula sending out an interface that no longer has a route. When true, Nebula watches
  139. # the routing socket and rebinds the listener once the change settles.
  140. # iOS does not use this, the host app drives the same rebind itself.
  141. # Default true. Not reloadable.
  142. #rebind_on_network_change: true
  143. # By default, Nebula replies to packets it has no tunnel for with a "recv_error" packet. This packet helps speed up reconnection
  144. # in the case that Nebula on either side did not shut down cleanly. This response can be abused as a way to discover if Nebula is running
  145. # on a host though. This option lets you configure if you want to send "recv_error" packets always, never, or only to private network remotes.
  146. # valid values: always, never, private
  147. # This setting is reloadable.
  148. #send_recv_error: always
  149. # Similar to send_recv_error, this option lets you configure if you want to accept "recv_error" packets from remote hosts.
  150. # valid values: always, never, private
  151. # This setting is reloadable.
  152. #accept_recv_error: always
  153. # The so_sock option is a Linux-specific feature that allows all outgoing Nebula packets to be tagged with a specific identifier.
  154. # This tagging enables IP rule-based filtering. For example, it supports 0.0.0.0/0 unsafe_routes,
  155. # allowing for more precise routing decisions based on the packet tags. Default is 0 meaning no mark is set.
  156. # This setting is reloadable.
  157. #so_mark: 0
  158. # the udp_offloads setting controls if Nebula will attempt to enable GSO and GRO for its UDP socket(s). Linux only, not reloadable.
  159. # udp_offloads: false
  160. # Routines is the number of thread pairs to run that consume from the tun and UDP queues.
  161. # Currently, this defaults to 1 which means we have 1 tun queue reader and 1
  162. # UDP queue reader. Setting this above one will set IFF_MULTI_QUEUE on the tun
  163. # device and SO_REUSEPORT on the UDP socket to allow multiple queues.
  164. # With multiport enabled this is the number of routines *per port*, so the total
  165. # is routines * multiport.ports.
  166. # This option is only supported on Linux.
  167. #routines: 1
  168. # EXPERIMENTAL: multiport lanes give each pair of hosts multiple underlay UDP
  169. # flows so overlay traffic is no longer bottlenecked by a single 5-tuple
  170. # (one ECMP path, one NIC RSS queue, one per-flow policer). Instead of every
  171. # socket sharing listen.port, multiport.ports consecutive ports are bound and
  172. # each gets its own group of `routines` sockets sharing it via SO_REUSEPORT, so
  173. # no port (the base port above all, which carries every handshake and every
  174. # vanilla peer) depends on a single core. Each port carries one lane: lane i
  175. # sends from local port listen.port+i to the peer's advertised
  176. # base+((i + pair_offset) mod peer_ports), where pair_offset is a per-pair hash
  177. # that spreads many small peers across a big peer's whole port range. Lane 0 is
  178. # the base tunnel itself.
  179. # A lane is not a separate tunnel and has no handshake of its own. Both sides
  180. # derive its keys from the base tunnel's, so it comes and goes with the base
  181. # tunnel, but it has its own nonce counter and replay window, so flows taking
  182. # different paths never fight over shared replay state. Each inside flow is
  183. # hashed onto one lane for its whole life, so multiport adds no reordering.
  184. #
  185. # Peers negotiate lanes in the handshake; vanilla peers get a single normal
  186. # tunnel. All control traffic (handshakes, lighthouse, punching, relays) and
  187. # the data fallback stay on the base tunnel/port. A lane only carries data once
  188. # a probe on it has been answered, and is re-probed every 30s while it is up;
  189. # traffic falls back to the base tunnel while a lane is down or not yet up.
  190. # Lanes are only probed on tunnels with traffic, so an idle tunnel costs
  191. # nothing extra.
  192. #
  193. # Requirements: multiport.ports > 1, Linux, and the port range
  194. # [listen.port, listen.port+multiport.ports-1] reachable through firewalls on
  195. # both sides. A lane whose port is unreachable stays down and its traffic rides
  196. # the base tunnel. With listen.port 0 the base port is dynamic and the next
  197. # ports-1 ports above it are claimed. Degrades to a single port when the
  198. # requirements don't hold. Not reloadable.
  199. #multiport:
  200. #enabled: true
  201. # How many consecutive UDP ports to bind, starting at listen.port. Must be
  202. # greater than 1 for multiport to do anything; there is no default, since
  203. # each port costs a full set of `routines` threads and sockets. Capped at 256
  204. # (the lane header limit). 4-8 is plenty to escape a single ECMP path.
  205. #ports: 0
  206. # How many lanes to send on, counting the base tunnel as lane 0. 0 (default)
  207. # means one per bound port. Lowering this sends on a subset of the range
  208. # (useful on a big server with many peers, to bound how many lane probes and
  209. # sessions each peer costs). It only limits sending: the ports are bound and
  210. # read either way, and we still receive on every lane a peer sends on.
  211. #lanes: 0
  212. punchy:
  213. # Continues to punch inbound/outbound at a regular interval to avoid expiration of firewall nat mappings
  214. # This setting is reloadable.
  215. punch: true
  216. # respond means that a node you are trying to reach will connect back out to you if your hole punching fails
  217. # this is extremely useful if one node is behind a difficult nat, such as a symmetric NAT
  218. # Default is false
  219. # This setting is reloadable.
  220. #respond: true
  221. # delays a punch response for misbehaving NATs, default is 1 second.
  222. # This setting is reloadable.
  223. #delay: 1s
  224. # set the delay before attempting punchy.respond. Default is 5 seconds. respond must be true to take effect.
  225. # This setting is reloadable.
  226. #respond_delay: 5s
  227. # Cipher allows you to choose between the available ciphers for your network. Options are chachapoly or aes
  228. # IMPORTANT: this value must be identical on ALL NODES/LIGHTHOUSES. We do not/will not support use of different ciphers simultaneously!
  229. #cipher: aes
  230. # Preferred ranges is used to define a hint about the local network ranges, which speeds up discovering the fastest
  231. # path to a network adjacent nebula node.
  232. # This setting is reloadable.
  233. #preferred_ranges: ["172.16.0.0/24"]
  234. # sshd can expose informational and administrative functions via ssh. This can expose informational and administrative
  235. # functions, and allows manual tweaking of various network settings when debugging or testing.
  236. #sshd:
  237. # Toggles the feature
  238. #enabled: true
  239. # Host and port to listen on, port 22 is not allowed for your safety
  240. #listen: 127.0.0.1:2222
  241. # A file containing the ssh host private key to use
  242. # A decent way to generate one: ssh-keygen -t ed25519 -f ssh_host_ed25519_key -N "" < /dev/null
  243. #host_key: ./ssh_host_ed25519_key
  244. # Authorized users and their public keys
  245. #authorized_users:
  246. #- user: steeeeve
  247. # keys can be an array of strings or single string
  248. #keys:
  249. #- "ssh public key string"
  250. # Trusted SSH CA public keys. These are the public keys of the CAs that are allowed to sign SSH keys for access.
  251. #trusted_cas:
  252. #- "ssh public key string"
  253. # sandbox_dir restricts file paths for profiling commands (start-cpu-profile, save-heap-profile,
  254. # save-mutex-profile) to the specified directory. Relative paths will be resolved within this directory,
  255. # and absolute paths outside of it will be rejected. Default is $TMP/nebula-debug.
  256. # The directory is NOT automatically created.
  257. # Overriding this to "" is the same as "/" and will allow overwriting any path on the host.
  258. #sandbox_dir: /var/tmp/nebula-debug
  259. # EXPERIMENTAL: relay support for networks that can't establish direct connections.
  260. relay:
  261. # Relays are a list of Nebula IP's that peers can use to relay packets to me.
  262. # IPs in this list must have am_relay set to true in their configs, otherwise
  263. # they will reject relay requests.
  264. #relays:
  265. #- 192.168.100.1
  266. #- <other Nebula VPN IPs of hosts used as relays to access me>
  267. # Set am_relay to true to permit other hosts to list my IP in their relays config. Default false.
  268. am_relay: false
  269. # Set use_relays to false to prevent this instance from attempting to establish connections through relays.
  270. # default true
  271. use_relays: true
  272. # Configure the private interface. Note: addr is baked into the nebula certificate
  273. tun:
  274. # When tun is disabled, a lighthouse can be started without a local tun interface (and therefore without root)
  275. disabled: false
  276. # Name of the device. If not set, a default will be chosen by the OS.
  277. # For macOS: if set, must be in the form `utun[0-9]+`.
  278. # For NetBSD: Required to be set, must be in the form `tun[0-9]+`
  279. dev: nebula1
  280. # Toggles forwarding of local broadcast packets, the address of which depends on the ip/mask encoded in pki.cert
  281. drop_local_broadcast: false
  282. # Toggles forwarding of multicast packets
  283. drop_multicast: false
  284. # 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
  285. tx_queue: 500
  286. # Default MTU for every packet, safe setting is (and the default) 1300 for internet based traffic
  287. mtu: 1300
  288. # the use_offloads setting controls if Nebula will attempt to enable GSO and GRO for the tun device. Linux only, not reloadable.
  289. #use_offloads: false
  290. # Linux only. pin_threads pins each tun reader/encrypt OS thread to a single CPU. This keeps every goroutine's
  291. # batched sends flowing through one XPS-selected NIC TX ring, so packets within a flow stay ordered on the wire
  292. # instead of being sprayed across multiple TX rings and reordered. Not reloadable. Coerced to false if routines <= 1.
  293. #pin_threads: true
  294. # pin_threads_key helps the CPU-auto-selector shuffle which CPUs are chosen for pinning.
  295. # Valid options are "pid" or "port". Use "port" if you want Nebula to choose the same cores every time, which is nice for benchmarking.
  296. # Linux only, not reloadable.
  297. #pin_threads_key: "pid"
  298. # Linux only. cpu_affinity overrides which CPUs the tun reader threads pin to: a list of CPU IDs, one per routine
  299. # (see the top-level `routines` setting). Lists shorter than `routines` are modulo-cycled across the queues; extra
  300. # entries are ignored. IDs must be within the process's allowed CPU set, so this respects taskset / cgroup cpusets;
  301. # a non-integer or not-allowed entry disables the override, leaving the default pin selection described below.
  302. # Only meaningful while pin_threads is true. Not reloadable.
  303. # When unset (or rejected), the default spread prefers performance cores on heterogeneous CPUs (ARM big.LITTLE,
  304. # Intel P/E hybrids, AMD compact cores), keeps all readers on one NUMA node and on distinct physical cores when the
  305. # topology allows (SMT siblings last), leaves CPU 0's physical core as a last resort, and rotates its starting
  306. # point per instance (keyed by the bound UDP port) so co-located nebulas don't stack their readers onto the
  307. # same cores.
  308. #cpu_affinity:
  309. # - 2
  310. # - 4
  311. # Route based MTU overrides, you have known vpn ip paths that can support larger MTUs you can increase/decrease them here
  312. routes:
  313. #- mtu: 8800
  314. # route: 10.0.0.0/16
  315. # Unsafe routes allows you to route traffic over nebula to non-nebula nodes
  316. # Unsafe routes should be avoided unless you have hosts/services that cannot run nebula
  317. # Supports weighted ECMP if you define a list of gateways, this can be used for load balancing or redundancy to hosts outside of nebula
  318. # NOTES:
  319. # * You will only see a single gateway in the routing table if you are not on linux
  320. # * If a gateway is not reachable through the overlay another gateway will be selected to send the traffic through, ignoring weights
  321. #
  322. # unsafe_routes:
  323. # # Multiple gateways without defining a weight defaults to a weight of 1, this will balance traffic equally between the three gateways
  324. # - route: 192.168.87.0/24
  325. # via:
  326. # - gateway: 10.0.0.1
  327. # - gateway: 10.0.0.2
  328. # - gateway: 10.0.0.3
  329. # # Multiple gateways with a weight, this will balance traffic accordingly
  330. # - route: 192.168.87.0/24
  331. # via:
  332. # - gateway: 10.0.0.1
  333. # weight: 10
  334. # - gateway: 10.0.0.2
  335. # weight: 5
  336. #
  337. # NOTE: The nebula certificate of the "via" node(s) *MUST* have the "route" defined as a subnet in its certificate
  338. # `via`: single node or list of gateways to use for this route
  339. # `mtu`: will default to tun mtu if this option is not specified
  340. # `metric`: will default to 0 if this option is not specified
  341. # `install`: will default to true, controls whether this route is installed in the systems routing table.
  342. # This setting is reloadable.
  343. unsafe_routes:
  344. #- route: 172.16.1.0/24
  345. # via: 192.168.100.99
  346. # mtu: 1300
  347. # metric: 100
  348. # install: true
  349. # On Windows only, sets the network category of the nebula interface. Without this, Windows often
  350. # leaves the network as "Unidentified" and treats it as Public, which makes the host firewall more
  351. # restrictive than you usually want for an overlay between trusted peers. Valid values:
  352. # private - treat the nebula network as a private/trusted network (default)
  353. # public - treat it as a public/untrusted network
  354. # domain - treat it as a domain-authenticated network
  355. # unset - leave whatever Windows decided alone
  356. # Not reloadable.
  357. #network_category: private
  358. # On Windows only
  359. # When true, Nebula installs a WFP (Windows Filtering Platform) PERMIT filter scoped to the nebula adapter LUID.
  360. # WFP sits below Windows Defender Firewall, so this lets inbound traffic through regardless of WDF rules.
  361. # Filters are auto-removed when the adapter goes away.
  362. # See listen.windows_bypass_wdf for the matching control over inbound to nebula's outside UDP listener.
  363. # Default true; set to false to leave WDF in charge of inbound decisions on the nebula interface. Not reloadable.
  364. #windows_bypass_wdf: true
  365. # On linux only, set to true to manage unsafe routes directly on the system route table with gateway routes instead of
  366. # in nebula configuration files. Default false, not reloadable.
  367. #use_system_route_table: false
  368. # Buffer size for reading routes updates. 0 means default system buffer size. (/proc/sys/net/core/rmem_default).
  369. # If using massive routes updates, for example BGP, you may need to increase this value to avoid packet loss.
  370. # SO_RCVBUFFORCE is used to avoid having to raise the system wide max
  371. #use_system_route_table_buffer_size: 0
  372. # Configure logging level
  373. logging:
  374. # trace, debug, info, warn, or error. Default is info and is reloadable.
  375. # fatal and panic are accepted for backwards compatibility and map to error.
  376. #NOTE: Debug and trace modes can log remotely controlled/untrusted data which can quickly fill a disk in some
  377. # scenarios. Debug and trace logging are also CPU intensive and will decrease performance overall.
  378. # Only enable debug or trace logging while actively investigating an issue.
  379. level: info
  380. # json or text formats currently available. Default is text.
  381. format: text
  382. # Disable timestamp logging. Useful when output is redirected to a logging system that already adds timestamps. Default is false.
  383. #disable_timestamp: true
  384. # Timestamps use RFC3339Nano ("2006-01-02T15:04:05.999999999Z07:00") and are not configurable.
  385. # The stats section is reloadable. A HUP may change the backend, toggle stats
  386. # on or off, switch the listen/host address, or pick up new DNS for the
  387. # configured graphite host.
  388. #stats:
  389. #type: graphite
  390. #prefix: nebula
  391. #protocol: tcp
  392. #host: 127.0.0.1:9999
  393. #interval: 10s
  394. #type: prometheus
  395. #listen: 127.0.0.1:8080
  396. #path: /metrics
  397. #namespace: prometheusns
  398. #subsystem: nebula
  399. #interval: 10s
  400. # enables counter metrics for meta packets
  401. # e.g.: `messages.tx.handshake`
  402. # NOTE: `message.{tx,rx}.recv_error` is always emitted
  403. # Not reloadable.
  404. #message_metrics: false
  405. # enables detailed counter metrics for lighthouse packets
  406. # e.g.: `lighthouse.rx.HostQuery`
  407. # Not reloadable.
  408. #lighthouse_metrics: false
  409. # Handshake Manager Settings
  410. #handshakes:
  411. # Handshakes are sent to all known addresses at each interval with a linear backoff,
  412. # Wait try_interval after the 1st attempt, 2 * try_interval after the 2nd, etc, until the handshake is older than timeout
  413. # A 100ms interval with the default 10 retries will give a handshake 5.5 seconds to resolve before timing out
  414. #try_interval: 100ms
  415. #retries: 20
  416. # query_buffer is the size of the buffer channel for querying lighthouses
  417. #query_buffer: 64
  418. # trigger_buffer is the size of the buffer channel for quickly sending handshakes
  419. # after receiving the response for lighthouse queries
  420. #trigger_buffer: 64
  421. # Tunnel manager settings
  422. #tunnels:
  423. # drop_inactive controls whether inactive tunnels are maintained or dropped after the inactive_timeout period has
  424. # elapsed.
  425. # In general, it is a good idea to enable this setting. It will be enabled by default in a future release.
  426. # This setting is reloadable
  427. #drop_inactive: false
  428. # inactivity_timeout controls how long a tunnel MUST NOT see any inbound or outbound traffic before being considered
  429. # inactive and eligible to be dropped.
  430. # This setting is reloadable
  431. #inactivity_timeout: 10m
  432. # Nebula security group configuration
  433. firewall:
  434. # Action to take when a packet is not allowed by the firewall rules.
  435. # Can be one of:
  436. # `drop` (default): silently drop the packet.
  437. # `reject`: send a reject reply.
  438. # - For TCP, this will be a RST "Connection Reset" packet.
  439. # - For other protocols, this will be an ICMP "Destination unreachable: Communication administratively prohibited" packet.
  440. outbound_action: drop
  441. inbound_action: drop
  442. # THIS FLAG IS DEPRECATED AND WILL BE REMOVED IN A FUTURE RELEASE. (Defaults to false.)
  443. # This setting only affects nebula hosts exposing unsafe_routes. When set to false, each inbound rule must contain a
  444. # `local_cidr` if the intention is to allow traffic to flow to an unsafe route. When set to true, every firewall rule
  445. # will apply to all configured unsafe_routes regardless of the actual destination of the packet, unless `local_cidr`
  446. # is explicitly defined. This is usually not the desired behavior and should be avoided!
  447. #default_local_cidr_any: false
  448. conntrack:
  449. tcp_timeout: 12m
  450. udp_timeout: 3m
  451. default_timeout: 10m
  452. # The firewall is default deny. There is no way to write a deny rule.
  453. # Rules are comprised of a protocol, port, and one or more of host, group, or CIDR
  454. # Logical evaluation is roughly: port AND proto AND (ca_sha OR ca_name) AND (host OR group OR groups OR cidr) AND (local cidr)
  455. # - 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).
  456. # proto: `any`, `tcp`, `udp`, or `icmp`
  457. # a port specification is ignored if proto is `icmp`
  458. # host: `any` or a literal hostname, ie `test-host`
  459. # group: `any` or a literal group name, ie `default-group`
  460. # 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
  461. # cidr: a remote CIDR, `0.0.0.0/0` is any ipv4 and `::/0` is any ipv6. `any` means any ip family and address.
  462. # local_cidr: a local CIDR, `0.0.0.0/0` is any ipv4 and `::/0` is any ipv6. `any` means any ip family and address.
  463. # This can be used to filter destinations when using unsafe_routes.
  464. # By default, this is set to only the VPN (overlay) networks assigned via the certificate networks field unless `default_local_cidr_any` is set to true.
  465. # If there are unsafe_routes present in this config file, `local_cidr` should be set appropriately for the intended us case.
  466. # ca_name: An issuing CA name
  467. # ca_sha: An issuing CA shasum
  468. outbound:
  469. # Allow all outbound traffic from this node
  470. - port: any
  471. proto: any
  472. host: any
  473. inbound:
  474. # Allow icmp between any nebula hosts
  475. - port: any
  476. proto: icmp
  477. host: any
  478. # Allow tcp/443 from any host with BOTH laptop and home group
  479. - port: 443
  480. proto: tcp
  481. groups:
  482. - laptop
  483. - home
  484. # Expose a subnet (unsafe route) to hosts with the group remote_client
  485. # This example assume you have a subnet of 192.168.100.1/24 or larger encoded in the certificate
  486. - port: 8080
  487. proto: tcp
  488. group: remote_client
  489. local_cidr: 192.168.100.1/24