Skip to content

Latest commit

 

History

History
56 lines (41 loc) · 3.59 KB

CLI.md

File metadata and controls

56 lines (41 loc) · 3.59 KB

docker-softether-vpnsrv

Initiates the SoftEtherVPN server that will run in this container.

docker-softether-vpnsrv [FLAGS]

Flags

CLI

Flag / Environment Description Type Required Default
$LOG_LEVEL Define the log level for the application. String
enum("PANIC", "FATAL", "WARNING", "INFO", "DEBUG", "TRACE")
false info
$ENV_FILE Environment files to inject. StringSlice false

DHCP Server

Flag / Environment Description Type Required Default
$DHCP_SERVER_TEMPLATE Template location for the DHCP server. String false /etc/template/dnsmasq.conf.tmpl
$DHCP_SERVER_LEASE DHCP server lease time for clients. String false 12h
$DHCP_SERVER_SEND_GATEWAY Whether to send the default gateway to the client. Sometimes you do not want to proxy traffic through the network, rather just establish a connection to the VPN network. Bool false false
$DHCP_SERVER_GATEWAY Set the gateway option for the underlying DNS server. String false CIDR address range start
$DHCP_SERVER_FORWARDING_ZONE Set forwarding-zone DNS addresses for the DHCP server. StringSlice false "8.8.8.8", "8.8.4.4"

Health

Flag / Environment Description Type Required Default
$HEALTH_CHECK_INTERVAL Health check interval to the upstream server in duration. Duration false 10m
$HEALTH_DHCP_SERVER_ADDRESS Upstream DHCP server address for doing health checks. String false CIDR address range start
$HEALTH_ENABLE_PING Whether to enable the ping check or not. Bool false false

Linux Bridge

Flag / Environment Description Type Required Default
$LINUX_BRIDGE_INTERFACE_NAME Interface name for the resulting communication bridge interface. String false br100
$LINUX_BRIDGE_UPSTREAM_INTERFACE Interface name for the upstream parent network interface to bridge to, this interface should provide a DHCP server to handle the clients. String false eth0
$LINUX_BRIDGE_USE_DHCP Use the upstream DHCP server to get ip for the bridge interface. Bool false false
$LINUX_BRIDGE_STATIC_IP Use a static IP for the bridge interface. String false

Server

Flag / Environment Description Type Required Default
$SERVER_MODE Server mode changes the behavior of the container. String
enum("dhcp", "bridge")
true
$SERVER_CIDR_ADDRESS CIDR address of the server. String false 10.0.0.0/24

SoftEther

Flag / Environment Description Type Required Default
$SOFTETHER_TEMPLATE Template location for the SoftEtherVPN server. String false /etc/template/vpn_server.config.tmpl
$SOFTETHER_TAP_INTERFACE Interface name for SoftEther and the server to bind to as a tap device. String false soft
$SOFTETHER_DEFAULT_HUB Default hub name for SoftEtherVPN server. String false DEFAULT