CRXN
/
docs
mirror of https://codeberg.org/CRXN/docs.git
1
0
Fork 0
Code Releases Activity

Added Entity DB tutorial

This commit is contained in:
Tristan B. Velloza Kildaire 2021-06-03 10:18:40 +02:00
parent 9e0b0aaccf
commit 2ad370f819
2 changed files with 51 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/entitydb.md Normal file
View File

@ -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
```

26
docs/getting-started.md
View File

@ -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