YASS_SEREVR(1)

NAME
yass_serevr - a lightweight and efficient, socks5/http forward proxy

SYNOPSIS
yass_serevr [option...]
yass_serevr -c file [option...]

DESCRIPTION
yass is initiated as C++ rewrite of the outdated shadowsocks-libev package and provide the similar functionalities. During the recent development, it also supports naiveproxy protocol which is more efficient protocol. Compared with shadowsocks-libev, it not only contains the client cli command and server cli command, but also it contains a gtk3/gtk4/qt5/qt6 (all are supported) graphical interface client which is more friendly to the new users.

  How to use
See https://github.com/hukeyue/yass/wiki/Usage.

OPTIONS

-c file, --configfile file
    Use specified file as config file.

-t  Don't run, just test the configuration file.

-v, --version
    Print yass_server version.

--limit_rate rate
    Limits the rate of response transmission to a client. Uint can be (none), k and m.

--ipv6_mode
    Enable IPv6 support.

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

--server_port port
    Set the server's port number.

--local_host host
    Set the local hostname or IP.

--local_port port
    Set the local port number.

--username username
    Set the username. The server and the client should use the same username.

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

--method method
    Method of encrypt method as required field. Allow cipher method depends on your build flags. Possible values are:

    libsodium compatible AEAD Cipher: aes-256-gcm, chacha20-ietf-poly1305, xchacha20-ietf-poly1305

    boringssl compatible AEAD Cipher: chacha20-ietf-poly1305-evp, xchacha20-ietf-poly1305-evp, aes-128-gcm-evp, aes-128-gcm12-evp, aes-192-gcm-evp, aes-256-gcm-evp

    mbedtls compatible STREAM Cipher: 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

    naiveproxy compatible Cipher Method: https, http2-plaintext, http2

    The default cipher method is http2.

--connect_timeout number
    Connect timeout is number in seconds.

--worker_connections number
    Maximum number of accepted connection is number.

--padding_support
    Enable padding support.

--ca_native
    Load CA certs from the OS.

--cacert file
    CA certificate file to verify peer against.

--capath dir
    CA directory dir to verify peer against. It is a colon separated list of directories.

--certificate_chain_file file
    Use custom certificate chain provided by file to verify server's private key (required by https and http2).

--private_key_file file
    Use custom private key provided by file to secure connection between server and client (required by https and http2).

--private_key_password password
    Use custom private key password provided by password to decrypt server's encrypted private key.

--user user
    Set non-privileged user for worker.

--group group
    Set non-privileged group for worker.

--hide_ip
    If true, the Forwarded header will not be augmented with your IP address.

--hide_via
    If true, the Via header will not be added.

--enable_post_quantum_kyber
    Enables post-quantum key-agreements (i.e. ML-KEM) in TLS 1.3 connections.

--congestion_algorithm algo
    Specify algo as TCP congestion control algorithm for underlying TCP connections (Linux Only)

    See /proc/sys/net/ipv4/tcp_allowed_congestion_control for available options and tcp(7).

ENVIRONMENT VARIABLES

SSL_CERT_FILE
    Use as the path of CA certificate to verify peer against. Same effect with --cacert file.

SSL_CERT_DIR
    Use as the path of CA directory to verify peer against. Same effect with --capath dir. It is a colon separated list of directories.

COPYRIGHT
Copyright (C) 2019-2026 Chilledheart. All rights reserved.

SEE ALSO
openssl(1), tcp(7)