Skip to content

Commit af5eb7d

Browse files
pjrobertsonalimakkinopdotcom
authored
Wireguard apps (StreisandEffect#1754)
* Add Windows install instructions for WireGuard * Update macOS install instructions to use official app from App Store Co-authored-by: Ali Makki <[email protected]> Co-authored-by: Jay Carlson <[email protected]>
1 parent 64dfbf4 commit af5eb7d

File tree

1 file changed

+17
-19
lines changed

1 file changed

+17
-19
lines changed

playbooks/roles/wireguard/templates/instructions.md.j2

+17-19
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,26 @@ An [experimental configuration for OpenWrt/LEDE](#openwrt) 17.01.4 (or later) is
1111

1212
---
1313
* Platforms
14+
* [Windows](#windows)
1415
* [Android](#android)
1516
* [iOS](#ios)
1617
* [Linux](#linux)
1718
* [macOS](#macos)
1819
* [OpenWrt](#openwrt)
1920

21+
<a name="windows"></a>
22+
### Windows ###
23+
1. [Install WireGuard for Windows](https://www.wireguard.com/install/)
24+
1. Download one of the client configuration files. **Only one computer can use a profile at a time**. For this example we'll assume you downloaded {{ vpn_client_names.results[0].stdout }}:
25+
{% for client in vpn_client_names.results %}
26+
* [{{ client.stdout }}](/wireguard/{{ client.stdout }}.conf)
27+
{% endfor %}
28+
1. Launch the app, and choose *Add Tunnel → Import tunnel(s) from file…*, select the downloaded file, then click *Open*.
29+
1. Select the imported tunnel and click *Activate* to connect.
30+
1. You should be good to go! You can verify that your traffic is being routed properly by [looking up your IP address on DuckDuckGo]({{ streisand_my_ip_url }}). It should say *Your public IP address is {{ streisand_ipv4_address }}*.
31+
32+
---
33+
2034
<a name="android"></a>
2135
### Android ###
2236
1. [Install WireGuard](https://play.google.com/store/apps/details?id=com.wireguard.android).
@@ -85,30 +99,14 @@ Each client configuration profile includes a `DNS` command that uses resolvconf
8599
**WARNING**: The macOS WireGuard client is in early stages of development and still considered experimental. It may be unstable or buggy.
86100

87101

88-
1. Install [Homebrew](https://brew.sh/), if you haven't already.
89-
1. Install the WireGuard tools using Homebrew:
90-
91-
`brew install wireguard-tools`
102+
1. [Install the macOS WireGuard App](https://itunes.apple.com/us/app/wireguard/id1451685025) from the Mac App Store
92103
1. Download one of the client configuration files. **Only one computer can use a profile at a time**. For this example we'll assume you downloaded {{ vpn_client_names.results[0].stdout }}:
93104
{% for client in vpn_client_names.results %}
94105
* [{{ client.stdout }}](/wireguard/{{ client.stdout }}.conf)
95106
{% endfor %}
96-
1. Move the client configuration file into the WireGuard configuration directory. The following command assumes you downloaded the configuration file into your `Downloads` folder. (If that's not the case, modify it accordingly):
97-
98-
`sudo sh -c 'umask 077 && mkdir -p /etc/wireguard/ && cat ~/Downloads/{{ vpn_client_names.results[0].stdout }}.conf > /etc/wireguard/{{ vpn_client_names.results[0].stdout }}.conf'`
99-
100-
1. Use the `wg-quick` utility to bring up the WireGuard interface:
101-
102-
`sudo wg-quick up {{ vpn_client_names.results[0].stdout }}`
103-
104-
107+
1. Launch the WireGuard app, click *Import tunnel(s) from file* and choose the file downloaded in the previous step. If this is your first time using WireGuard on your macOS device, you will be prompted allow 'WireGuard' to add VPN Configurations.
108+
1. Click *Activate* to enable the VPN.
105109
1. You should be good to go! You can verify that your traffic is being routed properly by [looking up your IP address on DuckDuckGo]({{ streisand_my_ip_url }}). It should say *Your public IP address is {{ streisand_ipv4_address }}*.
106-
1. You can check the vpn status at any time using `wg`:
107-
`sudo wg show`
108-
109-
1. To stop routing your traffic through WireGuard, simply bring the interface back down:
110-
111-
`sudo wg-quick down {{ vpn_client_names.results[0].stdout }}`
112110

113111
---
114112

0 commit comments

Comments
 (0)