Add private or dev network setup docs

Guides and config templates for use in setting up private
Veilid networks for independent or development needs.
This commit is contained in:
TC Johnson 2023-09-21 08:24:09 -05:00
parent 6e9610ecd2
commit 618b092e8b
No known key found for this signature in database
5 changed files with 22 additions and 11 deletions

View File

@ -14,12 +14,10 @@ Follow instructions in [INSTALL.md](./INSTALL.md)
## Configure Veilid as Bootstrap ## Configure Veilid as Bootstrap
**As root**
### Stop the Veilid service ### Stop the Veilid service
```shell ```shell
systemctl stop veilid-server.service sudo systemctl stop veilid-server.service
``` ```
### Setup the config ### Setup the config
@ -36,7 +34,7 @@ sudo -u veilid /bin/bash
### Generate a new keypair ### Generate a new keypair
Copy the output to secure storage. Copy the output to secure storage such as a password manager. This information will be used in the next step and can be used for node recovery, moving to a different server, etc.
```shell ```shell
veilid-server --generate-key-pair veilid-server --generate-key-pair
@ -44,7 +42,7 @@ veilid-server --generate-key-pair
### Create new node ID and flush existing route table ### Create new node ID and flush existing route table
Include the brackets [] when pasting the keys. Use the public key in the command. Secret key will be request interacitvly and will not echo when pasted. Include the brackets [] when pasting the keys. Use the public key in the command. Secret key will be requested interactively and will not echo when pasted.
```shell ```shell
veilid-server --set-node-id [PUBLIC_KEY] --delete-table-store veilid-server --set-node-id [PUBLIC_KEY] --delete-table-store
@ -52,18 +50,22 @@ veilid-server --set-node-id [PUBLIC_KEY] --delete-table-store
### Generate the DNS TXT record ### Generate the DNS TXT record
Copy the output to secure storage. Copy the output to secure storage. This information will be use to setup DNS records.
```shell ```shell
veilid-server --dump-txt-record veilid-server --dump-txt-record
``` ```
**Switch back to root**
### Start the Veilid service ### Start the Veilid service
Disconnect from the Veilid user and start veilid-server.service.
```shell ```shell
systemctl start veilid-server.service exit
```
```shell
sudo systemctl start veilid-server.service
``` ```
Optionally configure the service to start at boot `sudo systemctl enable veilid-server.service` Optionally configure the service to start at boot `sudo systemctl enable veilid-server.service`

View File

@ -16,7 +16,7 @@ This acts as a passphase to allow nodes to join the network. It is the mechanism
### Dev Bootstrap Server ### Dev Bootstrap Server
Follow the steps detailed in [BOOTSTRAP-SETUP.md](../BOOTSTRAP-SETUP.md) using the dev bootstrap example [config](../doc/config/veilid-dev-bootstrap-config.md) for the *Setup the config* section. Set your network key on line 28. Follow the steps detailed in [BOOTSTRAP-SETUP.md](../BOOTSTRAP-SETUP.md) using the dev bootstrap example [config](../doc/config/veilid-dev-bootstrap-config.md) for the *Setup the config* section. Set a _network_key_password_ in the config file.
### Dev Nodes ### Dev Nodes

View File

@ -3,6 +3,11 @@
# #
# Private Development Bootstrap Server Configuration # Private Development Bootstrap Server Configuration
# #
# This config is templated to setup a bootstrap server with
# a network_key_password. Set the network key to whatever you
# like. Treat it like a password. Use the same network key in
# the config files for at least four nodes to establish an
# independent Veilid network for private or development uses.
# ----------------------------------------------------------- # -----------------------------------------------------------
--- ---

View File

@ -1,8 +1,12 @@
# Veilid Server # Veilid Server
# ============= # =============
# #
# Dev Node Configuration # Private Development Node Configuration
# #
# This config is templated to setup a Velid node with a
# network_key_password. Set the network key to whatever you
# set within your private bootstrap server's config. Treat it
# like a password.
# ----------------------------------------------------------- # -----------------------------------------------------------
--- ---