This project offers an automation tool to let you securely build your high speed Shadowsocks and/or Wireguard VPN servers in one minute ⚡ using Github.com Action. With a 💰 5 USD/month server from common cloud providers like Linode, Digital Ocean, and so on, you can stream 4K videos (Speed >= 25 Mpbs) in real time. Once you generate your VPN server(s) configurations, you can simply scan the QR-code on mobile and start using the service immediately.

Shortlink: http://git.io/buildVPN Read this in other languages: English, 简体中文

In summary, you need to fork this repository, set up your server credentials via Github Secrets, then manually run the workflows/actions to build your VPN servers, then scan the resulting QR codes to configure your client side apps.

1. Prerequisite: have SSH access to a server with root permission. If you don't have a server yet, buying a $5/month instance from Linode or Digital Ocean would be an easy start.
2. Sign in to GitHub
3. Fork this repository, by click the Fork button in the top-right corner of the page ☝️ .
4. In your forked/own repository, set up Github Encrypted Secrets for your server: HOST, USERNAME, either PASSWORD or KEY, and optionally PORT if your port number is not default.
5. On your repository navigation, click Actions, then click Build Shadowsocks Server or Build Wireguard Server, then click Run workflow (from main). Shadowsocks builds have vanilla Shadowsocks and Shadowsocks over kcptun (optimized for real time). Either Shadowocks over kcptun or Wireguard is very fast, you can build both for redundency. Please see more additional documentation for use case comparsion and configurations.
6. The build should take one minute, once it's finished, check the result, under Configure your client step, there are your configurations and QR-code
7. ‼️ If your repository is public, Delete workflow run immediately after you successfully configure your client side app. Because, even though your secrets are masked in the log output, the generated QR-Code can reveal your secrets. Failing to do so can result in other people using your VPN without your permission. , more doc

Please see Client side app configurations.

This project/tool is probably quite different from most apps you have used. You don't have to download anything or run the code in your computer. Once you forked this project as the instruction says, you can keep your copy updated by pull from upstream if you are familiar with Git. Or you can simply delete your forked repository then start over.

You can open bug report, feature request or support request on this main project issues. Also, please read Contributing to Open Source Guides