From dc7852660169afd03d286448110e1445af436802 Mon Sep 17 00:00:00 2001 From: "Tristan B. Velloza Kildaire" Date: Wed, 23 Nov 2022 17:11:20 +0200 Subject: [PATCH] Removed old prefix registration documentation Added prefix allocation details --- docs/registration/entitydb.md | 47 ++++++----------------------------- mkdocs.yml | 2 +- 2 files changed, 8 insertions(+), 41 deletions(-) diff --git a/docs/registration/entitydb.md b/docs/registration/entitydb.md index e950642..f812655 100644 --- a/docs/registration/entitydb.md +++ b/docs/registration/entitydb.md @@ -1,45 +1,12 @@ -Entity DB -========= +Prefix allocation and registration +================================== -EntityDB holds all network allocations and associated information. All this must be done on this repository: https://codeberg.org/CRXN/entitydb/ or you can send an email to (TODO: add rany's email). +To simply forward IPv6 traffic on CRXN one only needs an IPv6 link-local address which is always guaranteed to be assigned (most of the time), however normally people join CRXN so that they can _also_ host services (and access others) on the inter-network. Therefore, one needs to allocate a prefix and register it to be able to make use of the network in such a manner. -## Format +## Generating a prefix (allocation) -Firstly create an entry by creating a directory with your unique username, `deavmi/` for example. +On CRXN we use addresses within the `fd00::/8` space otherwise known as the ULA-space. We then require users to generate a random ULA which is a subnet within this space with a prefix size of `/48`. -### Networks +Here is what a ULA would look like: `fd2d:194b:a02f::/48` -All network declarations are created as entries in the file `deavmi/network` as so: - -``` -[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" - -[deavmi.community.network1] - # Required network information - Prefix="fd08:8441:e254::/48" - PublicKey="" - - # For network connectivity tests - RouterIP="fd08:8441:e254::1" - NonRouterIP="fd08:8441:e254::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 +You can generate your ULA you would like to use for CRXN using a tool such as [Unique Local IPv6 Generator](https://www.unique-local-ipv6.com/) or if you are good at basic programming and mathematics you could write a C program to do it. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index f9f7f22..d08a0a8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -8,7 +8,7 @@ nav: - Rules: rules.md - Requirements: requirements.md - Registration: - - Adding your prefix to EntityDB: registration/entitydb.md + - Registering and adding your prefix to EntityDB: registration/entitydb.md - Routing: - Setting up Bird: - Bird basics: routing/bird/bird_basics.md