pi-hosted/docs/wireguard-install.md

Install and setup instructions for the WireGuard VPN Server

Introduction

An easy to use VPN server powered by WireGuard.

Screenshot

Installation

Pre-Installation Steps

First find Wiregaurd in the listing of templates from the project.

Then you will want to "Copy as Custom" because we will need to change some of the default values to tailor it for your use.

This Step is now complete go to the next step.

Customize the App Template.

We will need to edit the template to change a few values.

First Ensure the top 3 items (highlighted yellow) are filled out with your own values.

Second you will need to change the two values in the environment section that are circled.

Third you may want to change the 2 items with lines next to them. On my network I deploy a Pi-Hole for DNS level ad blocking and I also have multiple networks which all have various devices on them. So for my setup I used the following values, but make sure you use what will work for your setup:
- WG_DEFAULT_DNS=192.168.1.1 #This is the address of my router for DNS forwarding on my network, you can use outside DNS servers for this ie. 8.8.8.8, 8.8.4.4
- WG_ALLOWED_IPS=0.0.0.0/0, ::/0 #This will allow all addresses from any network, you may want to lock this down for your own setup.

Finally make sure you save these values by clicking on the "Update the Template" button on the bottom

Deploy the Stack

Find the new entry (WireGuard) in your Custom Templates and click on it, then click on the "Deploy the stack" button on the bottom.

Setup a User

On your main browser navigate to your pi's ip address with port attached (http://192.168.1.10:51821/)

You should be greeted with a login dialog on a white screen, just enter the password you defined when editing the stack and click login.

Now we need to create a user so that you can begin using the tunnel, click the "New Client" button.

Give the user a name and click "create", now you should see the user show up on the panel. There are a few options to use this account one being by QR code.

If you download the app to your Android/iPhone open the app and click the + button to add a tunnel. It will ask you if you want to scan a QR code, use that.

On the panel click the generate QR code button and scan this with your phone to add the tunnel.

The profile should now show up within the app, however it will not quite work yet.

Port forwarding

Every port forwarding in a ruoter is done differently so I can't tell you how to do that. However attached is a screenshot of what my port forward rule looks like in my routers forwarding panel to give you an idea of how it works.

Connection Test

Finally with forwarding working and the WireGaurd container running you should be ready for a test. Ensure you are not connected to your wifi network and that you have an active cell data connection on your phone.

Click the slider next to the tunnel we setup previously and it should activate (for android phones a little key icon shows up on your notification bar).

Open your browser and go to a standard website to ensure DNS is functional.
https://github.com/novaspirit/pi-hosted

Next open a new tab or in the same tab navigate to an IP based service that you have NOT made available outside your network, for me that would be Homer.
http://192.168.1.10:8902/

If you saw both pages then that means your VPN is functioning properly. Feel free to watch your streaming services or administer your network from anywhere in the world!