started work on docs...

Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>

Makefile

@@ -17,10 +17,14 @@
 # 	  CT's with DHCP network configuration.
 # 	- the rest of the CT's are created in order of importance, strting 
 # 	  from CT's needed for access and ending with services.
-CTs := \
+CORE_CTs := \
-       gate ns \
+	gate ns
-       ssh wireguard syncthing \
+MINIMAL_CTs := \
-       nextcloud #gitea
+	ssh wireguard 
+APP_CTs := \
+	syncthing nextcloud #gitea
+DEV_CTs := \
+	gitea
 
 
 DEPENDENCIES = make git dig pct
@@ -53,6 +57,9 @@ FORCE:
 	$<
 
 
+%.config: %/config.example
+
+
 config.global: config.global.example
 	@ [ ! -e "$@" ] \
 		&& cat "$<" > "$@" \
@@ -75,8 +82,21 @@ gate: gate-traefik
 
 #----------------------------------------------------------------------
 
+
+.PHONY: core
+core: config $CORE_CTs)
+
+
+.PHONY: minimal
+minimal: core $(BASE_CTs)
+
+
+.PHONY: dev
+dev: minimal $(DEV_CTs) 
+
+
 .PHONY: all
-all: config $(CTs) 
+all: minimal $(APP_CTs)
 
 
 

README.md

@@ -28,4 +28,46 @@ A set of scripts for automating setup and tasks in proxmox.
   - ...
 
 
+## Prerequisites
+
+### Proxmox
+
+```shell
+sudo apt update && sudo apt upgrade
+```
+
+```shell
+sudo apt install git make 
+```
+
+
+### Network Bridges
+
+`proxmox-utils` expects there to be at least three bridges:
+- WAN - connected to the port that faces the external network (either 
+  directly of via a router)
+- LAN - a virtual bridge, not connected to any physical interfaces
+- ADMIN - connected to a second physical interface used for 
+  administrative purposes.
+
+Note their numbers (i.e. the number in `vmbr#`), this will be needed for 
+setup.
+
+
+### DNS
+
+Add `10.1.1.1` to the DNS on the Proxmox host node after the `127.0.0.1`
+but before whatever external DNS you are using.
+
+
+## Setup
+
+```shell
+sudo make all
+```
+
+
+## Architecture
+
+