aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README18
1 files changed, 18 insertions, 0 deletions
diff --git a/README b/README
index 251c4ec..6ac73d4 100644
--- a/README
+++ b/README
@@ -8,6 +8,24 @@ For now, the principal hypervisor is `bhyve` on FreeBSD, and the domain
controller is a mix of `pf`, `relayd` and `wireguard` on OpenBSD latest.
+development guidelines
+----------------------
+
+- OpenBSD first! Playbooks, roles and tasks are aimed to be deployed on OpenBSD
+ instance first. Because we also need a fallback system, AlpineLinux is the
+ next system to be targeted.
+
+
+technology stack
+----------------
+
+- domain controller : `httpd`, `relayd`, `pf` and `wireguard`. Checkout
+ https://bsd.plumbing for the first two components. `acme-client` is also
+ needed for providing https.
+ Note: https is provided from the domain controller level. The traffic from
+ the domain controller host and source host is http only, but secured via
+ the wireguard tunnel.
+
naming scheme
-------------
remember that computers suck.