Distributed & E2EE self-hosting

Find a file

Scott Wallace c39e23be47 Restore whitespace changes		2022-03-31 14:42:52 +01:00
.gitlab-ci.yml	Fix Gitlab CI	2022-03-29 18:37:28 +01:00
candidates.md	Updated the candidates	2022-03-28 09:56:55 +01:00
config-lighthouse.yaml	Enable lighthouse DNS	2022-03-30 14:25:33 +01:00
config-node.yaml	Restore whitespace changes	2022-03-31 14:42:52 +01:00
docker-compose.yaml	Update the `docker-compose.yaml` to show ports need to be opened for Lighthouses	2022-03-31 14:35:13 +01:00
docker-entrypoint.sh	Comment updates	2022-03-30 13:26:38 +01:00
Dockerfile	Expose UDP ports from container image	2022-03-29 18:37:47 +01:00
README.md	Update the words	2022-03-31 13:24:10 +01:00
TODO.md	Test mesh network achieved!	2022-03-30 10:24:54 +01:00

InfraNet

Distributed & E2EE self-hosting. The goal is to have nodes voluntarily join the mesh and participate in the network providing compute and storage.

Tenets

End-to-end encrypted

E2EE is a requirement for privacy.
Collabrative

Members of the network are expected to cooperate to the best of their abilities, whether it's technical, financial or resources.
Distributed, resilient, reliable and dynamic

Nodes should be able to join and leave without too much disruption. Bootstrapping, joining and autodiscovery should be as easy as possible, allowing for easy scaling across all members of the network.
Free and open

All components should be free and open.
Shared responsibility

Knowledge of components will be documented and shared and responsibility for the uptime and maintainence should be shared where possible.

Tested

All components and goals should be testable to ensure changes don't impact existing functionality or reliabilty.
Monitored

All components should be monitored and raise appropriate alerts to ensure good health and early detection of potential problems.
Containerised

Simple, versioned components that can be resource constrained, when required, would be of great benefit.
IPv6

Avoiding issues with IPv4 NAT, etc. would be desirable.
Multi-architecture

The underlaying hardware type shouldn't be a constraint, within reason.

Clone the repo.
Create a directory to hold the config and certificates.
Copy lighthouse-config.yaml as config.yaml in the new directory.
Update the docker-compose.yaml to bind mount the newly created directory to /etc/nebula.
Run the container with docker-compose up -d. This will create two files, host.key and host.csr.
Send the contents of the host.csr file to a cluster admin to sign.
The returned, signed certificate should go alongside the host.csr file and be called, host.crt.
Start the container again and it should find the config and certificates and then connect to the existing cluster.
Update the static_host_map entry in the repo's node-config.yaml with the new Lighthouse mesh and public IP address and node admins to update their config files from the repo.

Clone the repo.
Create a directory to hold the config and certificates.
Copy node-config.yaml as config.yaml in the new directory.
Update the docker-compose.yaml to bind mount the newly created directory to /etc/nebula.
Run the container with docker-compose up -d. This will create two files, host.key and host.csr.
Send the contents of the host.csr file to a cluster admin to sign.
The returned, signed certificate should go alongside the host.csr file and be called, host.crt.
Start the container again and it should find the config and certificates and then connect to the existing cluster.