Merge pull request #216 from ethersphere/clef-fix

Update clef version and amend configuration
ethersphere · Jun 25, 2021 · 8da5dea · 8da5dea
2 parents 5db6b36 + 406b404
commit 8da5dea
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 39 deletions.
diff --git a/docs/installation/bee-clef.md b/docs/installation/bee-clef.md
@@ -33,24 +33,24 @@ Bee Clef can be installed automatically using your system's package manager.
 #### AMD64
 
 ```bash
-wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.13/bee-clef_0.4.13_amd64.deb
-sudo dpkg -i bee-clef_0.4.13_amd64.deb
+wget https://github.com/ethersphere/bee-clef/releases/download/v0.5.0/bee-clef_0.5.0_amd64.deb
+sudo dpkg -i bee-clef_0.5.0_amd64.deb
 ```
 
 #### ARM (Raspberry Pi)
 
 ##### ARMv7
 
 ```bash
-wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.13/bee-clef_0.4.13_armv7.deb
-sudo dpkg -i bee-clef_0.4.13_armv7.deb
+wget https://github.com/ethersphere/bee-clef/releases/download/v0.5.0/bee-clef_0.5.0_armv7.deb
+sudo dpkg -i bee-clef_0.5.0_armv7.deb
 ```
 
 ##### ARM64
 
 ```bash
-wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.13/bee-clef_0.4.13_arm64.deb
-sudo dpkg -i bee-clef_0.4.13_arm64.deb
+wget https://github.com/ethersphere/bee-clef/releases/download/v0.5.0/bee-clef_0.5.0_arm64.deb
+sudo dpkg -i bee-clef_0.5.0_arm64.deb
 ```
 
 </TabItem>
@@ -59,24 +59,24 @@ sudo dpkg -i bee-clef_0.4.13_arm64.deb
 #### AMD64
 
 ```bash
-wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.13/bee-clef_0.4.13_amd64.rpm
-sudo rpm -i bee-clef_0.4.13_amd64.rpm
+wget https://github.com/ethersphere/bee-clef/releases/download/v0.5.0/bee-clef_0.5.0_amd64.rpm
+sudo rpm -i bee-clef_0.5.0_amd64.rpm
 ```
 
 #### ARM (Raspberry Pi)
 
 ##### ARMv7
 
 ```bash
-wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.13/bee-clef_0.4.13_armv7.rpm
-sudo rpm -i bee-clef_0.4.13_armv7.rpm
+wget https://github.com/ethersphere/bee-clef/releases/download/v0.5.0/bee-clef_0.5.0_armv7.rpm
+sudo rpm -i bee-clef_0.5.0_armv7.rpm
 ```
 
 ##### ARM64
 
 ```bash
-wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.13/bee-clef_0.4.13_arm64.rpm
-sudo rpm -i bee-clef_0.4.13_arm64.rpm
+wget https://github.com/ethersphere/bee-clef/releases/download/v0.5.0/bee-clef_0.5.0_arm64.rpm
+sudo rpm -i bee-clef_0.5.0_arm64.rpm
 ```
 
 </TabItem>
@@ -98,9 +98,11 @@ brew services start swarm-clef
 
 
 ### Configuring Bee Clef
-Configuration files are stored in `/etc/bee-clef/`
+Configuration files are stored in `/etc/default/bee-clef/` on Linux and `/usr/local/etc/swarm-clef/default` on MacOS.
 
-For a normal installation using a package manger, there should not be any configuration changes necessary to start using Bee Clef.
+To install clef for Swarm mainnet, change `BEE_CLEF_CHAIN_ID` to be `100` in order to interact with the XDAI network. For testnet, use chain id `5`.
+
+For a normal installation using a package manager, this should be the only configuration changes necessary to start using Bee Clef.
 
 ### Interact With Bee Clef
 

diff --git a/docs/installation/docker.md b/docs/installation/docker.md
@@ -118,12 +118,14 @@ BEE_SWAP_ENDPOINT=https://stake.getblock.io/mainnet/?api_key=your-api-key
 BEE_PASSWORD=my-password
 ```
 
-To enable Clef support, we must also change the following params: 
+To enable Clef support on mainnet, we must also change the following params: 
 
 ```
-CLEF_CHAINID=5
+CLEF_CHAINID=100
 ```
 
+For testnet, use chain id `5`.
+
 ```
 BEE_CLEF_SIGNER_ENABLE=true
 BEE_CLEF_SIGNER_ENDPOINT=http://clef-1:8550

diff --git a/docs/installation/install.md b/docs/installation/install.md
@@ -53,24 +53,24 @@ specific configuration needed to make Clef work with Bee.
 #### AMD64
 
 ```bash
-wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.13/bee-clef_0.4.13_amd64.deb
-sudo dpkg -i bee-clef_0.4.13_amd64.deb
+wget https://github.com/ethersphere/bee-clef/releases/download/v0.5.0/bee-clef_0.5.0_amd64.deb
+sudo dpkg -i bee-clef_0.5.0_amd64.deb
 ```
 
 #### ARM (Raspberry Pi)
 
 ##### ARMv7
 
 ```bash
-wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.13/bee-clef_0.4.13_armv7.deb
-sudo dpkg -i bee-clef_0.4.13_armv7.deb
+wget https://github.com/ethersphere/bee-clef/releases/download/v0.5.0/bee-clef_0.5.0_armv7.deb
+sudo dpkg -i bee-clef_0.5.0_armv7.deb
 ```
 
 ##### ARM64
 
 ```bash
-wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.13/bee-clef_0.4.13_arm64.deb
-sudo dpkg -i bee-clef_0.4.13_arm64.deb
+wget https://github.com/ethersphere/bee-clef/releases/download/v0.5.0/bee-clef_0.5.0_arm64.deb
+sudo dpkg -i bee-clef_0.5.0_arm64.deb
 ```
 
 </TabItem>
@@ -79,24 +79,24 @@ sudo dpkg -i bee-clef_0.4.13_arm64.deb
 #### AMD64
 
 ```bash
-wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.13/bee-clef_0.4.13_amd64.rpm
-sudo rpm -i bee-clef_0.4.13_amd64.rpm
+wget https://github.com/ethersphere/bee-clef/releases/download/v0.5.0/bee-clef_0.5.0_amd64.rpm
+sudo rpm -i bee-clef_0.5.0_amd64.rpm
 ```
 
 #### ARM (Raspberry Pi)
 
 ##### ARMv7
 
 ```bash
-wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.13/bee-clef_0.4.13_armv7.rpm
-sudo rpm -i bee-clef_0.4.13_armv7.rpm
+wget https://github.com/ethersphere/bee-clef/releases/download/v0.5.0/bee-clef_0.5.0_armv7.rpm
+sudo rpm -i bee-clef_0.5.0_armv7.rpm
 ```
 
 ##### ARM64
 
 ```bash
-wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.13/bee-clef_0.4.13_arm64.rpm
-sudo rpm -i bee-clef_0.4.13_arm64.rpm
+wget https://github.com/ethersphere/bee-clef/releases/download/v0.5.0/bee-clef_0.5.0_arm64.rpm
+sudo rpm -i bee-clef_0.5.0_arm64.rpm
 ```
 
 </TabItem>

diff --git a/docs/installation/rasp-bee-ry-pi.md b/docs/installation/rasp-bee-ry-pi.md
@@ -64,8 +64,8 @@ Raspberry Pi [https://docs.ethswarm.org](https://docs.ethswarm.org).
 Click `Install > Bee Clef` and scroll down to find the installation commands for Bee Clef **ARM (Raspberry Pi) ARMv7**. These should look something like: 
 
 ```sh
-wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.13/bee-clef_0.4.13_armv7.deb
-sudo dpkg -i bee-clef_0.4.13_armv7.deb
+wget https://github.com/ethersphere/bee-clef/releases/download/v0.5.0/bee-clef_0.5.0_armv7.deb
+sudo dpkg -i bee-clef_0.5.0_armv7.deb
 ```
 
 Click `Copy` on the right hand side of the box containing the
@@ -77,27 +77,33 @@ character.
 You should see some output from the `wget` command which is a Linux utility this is used to download the correct Bee Clef 'package' from Github, where the development of the Bee utilities takes place.
 
 ```bash
-bee-clef_0.4.13_armv7.deb.1           100%[===================================================================>]   9.99M  8.21MB/s    in 1.2s    
+bee-clef_0.5.0_armv7.deb.1           100%[===================================================================>]   9.99M  8.21MB/s    in 1.2s    
 
-2021-05-15 17:34:02 (8.21 MB/s) - ‘bee-clef_0.4.13_armv7.deb’ saved [10473282/10473282]
+2021-05-15 17:34:02 (8.21 MB/s) - ‘bee-clef_0.5.0_armv7.deb’ saved [10473282/10473282]
 
-pi@raspberrypi:~ $ sudo dpkg -i bee-clef_0.4.13_armv7.deb
+pi@raspberrypi:~ $ sudo dpkg -i bee-clef_0.5.0_armv7.deb
 ```
 
 The other command will be left in your terminal, this uses the `dpkg` utility, the Debian Package Manager to install Bee Clef. Package Managers are used to conveniently install software on Linux systems.
 
 Press enter to start the installation process. All being well, you will see some output like this:
 
 ```
-pi@raspberrypi:~ $ sudo dpkg -i bee-clef_0.4.13_armv7.deb
+pi@raspberrypi:~ $ sudo dpkg -i bee-clef_0.5.0_armv7.deb
 Selecting previously unselected package bee-clef.
 (Reading database ... 98610 files and directories currently installed.)
-Preparing to unpack bee-clef_0.4.13_armv7.deb ...
-Unpacking bee-clef (0.4.13) ...
-Setting up bee-clef (0.4.13) ...
+Preparing to unpack bee-clef_0.5.0_armv7.deb ...
+Unpacking bee-clef (0.5.0) ...
+Setting up bee-clef (0.5.0) ...
 Created symlink /etc/systemd/system/multi-user.target.wants/bee-clef.service → /lib/systemd/system/bee-clef.service.
 ```
 
+Finally, if running a mainnet node, amend the configuration at `/etc/default/bee-clef` to include:
+
+```sh
+BEE_CLEF_CHAIN_ID=100
+```
+
 Congratulations! You just installed Bee Clef!
 
 Now to repeat the process for Bee itself. 
@@ -158,7 +164,7 @@ Your output should looks something like this:
 ```bash
 -rw-r--r--  1 pi   pi       3523 Mar  4 22:47 .bashrc
 -rw-r--r--  1 pi   pi   10787806 Mar 23 08:18 bee_1.0.0_armv7.deb
--rw-r--r--  1 pi   pi   10473282 Feb 24 18:00 bee-clef_0.4.13_armv7.deb
+-rw-r--r--  1 pi   pi   10473282 Feb 24 18:00 bee-clef_0.5.0_armv7.deb
 drwxr-xr-x  2 pi   pi       4096 Mar  4 22:57 Bookshelf
 ```
 
@@ -184,7 +190,7 @@ ls -la | grep "bee"
 ```
 
 ```bash
--rw-r--r--  1 pi   pi   10473282 Feb 24 18:00 bee-clef_0.4.13_armv7.deb
+-rw-r--r--  1 pi   pi   10473282 Feb 24 18:00 bee-clef_0.5.0_armv7.deb
 ```
 
 Success! The Bee package file is deleted! Note at the command line