diff --git a/README.md b/README.md index a9927503..d5edf8d2 100644 --- a/README.md +++ b/README.md @@ -466,6 +466,7 @@ Example configuration: // If not set, it will derive from the outer `mode` "mode": "tcp_and_udp", // OPTIONAL. Authentication configuration file + // Configuration file document could be found in the next section. "socks5_auth_config_path": "/path/to/auth.json" }, { @@ -661,6 +662,24 @@ Example configuration: } ``` +### SOCKS5 Authentication Configuration + +The configuration file is set by `socks5_auth_config_path` in `locals`. + +```jsonc +{ + // Password/Username Authentication (RFC1929) + "password": { + "users": [ + { + "user_name": "USERNAME in UTF-8", + "password": "PASSWORD in UTF-8" + } + ] + } +} +``` + ### Environment Variables - `SS_SERVER_PASSWORD`: A default password for servers that created from command line argument (`--server-addr`)