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

[#253] implement feedback for INSTALL.md

Browse Source 
- re-add one missing `<br />`
- add `sudo` to `systemctl` commands
- removed quoted/admonished section for running veilid-server directly
- instead, made 'With systemd' and 'Without systemd' sub-sections, with
  instructions
- removed extraneous instructions to `usermod` to allow login for `veilid` user
This commit is contained in:
zed tan 2023-09-15 22:38:32 +02:00
parent a3e3ab8ab5
commit 34b4419859
1 changed files with 16 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
INSTALL.md
View File

@ -10,7 +10,7 @@ These network support nodes are heavier than the node a user would establish on
Follow the steps here to add the repo to a Debian based system and install Veilid. Follow the steps here to add the repo to a Debian based system and install Veilid.
**Step 1**: Add the GPG keys to your operating systems keyring. **Step 1**: Add the GPG keys to your operating systems keyring.<br />
*Explanation*: The `wget` command downloads the public key, and the `sudo gpg` command adds the public key to the keyring. *Explanation*: The `wget` command downloads the public key, and the `sudo gpg` command adds the public key to the keyring.
```shell ```shell
@ -74,29 +74,26 @@ sudo dnf install veilid-server veilid-cli
## Start headless node ## Start headless node
To start a headless Veilid node, run as root: ### With systemd
To start a headless Veilid node, run:
```shell ```shell
systemctl start veilid-server.service sudo systemctl start veilid-server.service
``` ```
To have your Veilid node start at boot: To have your headless Veilid node start at boot:
```shell ```shell
systemctl enable --now veilid-server.service sudo systemctl enable --now veilid-server.service
``` ```
> **Not recommended:** ### Without systemd
> In cases where you must run `veilid-server`
> without `systemd` (e.g., systems that use OpenRC, or containers), `veilid-server` must be run as the `veilid` user.
> you _must_ run the `veilid-server`
> as the `veilid` user. To start your headless Veilid node without systemd, run:
> Do this manually by running as root:
> ```shell
> ```shell sudo -u veilid veilid-server
> # 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
> ```