wireguard-install/README.md

66 lines
2.5 KiB
Markdown
Raw Normal View History

2022-05-22 05:10:28 +02:00
[English](README.md) | [中文](README-zh.md)
2022-05-26 05:56:33 +02:00
# WireGuard VPN Server Auto Setup Script
2022-05-20 15:36:48 +02:00
2022-05-22 03:17:02 +02:00
WireGuard VPN server installer for Ubuntu, Debian, AlmaLinux, Rocky Linux, CentOS and Fedora.
2020-04-30 20:26:38 +02:00
2022-05-28 22:19:10 +02:00
This script will let you set up your own VPN server in just a few minutes, even if you haven't used WireGuard before. [WireGuard](https://www.wireguard.com) is a fast and modern VPN designed with the goals of ease of use and high performance.
2020-04-30 20:26:38 +02:00
2022-05-26 05:56:33 +02:00
[**» See also: OpenVPN Server Auto Setup Script**](https://github.com/hwdsl2/openvpn-install)
## Installation
2020-04-30 20:26:38 +02:00
2022-05-20 15:36:48 +02:00
Run the script on your Linux server\* and follow the prompts:
```bash
2022-05-21 02:00:23 +02:00
wget https://get.vpnsetup.net/wg -O wireguard.sh
2022-05-20 15:36:48 +02:00
sudo bash wireguard.sh
```
2022-05-28 22:19:10 +02:00
<details>
<summary>
2022-06-03 15:29:35 +02:00
Alternative commands.
2022-05-28 22:19:10 +02:00
</summary>
2022-06-03 15:29:35 +02:00
You may also use `curl` to download:
2022-05-28 22:19:10 +02:00
```bash
curl -fL https://get.vpnsetup.net/wg -o wireguard.sh
sudo bash wireguard.sh
```
2022-06-03 15:29:35 +02:00
Alternative setup URL:
```bash
https://github.com/hwdsl2/wireguard-install/raw/master/wireguard-install.sh
```
2022-05-28 22:19:10 +02:00
If you are unable to download, open [wireguard-install.sh](wireguard-install.sh), then click the `Raw` button on the right. Press `Ctrl/Cmd+A` to select all, `Ctrl/Cmd+C` to copy, then paste into your favorite editor.
</details>
2022-06-02 16:09:51 +02:00
\* A cloud server, virtual private server (VPS) or dedicated server.
## Next steps
2022-05-22 03:17:02 +02:00
After setup, you can run the script again to manage users or uninstall WireGuard.
2022-05-20 15:36:48 +02:00
2022-06-20 18:16:53 +02:00
[WireGuard VPN clients](https://www.wireguard.com/install/) are available for Windows, macOS, iOS and Android. To add a VPN connection, open the WireGuard App on your mobile device, tap the "Add" button, then scan the generated QR code in the script output. For Windows and macOS, first securely transfer the generated `.conf` file to your computer, then open WireGuard and import the file.
2022-05-22 05:46:20 +02:00
2022-06-02 16:09:51 +02:00
Enjoy your very own VPN! :sparkles::tada::rocket::sparkles:
2020-04-30 20:26:38 +02:00
2022-07-14 05:07:44 +02:00
<details>
<summary>
Like this project? You can show your support or appreciation.
</summary>
<a href="https://ko-fi.com/hwdsl2" target="_blank"><img height="36" width="187" src="docs/images/kofi2.png" border="0" alt="Buy Me a Coffee at ko-fi.com" /></a> &nbsp;<a href="https://coindrop.to/hwdsl2" target="_blank"><img src="docs/images/embed-button.png" height="36" width="145" border="0" alt="Coindrop.to me" /></a>
</details>
2022-05-26 05:56:33 +02:00
## Credits
2020-04-30 20:26:38 +02:00
2022-05-24 15:39:32 +02:00
This script is based on the great work of [Nyr and contributors](https://github.com/Nyr/wireguard-install), with enhancements and changes for compatibility with the [Setup IPsec VPN](https://github.com/hwdsl2/setup-ipsec-vpn) project.
2020-04-30 20:26:38 +02:00
2022-05-26 05:56:33 +02:00
## License
2020-04-30 20:26:38 +02:00
2022-05-20 15:36:48 +02:00
MIT