IntenseWebs/veilid
3
0
Fork 0
mirror of https://gitlab.com/veilid/veilid.git synced 2024-11-25 02:00:49 -06:00
Code Issues Packages Projects Releases Wiki Activity
4b5bef83e2
veilid/INSTALL.md

81 lines
2.8 KiB
Markdown
Raw Normal View History

Add docs and mod version bumping Added and modified documentation for the contribution process. Added the code of conduct file. Modified bump version's conf to auto create tags and commits.
2023-08-01 21:37:38 -05:00
# Install a Veilid Node
## Server Grade Headless Nodes
Fix typos
2023-08-18 16:33:58 -05:00
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 uptime availability is crucial for building the fast, secure, and private routing that Veilid is built to provide.
[#253] clean up INSTALL.md - Added `Install` section to group debian and rpm installs. - Re-added `</br>`s -- they're used to break the `_Explanation:_` blocks to the next line. My personal preference is to _not_ use `</br>`s in docs, but i didn't want to change too many things here. - Shortened titles `Add the repo to a Debian ...` and `... Fedora ...` to keep it super concise and decoupled from actual steps - Some formatting best-practices - newlines between markdown blocks - indent code blocks that belong to bullet points to make sure that they are syntatically grouped (i.e. correct markdown 'DOM' hierarchy) - sudo: - Removed `sudo` explanations. `apt/dnf/yum` will not run without, no need to explain. - added `sudo` to RPM instruction code blocks (just those two) for consistency, and also you can't run dnf/yum without root anyway. - Made generic "Fedora based" instructions. Actually YUM/DNF-based, keeping it simple for now. Also name-dropped common distros for SEO/CTRL+F convenience - Removed certain `Explanation` blocks for concision. Some are repeated, and some step titles are already self-explanatory
2023-09-12 09:19:14 -05:00
## Install
Re-apply INSTALL.MD changes after fork sync.
2023-08-18 08:34:58 -05:00
[#253] clean up INSTALL.md - Added `Install` section to group debian and rpm installs. - Re-added `</br>`s -- they're used to break the `_Explanation:_` blocks to the next line. My personal preference is to _not_ use `</br>`s in docs, but i didn't want to change too many things here. - Shortened titles `Add the repo to a Debian ...` and `... Fedora ...` to keep it super concise and decoupled from actual steps - Some formatting best-practices - newlines between markdown blocks - indent code blocks that belong to bullet points to make sure that they are syntatically grouped (i.e. correct markdown 'DOM' hierarchy) - sudo: - Removed `sudo` explanations. `apt/dnf/yum` will not run without, no need to explain. - added `sudo` to RPM instruction code blocks (just those two) for consistency, and also you can't run dnf/yum without root anyway. - Made generic "Fedora based" instructions. Actually YUM/DNF-based, keeping it simple for now. Also name-dropped common distros for SEO/CTRL+F convenience - Removed certain `Explanation` blocks for concision. Some are repeated, and some step titles are already self-explanatory
2023-09-12 09:19:14 -05:00
### Debian
Follow the steps here to add the repo to a Debian based system and install Veilid.
Fix typos
2023-08-18 16:33:58 -05:00
Cleaned up .md files syntax Used the VScode markdownlint utility to make the syntax and formatting of multuple .md files so that they are more correct.
2023-09-12 08:43:09 -05:00
**Step 1**: Add the GPG keys to your operating systems keyring.
Re-apply INSTALL.MD changes after fork sync.
2023-08-18 08:34:58 -05:00
*Explanation*: The `wget` command downloads the public key, and the `sudo gpg` command adds the public key to the keyring.
Cleaned up .md files syntax Used the VScode markdownlint utility to make the syntax and formatting of multuple .md files so that they are more correct.
2023-09-12 08:43:09 -05:00
Fix typos
2023-08-18 16:33:58 -05:00
```shell
Add docs and mod version bumping Added and modified documentation for the contribution process. Added the code of conduct file. Modified bump version's conf to auto create tags and commits.
2023-08-01 21:37:38 -05:00
wget -O- https://packages.veilid.net/gpg/veilid-packages-key.public | sudo gpg --dearmor -o /usr/share/keyrings/veilid-packages-keyring.gpg
```
Cleaned up .md files syntax Used the VScode markdownlint utility to make the syntax and formatting of multuple .md files so that they are more correct.
2023-09-12 08:43:09 -05:00
[#253] clean up INSTALL.md - Added `Install` section to group debian and rpm installs. - Re-added `</br>`s -- they're used to break the `_Explanation:_` blocks to the next line. My personal preference is to _not_ use `</br>`s in docs, but i didn't want to change too many things here. - Shortened titles `Add the repo to a Debian ...` and `... Fedora ...` to keep it super concise and decoupled from actual steps - Some formatting best-practices - newlines between markdown blocks - indent code blocks that belong to bullet points to make sure that they are syntatically grouped (i.e. correct markdown 'DOM' hierarchy) - sudo: - Removed `sudo` explanations. `apt/dnf/yum` will not run without, no need to explain. - added `sudo` to RPM instruction code blocks (just those two) for consistency, and also you can't run dnf/yum without root anyway. - Made generic "Fedora based" instructions. Actually YUM/DNF-based, keeping it simple for now. Also name-dropped common distros for SEO/CTRL+F convenience - Removed certain `Explanation` blocks for concision. Some are repeated, and some step titles are already self-explanatory
2023-09-12 09:19:14 -05:00
**Step 2**: Identify your architecture<br />
Re-apply INSTALL.MD changes after fork sync.
2023-08-18 08:34:58 -05:00
*Explanation*: The following command will tell you what type of CPU your system is running
Cleaned up .md files syntax Used the VScode markdownlint utility to make the syntax and formatting of multuple .md files so that they are more correct.
2023-09-12 08:43:09 -05:00
Re-apply INSTALL.MD changes after fork sync.
2023-08-18 08:34:58 -05:00
```shell
dpkg --print-architecture
```
[#253] clean up INSTALL.md - Added `Install` section to group debian and rpm installs. - Re-added `</br>`s -- they're used to break the `_Explanation:_` blocks to the next line. My personal preference is to _not_ use `</br>`s in docs, but i didn't want to change too many things here. - Shortened titles `Add the repo to a Debian ...` and `... Fedora ...` to keep it super concise and decoupled from actual steps - Some formatting best-practices - newlines between markdown blocks - indent code blocks that belong to bullet points to make sure that they are syntatically grouped (i.e. correct markdown 'DOM' hierarchy) - sudo: - Removed `sudo` explanations. `apt/dnf/yum` will not run without, no need to explain. - added `sudo` to RPM instruction code blocks (just those two) for consistency, and also you can't run dnf/yum without root anyway. - Made generic "Fedora based" instructions. Actually YUM/DNF-based, keeping it simple for now. Also name-dropped common distros for SEO/CTRL+F convenience - Removed certain `Explanation` blocks for concision. Some are repeated, and some step titles are already self-explanatory
2023-09-12 09:19:14 -05:00
**Step 3**: Add Veilid to your list of available software.<br />
*Explanation*: Use the result of your command in **Step 2** and run **one** of the following:
Re-apply INSTALL.MD changes after fork sync.
2023-08-18 08:34:58 -05:00
- For **AMD64** based systems run this command:
Cleaned up .md files syntax Used the VScode markdownlint utility to make the syntax and formatting of multuple .md files so that they are more correct.
2023-09-12 08:43:09 -05:00
[#253] clean up INSTALL.md - Added `Install` section to group debian and rpm installs. - Re-added `</br>`s -- they're used to break the `_Explanation:_` blocks to the next line. My personal preference is to _not_ use `</br>`s in docs, but i didn't want to change too many things here. - Shortened titles `Add the repo to a Debian ...` and `... Fedora ...` to keep it super concise and decoupled from actual steps - Some formatting best-practices - newlines between markdown blocks - indent code blocks that belong to bullet points to make sure that they are syntatically grouped (i.e. correct markdown 'DOM' hierarchy) - sudo: - Removed `sudo` explanations. `apt/dnf/yum` will not run without, no need to explain. - added `sudo` to RPM instruction code blocks (just those two) for consistency, and also you can't run dnf/yum without root anyway. - Made generic "Fedora based" instructions. Actually YUM/DNF-based, keeping it simple for now. Also name-dropped common distros for SEO/CTRL+F convenience - Removed certain `Explanation` blocks for concision. Some are repeated, and some step titles are already self-explanatory
2023-09-12 09:19:14 -05:00
```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
```
Cleaned up .md files syntax Used the VScode markdownlint utility to make the syntax and formatting of multuple .md files so that they are more correct.
2023-09-12 08:43:09 -05:00
Re-apply INSTALL.MD changes after fork sync.
2023-08-18 08:34:58 -05:00
- For **ARM64** based systems run this command:
Cleaned up .md files syntax Used the VScode markdownlint utility to make the syntax and formatting of multuple .md files so that they are more correct.
2023-09-12 08:43:09 -05:00
[#253] clean up INSTALL.md - Added `Install` section to group debian and rpm installs. - Re-added `</br>`s -- they're used to break the `_Explanation:_` blocks to the next line. My personal preference is to _not_ use `</br>`s in docs, but i didn't want to change too many things here. - Shortened titles `Add the repo to a Debian ...` and `... Fedora ...` to keep it super concise and decoupled from actual steps - Some formatting best-practices - newlines between markdown blocks - indent code blocks that belong to bullet points to make sure that they are syntatically grouped (i.e. correct markdown 'DOM' hierarchy) - sudo: - Removed `sudo` explanations. `apt/dnf/yum` will not run without, no need to explain. - added `sudo` to RPM instruction code blocks (just those two) for consistency, and also you can't run dnf/yum without root anyway. - Made generic "Fedora based" instructions. Actually YUM/DNF-based, keeping it simple for now. Also name-dropped common distros for SEO/CTRL+F convenience - Removed certain `Explanation` blocks for concision. Some are repeated, and some step titles are already self-explanatory
2023-09-12 09:19:14 -05:00
```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
```
Cleaned up .md files syntax Used the VScode markdownlint utility to make the syntax and formatting of multuple .md files so that they are more correct.
2023-09-12 08:43:09 -05:00
Re-apply INSTALL.MD changes after fork sync.
2023-08-18 08:34:58 -05:00
*Explanation*:
Fix typos
2023-08-18 16:33:58 -05:00
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.
Re-apply INSTALL.MD changes after fork sync.
2023-08-18 08:34:58 -05:00
[#253] clean up INSTALL.md - Added `Install` section to group debian and rpm installs. - Re-added `</br>`s -- they're used to break the `_Explanation:_` blocks to the next line. My personal preference is to _not_ use `</br>`s in docs, but i didn't want to change too many things here. - Shortened titles `Add the repo to a Debian ...` and `... Fedora ...` to keep it super concise and decoupled from actual steps - Some formatting best-practices - newlines between markdown blocks - indent code blocks that belong to bullet points to make sure that they are syntatically grouped (i.e. correct markdown 'DOM' hierarchy) - sudo: - Removed `sudo` explanations. `apt/dnf/yum` will not run without, no need to explain. - added `sudo` to RPM instruction code blocks (just those two) for consistency, and also you can't run dnf/yum without root anyway. - Made generic "Fedora based" instructions. Actually YUM/DNF-based, keeping it simple for now. Also name-dropped common distros for SEO/CTRL+F convenience - Removed certain `Explanation` blocks for concision. Some are repeated, and some step titles are already self-explanatory
2023-09-12 09:19:14 -05:00
**Step 4**: Refresh the package manager.<br />
*Explanation*: This tells the `apt` package manager to rebuild the list of available software using the files in `/etc/apt/sources.list.d/` directory.
Cleaned up .md files syntax Used the VScode markdownlint utility to make the syntax and formatting of multuple .md files so that they are more correct.
2023-09-12 08:43:09 -05:00
Add docs and mod version bumping Added and modified documentation for the contribution process. Added the code of conduct file. Modified bump version's conf to auto create tags and commits.
2023-08-01 21:37:38 -05:00
```shell
Update file INSTALL.md
2023-08-24 12:41:35 -05:00
sudo apt update
Add docs and mod version bumping Added and modified documentation for the contribution process. Added the code of conduct file. Modified bump version's conf to auto create tags and commits.
2023-08-01 21:37:38 -05:00
```
Re-apply INSTALL.MD changes after fork sync.
2023-08-18 08:34:58 -05:00
Cleaned up .md files syntax Used the VScode markdownlint utility to make the syntax and formatting of multuple .md files so that they are more correct.
2023-09-12 08:43:09 -05:00
**Step 5**: Install Veilid.
Add docs and mod version bumping Added and modified documentation for the contribution process. Added the code of conduct file. Modified bump version's conf to auto create tags and commits.
2023-08-01 21:37:38 -05:00
```shell
Update file INSTALL.md
2023-08-24 12:41:35 -05:00
sudo apt install veilid-server veilid-cli
Add docs and mod version bumping Added and modified documentation for the contribution process. Added the code of conduct file. Modified bump version's conf to auto create tags and commits.
2023-08-01 21:37:38 -05:00
```
Re-apply INSTALL.MD changes after fork sync.
2023-08-18 08:34:58 -05:00
[#253] clean up INSTALL.md - Added `Install` section to group debian and rpm installs. - Re-added `</br>`s -- they're used to break the `_Explanation:_` blocks to the next line. My personal preference is to _not_ use `</br>`s in docs, but i didn't want to change too many things here. - Shortened titles `Add the repo to a Debian ...` and `... Fedora ...` to keep it super concise and decoupled from actual steps - Some formatting best-practices - newlines between markdown blocks - indent code blocks that belong to bullet points to make sure that they are syntatically grouped (i.e. correct markdown 'DOM' hierarchy) - sudo: - Removed `sudo` explanations. `apt/dnf/yum` will not run without, no need to explain. - added `sudo` to RPM instruction code blocks (just those two) for consistency, and also you can't run dnf/yum without root anyway. - Made generic "Fedora based" instructions. Actually YUM/DNF-based, keeping it simple for now. Also name-dropped common distros for SEO/CTRL+F convenience - Removed certain `Explanation` blocks for concision. Some are repeated, and some step titles are already self-explanatory
2023-09-12 09:19:14 -05:00
### RPM-based
Follow the steps here to add the repo to
RPM-based systems (CentOS, Rocky Linux, AlmaLinux, Fedora, etc.)
and install Veilid.
Cleaned up .md files syntax Used the VScode markdownlint utility to make the syntax and formatting of multuple .md files so that they are more correct.
2023-09-12 08:43:09 -05:00
**Step 1**: Add Veilid to your list of available software.
Add docs and mod version bumping Added and modified documentation for the contribution process. Added the code of conduct file. Modified bump version's conf to auto create tags and commits.
2023-08-01 21:37:38 -05:00
```shell
[#253] clean up INSTALL.md - Added `Install` section to group debian and rpm installs. - Re-added `</br>`s -- they're used to break the `_Explanation:_` blocks to the next line. My personal preference is to _not_ use `</br>`s in docs, but i didn't want to change too many things here. - Shortened titles `Add the repo to a Debian ...` and `... Fedora ...` to keep it super concise and decoupled from actual steps - Some formatting best-practices - newlines between markdown blocks - indent code blocks that belong to bullet points to make sure that they are syntatically grouped (i.e. correct markdown 'DOM' hierarchy) - sudo: - Removed `sudo` explanations. `apt/dnf/yum` will not run without, no need to explain. - added `sudo` to RPM instruction code blocks (just those two) for consistency, and also you can't run dnf/yum without root anyway. - Made generic "Fedora based" instructions. Actually YUM/DNF-based, keeping it simple for now. Also name-dropped common distros for SEO/CTRL+F convenience - Removed certain `Explanation` blocks for concision. Some are repeated, and some step titles are already self-explanatory
2023-09-12 09:19:14 -05:00
sudo yum-config-manager --add-repo https://packages.veilid.net/rpm/veilid-rpm-repo.repo
```
**Step 2**: Install Veilid.
```shell
sudo dnf install veilid-server veilid-cli
Add docs and mod version bumping Added and modified documentation for the contribution process. Added the code of conduct file. Modified bump version's conf to auto create tags and commits.
2023-08-01 21:37:38 -05:00
```
Cleaned up .md files syntax Used the VScode markdownlint utility to make the syntax and formatting of multuple .md files so that they are more correct.
2023-09-12 08:43:09 -05:00
**Step 2**: Install Veilid.
Re-apply INSTALL.MD changes after fork sync.
2023-08-18 08:34:58 -05:00
*Explanation*: With the package manager updated, it is now possible to install Veilid!
Cleaned up .md files syntax Used the VScode markdownlint utility to make the syntax and formatting of multuple .md files so that they are more correct.
2023-09-12 08:43:09 -05:00
Add docs and mod version bumping Added and modified documentation for the contribution process. Added the code of conduct file. Modified bump version's conf to auto create tags and commits.
2023-08-01 21:37:38 -05:00
```shell
dnf install veilid-server veilid-cli
```
Reference in New Issue Copy Permalink