Skip to content

Commit 8b1a50b

Browse files
author
joey
committed
Added instructions for port configuration
I added instructions for customizing the WireGuard port and fixed a small typo.
1 parent 293bd17 commit 8b1a50b

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

docs/Containers/WireGuard.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,31 @@ services:
2323
- PGID=1000
2424
- TZ=America/Los_Angeles
2525
- SERVERURL=<Your-DuckDNS-account>.duckdns.org #optional
26+
- SERVERPORT=51820 #optional
2627
- PEERS=3 #optional
2728
- PEERDNS=auto #optional
2829
- INTERNAL_SUBNET=100.64.0.0/24 #optional
2930
```
3031

31-
The values you will probably want to change are `TZ` to your own timezone, `SERVERURL` to your own DuckDNS address and `PEERS` to set the number of devices you plan to connect to your VPN. If you customize other containers, just make sure the file only says `services:` once at the beginning of the file. Once you are done, you can run `./menu.sh` to build your stack. Finally, check that your changes were successfully integrated by running:
32+
The values you will probably want to change are `TZ` to your own timezone, `SERVERURL` to your own DuckDNS address and `PEERS` to set the number of devices you plan to connect to your VPN. If you also decide to edit the `SERVERPORT` value, you will also need to include a matching value in the `ports:` section as follows:
33+
34+
```
35+
services:
36+
wireguard:
37+
environment:
38+
- PUID=1000
39+
- PGID=1000
40+
- TZ=America/Los_Angeles
41+
- SERVERURL=<Your-DuckDNS-account>.duckdns.org #optional
42+
- SERVERPORT=55555 #optional
43+
- PEERS=3 #optional
44+
- PEERDNS=auto #optional
45+
- INTERNAL_SUBNET=100.64.0.0/24 #optional
46+
ports:
47+
- 55555:55555/udp
48+
```
49+
50+
If you customize other containers, just make sure the file only says `services:` once at the beginning of the file. Once you are done, you can run `./menu.sh` to build your stack. Finally, check that your changes were successfully integrated by running:
3251

3352
`$ cat docker-compose.yml`
3453

@@ -92,7 +111,7 @@ To copy the files from a Raspberry Pi onto another Linux machine for example, yo
92111
```
93112
$ sudo scp pi@<Rpi-ip-address>:/home/pi/IOTstack/services/wireguard/config/peer1/peer1.png ~/peer1.png
94113
```
95-
(Hint: you can use the `scp -i` flag to specify and IdentityFile or better yet, `scp -F` flag if you have your device configured in `.ssh/config`)
114+
(Hint: you can use the `scp -i` flag to specify an IdentityFile or better yet, `scp -F` flag if you have your device configured in `.ssh/config`)
96115

97116
You can repeat this step for each peer's QR code `.png` file and then scan the QR codes in the mobile app on your devices. The devices should now be configured and able to connect to your VPN.
98117

0 commit comments

Comments
 (0)