Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kirito41dd/ss-light
A lightweight shadowsocks implementation.
https://github.com/kirito41dd/ss-light
shadowsocks sip003 ss v2ray-plugin
Last synced: 3 months ago
JSON representation
A lightweight shadowsocks implementation.
- Host: GitHub
- URL: https://github.com/kirito41dd/ss-light
- Owner: kirito41dd
- Created: 2022-04-01T14:24:44.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-03-17T13:34:47.000Z (almost 2 years ago)
- Last Synced: 2024-09-26T21:22:53.913Z (3 months ago)
- Topics: shadowsocks, sip003, ss, v2ray-plugin
- Language: Rust
- Homepage:
- Size: 54.7 KB
- Stars: 10
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## shadowsocks lightweight implementation(server side)
a proxy tool written in rust.
## build
```bash
git clone https://github.com/kirito41dd/ss-light.git
cd ss-light && cargo test
cargo build --release
./target/release/server --version
```
## usage
run with `config.toml`:
```bash
./server -c config.toml
```
```toml
passwd = "123456"
method = "aes-256-gcm"
bind_addr = "0.0.0.0"
bind_port = 6789
timeout = 2000 # ms, timeout for tcp proxy handshake and tcp connect
log_level = "info" # error warn info debug trace
console_log = true
# file_log_dir = "applog/" # if no set, don't log to file
udp_capacity = 1000 # udp relay worker pool size, one proxy req one worker
udp_expiry_time = 30 # sec, expiration time for udp relay worker keep alive
# [plugin]
# name = "v2ray-plugin"
# opts = "server"
# args = []
```
or override config with:
```bash
./server -c config.toml -l 127.0.0.1 -p 1080 -k
```
if without `-c`, default config file is `$pwd/config.toml`
more usage:
```bash
./server -h
```
## quick start with docker
> tips: use `` exit container but keep it running
>
> v2ray-plugin are recommended
start with default config but specify password:
```bash
docker run --rm -it -p 8888:6789/tcp -p 8888:6789/udp kirito41dd/ss-light -k passwd123
```
or start with custom config file:
1. create new config dir in home then add `config.toml` file:
```
mkdir $HOME/.ss-light && cd $HOME/.ss-light
touch config.toml
```
2. edit `config.toml` like [here](#usage)
3. run docker:
```bash
docker run --rm -it -v $HOME/.ss-light:/app -p 8888:6789/tcp -p 8888:6789/udp kirito41dd/ss-light
```
use v2ray-plugin: (websocket)
```
docker run --rm -it -p 8888:6789/tcp -p 8888:6789/udp kirito41dd/ss-light -k passwd123 --plugin v2ray-plugin --plugin-opts server
```
use other [SIP003](https://shadowsocks.org/en/wiki/Plugin.html) plugins:
1. like start with custom config file, download plugin to `$HOME/.ss-light`
2. start
```
docker run --rm -it -v $HOME/.ss-light:/app -p 8888:6789/tcp -p 8888:6789/udp kirito41dd/ss-light --plugin=/app/
```
## best practice
ss-light + v2ray-plugin + cloudflare DNS
1. `apt -y install python3-certbot-nginx nginx`
2. `vim /etc/nginx/conf.d/ss.conf`
```
server {
listen 80;
server_name xxx.com;
location /dog {
proxy_pass http://127.0.0.1:8888;
proxy_redirect off;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_set_header Host $http_host;
}
}
```
3. `certbot --nginx --agree-tos --no-eff-email --email [email protected]`
4. `systemctl restart nginx`
5. `docker run --restart=always -it -p 127.0.0.1:8888:6789/tcp kirito41dd/ss-light -k passwd123 --plugin v2ray-plugin --plugin-opts "server;path=/dog;loglevel=none"`
6. setting your cloudflare SSL/TLS option `Full` or `Full (strict)`
7. use client: `xxx.com 443 passwd123 aes-256-gcm v2ray-plugin websocket xxx.com tsl /dog`
## feature
* Shadowsocks AEAD
* AES_256_GCM
* TCP relay
* UDP relay
* Plugin
* v2ray-plugin