Browse Source

Merge pull request #2125 from xuminready/master

Update README.md
pull/2135/merge
Max Lv 6 years ago
committed by GitHub
parent
commit
dc5f295835
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 47 additions and 38 deletions
  1. 85
      README.md

85
README.md

@ -375,74 +375,83 @@ you may refer to the man pages of the applications, respectively.
ss-[local|redir|server|tunnel|manager]
-s <server_host> host name or ip address of your remote server
-s <server_host> Host name or IP address of your remote server.
-p <server_port> port number of your remote server
-p <server_port> Port number of your remote server.
-l <local_port> port number of your local server
-l <local_port> Port number of your local server.
-k <password> password of your remote server
-k <password> Password of your remote server.
-m <encrypt_method> Encrypt method: rc4-md5,
-m <encrypt_method> Encrypt method: rc4-md5,
aes-128-gcm, aes-192-gcm, aes-256-gcm,
aes-128-cfb, aes-192-cfb, aes-256-cfb,
aes-128-ctr, aes-192-ctr, aes-256-ctr,
camellia-128-cfb, camellia-192-cfb,
camellia-256-cfb, bf-cfb,
chacha20-poly1305, chacha20-ietf-poly1305
chacha20-ietf-poly1305,
xchacha20-ietf-poly1305,
salsa20, chacha20 and chacha20-ietf.
The default cipher is chacha20-ietf-poly1305.
[-f <pid_file>] the file path to store pid
[-a <user>] Run as another user.
[-f <pid_file>] The file path to store pid.
[-t <timeout>] socket timeout in seconds
[-t <timeout>] Socket timeout in seconds.
[-c <config_file>] the path to config file
[-c <config_file>] The path to config file.
[-n <number>] Max number of open files.
[-i <interface>] network interface to bind,
not available in redir mode
[-i <interface>] Network interface to bind.
(not available in redir mode)
[-b <local_address>] local address to bind
[-b <local_address>] Local address to bind.
[-u] enable udprelay mode,
TPROXY is required in redir mode
[-u] Enable UDP relay.
(TPROXY is required in redir mode)
[-U] enable UDP relay and disable TCP relay,
not available in local mode
[-U] Enable UDP relay and disable TCP relay.
(not available in local mode)
[-L <addr>:<port>] specify destination server address and port
for local port forwarding,
only available in tunnel mode
[-L <addr>:<port>] Destination server address and port
for local port forwarding.
(only available in tunnel mode)
[-6] Resovle hostname to IPv6 address first.
[-d <addr>] setup name servers for internal DNS resolver,
only available in server mode
[-d <addr>] Name servers for internal DNS resolver.
(only available in server mode)
[--reuse-port] Enable port reuse.
[--fast-open] enable TCP fast open,
only available in local and server mode,
with Linux kernel > 3.7.0
[--acl <acl_file>] config file of ACL (Access Control List)
only available in local and server mode
[--manager-address <addr>] UNIX domain socket address
only available in server and manager mode
[--fast-open] Enable TCP fast open.
with Linux kernel > 3.7.0.
(only available in local and server mode)
[--acl <acl_file>] Path to ACL (Access Control List).
(only available in local and server mode)
[--manager-address <addr>] UNIX domain socket address.
(only available in server and manager mode)
[--mtu <MTU>] MTU of your network interface.
[--mptcp] Enable Multipath TCP on MPTCP Kernel.
[--no-delay] Enable TCP_NODELAY.
[--executable <path>] path to the executable of ss-server
only available in manager mode
[--executable <path>] Path to the executable of ss-server.
(only available in manager mode)
[--key <key_in_base64>] Key of your remote server.
[--plugin <name>] Enable SIP003 plugin. (Experimental)
[--plugin-opts <options>] Set SIP003 plugin options. (Experimental)
[-v] verbose mode
[-v] Verbose mode.
## Transparent proxy

Loading…
Cancel
Save