Skip to content
This repository has been archived by the owner on Dec 31, 2022. It is now read-only.

Commit

Permalink
Updated documentation with flexpool mode
Browse files Browse the repository at this point in the history
Updated download links to v1.5.2
  • Loading branch information
gilnobrega committed Jul 14, 2021
1 parent 7caf612 commit 4f50d9d
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 26 deletions.
3 changes: 3 additions & 0 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,9 @@ Notice that if you run it in a python venv then you must launch the farmr client
#### Showing FoxyPool balance
Set ``"Pool Public Key"`` to your pool public key if you want FoxyPool's pending and collateral balances to be displayed.

#### Showing Flexpool balance
Set ``"Flexpool Address"`` to your chia public address (starts with ``xch``) if you want Flexpool's balance to be displayed.

#### Showing HPool Balance

You need to set ``HPool Auth Token`` to the ``auth_key`` string in your hpool.com cookies. To see this token, open your browser and login to hpool.com, then right-click anywhere on the page and click on ``Inspect Element``, you should see a panel appear with a "Storage" tab. Right click on the string next to "auth_key" and copy that string string in ``value`` column. That's the string you should use as ``HPool Auth Token`` in farmr's ``config.json``. You should only need to update this value once every 3 months or when you logout from that device.
Expand Down
12 changes: 6 additions & 6 deletions docs/installation-fedora.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Installing farmr on Fedora

### Farmer/Full-node
1. Download [farmr-fedora-x86_64.rpm](https://github.com/joaquimguimaraes/farmr/releases/download/v1.5.1/farmr-fedora-x86_64.rpm) from the [latest release](https://github.com/joaquimguimaraes/farmr/releases/latest), open it and install it.
1. Download [farmr-fedora-x86_64.rpm](https://github.com/joaquimguimaraes/farmr/releases/download/v1.5.2/farmr-fedora-x86_64.rpm) from the [latest release](https://github.com/joaquimguimaraes/farmr/releases/latest), open it and install it.
3. Open the terminal and run: ```farmr```, once you see the main screen with your id and farmer stats you're good to go.
4. Link device to your discord account as shown in [First Time](./usage.md#First-time)

Expand All @@ -12,7 +12,7 @@ Read [Configuration](configuration.md) if you want to enable extra notifications
Read [Forks](forks.md) to learn how you can monitor farming other cryptocurrencies such as flax and chaingreen.

### Harvester
1. Download [farmr-fedora-x86_64.rpm](https://github.com/joaquimguimaraes/farmr/releases/download/v1.5.1/farmr-fedora-x86_64.rpm) from the [latest release](https://github.com/joaquimguimaraes/farmr/releases/latest), open it and install it.
1. Download [farmr-fedora-x86_64.rpm](https://github.com/joaquimguimaraes/farmr/releases/download/v1.5.2/farmr-fedora-x86_64.rpm) from the [latest release](https://github.com/joaquimguimaraes/farmr/releases/latest), open it and install it.
2. Open the terminal and run: ```farmr harvester```, once you see the main screen with your id and farmer stats you're good to go.
3. Link device to your discord account as shown in [First Time](./usage.md#First-time)

Expand All @@ -23,16 +23,16 @@ Read [Configuration](configuration.md) if you want to enable extra notifications
Read [Forks](forks.md) to learn how you can monitor harvesting other cryptocurrencies such as flax and chaingreen.

### FoxyPool Mode
1. Download [farmr-fedora-x86_64.rpm](https://github.com/joaquimguimaraes/farmr/releases/download/v1.5.1/farmr-fedora-x86_64.rpm) from the [latest release](https://github.com/joaquimguimaraes/farmr/releases/latest), open it and install it.
2. Open the terminal and run: ```farmr foxypoolog```, once you see the main screen with your id and farmer stats you're good to go.
1. Download [farmr-fedora-x86_64.rpm](https://github.com/joaquimguimaraes/farmr/releases/download/v1.5.2/farmr-fedora-x86_64.rpm) from the [latest release](https://github.com/joaquimguimaraes/farmr/releases/latest), open it and install it.
2. Open the terminal and run: ```farmr foxypoolog```/``farmr flexpool``, once you see the main screen with your id and farmer stats you're good to go.
3. Link device to your discord account as shown in [First Time](./usage.md#First-time)

farmr's files are installed to ``~/.farmr``

Lean how you can [enable FoxyPool balance](configuration.md#showing-foxypool-balance) or read [Configuration](configuration.md) if you want to enable extra notifications and statistics such as response times.
Lean how you can [enable FoxyPool balance](configuration.md#showing-foxypool-balance)/[enable Flexpool balance](configuration.md#showing-flexpool-balance) or read [Configuration](configuration.md) if you want to enable extra notifications and statistics such as response times.

### HPool Mode
1. Download [farmr-fedora-x86_64.rpm](https://github.com/joaquimguimaraes/farmr/releases/download/v1.5.1/farmr-fedora-x86_64.rpm) from the [latest release](https://github.com/joaquimguimaraes/farmr/releases/latest), open it and install it.
1. Download [farmr-fedora-x86_64.rpm](https://github.com/joaquimguimaraes/farmr/releases/download/v1.5.2/farmr-fedora-x86_64.rpm) from the [latest release](https://github.com/joaquimguimaraes/farmr/releases/latest), open it and install it.
2. Open the terminal and run: ```farmr hpool```, it will generate a template ``config-xch.json`` file in ``config`` directory and then it will show an error. This is expected since ``"HPool Directory"`` has not been set.
3. Edit ``config-xch.json`` in ``~/.farmr/config`` folder and set ``"HPool Directory"`` to the path where HPool is installed (there should be a file named ``config.yaml`` in this path).
4. Run ```farmr hpool``` again. Once you see the main screen with your id and stats you're good to go.
Expand Down
12 changes: 6 additions & 6 deletions docs/installation-ubuntu.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
(and other Debian-based distros)

### Farmer/Full-node
1. Download [farmr-ubuntu-x86_64.deb](https://github.com/joaquimguimaraes/farmr/releases/download/v1.5.1/farmr-ubuntu-x86_64.deb) from the [latest release](https://github.com/joaquimguimaraes/farmr/releases/latest), open it and install it.
1. Download [farmr-ubuntu-x86_64.deb](https://github.com/joaquimguimaraes/farmr/releases/download/v1.5.2/farmr-ubuntu-x86_64.deb) from the [latest release](https://github.com/joaquimguimaraes/farmr/releases/latest), open it and install it.
3. Open the terminal and run: ```farmr```, once you see the main screen with your id and farmer stats you're good to go.
4. Link device to your discord account as shown in [First Time](./usage.md#First-time)

Expand All @@ -13,7 +13,7 @@ Read [Configuration](configuration.md) if you want to enable extra notifications
Read [Forks](forks.md) to learn how you can monitor farming other cryptocurrencies such as flax and chaingreen.

### Harvester
1. Download [farmr-ubuntu-x86_64.deb](https://github.com/joaquimguimaraes/farmr/releases/download/v1.5.1/farmr-ubuntu-x86_64.deb) from the [latest release](https://github.com/joaquimguimaraes/farmr/releases/latest), open it and install it.
1. Download [farmr-ubuntu-x86_64.deb](https://github.com/joaquimguimaraes/farmr/releases/download/v1.5.2/farmr-ubuntu-x86_64.deb) from the [latest release](https://github.com/joaquimguimaraes/farmr/releases/latest), open it and install it.
2. Open the terminal and run: ```farmr harvester```, once you see the main screen with your id and farmer stats you're good to go.
3. Link device to your discord account as shown in [First Time](./usage.md#First-time)

Expand All @@ -24,16 +24,16 @@ Read [Configuration](configuration.md) if you want to enable extra notifications
Read [Forks](forks.md) to learn how you can monitor harvesting other cryptocurrencies such as flax and chaingreen.

### FoxyPool Mode
1. Download [farmr-ubuntu-x86_64.deb](https://github.com/joaquimguimaraes/farmr/releases/download/v1.5.1/farmr-ubuntu-x86_64.deb) from the [latest release](https://github.com/joaquimguimaraes/farmr/releases/latest), open it and install it.
2. Open the terminal and run: ```farmr foxypoolog```, once you see the main screen with your id and farmer stats you're good to go.
1. Download [farmr-ubuntu-x86_64.deb](https://github.com/joaquimguimaraes/farmr/releases/download/v1.5.2/farmr-ubuntu-x86_64.deb) from the [latest release](https://github.com/joaquimguimaraes/farmr/releases/latest), open it and install it.
2. Open the terminal and run: ```farmr foxypoolog```/``farmr flexpool``, once you see the main screen with your id and farmer stats you're good to go.
3. Link device to your discord account as shown in [First Time](./usage.md#First-time)

farmr's files are installed to ``~/.farmr``

Lean how you can [enable FoxyPool balance](configuration.md#showing-foxypool-balance) or read [Configuration](configuration.md) if you want to enable extra notifications and statistics such as response times.
Lean how you can [enable FoxyPool balance](configuration.md#showing-foxypool-balance)/[enable Flexpool balance](configuration.md#showing-flexpool-balance) or read [Configuration](configuration.md) if you want to enable extra notifications and statistics such as response times.

### HPool Mode
1. Download [farmr-ubuntu-x86_64.deb](https://github.com/joaquimguimaraes/farmr/releases/download/v1.5.1/farmr-ubuntu-x86_64.deb) from the [latest release](https://github.com/joaquimguimaraes/farmr/releases/latest), open it and install it.
1. Download [farmr-ubuntu-x86_64.deb](https://github.com/joaquimguimaraes/farmr/releases/download/v1.5.2/farmr-ubuntu-x86_64.deb) from the [latest release](https://github.com/joaquimguimaraes/farmr/releases/latest), open it and install it.
2. Open the terminal and run: ```farmr hpool```, it will generate a template ``config-xch.json`` file in ``config`` directory and then it will show an error. This is expected since ``"HPool Directory"`` has not been set.
3. Edit ``config-xch.json`` in ``~/.farmr/config`` folder and set ``"HPool Directory"`` to the path where HPool is installed (there should be a file named ``config.yaml`` in this path).
4. Run ```farmr hpool``` again. Once you see the main screen with your id and stats you're good to go.
Expand Down
14 changes: 7 additions & 7 deletions docs/installation-ubuntupi.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
(and other Debian-based distros)

### Farmer/Full-node
1. Download [farmr-ubuntu-aarch64.deb](https://github.com/joaquimguimaraes/farmr/releases/download/v1.5.1/farmr-ubuntu-aarch64.deb) from the [latest release](https://github.com/joaquimguimaraes/farmr/releases/latest), open it and install it.
1. Download [farmr-ubuntu-aarch64.deb](https://github.com/joaquimguimaraes/farmr/releases/download/v1.5.2/farmr-ubuntu-aarch64.deb) from the [latest release](https://github.com/joaquimguimaraes/farmr/releases/latest), open it and install it.
3. Open the terminal and run: ```farmr```, once you see the main screen with your id and farmer stats you're good to go.
4. Link device to your discord account as shown in [First Time](./usage.md#First-time)

Expand All @@ -13,7 +13,7 @@ Read [Configuration](configuration.md) if you want to enable extra notifications
Read [Forks](forks.md) to learn how you can monitor farming other cryptocurrencies such as flax and chaingreen.

### Harvester
1. Download [farmr-ubuntu-aarch64.deb](https://github.com/joaquimguimaraes/farmr/releases/download/v1.5.1/farmr-ubuntu-aarch64.deb) from the [latest release](https://github.com/joaquimguimaraes/farmr/releases/latest), open it and install it.
1. Download [farmr-ubuntu-aarch64.deb](https://github.com/joaquimguimaraes/farmr/releases/download/v1.5.2/farmr-ubuntu-aarch64.deb) from the [latest release](https://github.com/joaquimguimaraes/farmr/releases/latest), open it and install it.
2. Open the terminal and run: ```farmr harvester```, once you see the main screen with your id and farmer stats you're good to go.
3. Link device to your discord account as shown in [First Time](./usage.md#First-time)

Expand All @@ -23,17 +23,17 @@ Read [Configuration](configuration.md) if you want to enable extra notifications

Read [Forks](forks.md) to learn how you can monitor harvesting other cryptocurrencies such as flax and chaingreen.

### FoxyPool Mode
1. Download [farmr-ubuntu-aarch64.deb](https://github.com/joaquimguimaraes/farmr/releases/download/v1.5.1/farmr-ubuntu-aarch64.deb) from the [latest release](https://github.com/joaquimguimaraes/farmr/releases/latest), open it and install it.
2. Open the terminal and run: ```farmr foxypoolog```, once you see the main screen with your id and farmer stats you're good to go.
### FoxyPool/Flexpool Mode
1. Download [farmr-ubuntu-aarch64.deb](https://github.com/joaquimguimaraes/farmr/releases/download/v1.5.2/farmr-ubuntu-aarch64.deb) from the [latest release](https://github.com/joaquimguimaraes/farmr/releases/latest), open it and install it.
2. Open the terminal and run: ```farmr foxypoolog```/``farmr flexpool``, once you see the main screen with your id and farmer stats you're good to go.
3. Link device to your discord account as shown in [First Time](./usage.md#First-time)

farmr's files are installed to ``~/.farmr``

Lean how you can [enable FoxyPool balance](configuration.md#showing-foxypool-balance) or read [Configuration](configuration.md) if you want to enable extra notifications and statistics such as response times.
Lean how you can [enable FoxyPool balance](configuration.md#showing-foxypool-balance)/[enable Flexpool balance](configuration.md#showing-flexpool-balance) or read [Configuration](configuration.md) if you want to enable extra notifications and statistics such as response times.

### HPool Mode
1. Download [farmr-ubuntu-aarch64.deb](https://github.com/joaquimguimaraes/farmr/releases/download/v1.5.1/farmr-ubuntu-aarch64.deb) from the [latest release](https://github.com/joaquimguimaraes/farmr/releases/latest), open it and install it.
1. Download [farmr-ubuntu-aarch64.deb](https://github.com/joaquimguimaraes/farmr/releases/download/v1.5.2/farmr-ubuntu-aarch64.deb) from the [latest release](https://github.com/joaquimguimaraes/farmr/releases/latest), open it and install it.
2. Open the terminal and run: ```farmr hpool```, it will generate a template ``config-xch.json`` file in ``config`` directory and then it will show an error. This is expected since ``"HPool Directory"`` has not been set.
3. Edit ``config-xch.json`` in ``~/.farmr/config`` folder and set ``"HPool Directory"`` to the path where HPool is installed (there should be a file named ``config.yaml`` in this path).
4. Run ```farmr hpool``` again. Once you see the main screen with your id and stats you're good to go.
Expand Down
14 changes: 7 additions & 7 deletions docs/installation-windows.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Installing farmr on Windows

### Farmer/Full-node
1. Download [farmr-windows-x64.zip](https://github.com/joaquimguimaraes/farmr/releases/download/v1.5.1/farmr-windows-x64.zip) from the [latest release](https://github.com/joaquimguimaraes/farmr/releases/latest) and extract it to an **empty** folder.
1. Download [farmr-windows-x64.zip](https://github.com/joaquimguimaraes/farmr/releases/download/v1.5.2/farmr-windows-x64.zip) from the [latest release](https://github.com/joaquimguimaraes/farmr/releases/latest) and extract it to an **empty** folder.
2. Open ``farmer.exe``, once you see the main screen with your id and farmer stats you're good to go.
3. Link device to your discord account as shown in [First Time](./usage.md#First-time)

Expand All @@ -10,23 +10,23 @@ Read [Configuration](configuration.md) if you want to enable extra notifications
Read [Forks](forks.md) to learn how you can monitor farming other cryptocurrencies such as flax and chaingreen.

### Harvester
1. Download [farmr-windows-x64.zip](https://github.com/joaquimguimaraes/farmr/releases/download/v1.5.1/farmr-windows-x64.zip) from the [latest release](https://github.com/joaquimguimaraes/farmr/releases/latest) and extract it to an **empty** folder.
1. Download [farmr-windows-x64.zip](https://github.com/joaquimguimaraes/farmr/releases/download/v1.5.2/farmr-windows-x64.zip) from the [latest release](https://github.com/joaquimguimaraes/farmr/releases/latest) and extract it to an **empty** folder.
2. Open ``harvester.exe``, once you see the main screen with your id and harvester stats you're good to go.
3. Link device to your discord account as shown in [First Time](./usage.md#First-time)

Read [Configuration](configuration.md) if you want to enable extra notifications and statistics such as response times.

Read [Forks](forks.md) to learn how you can monitor harvesting other cryptocurrencies such as flax and chaingreen.

### FoxyPool Mode
1. Download [farmr-windows-x64.zip](https://github.com/joaquimguimaraes/farmr/releases/download/v1.5.1/farmr-windows-x64.zip) from the [latest release](https://github.com/joaquimguimaraes/farmr/releases/latest) and extract it to an **empty** folder.
2. Open ``foxypoolog.exe``, once you see the main screen with your id and farmer stats you're good to go.
### FoxyPool/Flexpool Mode
1. Download [farmr-windows-x64.zip](https://github.com/joaquimguimaraes/farmr/releases/download/v1.5.2/farmr-windows-x64.zip) from the [latest release](https://github.com/joaquimguimaraes/farmr/releases/latest) and extract it to an **empty** folder.
2. Open ``foxypoolog.exe``/``flexpool.exe``, once you see the main screen with your id and farmer stats you're good to go.
3. Link device to your discord account as shown in [First Time](./usage.md#First-time)

Lean how you can [enable FoxyPool balance](configuration.md#showing-foxypool-balance) or read [Configuration](configuration.md) if you want to enable extra notifications and statistics such as response times.
Lean how you can [enable FoxyPool balance](configuration.md#showing-foxypool-balance)/[enable Flexpool balance](configuration.md#showing-flexpool-balance) or read [Configuration](configuration.md) if you want to enable extra notifications and statistics such as response times.

### HPool Mode
1. Download [farmr-windows-x64.zip](https://github.com/joaquimguimaraes/farmr/releases/download/v1.5.1/farmr-windows-x64.zip) from the [latest release](https://github.com/joaquimguimaraes/farmr/releases/latest) and extract it to an **empty** folder.
1. Download [farmr-windows-x64.zip](https://github.com/joaquimguimaraes/farmr/releases/download/v1.5.2/farmr-windows-x64.zip) from the [latest release](https://github.com/joaquimguimaraes/farmr/releases/latest) and extract it to an **empty** folder.
2. Open ``hpool.exe``, it will generate a template ``config-xch.json`` file in ``config`` directory and then it will show an error. This is expected since ``"HPool Directory"`` has not been set.
3. Edit ``config-xch.json`` in ``config`` folder and set ``"HPool Directory"`` to the path where HPool is installed (there should be a file named ``config.yaml`` in this path).
4. Open ``hpool.exe`` again. Once you see the main screen with your id and stats you're good to go.
Expand Down

0 comments on commit 4f50d9d

Please sign in to comment.