From f7b5a97db82096f8764b2bebe3213902e2845d16 Mon Sep 17 00:00:00 2001 From: Scott Wallace Date: Wed, 30 Mar 2022 11:59:46 +0100 Subject: [PATCH] Added installation instructions to the README --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 6ce7b24..e6de44c 100644 --- a/README.md +++ b/README.md @@ -45,3 +45,17 @@ Distributed & E2EE self-hosting. The goal is to have nodes voluntarily join the * 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. The admin should have also provided an IP address in CIDR notation (e.g. `10.10.100.99/24`). Set that with the `NEBULA_IP` environment variable in the `docker-compose.yaml`. +9. Start the container again and it should find the config and certificates and then connect to the existing cluster.