config.yml 27 KB

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