Configuration examples
Each example has its own page with the complete, copyable YAML file. Change
addresses, credentials, certificates, and other deployment-specific values
before using it. Run shoes check after adapting the configuration.
Start here
Section titled “Start here”- Local SOCKS5 listener: loopback-only, no certificates or upstream services required.
- HTTP through SOCKS: connect an inbound listener to an upstream proxy.
- Multi-hop chain: route through more than one upstream.
- Routing with local rule sources: requires the referenced rule files.
- Clash controller: runtime selectors and controller configuration.
Validation
Section titled “Validation”Rust tests check YAML decoding and rule compilation for all these files. A
curated subset listed in src/config/tests.rs also passes native preparation
checks with repository fixtures. Parsing or preparation does not prove that
sockets, routes, external peers, or platform-specific features work on the
deployment machine.
All examples
Section titled “All examples”- anytls.yaml
- certificates_acme.yaml
- certificates_files.yaml
- clash_api.yaml
- dns_tuning.yaml
- fake_dns.yaml
- h2mux_client.yaml
- http_host_sniffing.yaml
- http_proxy_basic.yaml
- http_through_socks.yaml
- http2-proxy.yaml
- https.yaml
- hysteria2.yaml
- mixed.yaml
- multi_hop_chain.yaml
- naiveproxy.yaml
- named_certificates.yaml
- quic_clients.yaml
- quickstart_socks.yaml
- reality_basic.yaml
- reality_client.yaml
- reality_trojan.yaml
- reality_vision_client.yaml
- reality_vision.yaml
- rule_sources.yaml
- shadowsocks_basic.yaml
- shadowsocks-2022-client.yaml
- shadowtls_v3_local_handshake.yaml
- shadowtls_v3_remote_handshake.yaml
- snell_forward_rules.yaml
- snell.yaml
- sni_sniffing.yaml
- socks_basic.yaml
- socks_test.yaml
- socks_through_tls_vmess.yaml
- socks_through_vmess.yaml
- socks_through_wss_vmess.yaml
- tls_sni_vmess_and_snell.yaml
- trojan_basic.yaml
- trojan_tls_through_socks.yaml
- tuic_v5_port_range.yaml
- tuic_v5.yaml
- tun_desktop.yaml
- tun_vpn.yaml
- url_test.yaml
- vless_encryption.yaml
- vless_over_tls.yaml
- vless_variants.yaml
- vmess_through_socks.yaml
- vmess.yaml
- wireguard_client.yaml
- wireguard_outer_chain.yaml
- wireguard_proxied_server.yaml
- wireguard_server.yaml
- wss_vmess_and_shadowsocks.yaml
- wss_vmess.yaml
- xhttp.yaml