Easytier-Core 完整参数配置手册#
所有参数支持命令行指定/环境变量配置两种方式,命令行参数优先级高于配置文件;环境变量均以ET_为前缀,参数说明中保留核心使用规则、默认值及关键示例。
一、配置服务器与配置文件相关#
| 参数名(短参数) | 环境变量 | 参数说明 |
|---|
| config-server(-w) | ET_CONFIG_SERVER | 配置服务器地址,支持2种格式:1. 完整URL(如udp://127.0.0.1:22020/admin);2. 仅用户名(如admin,将使用官方服务器) |
| machine-id | ET_MACHINE_ID | 配置服务器识别机器的唯一标识,用于断线重连配置恢复,需固定且唯一,默认从系统获取 |
| config-file(-c) | ET_CONFIG_FILE | 配置文件路径,可指定多个;命令行配置会覆盖配置文件中的同名选项 |
| config-dir | ET_CONFIG_DIR | 加载目录下所有.toml文件启动网络实例,下发的配置也会保存在此目录 |
二、网络标识与密钥配置#
| 参数名(短参数) | 环境变量 | 参数说明 |
|---|
| network-name | ET_NETWORK_NAME | 标识当前VPN网络的名称,用于节点归属验证 |
| network-secret | ET_NETWORK_SECRET | 网络密钥,验证节点是否属于当前VPN网络,需所有节点保持一致 |
三、网络地址配置(IPv4/IPv6/DHCP)#
| 参数名(短参数) | 环境变量 | 参数说明 |
|---|
| ipv4(-i) | ET_IPV4 | 本VPN节点的IPv4地址,为空则仅转发数据包,不创建TUN设备 |
| ipv6 | ET_IPV6 | 本VPN节点的IPv6地址,可与IPv4搭配实现双栈网络通信 |
| dhcp(-d) | ET_DHCP | 由Easytier自动分配IP,默认从10.0.0.1开始;IP冲突时会自动更换,可选值:true、false |
四、对等节点与共享节点配置#
| 参数名(短参数) | 环境变量 | 参数说明 |
|---|
| peers(-p) | ET_PEERS | 节点启动时最初要连接的对等节点,可指定多个 |
| external-node(-e) | ET_EXTERNAL_NODE | 配置公共共享节点,用于自动发现网络中的其他对等节点 |
六、监听器相关配置#
| 参数名(短参数) | 环境变量 | 参数说明 |
|---|
| listeners(-l) | ET_LISTENERS | 节点接受连接的监听器,支持3种格式:1. 仅端口(如11010,自动适配多协议端口规则);2. URL(如tcp://0.0.0.0:11010,协议支持tcp/udp/ring/wg/ws/wss);3. 协议端口对(如wg:11011),可指定多个 |
| mapped-listeners | ET_MAPPED_LISTENERS | 手动指定监听器的公网地址,供其他节点连接,可指定多个(如tcp://123.123.123.123:11223) |
| no-listener | ET_NO_LISTENER | 不监听任何端口,节点仅主动连接对等节点,不接受外部连接 |
七、设备与实例标识配置#
| 参数名(短参数) | 环境变量 | 参数说明 |
|---|
| hostname | ET_HOSTNAME | 标识当前运行设备的主机名,用于魔法DNS等场景识别节点 |
| instance-name(-m) | ET_INSTANCE_NAME | 实例名称,用于在同一台机器上区分多个VPN节点 |
八、VPN门户与默认协议配置#
| 参数名(短参数) | 环境变量 | 参数说明 |
|---|
| vpn-portal | ET_VPN_PORTAL | 定义VPN门户URL,允许外部客户端连接(示例:wg://0.0.0.0:11010/10.14.14.0/24) |
| default-protocol | ET_DEFAULT_PROTOCOL | 节点连接对等节点时使用的默认通信协议 |
九、加密相关配置#
| 参数名(短参数) | 环境变量 | 参数说明 |
|---|
| disable-encryption(-u) | ET_DISABLE_ENCRYPTION | 禁用节点间通信加密,默认false,需所有节点配置一致,可选值:true、false |
| encryption-algorithm | ET_ENCRYPTION_ALGORITHM | 通信加密算法,默认aes-gcm,可选值:aes-gcm、aes-256-gcm、xor、chacha20 |
十、运行时性能配置(多线程)#
| 参数名(短参数) | 环境变量 | 参数说明 |
|---|
| multi-thread | ET_MULTI_THREAD | 启用多线程运行时,默认单线程,可选值:true、false |
| multi-thread-count | ET_MULTI_THREAD_COUNT | 多线程模式下的线程数,默认2,取值必须大于2 |
十一、TUN设备与网络基础配置#
| 参数名(短参数) | 环境变量 | 参数说明 |
|---|
| disable-ipv6 | ET_DISABLE_IPV6 | 禁用IPv6功能,可选值:true、false |
| dev-name | ET_DEV_NAME | 自定义TUN虚拟网卡的接口名称 |
| mtu | ET_MTU | TUN设备的MTU值,默认:非加密1380、加密1360 |
十二、路由与转发配置#
| 参数名(短参数) | 环境变量 | 参数说明 |
|---|
| latency-first | ET_LATENCY_FIRST | 启用延迟优先模式,尝试用最低延迟路径转发流量,默认使用最短路径,可选值:true、false |
| exit-nodes | ET_EXIT_NODES | 所有流量的出口节点(填写虚拟IPv4地址),优先级按配置顺序排列,可指定多个 |
| enable-exit-node | ET_ENABLE_EXIT_NODE | 允许本节点作为其他节点的流量出口节点,可选值:true、false |
| proxy-forward-by-system | ET_PROXY_FORWARD_BY_SYSTEM | 通过系统内核转发子网代理数据包,禁用内置NAT,可选值:true、false |
| no-tun | ET_NO_TUN | 不创建TUN设备,仅通过子网代理方式访问其他节点,可选值:true、false |
| use-smoltcp | ET_USE_SMOLTCP | 为子网代理、KCP代理启用smoltcp协议栈,可选值:true、false |
| manual-routes | ET_MANUAL_ROUTES | 手动分配路由CIDR,配置后将禁用子网代理和WireGuard路由传播(示例:192.168.0.0/16),可指定多个 |
| relay-network-whitelist | ET_RELAY_NETWORK_WHITELIST | 仅转发白名单网络的流量,支持通配符,多网络用空格分隔;为空则禁用转发,默认允许所有(示例:、def、net1 net2) |
十三、P2P与打洞功能配置#
| 参数名(短参数) | 环境变量 | 参数说明 |
|---|
| p2p-only | ET_P2P_ONLY | 仅与已建立P2P连接的对等节点通信,可选值:true、false |
| disable-p2p | ET_DISABLE_P2P | 禁用P2P通信,仅通过peers指定的节点转发数据包,可选值:true、false |
| disable-udp-hole-punching | ET_DISABLE_UDP_HOLE_PUNCHING | 禁用UDP打洞功能,可选值:true、false |
| disable-tcp-hole-punching | ET_DISABLE_TCP_HOLE_PUNCHING | 禁用TCP打洞功能,可选值:true、false |
| disable-sym-hole-punching | ET_DISABLE_SYM_HOLE_PUNCHING | 禁用基于生日攻击的对称NAT(NAT4)UDP打洞,该方式可能被运营商封锁,可选值:true、false |
| relay-all-peer-rpc | ET_RELAY_ALL_PEER_RPC | 转发所有对等节点的RPC数据包,帮助白名单外节点建立P2P连接,可选值:true、false |
十四、代理与压缩配置(KCP/QUIC/SOCKS5)#
| 参数名(短参数) | 环境变量 | 参数说明 |
|---|
| socks5 | ET_SOCKS5 | 启用SOCKS5服务器,允许客户端通过端口访问虚拟网络,仅需填写端口号(示例:1080) |
| compression | ET_COMPRESSION | 数据压缩算法,默认none,可选值:none、zstd |
| bind-device | ET_BIND_DEVICE | 将套接字绑定到物理设备,解决子网代理网段冲突问题,可选值:true、false |
| enable-kcp-proxy | ET_ENABLE_KCP_PROXY | 启用KCP代理TCP流,提升UDP丢包网络下的延迟和吞吐量,可选值:true、false |
| disable-kcp-input | ET_DISABLE_KCP_INPUT | 拒绝其他节点通过KCP代理连接本节点,本节点仍可主动使用KCP,可选值:true、false |
| enable-quic-proxy | ET_ENABLE_QUIC_PROXY | 启用QUIC代理TCP流,效果同KCP,可选值:true、false |
| disable-quic-input | ET_DISABLE_QUIC_INPUT | 拒绝其他节点通过QUIC代理连接本节点,本节点仍可主动使用QUIC,可选值:true、false |
| quic-listen-port | ET_QUIC_LISTEN_PORT | QUIC连接的监听端口,默认0(随机端口),需高版本支持 |
十五、端口转发与DNS配置#
| 参数名(短参数) | 环境变量 | 参数说明 |
|---|
| port-forward | ET_PORT_FORWARD | 本地端口转发到虚拟网络远程端口,支持多协议,可指定多个(示例:udp://0.0.0.0:12345/10.126.126.1:23456) |
| accept-dns | ET_ACCEPT_DNS | 启用魔法DNS,可通过.et.net访问节点,会修改系统DNS,可选值:true、false |
| tld-dns-zone | ET_TLD_DNS_ZONE | 自定义魔法DNS的顶级域名,仅accept-dns为true时生效,默认et.net. |
十六、网络安全与流量限制配置#
| 参数名(短参数) | 环境变量 | 参数说明 |
|---|
| private-mode | ET_PRIVATE_MODE | 禁止非本网络(名称/密钥不一致)节点通过本节点握手/中转,可选值:true、false |
| foreign-relay-bps-limit | ET_FOREIGN_RELAY_BPS_LIMIT | 作为共享节点时,限制非本地网络的流量转发速率,单位BPS(字节每秒),默认无限制 |
| tcp-whitelist | - | TCP端口白名单,支持单个端口(如80)、端口范围(如8000-9000),可指定多个 |
| udp-whitelist | - | UDP端口白名单,支持单个端口(如53)、端口范围(如5000-6000),可指定多个 |
| disable-relay-kcp | ET_DISABLE_RELAY_KCP | 禁止节点转发KCP数据包,防止流量过度消耗,默认false,可选值:true、false |
| enable-relay-foreign-network-kcp | ET_ENABLE_RELAY_FOREIGN_NETWORK_KCP | 作为共享节点时转发其他网络的KCP数据包,默认false,可选值:true、false |
十七、STUN服务器配置#
| 参数名(短参数) | 环境变量 | 参数说明 |
|---|
| stun-servers | ET_STUN_SERVERS | 覆盖内置IPv4 STUN服务器列表;设为空则不使用,不配置则用默认列表,可指定多个 |
| stun-servers-v6 | ET_STUN_SERVERS_V6 | 覆盖内置IPv6 STUN服务器列表;设为空则不使用,不配置则用默认列表,可指定多个 |
十八、日志相关配置#
| 参数名(短参数) | 环境变量 | 参数说明 |
|---|
| console-log-level | ET_CONSOLE_LOG_LEVEL | 控制台日志级别,支持trace/debug/info/warn/error/fatal(从详细到简略) |
| file-log-level | ET_FILE_LOG_LEVEL | 日志文件的日志级别,取值同控制台日志级别 |
| file-log-dir | ET_FILE_LOG_DIR | 日志文件的存储目录,不配置则不生成日志文件 |
| file-log-size | ET_FILE_LOG_SIZE | 单个日志文件的最大大小,单位MB,默认100 |
| file-log-count | ET_FILE_LOG_COUNT | 最大日志文件数量,默认10,超过则自动删除最旧文件 |
二十、工具与调试参数#
| 参数名(短参数) | 环境变量 | 参数说明 |
|---|
| gen-autocomplete | - | 生成shell补全脚本,可选值:bash、elvish、fish、powershell、zsh |
| check-config | - | 检查配置文件的有效性,验证完成后直接退出,不启动节点 |
| daemon | - | 以守护进程模式运行Easytier-Core |
| disable-env-parsing | - | 禁用配置文件中的环境变量解析功能 |
二十一、基础帮助参数#
| 参数名(短参数) | 环境变量 | 参数说明 |
|---|
| help(-h) | - | 打印所有参数的使用帮助信息 |
| version(-V) | - | 打印当前Easytier-Core的版本号 |
(注:文档部分内容可能由 AI 生成)