From 2ad370f8194a471c54a23ac80716a49b7780b6ef Mon Sep 17 00:00:00 2001
From: "Tristan B. Kildaire" <deavmi@redxen.eu>
Date: Thu, 3 Jun 2021 10:18:40 +0200
Subject: [PATCH] Added Entity DB tutorial

---
 docs/entitydb.md        | 36 ++++++++++++++++++++++++++++++++++++
 docs/getting-started.md | 26 +++++++++++++++-----------
 2 files changed, 51 insertions(+), 11 deletions(-)
 create mode 100644 docs/entitydb.md

diff --git a/docs/entitydb.md b/docs/entitydb.md
new file mode 100644
index 0000000..622010b
--- /dev/null
+++ b/docs/entitydb.md
@@ -0,0 +1,36 @@
+Entity DB
+=========
+
+EntityDB holds all network allocations and associated information. All this must be done on this repository: https://codeberg.org/CRXN/entitydb/
+
+## Format
+
+Firstly create an entry by creating a directory with your unique username, `deavmi/` for example.
+
+### Networks
+
+ALl network declarations are created as seperate files per allocation within `deavmi/networks`. An example would be `deavmi/networks/deavmi.home.network` which must look like this:
+
+```
+[deavmi.home.network]
+  # Required network information
+  Prefix="fdd2:cbf2:61bd::/48"
+  PublicKey=""
+
+  # For network connectivity tests
+  RouterIP="fdd2:cbf2:61bd::1"
+  NonRouterIP="fdd2:cbf2:61bd::2"
+```
+
+### Services
+
+All network services are declared within `deavmi/services` (file) like so:
+
+```
+[Web server]
+  address="fdd2:cbf2:61bd::2"
+  port=80
+[Babel web]
+  address="fdd2:cbf2:61bd::2"
+  port=4444
+```
\ No newline at end of file
diff --git a/docs/getting-started.md b/docs/getting-started.md
index 7d1979b..0eb605f 100644
--- a/docs/getting-started.md
+++ b/docs/getting-started.md
@@ -17,18 +17,18 @@ and configuration details needed to get connected!
 	* Zero-tolerance for breaking them
 2. [Requirements](requirements.md)
 	* TODO: Hardware, software, network connections
-3. Assigning subnet
+3. Registration
 	* [Registering a new /48 ULA](register_ula.md)
-	* TODO: IPs etc
-	* TODO: RPKI?
+	* [Adding your prefix to EntityDB](entitydb.md)
+	* ~TODO: IPs etc~~
+	* ~TODO: RPKI?~
 4. [Setting up routing](routing.md)
 	1. Setting up Bird
-		* [Bird 1.6](bird1.6.md)
-		* [Bird 2.0](bird2.md)
-		* TODO: Filtering etc
-		* TODO: Config
-		* TODO: Scripting
-		1. Setting up lg_proxy
+		1. [Bird basics](bird_basics.md)
+		2. Bird configuration
+			1. [Bird 1.6](bird1.6.md)
+			2. [Bird 2.0](bird2.md)
+		3. Setting up lg_proxy
 			* TODO: Setting up lg_proxy
 	2. Setting up Mikrotik
 		* TODO: Enabling graphs
@@ -39,8 +39,12 @@ and configuration details needed to get connected!
 	* TODO: Fastd config
 7. Getting peers
 	* TODO: Finding someone to tunnel to
-8. Setting up your home nwtwork
-	* TODO: radv etc.
+8. Setting up your home network
+	* [Configuring your hosts]
+		1. Statically (TODO)
+		2. Automatically with SLAAC and radv
+			1. [Setting up radv (router)](radv.md)
+			2. Setting up SLAAC (hosts)
 	* TODO: COnfiguring hosts
 	* TODO: Dns