From edf63253df04a2e46a2c614406952847f1f67217 Mon Sep 17 00:00:00 2001 From: Mike Dacre Date: Tue, 13 Jun 2023 19:04:06 -0700 Subject: [PATCH] Update README with Firefox VPN tabs instructions (#73) * Update README with Firefox VPN tabs instructions * move instructions to another file --------- Co-authored-by: octeep --- README.md | 10 +++--- UseWithVPN.md | 89 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 93 insertions(+), 6 deletions(-) create mode 100644 UseWithVPN.md diff --git a/README.md b/README.md index c99a939..52467ec 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,9 @@ cd wireproxy make ``` +# Use with VPN +Instructions for using wireproxy with Firefox container tabs and auto-start on MacOS can be found [here](/UseWithVPN.md). + # Sample config file ``` # The [Interface] and [Peer] configurations follow the same semantics and meaning @@ -161,10 +164,5 @@ ListenPort = 5080 Target = service-three.servicenet:80 ``` -## Donation - - - -## Stargazers over time - +# Stargazers over time [![Stargazers over time](https://starchart.cc/octeep/wireproxy.svg)](https://starchart.cc/octeep/wireproxy) diff --git a/UseWithVPN.md b/UseWithVPN.md new file mode 100644 index 0000000..8ca6a7d --- /dev/null +++ b/UseWithVPN.md @@ -0,0 +1,89 @@ +# Getting a Wireguard Server +You can create your own wireguard server using a host service like DigitalOcean, +or you can get a VPN service that provides WireGuard configs. + +I recommend ProtonVPN, because it is highly secure and has a great WireGuard +config generator. + +Simply go to https://account.protonvpn.com/downloads and scroll down to the +wireguard section to generate your configs, then paste into the apporpriate +section below. + +# Simple Setup for multiple SOCKS configs for firefox + +Create a folder for your configs and startup scripts. Can be the same place as +this code. That path you will use below. For reference this text uses +`/Users/jonny/vpntabs` + +For each VPN you want to run, you will download your wireguard config and name +it appropriately (e.g. `ProtonUS.adblock.server.conf`) and then create two new +files from those below with similar names (e.g. `ProtonUS.adblock.conf` and +`ProtonUS.adblock.sh`) + +You will also create a launch script, the reference below is only for macOS. The +naming should also be similar (e.g. +`/Users/jonny/Library/LaunchAgents/com.ProtonUS.adblock.plist`) + +## Config File +Make sure you use a unique port for every separate server +I recommend you set proxy authentication, you can use the same user/pass for all +``` +# Link to the Downloaded config +WGConfig = /Users/jonny/vpntabs/ProtonUS.adblock.server.conf + +# Used for firefox containers +[Socks5] +BindAddress = 127.0.0.1:25344 # Update the port here for each new server + +# Socks5 authentication parameters, specifying username and password enables +# proxy authentication. +#Username = ... +# Avoid using spaces in the password field +#Password = ... +``` + +## Startup Script File +This is a bash script to facilitate startup, not strictly essential, but adds +ease. +Note, you MUST update the first path to wherever you installed this code to. +Make sure you use the path for the config file above, not the one you downloaded +from e.g. protonvpn. +``` +#!/bin/bash +/Users/jonny/wireproxy/wireproxy -c /Users/jonny/vpntabs/ProtonUS.adblock.conf +``` + +## MacOS LaunchAgent +To make it run every time you start your computer, you can create a launch agent +in `$HOME/Library/LaunchAgents`. Name reference above. + +That file should contain the following, the label should be the same as the file +name and the paths should be set correctly: + +``` + + + + + Label + com.ProtonUS.adblock + Program + /Users/jonny/vpntabs/ProtonUS.adblock.sh + RunAtLoad + + KeepAlive + + + +``` + +To enable it, run +`launchctl load ~/Library/LaunchAgents/com.ProtonUS.adblock.plist` and +`launchtl start ~/Library/LaunchAgents/com.PortonUS.adblock.plist` + +# Firefox Setup +You will need to enable the Multi Account Container Tabs extension and a proxy extension, I +recommend Sideberry, but Container Proxy also works. + +Create a container to be dedicated to this VPN, and then add the IP, port, +username, and password from above.