diff --git a/docs_projectinca/astro.config.mjs b/docs_projectinca/astro.config.mjs index 854d0f3..a6820a2 100644 --- a/docs_projectinca/astro.config.mjs +++ b/docs_projectinca/astro.config.mjs @@ -18,8 +18,32 @@ export default defineConfig({ ], }, { - label: 'Reference', - autogenerate: { directory: 'reference' }, + label: 'Steps', + items: [ + // Each item here is one entry in the navigation menu. + { label: 'Install ThreeFold Connect', link: '/guides/threefold_connect/' }, + { label: 'Create an INCA Farm', link: '/guides/create_farm/' }, + { label: 'Get INCA Nodes', link: '/guides/get_inca_nodes/' }, + { label: 'Connect Your Nodes', link: '/guides/connect_the_nodes/' }, + { label: 'Manage Your Rewards', link: '/guides/manage_rewards/' }, + ], + }, + { + label: 'Resources', + items: [ + // Each item here is one entry in the navigation menu. + { label: 'Introduction', link: '/resources/resources_introduction/' }, + { 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/' }, + { label: 'Disclaimer', link: '/references/disclaimer/' }, + ], }, ], }), diff --git a/docs_projectinca/public/favicon.svg b/docs_projectinca/public/favicon.svg index cba5ac1..11eda84 100644 --- a/docs_projectinca/public/favicon.svg +++ b/docs_projectinca/public/favicon.svg @@ -1 +1,36 @@ - \ No newline at end of file + + + + + + 91 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs_projectinca/src/content/docs/guides/connect_the_nodes.md b/docs_projectinca/src/content/docs/guides/connect_the_nodes.md new file mode 100644 index 0000000..c1b552e --- /dev/null +++ b/docs_projectinca/src/content/docs/guides/connect_the_nodes.md @@ -0,0 +1,14 @@ +--- +title: Connect the Nodes +description: How to connect the nodes to the grid +--- + +Once you've received your INCA nodes, it takes a few minutes to connect it: + +- Plug the Ethernet cable in your INCA node and connect the cable to your router +- Plug the power cable in your INCA node and connect the cable to a power outlet +- Push the power on button to start the node + +The node will automatically connect to the INCA grid. That's it! + +The node is self-healing and you will need miminal if any maintenance. \ No newline at end of file diff --git a/docs_projectinca/src/content/docs/guides/create_farm.md b/docs_projectinca/src/content/docs/guides/create_farm.md new file mode 100644 index 0000000..b38cce0 --- /dev/null +++ b/docs_projectinca/src/content/docs/guides/create_farm.md @@ -0,0 +1,22 @@ +--- +title: Create a Farm +description: How to create a Farm with ThreeFold Connect +--- + +## Introduction + +We cover the steps to create a farm with the ThreeFold Connect app. + +## Steps + +Follow those steps to create a farm: + +- Open the main menu of the app and click on `Farming` +- Next to `Farms` click on the plus button +- Choose a farm name and click `Submit` + +## Farm ID + +Take note of the farm ID, it will be requested when you order your INCA nodes. + +Read more in the next section. \ No newline at end of file diff --git a/docs_projectinca/src/content/docs/guides/get_inca_nodes.md b/docs_projectinca/src/content/docs/guides/get_inca_nodes.md new file mode 100644 index 0000000..0afe505 --- /dev/null +++ b/docs_projectinca/src/content/docs/guides/get_inca_nodes.md @@ -0,0 +1,14 @@ +--- +title: Get INCA Nodes +description: How to get INCA nodes +--- + +There are different models of INCA nodes available. + +Visit the [official INCA website](https://internetcapacity.org/farming/) to choose and buy INCA nodes. + +## Input Your Farm ID + +When you buy an INCA node, you will be requested to enter your farm ID. + +For more information on this, read the [previous section](/guides/create_farm). diff --git a/docs_projectinca/src/content/docs/guides/getstarted.md b/docs_projectinca/src/content/docs/guides/getstarted.md deleted file mode 100644 index f4052a7..0000000 --- a/docs_projectinca/src/content/docs/guides/getstarted.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -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/) diff --git a/docs_projectinca/src/content/docs/guides/manage_rewards.md b/docs_projectinca/src/content/docs/guides/manage_rewards.md new file mode 100644 index 0000000..c3c2cd2 --- /dev/null +++ b/docs_projectinca/src/content/docs/guides/manage_rewards.md @@ -0,0 +1,8 @@ +--- +title: Manage Rewards +description: How to manage farming rewards +--- + +Farming rewards will be sent automatically to your ThreeFold Connect wallet. + +Simply visit your ThreeFold Connect wallet to see your rewards. \ No newline at end of file diff --git a/docs_projectinca/src/content/docs/guides/threefold_connect.md b/docs_projectinca/src/content/docs/guides/threefold_connect.md new file mode 100644 index 0000000..f1871e2 --- /dev/null +++ b/docs_projectinca/src/content/docs/guides/threefold_connect.md @@ -0,0 +1,32 @@ +--- +title: ThreeFold Connect +description: How to install the ThreeFold Connect app +--- + +## Introduction + +In this section, we cover the basics and advanced features of the ThreeFold Connect app. + +## Installation + +We cover the steps to install the app: + +- Download the app + - [Android](https://play.google.com/store/apps/details?id=org.jimber.threebotlogin&hl=en&gl=US) + - [iOS](https://apps.apple.com/us/app/threefold-connect/id1459845885) +- Open the app +- Click on `SIGN UP` +- Choose a ThreeFold Connect ID +- Enter your email address +- Take note of the mnemonics +- Open the confirmation email and +- Choose a 4-digit pin + +## Create a Wallet + +We cover the steps to create a wallet: + +- In the menu, click on `Wallet` +- Click on `Create Initial Wallet` + +Once you've installed ThreeFold Connect and created a wallet, create a farm. More on this in the next section! \ No newline at end of file diff --git a/docs_projectinca/src/content/docs/index.mdx b/docs_projectinca/src/content/docs/index.mdx index c32a314..517c711 100644 --- a/docs_projectinca/src/content/docs/index.mdx +++ b/docs_projectinca/src/content/docs/index.mdx @@ -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'; - 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. - 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. - 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! - 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! diff --git a/docs_projectinca/src/content/docs/reference/example.md b/docs_projectinca/src/content/docs/reference/example.md deleted file mode 100644 index 0224f09..0000000 --- a/docs_projectinca/src/content/docs/reference/example.md +++ /dev/null @@ -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 diff --git a/docs_projectinca/src/content/docs/references/disclaimer.md b/docs_projectinca/src/content/docs/references/disclaimer.md new file mode 100644 index 0000000..8404b1a --- /dev/null +++ b/docs_projectinca/src/content/docs/references/disclaimer.md @@ -0,0 +1,10 @@ +--- +title: Disclaimer +description: Disclaimer concerning Project INCA +--- + +## Disclaimer + +> The information provided in these tutorials or any related discussion is not intended as investment advice. The purpose is to provide educational and informational content only. Investing in cryptocurrencies or any other assets carries inherent risks, and it is crucial to conduct your own research and exercise caution before making any investment decisions. +> +> **The INCA Token** is not to be considered as a traditional investment instrument. The value of cryptocurrencies can be volatile, and there are no guarantees of profits or returns. Always be aware of the risks involved and make informed choices based on your own assessment and understanding. \ No newline at end of file diff --git a/docs_projectinca/src/content/docs/references/glossary.md b/docs_projectinca/src/content/docs/references/glossary.md new file mode 100644 index 0000000..c7f8001 --- /dev/null +++ b/docs_projectinca/src/content/docs/references/glossary.md @@ -0,0 +1,35 @@ +--- +title: Glossary +description: Glossary of terms from the INCA ecosystem +--- + +## Introduction + +We provide definitions of terms you may encounter while exploring 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. \ No newline at end of file diff --git a/docs_projectinca/src/content/docs/resources/farmerbot.md b/docs_projectinca/src/content/docs/resources/farmerbot.md new file mode 100644 index 0000000..cd3c60e --- /dev/null +++ b/docs_projectinca/src/content/docs/resources/farmerbot.md @@ -0,0 +1,255 @@ +--- +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). + +## 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 `` with the latest Farmerbot release. + ``` + wget https://github.com/threefoldtech/tfgrid-sdk-go/releases/download//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 +``` + +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 +``` + +## 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 +``` + +### 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 +``` \ No newline at end of file diff --git a/docs_projectinca/src/content/docs/resources/node_status_bot.md b/docs_projectinca/src/content/docs/resources/node_status_bot.md new file mode 100644 index 0000000..a4a4512 --- /dev/null +++ b/docs_projectinca/src/content/docs/resources/node_status_bot.md @@ -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. diff --git a/docs_projectinca/src/content/docs/resources/resources_introduction.md b/docs_projectinca/src/content/docs/resources/resources_introduction.md new file mode 100644 index 0000000..4be261c --- /dev/null +++ b/docs_projectinca/src/content/docs/resources/resources_introduction.md @@ -0,0 +1,11 @@ +--- +title: Introduction +description: Resources Introduction +--- + +This section is optional. We present two bots to optimize your farming experience. + +## The Bots + +- The Node Status Bot give you relevant information on your node status, notify you if the node status changes and also provide information on minting violations. +- The Farmerbot is a service that farmers can run in order to automatically manage the nodes in their farms. \ No newline at end of file diff --git a/docs_projectinca/src/content/docs/start_here/getting_started.md b/docs_projectinca/src/content/docs/start_here/getting_started.md index f4052a7..8525c06 100644 --- a/docs_projectinca/src/content/docs/start_here/getting_started.md +++ b/docs_projectinca/src/content/docs/start_here/getting_started.md @@ -1,10 +1,26 @@ --- -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 +It's now easier than ever to become a farmer on the ThreeFold Grid thanks to Project **IN**ternet **CA**pacity. -## Get a Node +Farmers are cloud service providers who offer compute, storage and network resources to the world. In exchange, farmers receive INCA rewards. -- Visit the official INCA website to [get INCA nodes](https://internetcapacity.org/) +You can contribute to the worldwide cloud landscape and own your own part of the Internet! + +## Main Steps + +There are only a handful of steps needed to become a cloud service provider. + +- Install the ThreeFold Connect ap +- Create an INCA Farm +- Get INCA nodes +- Connect your nodes +- Manage your rewards + +## Let's Go + +The next pages will guide you through the process of becoming a cloud service provider. + +All aboard the ThreeFold Grid... Let's deploy some INCA nodes! \ No newline at end of file