update provider docs

This commit is contained in:
BiPhan4 2023-04-21 18:16:46 -04:00
parent ad1f82c1ba
commit 96f2c5735f
3 changed files with 40 additions and 9 deletions

View File

@ -5,20 +5,19 @@ sidebar_position: 0
## Pre-Requisites ## Pre-Requisites
There are a few things needed before installing. There are a few things needed before installing.
:::tip While logged in as the 'root' or 'admin' user, we add a 'jackal' user and give them root privileges.
Perform the follow instructions as `root` or your `admin` account.
:::
### Create Jackal user ### Create Jackal user
```sh ```sh
sudo adduser --gecos "" jackal sudo adduser --gecos "" jackal
sudo usermod -aG sudo jackal
``` ```
Re-log in as the jackal user to complete the below steps.
### Installing required tools ### Installing required tools
This will install the necessary tools to build the jackal chain source, along with lz4 compression tool and jquery tool. This will install the necessary tools to build the jackal chain source, along with lz4 compression tool and jquery tool.

View File

@ -44,10 +44,16 @@ Disk identifier: D2827F71-7F0A-EE4A-BB12-1B2172641DBE
... ...
``` ```
Note down the Disk paths that you wish to use for your storage provider, in this case it is `/dev/sdb` and `/dev/sda`. Now we create a new pool as follows: Note down the Disk paths that you wish to use for your storage provider, in this case it is `/dev/sdb` and `/dev/sda`.
We install ZFS and create a new pool as follows:
```sh ```sh
sudo zpool create {pool-name} /dev/sdb /dev/sda ... sudo apt install zfsutils-linux
sudo zpool create {pool-name} /dev/sda /dev/sdb ...
sudo zpool status
``` ```
This folder will now have the drives mounted at `/{pool-name}`. For more in-depth guides to using zfs, check out [this page](https://zfsonlinux.org/). This folder will now have the drives mounted at `/{pool-name}`. For more in-depth guides to using zfs, check out [this page](https://zfsonlinux.org/).

View File

@ -16,10 +16,23 @@ Check latest version [here](https://github.com/JackalLabs/canine-provider/releas
:::note :::note
'Setting Up' instructions must be followed fully to add necessary golang path info to the current users ~/.profile. If these steps are skipped, 'make install' will not build jprovd--the provider daemon. 'Setting Up' instructions must be followed fully to add necessary golang path info to the current users ~/.profile. If these steps are skipped, 'make install' will not build jprovd--the provider daemon. Please ensure to perform the below steps as the 'jackal' user you previously made.
::: :::
Install make and confirm installation.
```sh
sudo apt update
sudo apt install make
make --version
```
Build jprovd and source the .profile to ensure your shell can find jprovd. Confirm installation.
```sh ```sh
git clone https://github.com/JackalLabs/canine-provider.git git clone https://github.com/JackalLabs/canine-provider.git
@ -30,6 +43,19 @@ git pull
git checkout {version} git checkout {version}
make install make install
source ~/.profile
jprovd --version
```
If you used ZFS to make a zpool. Given ownership of the zpool to the jackal user.
```sh
sudo chown -R jackal:jackal /{pool-name}
``` ```
## Initializing ## Initializing