SS-MANAGER(1)

NAME
ss-manager - ss-server controller for multi-user management and traffic statistics

SYNOPSIS
ss-manager
    [-AhuUv]
    [-s server_host] [-p server_port] [-l local_port]
    [-k password] [-m encrypt_method] [-f pid_file]
    [-t timeout] [-c config_file] [-i interface]
    [-b local_addr] [-a user_name]
    [--manager-address path_to_unix_domain]
    [--executable path_to_server_executable]

DESCRIPTION
Shadowsocks-libev is a lightweight and secure socks5 proxy. It is a port of the original shadowsocks created by clowwindy. Shadowsocks-libev is written in pure C and takes advantage of libev to achieve both high performance and low resource consumption.

Shadowsocks-libev consists of five components. ss-manager(1) is a controller for multi-user management and traffic statistics, using UNIX domain socket to talk with ss-server(1). Also, it provides a UNIX domain socket or IP based API for other software. About the details of this API, please refer to the following PROTOCOL section.

OPTIONS

-s server_host
    Set the server's hostname or IP.

-p server_port
    Set the server's port number.

-l local_port
    Set the local port number.

-k password
    Set the password. The server and the client should use the same password.

-m encrypt_method
    Set the cipher. Shadowsocks-libev accepts 18 different ciphers: table, rc4, rc4-md5, aes-128-cfb, aes-192-cfb, aes-256-cfb, bf-cfb, camellia-128-cfb, camellia-192-cfb, camellia-256-cfb, cast5-cfb, des-cfb, idea-cfb, rc2-cfb, seed-cfb, salsa20, chacha20 and chacha20-ietf. The default cipher is table. If built with PolarSSL or custom OpenSSL libraries, some of these ciphers may not work.

-f pid_file
    Start shadowsocks as a daemon with specific pid file.

-t timeout
    Set the socket timeout in seconds. The default value is 10.

-c config_file
    Use a configuration file.

-i interface
    Specify network interface to bind.

-b local_address
    Specify local address to bind.

-a user_name
    Run as a specific user.

-u  Enable UDP relay.

-U  Enable UDP relay and disable TCP relay.

-A  Enable onetime authentication.

--manager-address path_to_unix_domain
    Specify UNIX domain socket address for the communication between ss-manager and ss-server. Only available in server and manager mode.

--executable path_to_server_executable
    Specify the executable path of ss-server. Only available in manager mode.

-v  Enable verbose mode.

PROTOCOL
ss-manager(1) provides several APIs through UDP protocol:
    Send UDP commands in the following format to the manager-address provided to ss-manager(1).
        command: [JSON data]
    To add a port:
        add: {"server_port": 8001, "password":"7cd308cc059"}
    To remove a port:
        remove: {"server_port": 8001}
    To receive a pong:
        ping
    Then ss-manager(1) will send back the traffic statistics:
        stat: {"8001":11370}

EXAMPLE
To use ss-manager(1), First start it and specify necessary information. Then communicate with ss-manager(1) through UNIX Domain Socket using UDP protocol:
    # Start the manager. Arguments for ss-server will be passed to generated
    # ss-server process(es) respectively.
    ss-manager --manager-address /tmp/manager.sock --executable $(which ss-server) -s example.com -m aes-256-cfb -c /path/to/config.json
    # Connect to the socket. Using netcat-openbsd as an example.
    # You should use scripts or other programs for further management.
    nc -Uu /tmp/manager.sock After that, you may communicate with ss-manager(1) as described above in the PROTOCOL section.

SEE ALSO
ss-local(1), ss-server(1), ss-tunnel(1), ss-redir(1), shadowsocks-libev(8), iptables(8), /etc/shadowsocks-libev/config.json

AUTHOR
shadowsocks was created by clowwindy <clowwindy42@gmail.com> and shadowsocks-libev was maintained by Max Lv <max.c.lv@gmail.com> and Linus Yang <laokongzi@gmail.com>.

This manual page was written by Max Lv <max.c.lv@gmail.com>.

The manual pages were rearranged by hosiet <073plan@gmail.com>.