Configuration File Guide

The program's configuration sources mainly include:

• landscape_init.toml: Full configuration file, includes various rule configurations as well as complete landscape.toml. Read only once on first run. After reading, a landscape_init.lock file will be created. You can export the current configuration as an init file in the UI interface, which is convenient for redeployment using the current configuration.
• landscape.toml: Read on each startup, contains only listen addresses, login username and password, logs and other configurations.

The program can start without any file configuration.
If you want it to be ready on first boot, you can configure landscape_init.toml.

Settings in landscape.toml have lower priority than command-line arguments.

WARNING

• When the landscape_init.lock file is deleted, startup will clear all existing configurations and then refresh the entire configuration using the content in landscape_init.toml, including the configuration in landscape.toml. So be cautious when deleting this file.
• Path configurations in configuration files can only use absolute paths or relative paths. Cannot use paths starting with ~
• The landscape_init.toml file can only be used for recovery of the current version; cross-version recovery will fail. So you can first restore in the appropriate version, then start with the new version. The new version can automatically migrate old version configurations. (Note: Version file export is supported after version v0.6.7)

landscape.toml Configuration Example (only configure what you need)

[auth]
# Login username
admin_user = "root"
# Login password
admin_pass = "root"

[web]
# Web root directory path
web_root = "/root/.landscape-router/static"
# HTTP listen port
port = 6300
# HTTPS listen port
https_port = 6443
# Listen address, use 0.0.0.0 for IPv4 only
address = "::"

[log]
# Log file path
log_path = "/root/.landscape-router/logs"
# Enable debug mode
debug = false
# Output logs to terminal
log_output_in_terminal = false
# Maximum number of log files
max_log_files = 10

[store]
# Database path
database_path = "sqlite:///root/.landscape-router/landscape_db.sqlite?mode=rwc"

landscape_init.toml Configuration Example

config Definition

Configuration details are the same as above, the only difference is that you need to add config. prefix, for example:

[config.auth]
admin_user = "root"
admin_pass = "root"

[config.web]
web_root = "/root/.landscape-router/static"

[config.log]
log_path = "/root/.landscape-router/logs"

[config.store]
database_path = "sqlite:///root/.landscape-router/landscape_db.sqlite?mode=rwc"

Network Interface Definition

[[ifaces]]
name = "ens3" # Interface name
create_dev_type = "no_need_to_create" # Physical interface doesn't need creation
zone_type = "wan" # Zone type
enable_in_boot = true # Enable this interface on boot
wifi_mode = "undefined" # Is it a WiFi interface

# xps_rps configuration for CPU soft load balancing, needed when single CPU core is weak
[ifaces.xps_rps]
xps = "4"
rps = "4"

Interface IP Configuration Method

[[ipconfigs]]
iface_name = "ens3" # Which interface to apply to
enable = true # Whether to enable

[ipconfigs.ip_model] # Specific IP configuration method
t = "static" # Static IP configuration
default_router_ip = "10.1.1.10" # Router IP
default_router = true # Whether to set default_router_ip as default route
ipv4 = "10.1.1.237" # Static IP to be set for current interface
ipv4_mask = 24

DHCP Service Configuration

[[dhcpv4_services]]
iface_name = "test"
enable = false

[dhcpv4_services.config]
ip_range_start = "192.168.5.2"
ip_range_end = "192.168.5.255"
server_ip_addr = "192.168.5.1"
network_mask = 24

# MAC address IP binding
mac_binding_records = [
    { mac = "00:11:22:33:44:55", ip = "192.168.5.100" },
    { mac = "00:11:22:33:44:55", ip = "192.168.5.200" },
]