Skip to content
Shoes
devSource ab9402f65fa0

First configuration

This example listens on loopback, so only programs on the same machine can connect. It requires no certificate or external proxy.

Create quickstart_socks.yaml in your working directory with this configuration:

quickstart_socks.yaml
- address: "127.0.0.1:1080"
  protocol:
    type: socks

With Shoes installed, validate the file before starting a listener:

Terminal window
shoes check quickstart_socks.yaml
shoes quickstart_socks.yaml

Point a SOCKS5-capable application at 127.0.0.1:1080. The listener allows direct connections by default. To accept remote users, bind to another interface and add authentication and destination rules before exposing the port. See SOCKS5 and rules.

check validates syntax, certificates, and configuration relationships but does not bind sockets or perform DNS bootstrap networking. A successful check does not guarantee that the listener can start on this machine.