From 9b3493a661d04f17ae69de9f03096f4199140e8c Mon Sep 17 00:00:00 2001 From: Nico Schottelius Date: Sat, 1 Aug 2020 16:24:21 +0200 Subject: [PATCH] [doc] integrate vpn into manual --- doc/README-vpn.org | 34 ----------------------------- doc/uncloud-manual-2020-08-01.org | 36 +++++++++++++++++++++++++++++++ 2 files changed, 36 insertions(+), 34 deletions(-) delete mode 100644 doc/README-vpn.org diff --git a/doc/README-vpn.org b/doc/README-vpn.org deleted file mode 100644 index 7d041cb..0000000 --- a/doc/README-vpn.org +++ /dev/null @@ -1,34 +0,0 @@ -* How to add a new VPN Host -** Install wireguard to the host -** Install uncloud to the host -** Add `python manage.py vpn --hostname fqdn-of-this-host` to the crontab -** Use the CLI to configure one or more VPN Networks for this host -* Example of adding a VPN host at ungleich -** Create a new dual stack alpine VM -** Add it to DNS as vpn-XXX.ungleich.ch -** Route a /40 network to its IPv6 address -** Install wireguard on it -** TODO Enable wireguard on boot -** TODO Create a new VPNPool on uncloud with -*** the network address (selecting from our existing pool) -*** the network size (/...) -*** the vpn host that provides the network (selecting the created VM) -*** the wireguard private key of the vpn host (using wg genkey) -*** http command -``` -http -a nicoschottelius:$(pass - ungleich.ch/nico.schottelius@ungleich.ch) - http://localhost:8000/admin/vpnpool/ network=2a0a:e5c1:200:: \ - network_size=40 subnetwork_size=48 - vpn_hostname=vpn-2a0ae5c1200.ungleich.ch - wireguard_private_key=... -``` -* Example http commands / REST calls -** creating a new vpn pool - http -a nicoschottelius:$(pass - ungleich.ch/nico.schottelius@ungleich.ch) - http://localhost:8000/admin/vpnpool/ network_size=40 - subnetwork_size=48 network=2a0a:e5c1:200:: - vpn_hostname=vpn-2a0ae5c1200.ungleich.ch wireguard_private_key=$(wg - genkey) -** Creating a new vpn network diff --git a/doc/uncloud-manual-2020-08-01.org b/doc/uncloud-manual-2020-08-01.org index 7024e2f..52d4427 100644 --- a/doc/uncloud-manual-2020-08-01.org +++ b/doc/uncloud-manual-2020-08-01.org @@ -33,3 +33,39 @@ Order register the one time price and the recurring price. These fields should be treated as immutable. If they need to be modified, a new order that replaces the current order should be created. +* Products +** VPN +*** How to add a new VPN Host +**** Install wireguard to the host +**** Install uncloud to the host +**** Add `python manage.py vpn --hostname fqdn-of-this-host` to the crontab +**** Use the CLI to configure one or more VPN Networks for this host +*** Example of adding a VPN host at ungleich +**** Create a new dual stack alpine VM +**** Add it to DNS as vpn-XXX.ungleich.ch +**** Route a /40 network to its IPv6 address +**** Install wireguard on it +**** TODO Enable wireguard on boot +**** TODO Create a new VPNPool on uncloud with +***** the network address (selecting from our existing pool) +***** the network size (/...) +***** the vpn host that provides the network (selecting the created VM) +***** the wireguard private key of the vpn host (using wg genkey) +***** http command + ``` + http -a nicoschottelius:$(pass + ungleich.ch/nico.schottelius@ungleich.ch) + http://localhost:8000/admin/vpnpool/ network=2a0a:e5c1:200:: \ + network_size=40 subnetwork_size=48 + vpn_hostname=vpn-2a0ae5c1200.ungleich.ch + wireguard_private_key=... + ``` +*** Example http commands / REST calls +**** creating a new vpn pool + http -a nicoschottelius:$(pass + ungleich.ch/nico.schottelius@ungleich.ch) + http://localhost:8000/admin/vpnpool/ network_size=40 + subnetwork_size=48 network=2a0a:e5c1:200:: + vpn_hostname=vpn-2a0ae5c1200.ungleich.ch wireguard_private_key=$(wg + genkey) +**** Creating a new vpn network