Git-Mirrors/veilid
1
0
Fork 0
mirror of https://gitlab.com/veilid/veilid.git synced 2024-10-01 01:26:08 -04:00
Code Issues Packages Projects Releases Wiki Activity

Added examples for setting up auto updates. Cleaned up some formatting. [ci skip]

Browse Source
This commit is contained in:
TC 2024-08-04 16:59:44 +00:00
parent 02079bf018
commit 0b1b533ea6
1 changed files with 41 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
INSTALL.md
View File

@ -70,11 +70,11 @@ sudo apt update
sudo apt install veilid-server veilid-cli sudo apt install veilid-server veilid-cli
``` ```
***Step 6***: Start veilid-server.service **Step 6**: Start veilid-server.service
Go to [Start headless node](#start-headless-node) Go to [Start headless node](#start-headless-node)
***Step 7***: View Node Activity **Step 7**: View Node Activity
Invoke the Veilid CLI utility. Invoke the Veilid CLI utility.
@ -113,11 +113,11 @@ sudo dnf config-manager --add-repo https://packages.veilid.net/rpm/nightly/x86_6
sudo dnf install veilid-server veilid-cli sudo dnf install veilid-server veilid-cli
``` ```
***Step 3***: Start veilid-server.service **Step 3**: Start veilid-server.service
Go to [Start headless node](#start-headless-node) Go to [Start headless node](#start-headless-node)
***Step 4***: View Node Activity **Step 4**: View Node Activity
Invoke the Veilid CLI utility. Invoke the Veilid CLI utility.
@ -130,7 +130,44 @@ Or use _sudo_ to invoke as the _veilid_ user
sudo -u veilid veilid-cli sudo -u veilid veilid-cli
``` ```
### Setup Auto Updates
**Stable Releases**
We set the bootstrap nodes to check for updates every hour by using crontab
On a Debian based machine:
```shell
sudo crontab -e
```
In the editor that opens append:
```shell
0 * * * * apt -y update && apt -y upgrade veilid-cli veilid-server > ~/auto_updates.log 2>&1
```
**Nightly Releases**
The nightly auto release triggers at 11PM US Central Time. The following crontab exmaple will
trigger at 6AM for your machine's local time which should give plenty of time for the auto release
to complete no matter where you are in the world.
```shell
sudo crontab -e
```
In the editor that opens append:
```shell
* 6 * * * apt -y update && apt -y upgrade veilid-cli veilid-server > ~/auto_updates.log 2>&1
```
**Fedora Based Machines**
The above steps should work, replace the apt commands with appropriate dnf commands.
### macOS ### macOS
***Not maintained by the Veilid team. Seek assistance in the Discord community.***
Veilid is available [via Homebrew](https://formulae.brew.sh/formula/veilid). Veilid is available [via Homebrew](https://formulae.brew.sh/formula/veilid).