Proxies

Egern supports multiple proxy protocols, including HTTP, Socks5, Shadowsocks, Trojan, Hysteria2, Vless, and Vmess.

HTTP

Field Name	Type	Required	Description
name	string	Yes	Proxy name
server	string	Yes	Server address
port	integer	Yes	Server port
username	string	No	Username, if authentication is required by server
password	string	No	Password, if authentication is required by server
tfo	boolean	No	Enable TCP Fast Open; default is false

Socks5

Field Name	Type	Required	Description
name	string	Yes	Proxy name
server	string	Yes	Server address
port	integer	Yes	Server port
username	string	No	Username, if authentication is required by server
password	string	No	Password, if authentication is required by server
tfo	boolean	No	Enable TCP Fast Open; default is false
udp_relay	boolean	No	Enable UDP relay; default is false

Shadowsocks

Field Name	Type	Required	Description
name	string	Yes	Proxy name
method	string	Yes	Encryption method
server	string	Yes	Server address
port	integer	Yes	Server port
password	string	Yes	Password
tfo	boolean	No	Enable TCP Fast Open; default is false
udp_relay	boolean	No	Enable UDP relay; default is false
obfs	string	No	Obfuscation type
obfs_host	string	No	Obfuscation host
obfs_uri	string	No	Obfuscation path

Trojan

Field Name	Type	Required	Description
name	string	Yes	Proxy name
server	string	Yes	Server address
port	integer	Yes	Server port
sni	string	Yes	Server Name Indication (SNI)
password	string	Yes	Password
tfo	boolean	No	Enable TCP Fast Open; default is false
udp_relay	boolean	No	Enable UDP relay; default is false

Vmess

Field Name	Type	Required	Description
name	string	Yes	Proxy name
server	string	Yes	Server address
port	integer	Yes	Server port
user_id	string	Yes	User ID
security	string	Yes	Encryption method
legacy	boolean	No	Use deprecated protocol; default is false
tfo	boolean	No	Enable TCP Fast Open; default is false
udp_relay	boolean	No	Enable UDP relay; default is false
transport	object	No	Transport protocol
transport.tls.sni	string	No	TLS SNI if using TLS transport
transport.wss.uri	string	No	WSS URI if using WSS transport
transport.ws.uri	string	No	WS URI if using WS transport

Vless

Field Name	Type	Required	Description
name	string	Yes	Proxy name
server	string	Yes	Server address
port	integer	Yes	Server port
user_id	string	Yes	User ID
tfo	boolean	No	Enable TCP Fast Open; default is false
udp_relay	boolean	No	Enable UDP relay; default is false
transport	object	No	Transport protocol
transport.tls.sni	string	No	TLS SNI if using TLS transport
transport.wss.uri	string	No	WSS URI if using WSS transport
transport.ws.uri	string	No	WS URI if using WS transport

Hysteria2

Field Name	Type	Required	Description
name	string	Yes	Proxy name
server	string	Yes	Server address
port	integer	Yes	Server port
auth	string	Yes	Authentication
sni	string	Yes	Server Name Indication (SNI)
obfs	string	No	Obfuscation protocol
obfs_password	string	No	Obfuscation protocol password
skip_tls_verify	boolean	No	Skip TLS verification; default is false

Configuration Example

proxies:
  - http:
      name: Http
      server: 127.0.0.1
      port: 1080
      username: ""
      password: ""
      tfo: true
  - socks5:
      name: Socks5
      server: 127.0.0.1
      port: 1080
      username: ""
      password: ""
      tfo: true
      udp_relay: true
  - shadowsocks:
      name: Shadowsocks
      method: ChaCha20-Poly1305
      password: password
      server: 127.0.0.1
      port: 433
      tfo: false
      udp_relay: true
  - trojan:
      name: Trojan
      server: 127.0.0.1
      port: 443
      sni: bing.com
      password: password
      tfo: false
      udp_relay: true
  - vless:
      name: Vless
      server: 127.0.0.1
      port: 443
      user_id: 27848739-7e62-4138-9fd3-098a63964b6b
      tfo: false
      udp_relay: true
      transport:
        wss:
          uri: "wss://www.bing.com/"
  - vmess:
      name: Vmess
      server: 127.0.0.1
      port: 443
      user_id: 27848739-7e62-4138-9fd3-098a63964b6b
      security: auto
      legacy: false
      tfo: false
      udp_relay: true
      transport:
        wss:
          uri: "wss://www.bing.com/"