From 49630c617e3e8cc2f2df3c9e089ac85513d49ba9 Mon Sep 17 00:00:00 2001 From: "Alex A. Naanou" Date: Fri, 1 Nov 2024 15:19:56 +0300 Subject: [PATCH] docs... Signed-off-by: Alex A. Naanou --- Makefile | 2 + README.md | 109 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 109 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index 9b8992c..d517b9c 100644 --- a/Makefile +++ b/Makefile @@ -139,11 +139,13 @@ clean: */traefik \ */config.last-run + .PHONY: clean-interfaces clean-interfaces: /etc/network/interfaces.orig # NOTE: this may need 'ifreload -a' to take effect... cp "$<" "$(subst .orig,,$<)" + .PHONY: clean-all clean-all: clean -rm -rf \ diff --git a/README.md b/README.md index 832f3a0..4f7c5a4 100644 --- a/README.md +++ b/README.md @@ -182,8 +182,11 @@ At this point WAN interface exposes two IPs: - ssh:22 The Proxmox administrative interface is available behind the -[Wireguard](https://www.wireguard.com/) proxy or on the ADMIN port, both -on https://10.0.0.254:8006. +[Wireguard](https://www.wireguard.com/) proxy on the WAN port or directly +on the ADMIN port, both on https://10.0.0.254:8006. + +At this point, it is recommended to check both the fail-safe `ssh` +connection now and the Wireguard access. Additional administrative tasks can be performed now if needed. @@ -239,6 +242,108 @@ _WARNING: NEVER store any ssh keys on the `ssh` CT, use `ssh-agent` instead!_ +#### Recovery + +- Configuration or bridge failure while bootstrapping + + Remove all the CT's that were created by make: + ```shell + pct destroy ID + ``` + + Cleanup the interfaces: + ```shell + make clean-interfaces + ``` + + Revise configuration if `./config.global` + + Cleanup CT cached configuration: + ```shell + make clean + ``` + + Rebuild the bridges: + ```shell + make host-bootstrap + ``` + And select (type "y") "Create bridges" while rejecting all other sections. + + Or, do a full rebuild selecting/rejecting the appropriate sections: + ```shell + make bootstrap + ``` + + +- Failure while creating the `gate` CT + + Check if the bridges are correct, and check if the host as internet access. + + Remove the `gate` CT (replacing 110 if you created it with a different ID): + ```shell + pct destroy 110 + ``` + + Build the bootstrapped gate: + ```shell + make gate-bootstrap + ``` + + Check if gate is accesable and if it has internet access. + + Then create the base CT's: + ```shell + make ns ssh wireguard + ``` + + finally cleanup: + ```shell + make bootstrap-clean + ``` + + now the setup can be finalized (see: [Setup](#setup)) + + + +- Failure while creating other CT's + + Check if gate is accesable and if it has internet access, if it is not + then this will fail, check or rebuild the gate. + + Simply remove the CT + ```shell + pct destroy ID + ``` + + Then rebuild it: + ```shell + make CT_NAME + ``` + + + +- Full clean rebuild + + Remove any of the base CT's: + ```shell + pct destroy ID + ``` + + Restore bridge configuration: + ```shell + make clean-interfaces + ``` + + Cleanup the configuration data: + ```shell + make clean-all + ``` + + Follow the instructions in [Setup](#setup) + + + + #### Configuration XXX