scott/infranet
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Added installation instructions to the README

Browse source
This commit is contained in:
Scott Wallace 2022-03-30 11:59:46 +01:00
parent a4eee2aa99
commit f7b5a97db8
Signed by: scott
GPG key ID: AA742FDC5AFE2A72
1 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

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