mirror of https://github.com/unifi-utilities/unifios-utilities.git synced 2024-08-30 18:32:21 +00:00

History

bruvv 162d4ce478 Auto set correct data path (#491 ) * Corrected file path by removing /mnt * Update 20-zerotier.sh * Update README.md * removed /mnt directory as evertyhing is done in /data * Corrected URL * Update remote_install.sh * Auto check data dir * fixed adguard installation * More data fixes * Fix dns common data path * fixed haproxy readme		2023-02-22 08:49:54 -08:00
..
configs	Clarifying wireguard based on feedback	2020-07-12 22:54:09 -07:00
on_boot.d	Auto set correct data path (#491 )	2023-02-22 08:49:54 -08:00
README.md	Auto set correct data path (#491 )	2023-02-22 08:49:54 -08:00

README.md

Wireguard VPN server / client

Features

Wireguard VPN to anywhere! Uses wireguard-go, not the kernel module
Persists through reboots and firmware updates
Tested with a Wireguard Server in AWS

Requirements

You have successfully setup the on boot script described here
Not recommended for Wireguard newbies. Set it up on other devices first. This document does not include iptables / nat rules

Customization

Update wg0.conf to match your environment
You can use a custom interface name by changing wg0.conf to whatever you like
Use PostUp and PostDown in your wg.conf to execute any commands after the interface is created or destroyed

Steps

Make a directory for your keys and configuration:
```
mkdir -p /data/wireguard
```

Create your public and private keys:

podman run -i --rm --net=host --name wireguard_conf masipcat/wireguard-go wg genkey > /data/wireguard/privatekey
podman run -i --rm --net=host --name wireguard_conf masipcat/wireguard-go wg pubkey < /data/wireguard/privatekey > /data/wireguard/publickey

Create a Wireguard configuration in /data/wireguard
Copy 20-wireguard.sh to /data/on_boot.d and update its values to reflect your environment
Execute /data/on_boot.d/20-wireguard.sh
If you are running a server, make the appropriate firewall rules / port forwards

Execute the wg command in the container to verify the tunnel is up. It should look something like this:

$ podman exec -it wireguard wg
interface: wg0
    public key: <your public key here>
    private key: (hidden)
    listening port: 54321

peer: <your peers public key>
    endpoint: 10.0.0.2:54321
    allowed ips: 10.1.0.0/16, 10.2.0.0/16
    latest handshake: 1 day, 14 hours, 46 minutes, 27 seconds ago
    transfer: 138.44 MiB received, 5.00 GiB sent

Useful commands

# See interface status, see your public key
podman exec -it wireguard wg
# Bring up wg0
podman exec -it wireguard wg-quick up wg0
# Bring down wg0
podman exec -it wireguard wg-quick down wg0