{"id":15056790,"url":"https://github.com/ycgambo/shadowrocket","last_synced_at":"2025-04-10T04:35:01.201Z","repository":{"id":49327798,"uuid":"122318317","full_name":"ycgambo/shadowrocket","owner":"ycgambo","description":"A socks5 proxy to build your own shadowsocks private network. PHP based \u0026 Composer supported.","archived":false,"fork":false,"pushed_at":"2018-05-21T02:13:05.000Z","size":118,"stargazers_count":33,"open_issues_count":0,"forks_count":9,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-02T19:51:32.107Z","etag":null,"topics":["composer-component","php","proxy","shadowsocks","socket-tunnel","socks-proxy","socks5"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ycgambo.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}},"created_at":"2018-02-21T09:50:38.000Z","updated_at":"2024-11-07T18:15:56.000Z","dependencies_parsed_at":"2022-09-23T17:40:30.686Z","dependency_job_id":null,"html_url":"https://github.com/ycgambo/shadowrocket","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ycgambo%2Fshadowrocket","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ycgambo%2Fshadowrocket/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ycgambo%2Fshadowrocket/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ycgambo%2Fshadowrocket/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ycgambo","download_url":"https://codeload.github.com/ycgambo/shadowrocket/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239140106,"owners_count":19588338,"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":["composer-component","php","proxy","shadowsocks","socket-tunnel","socks-proxy","socks5"],"created_at":"2024-09-24T21:56:30.526Z","updated_at":"2025-02-16T14:31:12.447Z","avatar_url":"https://github.com/ycgambo.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# shadowrocket\n\nA socks5 proxy to build your own shadowsocks private network. PHP based \u0026 Composer supported.\n\n[中文文档](/doc/README-chn.md)\n[Contributing](/doc/contributing.md)\n\n## Features\n1. TCP/UDP support\n2. IPV4/DOMAINNAME/IPV6 support\n3. Graceful restart\n4. Monolog Logger\n5. Guarder(Black List)\n6. Server Manager\n\n### Coming Next\n- bandwidth throttling\n- user management\n\n\n## Install\n\n    composer require ycgambo/shadowrocket\n\n### Requirements\n1. Composer\n2. PHP 5.3+\n\n## Usage\n\n### Run a server\n\n```php\n\u003c?php\nrequire_once __DIR__ . '/vendor/autoload.php';\n\n$config = array(\n    'server' =\u003e array(\n        'port'        =\u003e '8388',\n        'password'    =\u003e 'mypass',\n        'encryption'  =\u003e 'aes-256-cfb',\n        'process_num' =\u003e 12,\n    ),\n);\n\nShadowRocket\\Bin\\Launcher::launch($config);\n```\n\n### Run a local proxy\n\n```php\n\u003c?php\nrequire_once __DIR__ . '/vendor/autoload.php';\n\n$config = array(\n    'local' =\u003e array(\n        'server'      =\u003e '123.456.78.9',\n        'port'        =\u003e '8388',\n        'password'    =\u003e 'mypass',\n        'encryption'  =\u003e 'aes-256-cfb',\n        'local_port'  =\u003e '1086',\n        'process_num' =\u003e 12,\n    )\n);\n\nShadowRocket\\Bin\\Launcher::launch($config);\n```\n\nThis means we want to pass data to local proxy 127.0.0.1:1086 which \nwill request proxy server 123.456.78.9:8388 for reply.\n\n### Fire your script up\n\nAssuming your script is named as start.php, in which contains code to launch the Launcher.\n\nTo run as daemon:\n\n    php start.php start -d\n\nTo stop your script:\n\n    php start.php stop\n\nTo graceful restart：\n\n    php start.php reload\n\nTo check status:\n\n    php start.php status\n\nTo check connections:\n\n    php start.php connections\n\n### More docs\n- [Run multi server on different port](/doc/multi-server.md)\n- [Launcher](/doc/launcher.md)\n- [Modules](/doc/modules.md)\n\n## Want a client APP?\n\n- [For Android](https://github.com/shadowsocks/shadowsocks-android/releases)\n- [For IOS](https://itunes.apple.com/cn/app/superwingy/id1290093815?mt=8)\n- [For Mac](https://github.com/shadowsocks/ShadowsocksX-NG/releases) \n- [For Windows](https://github.com/shadowsocks/shadowsocks-windows/releases)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fycgambo%2Fshadowrocket","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fycgambo%2Fshadowrocket","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fycgambo%2Fshadowrocket/lists"}