{"id":17184600,"url":"https://github.com/josexy/mini-ss","last_synced_at":"2025-04-13T18:06:22.952Z","repository":{"id":65389428,"uuid":"586827744","full_name":"josexy/mini-ss","owner":"josexy","description":"Mini ss server and client(support mitm/tun)","archived":false,"fork":false,"pushed_at":"2024-07-16T12:34:59.000Z","size":6663,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-22T00:31:46.571Z","etag":null,"topics":["golang","mitm","shadowsocks","tun"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/josexy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-09T10:25:26.000Z","updated_at":"2024-11-01T22:29:32.000Z","dependencies_parsed_at":"2024-05-08T13:28:23.970Z","dependency_job_id":"33108175-9e26-4cde-9b85-6ea406106f01","html_url":"https://github.com/josexy/mini-ss","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/josexy%2Fmini-ss","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/josexy%2Fmini-ss/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/josexy%2Fmini-ss/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/josexy%2Fmini-ss/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/josexy","download_url":"https://codeload.github.com/josexy/mini-ss/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240384372,"owners_count":19792970,"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":["golang","mitm","shadowsocks","tun"],"created_at":"2024-10-15T00:43:44.593Z","updated_at":"2025-02-23T21:31:40.746Z","avatar_url":"https://github.com/josexy.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# mini-ss\n\nMini shadowsocks server and client in Golang\n\n[![Go Report Card](https://goreportcard.com/badge/github.com/josexy/mini-ss)](https://goreportcard.com/report/github.com/josexy/mini-ss)\n[![License](https://img.shields.io/github/license/josexy/mini-ss)](https://github.com/josexy/mini-ss/blob/main/LICENSE)\n[![Publish Go Releases](https://github.com/josexy/mini-ss/actions/workflows/go-release.yml/badge.svg)](https://github.com/josexy/mini-ss/actions/workflows/go-release.yml)\n\n## Usage\n\n### Clone\n\n```shell\ngit clone https://github.com/josexy/mini-ss\n# build\ncd mini-ss \u0026\u0026 make build\n# copy Country.mmdb\ncp Country.mmdb bin/ \u0026\u0026 cd bin\n# help\n./mini-ss -h\n./mini-ss client -h\n./mini-ss server -h\n```\n\n### Client\n\n```shell\n# help\n./mini-ss client -h\n\n# simple\n./mini-ss client -s 127.0.0.1:8388 -l :10086 -x :10087 -m aes-128-cfb -p 123456 -CV3\n\n# udp relay if support\n./mini-ss client -s 127.0.0.1:8388 -M 127.0.0.1:10088 -m aes-128-cfb -p 123456 -CV3 --udp-relay \n\n# enable tun mode\nsudo ./mini-ss client -s 127.0.0.1:8388 -M :10088 -m aes-128-cfb -p 123456 -CV3 --tun-enable --auto-detect-iface\n\n# ssr client\n./mini-ss client -s server:port -M 127.0.0.1:10088 -m aes-256-cfb -p 123456 -t default -o tls1.2_ticket_auth -O auth_chain_a -T ssr -CV3 --system-proxy\n\n# load from config file\n./mini-ss client -c ../example-configs/simple-client-config.yaml\n```\n\n### Server\n\n```shell\n# help\n./mini-ss server -h\n\n# simple\n./mini-ss server -s :8388 -m aes-128-cfb -p 123456 -CV3 --udp-relay --auto-detect-iface\n\n# load from config file\n./mini-ss server -c ../example-configs/simple-server-config.yaml\n```\n\nYou can find the test configuration from `example-configs`\n\n## Rules\n\n- GLOBAL\n- DIRECT\n- MATCH\n  - DOMAIN\n  - DOMAIN-KEYWORD\n  - DOMAIN-SUFFIX\n  - GEOIP\n  - IP-CIDR\n  - OTHERS\n\n## Docker usage\n\nHere is an example of how to use the Dockerfile to build the image and run the container for server and client.\n\n```shell\ndocker build -t josexy/mini-ss:v1 -f docker/Dockerfile .\n\ndocker stop mini-ss-server ; docker rm mini-ss-server\ndocker stop mini-ss-client ; docker rm mini-ss-client\n\ndocker network create mini-ss-network\n# run as server\ndocker run -itd --name mini-ss-server --network mini-ss-network -p 8388:8388 -v ./example-configs:/etc/configs josexy/mini-ss:v1 server -c /etc/configs/simple-server-config.yaml\n# run as client, need to modify server address of config file to link to server\ndocker run -itd --name mini-ss-client --link mini-ss-server:mini-ss-server --network mini-ss-network -p 10088:10088 -v ./example-configs:/etc/configs josexy/mini-ss:v1 client -c /etc/configs/simple-client-config.yaml\n\n# see the logs\ndocker logs mini-ss-client -f\ndocker logs mini-ss-server -f\n```\n\n## References\n\n- https://github.com/shadowsocks/go-shadowsocks2\n- https://github.com/Dreamacro/clash\n- https://github.com/ginuerzh/gost\n- https://github.com/xjasonlyu/tun2socks\n- https://github.com/josexy/netstackgo\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjosexy%2Fmini-ss","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjosexy%2Fmini-ss","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjosexy%2Fmini-ss/lists"}