config.examples/example-1.rncn.net/main.cfg

; Example node configuration

; Optional directives are set to the default value but commented out.


node_address = 192.0.2.0

;set_hostname = false
;replace_sysctl_conf = false
;replace_resolv_conf = false
;add_login_logo = true
;run_sniproxy = false
;run_dns_server = false
;dns_server_port = 53

; External name server for using as a fallback before RNCN becomes operational
; at this node
;fallback_name_server =

; Configure default time zone for this node by updating the '/etc/localtime'
; symbolic link
;time_zone =

; The default router should be specified in either an IP address or a double
; quoted interface name.
; Same as BIRD configuration syntax, the literal double quotemarks in the
; alternative 'ipv4_default_router' directive inducates that the default
; router is on link of the quoted interface without a need of specifying its
; IP address.

; Specify IPv4 default router using its IP address
ipv4_default_router = 198.51.100.1
; Or, specify an interface IPv4 default routes
ipv4_default_router = "eth0"
; Same rules apply for IPv6 default router, but this is optional
;ipv6_default_router =

; URL to a remote configuration file for the DNS server
;dns_config_update_url =


; The monitor section configures timings of the rncn-bird-link-status-monitor
; service
; Each directive under this section have an unit of second
[monitor]
; Duration of each ping(8) to run for the initial cycle (the first cycle after
; the service was started)
;initial_ping_duration = 60
; Duration of each ping(8) to run for later cycles
;ping_duration = 3600
; Minimal time to wait for each cycle; next cycle will not begin until this
; amount of time has been passed, even if all the ping(8) processes has ended
;minimal_ping_wait = 3600

[wireguard]
; A private key for WireGuard can be generated by running 'wg genkey'
private_key =
;use_peer_resolver = false
; Whether to periodically rebind to a random port for each WireGuard interface
; that don't have a configuration-fixed bind port, in a random interval
;periodic_rebind_port = false

; Example peer for waiting for the peer to initiate WireGuard handshake to
; this node
[peer example-2]
; 'wireguard' is the default tunnel type
;tunnel_type = wireguard
; The peer public key for WireGuard
public_key =
; Local port number for receiving packet for this WireGuard tunnel; due to the
; design limitation of WireGuard, it is not possible to specify bind address
; or address family
bind_port = 15911
; Optional tunnel interface MTU to override default value of 1420; should be
; specified if the underlaying default router (WAN) interface has a MTU
; smalller than 1500; for example when using over PPPoE with MTU of 1492, the
; WireGuard interface MTU should be set to 1412 (1492-80)
;mtu = 1420
; In-tunnel IPv4 address (single address only)
ip4_addr = 10.100.0.0
; In-tunnel IPv6 addresses
ip6_addr = fd00:db8:100:0::
ip6_addr = fe80:100:0::
; Adjustment value for calculating final metric for this peer
;metric_offset = 0

; Example peer for this node to initiate WireGuard handshake to the peer
[peer example-3]
public_key =
; Peer IP address and port number for WireGuard
remote = example-2.rncn.net:15911
;mtu = 1420
ip4_addr = 10.100.1.1
ip6_addr = fd00:db8:100:1::1
ip6_addr = fe80:100:1::1
;metric_offset = 0

; Example peer that uses GRE as the tunneling protocol
[peer example-gre]
tunnel_type = gre
bind = 198.51.100.2
remote = example-gre.rncn.net
; May override default MTU here
;mtu = 1476
ip4_addr = 10.100.0.2
ip6_addr = fd00:db8:100:0::2
ip6_addr = fe80:100:0::2
;metric_offset = 0

[peer example-gre-fou]
tunnel_type = gre-fou
bind = 198.51.100.2:15912
remote = example-gre-fou.rncn.net:15912
;mtu = 1476
ip4_addr = 10.100.0.4
ip6_addr = fd00:db8:100:0::4
ip6_addr = fe80:100:0::4
;metric_offset = 0

; The in-tunnel IP addresses use 1-bit host number; thus, the prefix lengths
; are /23 and /127 for IPv4 and IPv6 address respectively. The remaining
; address in this sub-network is used as peer's in-tunnel address implicitly;
; take the local IPv4 address of peer example-3 configuration for example,
; the peer's in-tunnel IPv4 address will be 10.100.1.0.


; URLs for fetching address ranges for advertising routes for specified
; networks from this node; can be empty
[ra-list]
;https://api.rncn.net/example/routing-advertisements/all.area
;https://api.rncn.net/example/routing-advertisements/eur.area

; Exclude these IPv4 address ranges from advertising; note the entries are
; matched by text only, address prefix lengths are not considered
[ipv4-ra-exclusion]
;216.239.32.0/24
;216.239.34.0/24
;216.239.36.0/24
;216.239.38.0/24
;1.1.1.0/24

; Static IPv4 routes that uses the default router, and should be applied to,
; as well as advertised from this node;
[wan-ipv4-route-targets]
;1.1.1.1/32

; Likewise, but for IPv6 routes
[wan-ipv6-route-targets]
;2606:4700:4700::1111/128