new content for inca docs
This commit is contained in:
Mik-TF
parent
ca63ac2ebe
commit
0c625ea869
@ -18,8 +18,28 @@ export default defineConfig({
|
||||
],
|
||||
},
|
||||
{
|
||||
label: 'Reference',
|
||||
autogenerate: { directory: 'reference' },
|
||||
label: 'INCA Nodes',
|
||||
items: [
|
||||
// Each item here is one entry in the navigation menu.
|
||||
{ label: 'Get INCA Nodes', link: '/inca_nodes/get_inca_nodes/' },
|
||||
{ label: 'Set Up INCA Nodes', link: '/inca_nodes/set_up_inca_nodes/' },
|
||||
{ label: 'Manage Rewards', link: '/inca_nodes/manage_rewards/' },
|
||||
],
|
||||
},
|
||||
{
|
||||
label: 'Resources',
|
||||
items: [
|
||||
// Each item here is one entry in the navigation menu.
|
||||
{ label: 'Node Status bot', link: '/resources/node_status_bot/' },
|
||||
{ label: 'Farmerbot', link: '/resources/farmerbot/' },
|
||||
],
|
||||
},
|
||||
{
|
||||
label: 'References',
|
||||
items: [
|
||||
// Each item here is one entry in the navigation menu.
|
||||
{ label: 'Glossary', link: '/references/glossary/' },
|
||||
],
|
||||
},
|
||||
],
|
||||
}),
|
||||
|
||||
@ -1 +1,36 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128"><path fill-rule="evenodd" d="M81 36 64 0 47 36l-1 2-9-10a6 6 0 0 0-9 9l10 10h-2L0 64l36 17h2L28 91a6 6 0 1 0 9 9l9-10 1 2 17 36 17-36v-2l9 10a6 6 0 1 0 9-9l-9-9 2-1 36-17-36-17-2-1 9-9a6 6 0 1 0-9-9l-9 10v-2Zm-17 2-2 5c-4 8-11 15-19 19l-5 2 5 2c8 4 15 11 19 19l2 5 2-5c4-8 11-15 19-19l5-2-5-2c-8-4-15-11-19-19l-2-5Z" clip-rule="evenodd"/><path d="M118 19a6 6 0 0 0-9-9l-3 3a6 6 0 1 0 9 9l3-3Zm-96 4c-2 2-6 2-9 0l-3-3a6 6 0 1 1 9-9l3 3c3 2 3 6 0 9Zm0 82c-2-2-6-2-9 0l-3 3a6 6 0 1 0 9 9l3-3c3-2 3-6 0-9Zm96 4a6 6 0 0 1-9 9l-3-3a6 6 0 1 1 9-9l3 3Z"/><style>path{fill:#000}@media (prefers-color-scheme:dark){path{fill:#fff}}</style></svg>
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
|
||||
<!-- License: CC Attribution. Made by Smarticons: https://github.com/frexy/glyph-iconset -->
|
||||
<svg width="800px" height="800px" viewBox="0 0 25 25" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" class="si-glyph si-glyph-network">
|
||||
|
||||
<title>91</title>
|
||||
|
||||
<defs>
|
||||
|
||||
</defs>
|
||||
<g stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
|
||||
<g fill="#434343">
|
||||
<path d="M11.783,10.094 C10.084,11.092 8.017,11.778 6.105,12.044 C5.993,12.432 5.751,12.762 5.421,12.978 C5.933,14.071 6.67,15.065 7.56,15.965 C10.072,16.085 12.601,15.027 14.262,12.891 C14.291,12.853 14.317,12.811 14.345,12.772 C14.101,11.858 13.697,10.988 13.2,10.128 C13.11,10.154 13.024,10.174 12.939,10.19 C12.796,10.23 12.648,10.258 12.493,10.258 C12.238,10.258 12,10.196 11.783,10.094 L11.783,10.094 Z" class="si-glyph-fill">
|
||||
|
||||
</path>
|
||||
<path d="M9.051,5.492 C8.409,5.025 7.735,4.607 7.047,4.236 C6.795,4.84 6.199,5.263 5.502,5.263 C5.377,5.263 5.257,5.247 5.14,5.221 C4.733,6.756 4.516,8.383 4.629,9.915 C5.393,9.973 6.011,10.532 6.149,11.269 C7.844,10.99 9.619,10.39 11.116,9.531 C10.93,9.26 10.819,8.934 10.819,8.582 C10.819,8.169 10.975,7.796 11.222,7.504 C10.568,6.768 9.833,6.061 9.051,5.492 L9.051,5.492 Z" class="si-glyph-fill">
|
||||
|
||||
</path>
|
||||
<path d="M4,9.989 C3.863,8.355 4.104,6.597 4.541,4.957 C4.111,4.653 3.828,4.155 3.828,3.588 C3.828,3.391 3.867,3.202 3.932,3.026 C3.276,2.904 2.618,2.828 1.958,2.779 C1.869,2.883 1.773,2.983 1.689,3.093 C-0.04,5.317 -0.405,8.165 0.459,10.64 C1.23,10.969 2.025,11.187 2.856,11.306 C2.959,10.681 3.408,10.178 4,9.989 L4,9.989 Z" class="si-glyph-fill">
|
||||
|
||||
</path>
|
||||
<path d="M13.928,9.689 C13.899,9.726 13.864,9.756 13.832,9.789 C14.265,10.525 14.631,11.271 14.885,12.057 C16.002,10.167 16.256,7.958 15.717,5.935 C15.627,6.068 15.541,6.202 15.446,6.331 C15.01,6.932 14.571,7.548 14.092,8.103 C14.137,8.255 14.168,8.414 14.168,8.582 L14.168,8.586 C14.252,8.96 14.181,9.365 13.928,9.689 L13.928,9.689 Z" class="si-glyph-fill">
|
||||
|
||||
</path>
|
||||
<path d="M7.164,3.447 C7.963,3.861 8.748,4.345 9.494,4.887 C10.334,5.498 11.121,6.26 11.818,7.051 C12.025,6.959 12.252,6.906 12.494,6.906 C12.994,6.906 13.439,7.131 13.746,7.478 C14.15,6.986 14.529,6.456 14.907,5.938 C15.101,5.67 15.279,5.395 15.451,5.118 C14.945,3.807 14.097,2.612 12.909,1.687 C11.364,0.485 9.515,-0.057 7.701,0.012 C7.586,0.158 7.472,0.302 7.362,0.451 C6.961,1.003 6.623,1.531 6.322,2.088 C6.361,2.117 6.386,2.154 6.422,2.188 C6.839,2.464 7.119,2.922 7.164,3.447 L7.164,3.447 Z" class="si-glyph-fill">
|
||||
|
||||
</path>
|
||||
<path d="M2.879,11.965 C2.168,11.867 1.477,11.719 0.809,11.478 C1.328,12.553 2.087,13.531 3.094,14.314 C4.16,15.143 5.371,15.657 6.615,15.875 C5.893,15.058 5.303,14.169 4.862,13.215 C4.747,13.239 4.628,13.255 4.505,13.255 C3.713,13.254 3.054,12.703 2.879,11.965 L2.879,11.965 Z" class="si-glyph-fill">
|
||||
|
||||
</path>
|
||||
<path d="M4.514,2.242 C4.825,1.9 5.277,1.753 5.713,1.826 C6.025,1.24 6.377,0.683 6.794,0.104 C5.236,0.342 3.752,1.04 2.547,2.166 C3.137,2.232 3.723,2.306 4.308,2.418 C4.371,2.354 4.441,2.297 4.514,2.242 L4.514,2.242 Z" class="si-glyph-fill">
|
||||
|
||||
</path>
|
||||
</g>
|
||||
</g>
|
||||
</svg>
|
||||
|
Before Width: | Height: | Size: 696 B After Width: | Height: | Size: 3.2 KiB |
@ -0,0 +1,10 @@
|
||||
---
|
||||
title: Get Started
|
||||
description: Earn INCA rewards by hosting nodes
|
||||
---
|
||||
|
||||
Earn INCA rewards by hosting nodes
|
||||
|
||||
## Get a Node
|
||||
|
||||
- Visit the official INCA website to [get INCA nodes](https://internetcapacity.org/)
|
||||
@ -0,0 +1,10 @@
|
||||
---
|
||||
title: Get Started
|
||||
description: Earn INCA rewards by hosting nodes
|
||||
---
|
||||
|
||||
Earn INCA rewards by hosting nodes
|
||||
|
||||
## Get a Node
|
||||
|
||||
- Visit the official INCA website to [get INCA nodes](https://internetcapacity.org/)
|
||||
@ -8,7 +8,7 @@ hero:
|
||||
file: ../../assets/hero_host3.png
|
||||
actions:
|
||||
- text: Get Started
|
||||
link: /guides/getstarted/
|
||||
link: /start_here/getting_started/
|
||||
icon: right-arrow
|
||||
variant: primary
|
||||
- text: Visit the website
|
||||
@ -22,15 +22,15 @@ import { Card, CardGrid } from '@astrojs/starlight/components';
|
||||
|
||||
<CardGrid stagger>
|
||||
<Card title="Learn about INCA" icon="open-book">
|
||||
Read the [INCA Docs](/guides/getstarted) to learn about the ecosystem.
|
||||
Read the [INCA Docs](/start_here/getting_started) to learn how to set up your INCA nodes and to know more about the ThreeFold ecosystem.
|
||||
</Card>
|
||||
<Card title="Get INCA Nodes" icon="laptop">
|
||||
You can get INCA nodes at the [official INCA website](https://internetcapacity.org/farming/).
|
||||
Get INCA nodes at the [official INCA website](https://internetcapacity.org/farming/) to provide compute, storage and network resources to the world.
|
||||
</Card>
|
||||
<Card title="Part of a Worldwide Grid" icon="sun">
|
||||
Project INCA is the fourth version of the [ThreeFold Grid](https://threefold.io/) available in 60+ countries!
|
||||
Project INCA is the fourth version of the [ThreeFold Grid](https://threefold.io/) available in 60+ countries with thousands of nodes!
|
||||
</Card>
|
||||
<Card title="Earn INCA Rewards" icon="star">
|
||||
When you deploy INCA nodes, you contribute to the growth of the grid and earn INCA rewards!
|
||||
When you deploy INCA nodes, you contribute to the growth of the ThreeFold Grid and earn INCA rewards!
|
||||
</Card>
|
||||
</CardGrid>
|
||||
|
||||
@ -1,11 +0,0 @@
|
||||
---
|
||||
title: Example Reference
|
||||
description: A reference page in my new Starlight docs site.
|
||||
---
|
||||
|
||||
Reference pages are ideal for outlining how things work in terse and clear terms.
|
||||
Less concerned with telling a story or addressing a specific use case, they should give a comprehensive outline of what you're documenting.
|
||||
|
||||
## Further reading
|
||||
|
||||
- Read [about reference](https://diataxis.fr/reference/) in the Diátaxis framework
|
||||
35
docs_projectinca/src/content/docs/references/glossary.md
Normal file
35
docs_projectinca/src/content/docs/references/glossary.md
Normal file
@ -0,0 +1,35 @@
|
||||
---
|
||||
title: Glossary
|
||||
description: Glossary of terms from the INCA ecosystem
|
||||
---
|
||||
|
||||
## Introduction
|
||||
|
||||
We provide a glossary of terms that you may encounter while reading on the INCA ecosystem.
|
||||
|
||||
## Terms and Definitions
|
||||
|
||||
### Compute
|
||||
|
||||
Compute refers to the processing power and resources required to perform calculations, execute instructions, and complete tasks. In computing, compute resources include central processing units (CPUs), graphics processing units (GPUs), and other processing units that execute software instructions.
|
||||
### Network
|
||||
|
||||
A network is a collection of interconnected devices, such as computers, servers, and peripherals, that communicate with each other to share resources and exchange data. Networks can be wired or wireless and can range from small local area networks (LANs) to large-scale wide area networks (WANs) and the internet.
|
||||
### Storage
|
||||
|
||||
Storage refers to the holding and preservation of data in a digital form. This can include hard disk drives, solid-state drives, flash drives, and other devices that store data. Storage can be local, such as on a personal computer, or remote, such as in a cloud-based storage service.
|
||||
### Cloud
|
||||
|
||||
Cloud refers to a model of delivering computing services over the internet, where resources such as servers, storage, and applications are provided as a service to users on-demand. Cloud computing allows users to access and use computing resources without having to manage or maintain the underlying infrastructure.
|
||||
### DePIN
|
||||
|
||||
A DePIN (Decentralized Physical Infrastructure Network) is a protocol that uses cryptocurrency tokens to incentivize communities to build and maintain physical infrastructure networks in a decentralized manner. These networks can range from wireless and sensor networks to energy networks and cloud storage.
|
||||
### Blockchain
|
||||
|
||||
Blockchain is a decentralized, distributed ledger technology that enables secure, transparent, and tamper-proof transactions. It is the underlying technology behind cryptocurrencies such as Bitcoin and Ethereum, but it also has applications in supply chain management, smart contracts, and other areas.
|
||||
### Operating System
|
||||
|
||||
An operating system (OS) is a software that manages and controls a computer's hardware and software resources. It acts as an intermediary between computer hardware and user-level applications, providing services such as process management, memory management, and input/output management. Examples of operating systems include Windows, macOS, and Linux.
|
||||
### End-to-End Encryption
|
||||
|
||||
End-to-end encryption is a method of secure communication where only the communicating parties can read the messages. It ensures that data is encrypted at the sender's end and decrypted at the receiver's end, making it unreadable to anyone intercepting the data in transit. This provides a high level of security and privacy for online communications.
|
||||
273
docs_projectinca/src/content/docs/resources/farmerbot.md
Normal file
273
docs_projectinca/src/content/docs/resources/farmerbot.md
Normal file
@ -0,0 +1,273 @@
|
||||
---
|
||||
title: Farmerbot
|
||||
description: How to use the Farmerbot
|
||||
---
|
||||
|
||||
## Introduction
|
||||
|
||||
In this guide, we show how to deploy the [Farmerbot](https://github.com/threefoldtech/tfgrid-sdk-go/tree/development/farmerbot) on a full VM running on the TFGrid.
|
||||
|
||||
This guide can be done on bare metal or on a full VM running on the TFGrid. You need at least two 3Nodes on the same farm to make use of the Farmerbot.
|
||||
|
||||
This version of the Farmerbot also works with ARM64. This means that if you have a Pi 3, 4, or Zero 2 with a 64 bit OS, you can download the appropriate release archive and it will work properly.
|
||||
|
||||
Read the [Additional Information](farmerbot_information.md) section for further details concerning the Farmerbot.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- The TFChain account associated with the farm should have at least 5 TFT (recommended is 50 TFT)
|
||||
|
||||
## Farmerbot Costs on the TFGrid
|
||||
|
||||
If you run the Farmerbot on a 3Node on the TFGrid, you will have to pay TFT to deploy on that 3Node. You can run a full VM at minimum specs for the Farmerbot, that is 1vcore, 15GB of SSD storage and 512MB of RAM. Note that you can use the Planetary Network. You do not need to deploy a 3Node with IPv4. The cost on main net for this kind of workload is around 0.175TFT/hour (as of the date 11-07-23).
|
||||
|
||||
Next to that, you will have to pay the transaction fees every time the Farmerbot has to wake up or shut down a node. This means that you need some TFT on the account tied to the twin of your farm.
|
||||
|
||||
For the periodic wakeups, each node in the farm is shut down and powered on once a day, i.e. 30 times per month. Also, there is 10 random wakeups per month for each node. This means that each node is turned off and on 40 times per month in average. In that case, the average cost per month to power on nodes and shut them back down equals:
|
||||
|
||||
> average transaction fees cost per month = 0.001 TFT (extrinsic fee) * amount of nodes * 40 * 2 (1 for powering down, one for powering up)
|
||||
|
||||
## Enable Wake-On-Lan
|
||||
|
||||
For a 3Node to work properly with the Farmerbot, the parameter wake-on-lan must be enabled. Enabling wake-on-lan on your 3Node may differ depending on your computer model. Please refer to the documentation of your computer if needed.
|
||||
|
||||
Usually the feature will be called Wake-on-Lan and you need to set it as "enabled" in the BIOS/UEFI settings.
|
||||
|
||||
Here are some examples to guide you:
|
||||
|
||||
* Racker Server, Dell R720
|
||||
* Go into `System Setup -> Device Settings -> NIC Port -> NIC Configuration`
|
||||
* Set Wake-on-Lan to `Enable`
|
||||
* Desktop Computer, HP EliteDesk G1
|
||||
* Go to Power -> Hardware Power Management
|
||||
* Disable `S5 Maximum Power Saving`
|
||||
* Go to `Advanced -> Power-On Options`
|
||||
* Set `Remote Wake up Boot source` to `Remote Server`
|
||||
|
||||
> Hint: Check the Z-OS monitor screen and make sure that all the 3Nodes are within the same lan (e.g. all 3Nodes addresses are between 192.168.15.00 and 192.168.15.255).
|
||||
|
||||
For more information on WOL, [read this section](farmerbot_information.md#how-to-prepare-your-farm-for-the-farmerbot-with-wol).
|
||||
|
||||
## Deploy a Full VM
|
||||
|
||||
For this guide, we run the Farmerbot on a Full VM running on the TFGrid. Note that while you do not need to run the Farmerbot on the TFGrid, the whole process is very simple as presented here.
|
||||
|
||||
- Deploy a full VM on the TFGrid
|
||||
- Update and upgrade the VM
|
||||
```
|
||||
apt update && apt upgrade
|
||||
```
|
||||
- Reboot and reconnect to the VM
|
||||
```
|
||||
reboot
|
||||
```
|
||||
|
||||
## Farmerbot Setup
|
||||
|
||||
We present the different steps to run the Farmerbot using the binaries.
|
||||
|
||||
> For a script that can help automate the steps in this guide, [check this forum post](https://forum.threefold.io/t/new-farmerbot-install-script/4207).
|
||||
|
||||
### Download the Farmerbot Binaries
|
||||
|
||||
- Download the latest [ThreeFold tfgrid-sdk-go release](https://github.com/threefoldtech/tfgrid-sdk-go/releases) and extract the farmerbot for your specific setup (here we use `x86_64`). On the line `wget ...`, make sure to replace `<latest_release>` with the latest Farmerbot release.
|
||||
```
|
||||
wget https://github.com/threefoldtech/tfgrid-sdk-go/releases/download/<latest_release>/tfgrid-sdk-go_Linux_x86_64.tar.gz
|
||||
tar xf tfgrid-sdk-go_Linux_x86_64.tar.gz farmerbot
|
||||
```
|
||||
- Move the Farmerbot
|
||||
```
|
||||
mv farmerbot /usr/local/bin
|
||||
```
|
||||
- Remove the tar file
|
||||
```
|
||||
rm tfgrid-sdk-go_Linux_x86_64.tar.gz
|
||||
```
|
||||
|
||||
### Create the Farmerbot Files
|
||||
|
||||
- Create Farmerbot files directory
|
||||
```
|
||||
cd ~
|
||||
mkdir farmerbotfiles
|
||||
```
|
||||
- Create the Farmerbot `config.yml` file ([see template below](#configuration-file-template-configyml))
|
||||
```
|
||||
nano ~/farmerbotfiles/config.yml
|
||||
```
|
||||
- Create the environment variables file and set the variables ([see template below](#environment-variables-file-template-env))
|
||||
```
|
||||
nano ~/farmerbotfiles/.env
|
||||
```
|
||||
|
||||
### Run the Farmerbot
|
||||
|
||||
We run the Farmerbot with the following command:
|
||||
|
||||
```
|
||||
farmerbot run -e ~/farmerbotfiles/.env -c ~/farmerbotfiles/config.yml -d
|
||||
```
|
||||
|
||||
For farmers with **ed25519** keys, the flag `-k` should be used. Note that by default, the Farmerbot uses the **sr25519** keys.
|
||||
|
||||
```
|
||||
farmerbot run -k ed25519 -e ~/farmerbotfiles/.env -c ~/farmerbotfiles/config.yml -d
|
||||
```
|
||||
|
||||
For more information on the supported commands, the [Additional Information section](farmerbot_information.md#supported-commands-and-flags). You can also consult the [Farmerbot repository](https://github.com/threefoldtech/tfgrid-sdk-go/tree/development/farmerbot).
|
||||
|
||||
Once you've verified that the Farmerbot runs properly, you can stop the Farmerbot and go to the next section to set a Farmerbot service. This step will ensure the Farmerbot keeps running after exiting the VM.
|
||||
|
||||
### Set a systemd Service
|
||||
|
||||
It is highly recommended to set a Ubuntu systemd service to keep the Farmerbot running after exiting the VM.
|
||||
|
||||
* Create the service file
|
||||
* ```
|
||||
nano /etc/systemd/system/farmerbot.service
|
||||
```
|
||||
* Set the Farmerbot systemd service
|
||||
|
||||
```
|
||||
[Unit]
|
||||
Description=ThreeFold Farmerbot
|
||||
StartLimitIntervalSec=0
|
||||
|
||||
[Service]
|
||||
Restart=always
|
||||
RestartSec=5
|
||||
StandardOutput=append:/root/farmerbotfiles/farmerbot.log
|
||||
StandardError=append:/root/farmerbotfiles/farmerbot.log
|
||||
ExecStart=/usr/local/bin/farmerbot run -e /root/farmerbotfiles/.env -c /root/farmerbotfiles/config.yml -d
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
```
|
||||
* Enable the Farmerbot service
|
||||
```
|
||||
systemctl daemon-reload
|
||||
systemctl enable farmerbot
|
||||
systemctl start farmerbot
|
||||
```
|
||||
* Verify that the Farmerbot service is properly running
|
||||
```
|
||||
systemctl status farmerbot
|
||||
```
|
||||
|
||||
### Check the Farmerbot Logs
|
||||
|
||||
Once you've set a Farmerbot systemd service [as show above](#set-a-systemd-service), the Farmerbot will start writing logs to the file `farmerbot.log` in the directory `farmerbotfiles`.
|
||||
|
||||
Thus, you can get more details on the operation of the Farmerbot by inspecting the log file. This can also be used to see the **Farmerbot Report Table** as this table is printed in the Farmerbot log.
|
||||
|
||||
* See all logs so far
|
||||
```
|
||||
cat ~/farmerbotfiles/farmerbot.log
|
||||
```
|
||||
* See the last ten lines and new logs as they are generated
|
||||
```
|
||||
tail -f ~/farmerbotfiles/farmerbot.log
|
||||
```
|
||||
* See all logs and new lines as they are generated
|
||||
```
|
||||
tail -f -n +1 ~/farmerbotfiles/farmerbot.log
|
||||
```
|
||||
* See the last report table
|
||||
```
|
||||
tac ~/farmerbotfiles/farmerbot.log | grep -B5000 -m1 "Nodes report" | tac
|
||||
```
|
||||
|
||||
### Stop the Farmerbot
|
||||
|
||||
You can stop the farmerbot with the following command:
|
||||
|
||||
```
|
||||
systemctl stop farmerbot
|
||||
```
|
||||
|
||||
After stopping the farmerbot, any nodes in standby mode will remain in standby. To bring them online, use this command:
|
||||
|
||||
```
|
||||
farmerbot start all -e /root/farmerbotfiles/.env --farm <farm_id>
|
||||
```
|
||||
|
||||
## Farmerbot Files
|
||||
|
||||
### Configuration File Template (config.yml)
|
||||
|
||||
In this example, the farm ID is 1, we are setting the Farmerbot with 4 nodes and the node 1 never shuts down, we set a periodic wakeup at 1:00PM.
|
||||
|
||||
Note that the timezone of the farmerbot will be the same as the time zone of the machine the farmerbot running inside. By default, a full VM on the TFGrid will be set in UTC.
|
||||
|
||||
```
|
||||
farm_id: 1
|
||||
included_nodes:
|
||||
- 1
|
||||
- 2
|
||||
- 3
|
||||
- 4
|
||||
never_shutdown_nodes:
|
||||
- 1
|
||||
power:
|
||||
periodic_wake_up_start: 01:00PM
|
||||
```
|
||||
|
||||
Note that if the user wants to include all the nodes within a farm, they can simply omit the `included_nodes` section. In this case, all nodes of the farm will be included in the Farmerbot, as shown in the example below. If you are proceeding like this, make sure that you don't have any unused node IDs on your farm, as the Farmerbot would try to wake up nodes that aren't running anymore on the grid.
|
||||
|
||||
```
|
||||
farm_id: 1
|
||||
never_shutdown_nodes:
|
||||
- 1
|
||||
power:
|
||||
periodic_wake_up_start: 01:00PM
|
||||
```
|
||||
|
||||
For more information on the configuration file, refer to the [Additional Information section](farmerbot_information.md#yaml-configuration-file-template).
|
||||
|
||||
You can also consult the [Farmerbot repository](https://github.com/threefoldtech/tfgrid-sdk-go/tree/development/farmerbot).
|
||||
|
||||
### Environment Variables File Template (.env)
|
||||
|
||||
The network can be either `main`, `tets`, `dev` or `qa`. The following example is with the main network.
|
||||
|
||||
```
|
||||
MNEMONIC_OR_SEED="word1 word2 word3 ... word12"
|
||||
NETWORK="main"
|
||||
```
|
||||
|
||||
## Running Multiple Farmerbots on the Same VM
|
||||
|
||||
You can run multiple instances of the Farmerbot on the same VM.
|
||||
|
||||
To do so, you need to create a directory for each instance of the Farmerbot. Each directory should contain the configuration and variables files as shown above. Once you've set the files, you can simply execute the Farmerbot `run` command to start each bot in each directory.
|
||||
|
||||
It's recommended to use distinct names for the directories and the services to easily differentiate the multiple farmerbots running on the VM.
|
||||
|
||||
For example, the directory tree of two Farmerbots could be:
|
||||
|
||||
```
|
||||
└── farmerbotfiles
|
||||
├── farmerbot1
|
||||
│ ├── .env
|
||||
│ └── config.yml
|
||||
└── farmerbot2
|
||||
├── .env
|
||||
└── config.yml
|
||||
```
|
||||
|
||||
For example, the services of two Farmerbots could be named as follows:
|
||||
|
||||
```
|
||||
farmerbot1.service
|
||||
farmerbot2.service
|
||||
```
|
||||
|
||||
## Questions and Feedback
|
||||
|
||||
This guide is meant to get you started quickly with the Farmerbot. That being said, there is a lot more that can be done with the Farmerbot.
|
||||
|
||||
For more information on the Farmerbot, please refer to the [Additional Information section](./farmerbot_information.md). You can also consult the [official Farmerbot Go repository](https://github.com/threefoldtech/tfgrid-sdk-go/tree/development/farmerbot).
|
||||
|
||||
If you have any questions, you can ask the ThreeFold community for help on the [ThreeFold Forum](https://forum.threefold.io/) or on the [ThreeFold Farmers Chat](https://t.me/threefoldfarmers) on Telegram.
|
||||
|
||||
> This is the new version of the Farmerbot written in Go. If you have any feedback and issues, please let us know!
|
||||
115
docs_projectinca/src/content/docs/resources/node_status_bot.md
Normal file
115
docs_projectinca/src/content/docs/resources/node_status_bot.md
Normal file
@ -0,0 +1,115 @@
|
||||
---
|
||||
title: Node Status Bot
|
||||
description: How to use the Node Status bot
|
||||
---
|
||||
|
||||
## Introduction
|
||||
|
||||
We present the [Node Status Bot](https://t.me/tfnodestatusbot) and how to use it.
|
||||
|
||||
The Node Status Bot is a very helpful tool for farmers of the ThreeFold Grid. It can give you relevant information on your node status, notify you if the node status changes and also provide information on minting violations.
|
||||
|
||||
You can find the bot source code on GitHub [here](https://github.com/threefoldfoundation/node-status-bot).
|
||||
|
||||
## Disclaimer
|
||||
|
||||
Note that the bot is developed and operated on a best effort basis. You are responsible for your nodes' uptime and your farming rewards.
|
||||
|
||||
## Getting Started with the Bot
|
||||
|
||||
To get started with the bot, simply go to the [bot link on Telegram](https://t.me/tfnodestatusbot) and hit the start button to begin interacting with the bot.
|
||||
|
||||
You can get the real time status of a node with the status command. For example, this gives the status of node 42
|
||||
|
||||
```
|
||||
/status 42
|
||||
```
|
||||
|
||||
The bot can also send you a message when the status of a node changes. Use the subscribe command (or sub for short) to begin alerts for one or more nodes. Here we are subscribing to nodes 1, 2, and 3:
|
||||
|
||||
```
|
||||
/sub 1 2 3
|
||||
```
|
||||
|
||||
Once you have subscribed you can issue the status command with no input to get the current status of the nodes you are subscribed to:
|
||||
|
||||
```
|
||||
/status
|
||||
```
|
||||
|
||||
By default, the bot is on main network. To change the network to the dev or test networks, use the network (net) command. Changing the network does not affect any existing subscriptions, and the bot does not specify which network the nodes belong to in its messages. Here's an example to change the network to devnet:
|
||||
|
||||
```
|
||||
/net dev
|
||||
```
|
||||
|
||||
You can also check if there are any violations in the current minting period. Like status, this command takes a node id as input or works on the currently subscribed nodes if no input is given:
|
||||
|
||||
```
|
||||
/violations
|
||||
```
|
||||
|
||||
The next section covers in-depth the different commands available.
|
||||
|
||||
## Commands
|
||||
|
||||
Here is a reference for all supported commands and their different forms:
|
||||
|
||||
- `/help`
|
||||
- Print the start message with all the available commands
|
||||
- `/status`
|
||||
- Check the current status of one or all nodes.
|
||||
- This uses a similar method as the Dashboard for determining node status, and update may be delayed by an hour
|
||||
- With no input, a status report will be generated for all subscribed nodes, if any
|
||||
- Examples
|
||||
- Check status of node ID 1
|
||||
- `/status 1`
|
||||
- Check status of all currently subscribed nodes
|
||||
- `/status`
|
||||
- `/violations`
|
||||
- Scan for farmerbot related violations during the current and previous minting periods
|
||||
- Like status, this works on all subscribed nodes when no input is given
|
||||
- Examples
|
||||
- Check violations of node ID 1
|
||||
- `/violations 1`
|
||||
- Check status of all currently subscribed nodes
|
||||
- `/violations`
|
||||
- `/subscribe`
|
||||
- Subscribe to updates about one or more nodes
|
||||
- You can use the shortcut `/sub`
|
||||
- If you don't provide an input, the nodes you are currently subscribed to will be shown
|
||||
- Examples
|
||||
- Subscribe to node ID 1
|
||||
- `/sub 1`
|
||||
- Subscribe to node ID 1, 2, 3
|
||||
- `/sub 1 2 3`
|
||||
- Check all subscribed nodes
|
||||
- `/sub`
|
||||
- `/unsubscribe`
|
||||
- Unsubscribe to updates about one or more nodes
|
||||
- You can use the shortcut `/unsub`
|
||||
- Examples
|
||||
- Unsubscribe to node ID 1
|
||||
- `/unsubscribe 1`
|
||||
- Unsubscribe to node ID 1, 2, 3
|
||||
- `/unsubscribe 1 2 3`
|
||||
- Unsubscribe to all currently subscribed nodes
|
||||
- `/unsub all`
|
||||
- `/network`
|
||||
- Change the network to `dev`, `test`, or `main`
|
||||
- Default is `main`
|
||||
- You can use the shortcut `/net`
|
||||
- If you don't provide an input, the currently selected network is shown
|
||||
- Examples
|
||||
- Check current network
|
||||
- `/network`
|
||||
- Change to another network, e.g. to `dev`
|
||||
- `/net dev`
|
||||
|
||||
## Bugs and Features
|
||||
|
||||
To report bugs and request features, please open an issue on the [GitHub repo](https://github.com/threefoldfoundation/node-status-bot) or contact [Scott Yeager on Telegram](https://t.me/scottyeager).
|
||||
|
||||
## Node Status Bot News
|
||||
|
||||
If you use the bot, please also subscribe to the [Node Status Bot News channel](https://t.me/node_bot_updates) on Telegram to receive occasional updates and news concerning the bot.
|
||||
@ -1,10 +1,15 @@
|
||||
---
|
||||
title: Get Started
|
||||
description: Earn INCA rewards by hosting nodes
|
||||
title: Getting Started
|
||||
description: Basic Steps to Farm INCA!
|
||||
---
|
||||
|
||||
Earn INCA rewards by hosting nodes
|
||||
## Process Overview
|
||||
|
||||
## Get a Node
|
||||
It's now easier than ever to become a cloud service provider and provide compute, storage and network resources to the world. You can own your part of the Internet and earn rewards while doing so!
|
||||
|
||||
### [Get INCA Nodes](/inca_nodes/get_inca_nodes)
|
||||
|
||||
### [Set Up INCA Nodes](/inca_nodes/set_up_inca_nodes)
|
||||
|
||||
### [Manage Rewards](/inca_nodes/manage_rewards)
|
||||
|
||||
- Visit the official INCA website to [get INCA nodes](https://internetcapacity.org/)
|
||||
|
||||
Loading…
Reference in New Issue
Block a user