Skip to content

Commit 4ee407d

Browse files
committed
Add schematic explaining the example setup
1 parent 12d886c commit 4ee407d

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

README.org

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,15 @@ First, you have to write the JSON configuration which will be used to generate k
1515
configuration files. [[file:input.json.example]] is an example configuration. One thing to note is that
1616
the identifiers for all the peers must be unique.
1717

18+
This example configuration shows the following VPN setup:
19+
20+
[[file:img/Wireguard-Configuration-Generator-Schematic.png]]
21+
22+
There are 2 networks here. When the client has the green network turned on, all traffic will be
23+
routed through =server1=, whereas the blue network will route all traffic through =server2=. This
24+
means that the sites that you visit will see the IP address of =server1= rather than the public IP
25+
address of =client1=.
26+
1827
Second, you should generate the =wg-quick=-compatible configurations using:
1928

2029
#+begin_src sh
@@ -34,7 +43,7 @@ could use [[https://dyne.org/software/tomb/][tomb]] to have a single file which
3443
move that file around as you would any other file. You can also version control the configurations
3544
to ensure that you don't end up making some change to the configuration which you can't revert.
3645

37-
Third, you should write the =hosts= file which will be used by =wireguard-ansible=, if you plan to
46+
Third, you should write the =hosts= file which will be used by [[https://github.com/icyflame/wireguard-ansible][=ansible-wireguard=]][fn:2], if you plan to
3847
use that to set up any of the supported operating systems. You can use the [[file:hosts.example]] as a
3948
sample. The network names and server identifiers in this file should match those in the JSON
4049
configuration file.
@@ -53,6 +62,8 @@ configuration generator.
5362

5463
* Footnotes
5564

65+
[fn:2] This repository is not public on GitHub.
66+
5667
[fn:1] I run a CoreDNS-based DNS server with the [[https://github.com/icyflame/blocker][blocker]] plugin, which blocks most domains which
5768
serve only advertisements. By combining the adblocking DNS server and Wireguard, I can block ads
5869
even on mobile data on an iPhone, where addons like uBlock Origin can't be installed. Without
94.1 KB
Loading

0 commit comments

Comments
 (0)