scott/infranet
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
Distributed & E2EE self-hosting
28 commits 1 branch 0 tags 123 KiB
Shell 61.9%
Dockerfile 38.1%
Find a file
Scott Wallace 346a71e79c
Remove references to NEBULA_IP as it's not required
2022-03-30 12:19:37 +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 Update configs for a better bootstrap 2022-03-30 08:56:13 +01:00
config-node.yaml Update configs for a better bootstrap 2022-03-30 08:56:13 +01:00
docker-compose.yaml Remove references to NEBULA_IP as it's not required 2022-03-30 12:19:37 +01:00
docker-entrypoint.sh Remove references to NEBULA_IP as it's not required 2022-03-30 12:19:37 +01:00
Dockerfile Expose UDP ports from container image 2022-03-29 18:37:47 +01:00
README.md Remove references to NEBULA_IP as it's not required 2022-03-30 12:19:37 +01:00
TODO.md Test mesh network achieved! 2022-03-30 10:24:54 +01:00

README.md

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.

Design principles

  • 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.

Node installation

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