From e9527faca49c949779725a5632b85863d469363d Mon Sep 17 00:00:00 2001 From: Banjo Fox Date: Fri, 18 Aug 2023 09:34:58 -0400 Subject: [PATCH] Re-apply INSTALL.MD changes after fork sync. --- INSTALL.md | 34 ++++++++++++++++++++++++++++++---- 1 file changed, 30 insertions(+), 4 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index c4a7a83e..797c7801 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -2,31 +2,57 @@ ## Server Grade Headless Nodes -These network support nodes are heavier than the node a user would establish on their phone in the form of a chat or social media application. A cloud based virtual private server (VPS), such as Digital Ocean Droplets or AWS EC2, with high bandwidth, processing resources, and up time availability is crucial for building the fast, secure, and private routing that Veilid is built to provide. +These network support nodes are heavier than the node a user would establish on their phone in the form of a chat or social media application. A cloud based virtual private server (VPS), such as Digital Ocean Droplets or AWS EC2, with high bandwidth, processing resources, and up time availability is cruicial for building the fast, secure, and private routing that Veilid is built to provide. ### Add the repo to a Debian based system and install a Veilid node +This is a multi-step process. + +**Step 1**: Add the GPG keys to your operating systems keyring.
+*Explanation*: The `wget` command downloads the public key, and the `sudo gpg` command adds the public key to the keyring. ```shell wget -O- https://packages.veilid.net/gpg/veilid-packages-key.public | sudo gpg --dearmor -o /usr/share/keyrings/veilid-packages-keyring.gpg ``` -For AMD64 based systems run the following: +**Step 2**: Identify your architecture
+*Explanation*: The following command will tell you what type of CPU your system is running +```shell +dpkg --print-architecture +``` + +**Step 3**: Add Veilid to your list of availible software.
+*Explanation*: Using the command in **Step 2** you will need to run **one** of the following: + +- For **AMD64** based systems run this command: ```shell echo "deb [arch=amd64 signed-by=/usr/share/keyrings/veilid-packages-keyring.gpg] https://packages.veilid.net/apt stable main" | sudo tee /etc/apt/sources.list.d/veilid.list 1>/dev/null ``` -For ARM64 based systems, run the following: +- For **ARM64** based systems run this command: ```shell echo "deb [arch=arm64 signed-by=/usr/share/keyrings/veilid-packages-keyring.gpg] https://packages.veilid.net/apt stable main" | sudo tee /etc/apt/sources.list.d/veilid.list 1>/dev/null ``` -For all, run: +*Explanation*: +Each of the above commands will create a new file called `veilid.list` in the `/etc/apt/sources.list.d/`. This file contains instructions that tell the operating system where to download Veilid. + +**Step 4**: Refresh the package manager.
+*Explanation*: This tells the `apt` package manager to rebuild the list of available software using the files in `/etc/apt/sources.list.d/` directory ```shell apt update ``` + +**Step 5**: Install Veilid.
+*Explanation*: With the package manager updated, it is now possible to install Veilid! ```shell apt install veilid-server veilid-cli ``` + + ### Add the repo to a Fedora based system and install a Veilid node +**Step 1**: Add Veilid to your list of availible software.
+*Explanation*: With the package manager updated, it is now possible to install Veilid! ```shell yum-config-manager --add-repo https://packages.veilid.net/rpm/veilid-rpm-test-repo.repo ``` +**Step 2**: Install Veilid.
+*Explanation*: With the package manager updated, it is now possible to install Veilid! ```shell dnf install veilid-server veilid-cli ```