liz/veilid
liz/veilid
1
0
Fork 0
Code Pull Requests Packages Releases Activity

[#253] add instructions to run veilid node

Browse Source 
Added instructions to:

- Run a veilid node with systemd
- add instructions for getting veilid to start at boot
- Manually run a veilid node, because users may use platforms without
  systemd available.

Changes:

- Changed title to include run
- Added `systemctl start ...` instructions
- Added heavily caveated instructions to run veilid-server manually
This commit is contained in:
zed tan 2023-09-11 22:21:40 +02:00
parent 4b5bef83e2
commit a3e3ab8ab5
1 changed files with 26 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
INSTALL.md
View File

@ -1,4 +1,4 @@
# Install a Veilid Node # Install and run a Veilid Node
## Server Grade Headless Nodes ## Server Grade Headless Nodes
@ -72,9 +72,31 @@ sudo yum-config-manager --add-repo https://packages.veilid.net/rpm/veilid-rpm-re
sudo dnf install veilid-server veilid-cli sudo dnf install veilid-server veilid-cli
``` ```
**Step 2**: Install Veilid. ## Start headless node
*Explanation*: With the package manager updated, it is now possible to install Veilid!
To start a headless Veilid node, run as root:
```shell ```shell
dnf install veilid-server veilid-cli systemctl start veilid-server.service
``` ```
To have your Veilid node start at boot:
```shell
systemctl enable --now veilid-server.service
```
> **Not recommended:**
> In cases where you must run `veilid-server`
> without `systemd` (e.g., systems that use OpenRC, or containers),
> you _must_ run the `veilid-server`
> as the `veilid` user.
> Do this manually by running as root:
>
> ```shell
> # Force-allow login by setting shell
> usermod -s /bin/bash veilid
> # Run veilid-server as veilid user
> # Note that by default, veilid user is still passwordless.
> sudo -u veilid veilid-server
> ```