From 96f2c5735f03c57e11b6ebde3d4a2377904fb945 Mon Sep 17 00:00:00 2001 From: BiPhan4 Date: Fri, 21 Apr 2023 18:16:46 -0400 Subject: [PATCH 1/4] update provider docs --- docs/nodes/1_install.md | 11 +++++------ docs/nodes/providers/1_building.md | 10 ++++++++-- docs/nodes/providers/2_setting_up.md | 28 +++++++++++++++++++++++++++- 3 files changed, 40 insertions(+), 9 deletions(-) diff --git a/docs/nodes/1_install.md b/docs/nodes/1_install.md index 18d1d87..6e16e36 100644 --- a/docs/nodes/1_install.md +++ b/docs/nodes/1_install.md @@ -5,20 +5,19 @@ sidebar_position: 0 ## Pre-Requisites -There are a few things needed before installing. +There are a few things needed before installing. -:::tip - -Perform the follow instructions as `root` or your `admin` account. - -::: +While logged in as the 'root' or 'admin' user, we add a 'jackal' user and give them root privileges. ### Create Jackal user ```sh sudo adduser --gecos "" jackal +sudo usermod -aG sudo jackal ``` +Re-log in as the jackal user to complete the below steps. + ### Installing required tools This will install the necessary tools to build the jackal chain source, along with lz4 compression tool and jquery tool. diff --git a/docs/nodes/providers/1_building.md b/docs/nodes/providers/1_building.md index fdef5f2..61b9d69 100644 --- a/docs/nodes/providers/1_building.md +++ b/docs/nodes/providers/1_building.md @@ -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 -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/). diff --git a/docs/nodes/providers/2_setting_up.md b/docs/nodes/providers/2_setting_up.md index 67056b4..01972f0 100644 --- a/docs/nodes/providers/2_setting_up.md +++ b/docs/nodes/providers/2_setting_up.md @@ -16,10 +16,23 @@ Check latest version [here](https://github.com/JackalLabs/canine-provider/releas :::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 git clone https://github.com/JackalLabs/canine-provider.git @@ -30,6 +43,19 @@ git pull git checkout {version} 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 From 8dfd834cba11040e5e0c2929cd2a0f7f65d6447e Mon Sep 17 00:00:00 2001 From: BiPhan4 Date: Fri, 21 Apr 2023 18:22:11 -0400 Subject: [PATCH 2/4] clean up --- docs/nodes/providers/2_setting_up.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/nodes/providers/2_setting_up.md b/docs/nodes/providers/2_setting_up.md index 01972f0..50cefb9 100644 --- a/docs/nodes/providers/2_setting_up.md +++ b/docs/nodes/providers/2_setting_up.md @@ -50,7 +50,7 @@ jprovd --version ``` -If you used ZFS to make a zpool. Given ownership of the zpool to the jackal user. +If you used ZFS to make a zpool. Give ownership of the zpool to the jackal user. ```sh From 05e1d7d00db96f0ba77abb2c5b4b7e7dfc43826e Mon Sep 17 00:00:00 2001 From: Tieman0220 <128452144+Tieman0220@users.noreply.github.com> Date: Fri, 21 Apr 2023 18:34:29 -0500 Subject: [PATCH 3/4] Update 2_setting_up.md update to provider IP_ADDRESS to make clear a FQDN should appear there instead. move source ~/.profile above make install remove "install make" as this is done when Go is installed --- docs/nodes/providers/2_setting_up.md | 19 ++++--------------- 1 file changed, 4 insertions(+), 15 deletions(-) diff --git a/docs/nodes/providers/2_setting_up.md b/docs/nodes/providers/2_setting_up.md index 50cefb9..9684063 100644 --- a/docs/nodes/providers/2_setting_up.md +++ b/docs/nodes/providers/2_setting_up.md @@ -20,17 +20,6 @@ Check latest version [here](https://github.com/JackalLabs/canine-provider/releas ::: -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 @@ -42,10 +31,10 @@ git pull git checkout {version} -make install - source ~/.profile +make install + jprovd --version ``` @@ -112,7 +101,7 @@ Mainnet tokens can be purchased on https://frontier.osmosis.zone/ 5. Initialize the provider ```sh -jprovd init {IP_ADDRESS} {STORAGE_IN_BYTES} {KEYBASE_IDENTITY} --home=$PHOME +jprovd init {FQDN} {STORAGE_IN_BYTES} {KEYBASE_IDENTITY} --home=$PHOME ``` example: @@ -121,7 +110,7 @@ example: jprovd init "https://storagep1.chainstrategies.cloud" "9000" "" --home=$PHOME ``` - Please note that 'https://' is required to be included in the ip or init will throw an error. + Please note that 'https://' is required to be included in the FQDN or init will throw an error. Link for TB to Bytes converter: https://www.convertunits.com/from/TB/to/byte 6. Start the provider From 0d73bdefb539e3b4569dd261b59be027ca1ea263 Mon Sep 17 00:00:00 2001 From: Jackson Willette <128452144+Tieman0220@users.noreply.github.com> Date: Fri, 21 Apr 2023 21:37:33 -0500 Subject: [PATCH 4/4] Update 2_setting_up.md resolve comments --- docs/nodes/providers/2_setting_up.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/docs/nodes/providers/2_setting_up.md b/docs/nodes/providers/2_setting_up.md index 9684063..10a400c 100644 --- a/docs/nodes/providers/2_setting_up.md +++ b/docs/nodes/providers/2_setting_up.md @@ -20,6 +20,17 @@ Check latest version [here](https://github.com/JackalLabs/canine-provider/releas ::: +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 @@ -31,10 +42,10 @@ git pull git checkout {version} -source ~/.profile - make install +source ~/.profile + jprovd --version ```