{"id":15107310,"url":"https://github.com/kirito41dd/ss-light","last_synced_at":"2025-10-23T02:31:08.559Z","repository":{"id":40548867,"uuid":"476751824","full_name":"kirito41dd/ss-light","owner":"kirito41dd","description":"A lightweight shadowsocks implementation.","archived":false,"fork":false,"pushed_at":"2023-03-17T13:34:47.000Z","size":56,"stargazers_count":10,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-09-26T21:22:53.913Z","etag":null,"topics":["shadowsocks","sip003","ss","v2ray-plugin"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kirito41dd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-04-01T14:24:44.000Z","updated_at":"2023-08-20T19:46:35.000Z","dependencies_parsed_at":"2022-08-09T22:50:52.115Z","dependency_job_id":null,"html_url":"https://github.com/kirito41dd/ss-light","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kirito41dd%2Fss-light","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kirito41dd%2Fss-light/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kirito41dd%2Fss-light/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kirito41dd%2Fss-light/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kirito41dd","download_url":"https://codeload.github.com/kirito41dd/ss-light/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219868400,"owners_count":16555748,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["shadowsocks","sip003","ss","v2ray-plugin"],"created_at":"2024-09-25T21:23:05.665Z","updated_at":"2025-10-23T02:31:03.282Z","avatar_url":"https://github.com/kirito41dd.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"## shadowsocks lightweight implementation(server side)\na proxy tool written in rust.\n\n## build\n```bash\ngit clone https://github.com/kirito41dd/ss-light.git\ncd ss-light \u0026\u0026 cargo test\ncargo build --release\n./target/release/server --version\n```\n## usage\nrun with `config.toml`:\n```bash\n./server -c config.toml\n```\n```toml\npasswd = \"123456\"\nmethod = \"aes-256-gcm\"\nbind_addr = \"0.0.0.0\"\nbind_port = 6789\ntimeout = 2000         # ms, timeout for tcp proxy handshake and tcp connect\nlog_level = \"info\"     # error warn info debug trace\nconsole_log = true\n# file_log_dir = \"applog/\" # if no set, don't log to file\nudp_capacity = 1000  # udp relay worker pool size, one proxy req one worker\nudp_expiry_time = 30 # sec, expiration time for udp relay worker keep alive\n# [plugin]\n# name = \"v2ray-plugin\"\n# opts = \"server\"\n# args = []\n```\n\nor override config with: \n```bash\n./server -c config.toml -l 127.0.0.1 -p 1080 -k \u003ca-secure-password\u003e\n```\nif without `-c`, default config file is `$pwd/config.toml`\n\nmore usage:\n```bash\n./server -h\n```\n\n## quick start with docker\n\u003e tips: use `\u003cctrl-p\u003e\u003cctrl-q\u003e` exit container but keep it running\n\u003e\n\u003e v2ray-plugin are recommended\n\nstart with default config but specify password:\n```bash\ndocker run --rm -it -p 8888:6789/tcp -p 8888:6789/udp kirito41dd/ss-light -k passwd123\n```\nor start with custom config file:\n1. create new config dir in home then add `config.toml` file:\n    ```\n    mkdir $HOME/.ss-light \u0026\u0026 cd $HOME/.ss-light\n    touch config.toml\n    ```\n2. edit `config.toml` like [here](#usage)\n3. run docker:\n    ```bash\n    docker run --rm -it -v $HOME/.ss-light:/app -p 8888:6789/tcp -p 8888:6789/udp kirito41dd/ss-light\n    ```\nuse v2ray-plugin: (websocket)\n```\ndocker run --rm -it -p 8888:6789/tcp -p 8888:6789/udp kirito41dd/ss-light -k passwd123 --plugin v2ray-plugin --plugin-opts server\n```\nuse other [SIP003](https://shadowsocks.org/en/wiki/Plugin.html) plugins:\n1. like start with custom config file, download plugin to `$HOME/.ss-light`\n2. start\n    ```\n    docker run --rm -it -v $HOME/.ss-light:/app -p 8888:6789/tcp -p 8888:6789/udp kirito41dd/ss-light --plugin=/app/\u003cyour-plugin\u003e\n    ```\n\n## best practice\n\nss-light + v2ray-plugin + cloudflare DNS\n\n1. `apt -y install python3-certbot-nginx nginx`\n2. `vim /etc/nginx/conf.d/ss.conf`\n    ```\n    server {\n        listen      80;\n        server_name xxx.com;\n\n        location /dog {\n            proxy_pass              http://127.0.0.1:8888;\n            proxy_redirect          off;\n            proxy_http_version      1.1;\n            proxy_set_header        Upgrade $http_upgrade;\n            proxy_set_header        Connection \"upgrade\";\n            proxy_set_header        Host $http_host;\n        }\n    }\n    ```\n3. `certbot --nginx --agree-tos --no-eff-email --email xxx@gmail.com`\n4. `systemctl restart nginx`\n5. `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\"`\n6. setting your cloudflare SSL/TLS option `Full` or `Full (strict)`\n7. use client: `xxx.com 443 passwd123 aes-256-gcm v2ray-plugin websocket xxx.com tsl /dog`\n\n\n\n\n## feature\n* Shadowsocks AEAD\n    * AES_256_GCM\n* TCP relay\n* UDP relay\n* Plugin\n    * v2ray-plugin\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkirito41dd%2Fss-light","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkirito41dd%2Fss-light","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkirito41dd%2Fss-light/lists"}