Generate client configuration

Step 1: Download the configuration generator

You can download the generator package from web page or command line.

From web:
Go to the release page of this project and download sskcp-confgenerator-[VERSION].zip.

From command line:

wget https://github.com/elespejo/sskcp/releases/download/[VERSION]/sskcp-confgenerator-[VERSION].zip

e.g, download configuration generator of version 0.4.8

wget https://github.com/elespejo/sskcp/releases/download/0.4.8/sskcp-confgenerator-0.4.8.zip

Step 2: Unzip

unzip sskcp-confgenerator-[VERSION].zip
cd sskcp-confgenerator/

e.g:

unzip sskcp-confgenerator-0.4.8.zip
cd sskcp-confgenerator/

Step 3: Modify the conf-info

Here is the template conf-info for sskcp client:

client:
  - { mode: [ss or sskcp], listenport: [port], vpsip: [ip], vpsport: [port], key: [key], log-dir: [path] }

The explanation of needed keywords:

[mode]: The mode of the instance. It can be ss or sskcp.
[listenport]: The port that the instance listens.
[vpsip]: The vps ip where the instance sent data.
[vpsport]: The vps port where the instance sent data.
[key]: The password for client and server authorize each other. Please note that the key you filled here will not be used directly, a prefix will be added to it, e.g, ss_[key] for shadowsocks and kcp_[key] for kcp.
[log-dir]: The absolute path where the log directory created. The confgenerator will create a directory named [listenport]-[vpsip]-[vpsport] to store snmp log under this path.

Step 4: Use confgenerator

python -m confgenerator.cli client -f [conf-info] -d [dest]

The explanation of arguments:

[conf-info]: the absolute path of conf-info file.
[dest]: the absolute path for configuration generation.

Step 4: validation

After generation, A configuration directory named [listenport]-[vpsip]-[vpsport] is generated in [dest].

tree [dest]/
[dest]
└── [listenport]-[vpsip]-[vpsport]
    ├── conf
    │   ├── kcp.json # if mode is ss, this file is not exists.
    │   └── ss.json 
    └── config.env

Also, A log directory named [listenport]-[vpsip]-[vpsport] is created in [log-dir].

tree [log-dir]
[log-dir]
└── [listenport]-[vpsip]-[vpsport]

Log files will consistently generated after instance started.

Generate configuration