{"id":18722936,"url":"https://github.com/arkbriar/ssmgr","last_synced_at":"2025-04-12T14:53:37.919Z","repository":{"id":87640484,"uuid":"78607962","full_name":"arkbriar/ssmgr","owner":"arkbriar","description":"Shadowsocks manager of multiple servers, with advanced features for management.","archived":false,"fork":false,"pushed_at":"2017-11-01T13:44:22.000Z","size":720,"stargazers_count":10,"open_issues_count":8,"forks_count":3,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-03-26T09:22:59.851Z","etag":null,"topics":["angularjs","golang","grpc","proxy","shadowsocks","shadowsocks-manager"],"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/arkbriar.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":"2017-01-11T06:03:53.000Z","updated_at":"2023-09-28T07:10:19.000Z","dependencies_parsed_at":"2023-05-05T11:01:04.275Z","dependency_job_id":null,"html_url":"https://github.com/arkbriar/ssmgr","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arkbriar%2Fssmgr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arkbriar%2Fssmgr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arkbriar%2Fssmgr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arkbriar%2Fssmgr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/arkbriar","download_url":"https://codeload.github.com/arkbriar/ssmgr/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248586238,"owners_count":21128995,"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":["angularjs","golang","grpc","proxy","shadowsocks","shadowsocks-manager"],"created_at":"2024-11-07T13:47:07.747Z","updated_at":"2025-04-12T14:53:37.912Z","avatar_url":"https://github.com/arkbriar.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SSMGR\n\nShadowsocks manager of multiple servers, providing simple and easy way for users to acquire shadowsocks services over regions of servers and advanced tools for operators to manage the servers.\n\n**NOTIFICATION** *After [commit ca33594](https://github.com/arkbriar/ssmgr/pull/23/commits/ca335940389f4a9ec937386a898880d52b529f70), slave's managed dir changes to $HOME/.ssmgr, refer to [#23](https://github.com/arkbriar/ssmgr/pull/23) if you want to do a migration.*\n\n## Compile\n\nFirst of all, install the dependent tools.\n\nFor mac users,\n\n```bash\nbrew install go node protobuf\n```\n\nFor ubuntu/debian users, install golang toolchain (\u003e=1.7) and\n\n```bash\nsudo add-apt-repository ppa:maarten-fonville/protobuf\ncurl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -\nsudo apt update\nsudo apt install nodejs protobuf-compiler\n```\n\nThen,\n\n```bash\n# Install protobuf go plugin\ngo get -u github.com/golang/protobuf/protoc-gen-go\n# And make sure that protoc-gen-go is in \n# your env $PATH so that protoc can find and use it, such as\n\n# export PATH=$PATH:$(go env GOPATH)/bin\n\nmake all\n```\n\n## Install\n\n**[NOTE]** `install` is only supported on linux with systemd.\n\n**[NOTE]** If you want to enable TLS, you should modify the env and config files and specify your certificates. For more details about generating self-signed certificates, please see [Generate Self-signed Certificates](#generate-self-signed-certificates).\n\nBefore install ssmgr, install shadowsocks-libev first.\n\n```\nsudo apt install shadowsocks-libev\n```\n\nTo install it completely (binaries and systemd services), \n\n```bash\n# Install to /usr/local/ssmgr/*, /etc/default/ssmgr.{master/slave}, \n# /lib/systemd/system/ssmgr-{master/slave}.service and /etc/ssmgr/*\nsudo make install\n```\n\nOr you can install master/slave seperately,\n\n```bash\n# Master\nsudo make install-master\n# Slave\nsudo make install-slave\n```\n\n## Docs\n\n### Enable TLS\n\nEnable TLS to secure the communication between master and slaves.\n\n**TLS on Slave**\n\nAdd \"tls\" field to config.json file.\n\n```json\n{\n  \"port\": 6001,\n  \"manager_port\": 6001,\n  \"token\": \"SSMGRTEST\",\n  \"tls\": {\n    \"cert_file\": \"testdata/certs/server.crt\",\n    \"key_file\": \"testdata/certs/server.key\"\n  }\n}\n```\n\n**TLS on Master**\n\nSpecify CA X.509 file when you start the master.\n\n```bash\nmaster -w frontend -c config.json -ca path/to/ca.pem\n```\n\n### Generate Self-signed Certificates\n\nGenerate CA key and PEM file if you do not have one:\n\n```\nopenssl genrsa -out ca.key 2048\nopenssl req -x509 -new -nodes -key ca.key -sha256 -days 3650 -out ca.pem\n```\n\nThen, using script `gssc` to generate these certificates.\n\n```bash\n./tools/gssc --ip SLAVE_IP --ca CA_DIR\n```\n\nThis will generate a 2048 bits key and a certificate whose expiry is 365 days in current directory.\n\nFor more details of `gssc`, please see\n\n```bash\n./tools/gssc -h\n```\n\n### Log to Slack\n\nWe implement a hook of logrus to send some levels of logs to slack channel. This helps developers to monitor servers and to develop ChatOps in the future.\n\nSlack logs is only supported on master. To enable it, add the \"slack\" field to config.json file, \n\n```json\n{\n  \"...\": \"...\",\n  \"slack\": {\n    \"channel\": \"#SLACK_CHANNEL\",\n    \"token\": \"TEST_SLACK_TOKEN\",\n    \"levels\": [\n      \"panic\",\n      \"fatal\",\n      \"error\",\n      \"warn\",\n      \"info\",\n      \"debug\"\n    ]\n  }\n}\n```\n\nwhere token is the application token and levels are the logrus levels to send.\n\n## Known Issues\n\n1. [Issues](https://github.com/arkbriar/ssmgr/issues?q=is%3Aopen+is%3Aissue+label%3Abug) here with `bug` tags.\n2. Can not debug on master because it imports a library with native C codes (go-sqlite3).\n\n## License\n\nLicensed under [GPL v3](LICENSE).\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farkbriar%2Fssmgr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farkbriar%2Fssmgr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farkbriar%2Fssmgr/lists"}