https://github.com/drew2a/wireguard
This repository contains scripts that make it easy to configure WireGuard on VPS.
https://github.com/drew2a/wireguard
Last synced: 10 months ago
JSON representation
This repository contains scripts that make it easy to configure WireGuard on VPS.
- Host: GitHub
- URL: https://github.com/drew2a/wireguard
- Owner: drew2a
- License: mit
- Created: 2019-10-27T15:00:11.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-09-26T10:37:47.000Z (over 3 years ago)
- Last Synced: 2024-12-10T08:34:47.768Z (over 1 year ago)
- Language: Shell
- Homepage:
- Size: 41 KB
- Stars: 139
- Watchers: 12
- Forks: 51
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.com/drew2a/wireguard)
[](https://codeclimate.com/github/drew2a/wireguard/maintainability)
# Wireguard
This repository contains scripts that make it easy to configure [WireGuard](https://www.wireguard.com)
on [VPS](https://en.wikipedia.org/wiki/Virtual_private_server).
Medium article: [How to deploy WireGuard node on a DigitalOcean's droplet](https://medium.com/@drew2a/replace-your-vpn-provider-by-setting-up-wireguard-on-digitalocean-6954c9279b17)
## Quick Start
### Ubuntu
```bash
wget https://raw.githubusercontent.com/drew2a/wireguard/master/wg-ubuntu-server-up.sh
chmod +x ./wg-ubuntu-server-up.sh
sudo ./wg-ubuntu-server-up.sh
```
### Debian
```bash
wget https://raw.githubusercontent.com/drew2a/wireguard/master/wg-debian-server-up.sh
chmod +x ./wg-debian-server-up.sh
sudo ./wg-debian-server-up.sh
```
To get a full instruction, please follow to the article above.
### Supported OS
* Ubuntu 18.04
* Ubuntu 20.04
* Ubuntu 22.04
* Debian 9
* Debian 10
## wg-ubuntu-server-up.sh
This script:
* Installs all necessary software on an empty Ubuntu DigitalOcean droplet
(it should also work with most modern Ubuntu images)
* Configures IPv4 forwarding and iptables rules
* Sets up [unbound](https://github.com/NLnetLabs/unbound) DNS resolver
* Creates a server and clients configurations
* Installs [qrencode](https://github.com/fukuchi/libqrencode/)
* Runs [WireGuard](https://www.wireguard.com)
### Usage
```bash
wg-ubuntu-server-up.sh [--clients=] [--no-reboot] [--no-unbound]
```
Options:
* `--clients=` how many client's configs will be created
* `--no-unbound` disables Unbound server installation (1.1.1.1 will be used as
a default DNS for client's configs)
* `--no-reboot` disables rebooting at the end of the script execution
### Example of usage
```bash
./wg-ubuntu-server-up.sh
```
```bash
./wg-ubuntu-server-up.sh --clients=10
```
## wg-debian-server-up.sh
This script works the same way and with the same options, that
`wg-ubuntu-server-up.sh` do.
## wg-genconf.sh
This script generate server and clients configs for WireGuard.
If the public IP is not defined, then the public IP of the machine from which
the script is run is used.
If the number of clients is not defined, then used 10 clients.
### Prerequisites
Install [WireGuard](https://www.wireguard.com) if it's not installed.
### Usage
```bash
./wg-genconf.sh [ [ []]]
```
Where:
* `number_of_clients` how many client's configs will be generated
* `dns_ip` the script should use this IP as a DNS address
* `server_public_ip` the script should use this IP as a server address
### Example of usage:
```bash
./wg-genconf.sh
```
```bash
./wg-genconf.sh 10
```
```bash
./wg-genconf.sh 10 1.1.1.1
```
```bash
./wg-genconf.sh 10 1.1.1.1 157.245.73.253
```