mirror of https://github.com/angristan/wireguard-install.git synced 2024-10-31 18:52:31 +00:00

Go to file

landaal-ict 085017a0f1 Merge `b98dba022f` into `39caf2fcf6`		2023-04-21 15:07:59 +02:00
.github	Update issue template	2023-01-21 23:19:13 +01:00
LICENSE	Update LICENSE	2022-05-20 18:37:49 +02:00
README.md	Add openSUSE to Readme	2023-04-21 15:05:41 +02:00
wireguard-install.sh	Add openSUSE Support	2023-04-21 15:04:11 +02:00

README.md

WireGuard installer

This project is a bash script that aims to setup a WireGuard VPN on a Linux server, as easily as possible!

WireGuard is a point-to-point VPN that can be used in different ways. Here, we mean a VPN as in: the client will forward all its traffic through an encrypted tunnel to the server. The server will apply NAT to the client's traffic so it will appear as if the client is browsing the web with the server's IP.

The script supports both IPv4 and IPv6. Please check the issues for ongoing development, bugs and planned features! You might also want to check the discussions for help.

WireGuard does not fit your environment? Check out openvpn-install.

Requirements

Supported distributions:

AlmaLinux >= 8
Arch Linux
CentOS Stream >= 8
Debian >= 10
Fedora >= 32
Oracle Linux
Rocky Linux >= 8
Ubuntu >= 18.04
openSUSE

Usage

Download and execute the script. Answer the questions asked by the script and it will take care of the rest.

curl -O https://raw.githubusercontent.com/angristan/wireguard-install/master/wireguard-install.sh
chmod +x wireguard-install.sh
./wireguard-install.sh

It will install WireGuard (kernel module and tools) on the server, configure it, create a systemd service and a client configuration file.

Run the script again to add or remove clients!

Providers

I recommend these cheap cloud providers for your VPN server:

Vultr: Worldwide locations, IPv6 support, starting at $5/month
Hetzner: Germany, Finland and USA. IPv6, 20 TB of traffic, starting at 4.5€/month
Digital Ocean: Worldwide locations, IPv6 support, starting at $4/month

Contributing

Discuss changes

Please open an issue before submitting a PR if you want to discuss a change, especially if it's a big one.

Code formatting

We use shellcheck and shfmt to enforce bash styling guidelines and good practices. They are executed for each commit / PR with GitHub Actions, so you can check the configuration here.