docs inca transfer to independent repo for cicd use
This commit is contained in:
Mik-TF
parent
ea630386de
commit
ece63c827d
21
.gitignore
vendored
Normal file
21
.gitignore
vendored
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
# build output
|
||||||
|
dist/
|
||||||
|
# generated types
|
||||||
|
.astro/
|
||||||
|
|
||||||
|
# dependencies
|
||||||
|
node_modules/
|
||||||
|
|
||||||
|
# logs
|
||||||
|
npm-debug.log*
|
||||||
|
yarn-debug.log*
|
||||||
|
yarn-error.log*
|
||||||
|
pnpm-debug.log*
|
||||||
|
|
||||||
|
|
||||||
|
# environment variables
|
||||||
|
.env
|
||||||
|
.env.production
|
||||||
|
|
||||||
|
# macOS-specific files
|
||||||
|
.DS_Store
|
||||||
104
README.md
104
README.md
@ -1,3 +1,103 @@
|
|||||||
# www_docs_projectinca
|
<h1> Project INCA Docs </h1>
|
||||||
|
|
||||||
Project INCA Docs Website in Astro
|
<h2>Table of Contents</h2>
|
||||||
|
|
||||||
|
- [Introduction](#introduction)
|
||||||
|
- [Prerequisites](#prerequisites)
|
||||||
|
- [Install the prerequisites on Ubuntu](#install-the-prerequisites-on-ubuntu)
|
||||||
|
- [Install the prerequisites on MAC or Linux with Brew](#install-the-prerequisites-on-mac-or-linux-with-brew)
|
||||||
|
- [Check if the Prerequisites Are Installed](#check-if-the-prerequisites-are-installed)
|
||||||
|
- [Clone the Repository](#clone-the-repository)
|
||||||
|
- [Preview the Website](#preview-the-website)
|
||||||
|
- [License](#license)
|
||||||
|
- [References](#references)
|
||||||
|
- [Contribute](#contribute)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Introduction
|
||||||
|
|
||||||
|
This repository contains the code to deploy the Project INCA Docs website, a project by [ThreeFold](https://threefold.io).
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
You need [npm](https://www.npmjs.com/) to run this website.
|
||||||
|
|
||||||
|
To clone the repository, you need `git`.
|
||||||
|
|
||||||
|
To use the Makefile for quick deployment, you need `make`
|
||||||
|
|
||||||
|
### Install the prerequisites on Ubuntu
|
||||||
|
```
|
||||||
|
sudo apt update
|
||||||
|
sudo apt install nodejs
|
||||||
|
sudo apt install git
|
||||||
|
sudo apt install make
|
||||||
|
```
|
||||||
|
|
||||||
|
### Install the prerequisites on MAC or Linux with Brew
|
||||||
|
|
||||||
|
- [Install Brew](https://brew.sh/)
|
||||||
|
```
|
||||||
|
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
|
||||||
|
```
|
||||||
|
- Install the prerequisites
|
||||||
|
```
|
||||||
|
brew install node
|
||||||
|
brew install git
|
||||||
|
brew install make
|
||||||
|
```
|
||||||
|
|
||||||
|
### Check if the Prerequisites Are Installed
|
||||||
|
|
||||||
|
```
|
||||||
|
npm --version
|
||||||
|
git version
|
||||||
|
make --version
|
||||||
|
```
|
||||||
|
|
||||||
|
## Clone the Repository
|
||||||
|
|
||||||
|
|
||||||
|
```
|
||||||
|
git clone https://git.ourworld.tf/tfgrid/www_docs_projectinca
|
||||||
|
cd www_docs_projectinca
|
||||||
|
```
|
||||||
|
|
||||||
|
For more information, read the original [AstroWind docs](./docs_starlight/starlight_README.md).
|
||||||
|
|
||||||
|
## Preview the Website
|
||||||
|
|
||||||
|
You can preview the website with those two lines.
|
||||||
|
|
||||||
|
```
|
||||||
|
npm install
|
||||||
|
npm run dev
|
||||||
|
```
|
||||||
|
|
||||||
|
The equivalent can be achieved using the Makefile:
|
||||||
|
|
||||||
|
```
|
||||||
|
make run
|
||||||
|
```
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
**INCA Docs** is licensed under the Apache 2.0 license — see the [LICENSE](../LICENSE) file for details.
|
||||||
|
|
||||||
|
## References
|
||||||
|
|
||||||
|
This Project INCA Docs website is based on the amazing [AstroWind Starlight repo](https://github.com/withastro/starlight).
|
||||||
|
|
||||||
|
We changed the license from MIT to Apache 2.0 to suit this specific project.
|
||||||
|
|
||||||
|
## Contribute
|
||||||
|
|
||||||
|
To contribute to this repository:
|
||||||
|
|
||||||
|
- Make a new branch with `development_` as a prefix (e.g. `development_update`)
|
||||||
|
- Make changes locally on your code editor
|
||||||
|
- Push changes to the new branch
|
||||||
|
- Make a pull request to `development` branch
|
||||||
|
|
||||||
|
The code owners will merge `development` branch to `main` branch.
|
||||||
71
astro.config.mjs
Normal file
71
astro.config.mjs
Normal file
@ -0,0 +1,71 @@
|
|||||||
|
import { defineConfig } from 'astro/config';
|
||||||
|
import starlight from '@astrojs/starlight';
|
||||||
|
|
||||||
|
// https://astro.build/config
|
||||||
|
export default defineConfig({
|
||||||
|
integrations: [
|
||||||
|
starlight({
|
||||||
|
title: 'Project INCA Docs',
|
||||||
|
social: {
|
||||||
|
github: 'https://github.com/threefoldtech',
|
||||||
|
telegram: 'https://t.me/threefold',
|
||||||
|
'x.com': 'https://x.com/threefold_io',
|
||||||
|
discord: 'https://discord.com/invite/NZqKC4jEhD',
|
||||||
|
},
|
||||||
|
sidebar: [
|
||||||
|
{
|
||||||
|
label: 'Start Here',
|
||||||
|
items: [
|
||||||
|
|
||||||
|
{ label: 'Getting Started', link: '/start_here/getting_started/' },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
label: 'Steps',
|
||||||
|
items: [
|
||||||
|
|
||||||
|
{ 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: [
|
||||||
|
|
||||||
|
{ label: 'How to Use the Bots', link: '/resources/resources_introduction/' },
|
||||||
|
{ label: 'Node Status Bot', link: '/resources/node_status_bot/' },
|
||||||
|
{ label: 'Farmerbot', link: '/resources/farmerbot/' },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
label: 'References',
|
||||||
|
items: [
|
||||||
|
|
||||||
|
{ label: 'Glossary', link: '/references/glossary/' },
|
||||||
|
{ label: 'Whitepaper', link: '/references/inca_whitepaper/' },
|
||||||
|
{ label: 'Disclaimer', link: '/references/disclaimer/' },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
label: 'Legal',
|
||||||
|
items: [
|
||||||
|
|
||||||
|
{ label: 'Terms and Conditions', link: '/legal/terms_and_conditions/' },
|
||||||
|
{ label: 'Privacy Policy', link: '/legal/privacy_policy/' },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
head: [
|
||||||
|
{
|
||||||
|
tag: 'script',
|
||||||
|
attrs: {
|
||||||
|
src: '/crisp.js',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
});
|
||||||
1
crisp.js
Normal file
1
crisp.js
Normal file
@ -0,0 +1 @@
|
|||||||
|
window.$crisp=[];window.CRISP_WEBSITE_ID="1a5a5241-91cb-4a41-8323-5ba5ec574da0";(function(){d=document;s=d.createElement("script");s.src="https://client.crisp.chat/l.js";s.async=1;d.getElementsByTagName("head")[0].appendChild(s);})();
|
||||||
54
docs_starlight/starlight_README.md
Normal file
54
docs_starlight/starlight_README.md
Normal file
@ -0,0 +1,54 @@
|
|||||||
|
# Starlight Starter Kit: Basics
|
||||||
|
|
||||||
|
[](https://starlight.astro.build)
|
||||||
|
|
||||||
|
```
|
||||||
|
npm create astro@latest -- --template starlight
|
||||||
|
```
|
||||||
|
|
||||||
|
[](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
|
||||||
|
[](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
|
||||||
|
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs)
|
||||||
|
|
||||||
|
> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
|
||||||
|
|
||||||
|
## 🚀 Project Structure
|
||||||
|
|
||||||
|
Inside of your Astro + Starlight project, you'll see the following folders and files:
|
||||||
|
|
||||||
|
```
|
||||||
|
.
|
||||||
|
├── public/
|
||||||
|
├── src/
|
||||||
|
│ ├── assets/
|
||||||
|
│ ├── content/
|
||||||
|
│ │ ├── docs/
|
||||||
|
│ │ └── config.ts
|
||||||
|
│ └── env.d.ts
|
||||||
|
├── astro.config.mjs
|
||||||
|
├── package.json
|
||||||
|
└── tsconfig.json
|
||||||
|
```
|
||||||
|
|
||||||
|
Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
|
||||||
|
|
||||||
|
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
|
||||||
|
|
||||||
|
Static assets, like favicons, can be placed in the `public/` directory.
|
||||||
|
|
||||||
|
## 🧞 Commands
|
||||||
|
|
||||||
|
All commands are run from the root of the project, from a terminal:
|
||||||
|
|
||||||
|
| Command | Action |
|
||||||
|
| :------------------------ | :----------------------------------------------- |
|
||||||
|
| `npm install` | Installs dependencies |
|
||||||
|
| `npm run dev` | Starts local dev server at `localhost:4321` |
|
||||||
|
| `npm run build` | Build your production site to `./dist/` |
|
||||||
|
| `npm run preview` | Preview your build locally, before deploying |
|
||||||
|
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
|
||||||
|
| `npm run astro -- --help` | Get help using the Astro CLI |
|
||||||
|
|
||||||
|
## 👀 Want to learn more?
|
||||||
|
|
||||||
|
Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
|
||||||
8108
package-lock.json
generated
Normal file
8108
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
19
package.json
Normal file
19
package.json
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
{
|
||||||
|
"name": "",
|
||||||
|
"type": "module",
|
||||||
|
"version": "0.0.1",
|
||||||
|
"scripts": {
|
||||||
|
"dev": "astro dev",
|
||||||
|
"start": "astro dev",
|
||||||
|
"build": "astro check && astro build",
|
||||||
|
"preview": "astro preview",
|
||||||
|
"astro": "astro"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"@astrojs/check": "^0.7.0",
|
||||||
|
"@astrojs/starlight": "^0.24.3",
|
||||||
|
"astro": "^4.10.3",
|
||||||
|
"sharp": "^0.32.5",
|
||||||
|
"typescript": "^5.4.5"
|
||||||
|
}
|
||||||
|
}
|
||||||
36
public/favicon.svg
Normal file
36
public/favicon.svg
Normal file
@ -0,0 +1,36 @@
|
|||||||
|
<?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>
|
||||||
|
After Width: | Height: | Size: 3.2 KiB |
BIN
src/assets/black_threefold.png
Normal file
BIN
src/assets/black_threefold.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 80 KiB |
BIN
src/assets/hero_host3.png
Normal file
BIN
src/assets/hero_host3.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 670 KiB |
BIN
src/assets/houston.webp
Normal file
BIN
src/assets/houston.webp
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 96 KiB |
BIN
src/assets/inca_background.webp
Normal file
BIN
src/assets/inca_background.webp
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 87 KiB |
6
src/content/config.ts
Normal file
6
src/content/config.ts
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
import { defineCollection } from 'astro:content';
|
||||||
|
import { docsSchema } from '@astrojs/starlight/schema';
|
||||||
|
|
||||||
|
export const collections = {
|
||||||
|
docs: defineCollection({ schema: docsSchema() }),
|
||||||
|
};
|
||||||
14
src/content/docs/guides/connect_the_nodes.md
Normal file
14
src/content/docs/guides/connect_the_nodes.md
Normal file
@ -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 grid. That's it!
|
||||||
|
|
||||||
|
The node is self-healing and you will need miminal if any maintenance.
|
||||||
22
src/content/docs/guides/create_farm.md
Normal file
22
src/content/docs/guides/create_farm.md
Normal file
@ -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.
|
||||||
14
src/content/docs/guides/get_inca_nodes.md
Normal file
14
src/content/docs/guides/get_inca_nodes.md
Normal file
@ -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).
|
||||||
8
src/content/docs/guides/manage_rewards.md
Normal file
8
src/content/docs/guides/manage_rewards.md
Normal file
@ -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.
|
||||||
32
src/content/docs/guides/threefold_connect.md
Normal file
32
src/content/docs/guides/threefold_connect.md
Normal file
@ -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!
|
||||||
36
src/content/docs/index.mdx
Normal file
36
src/content/docs/index.mdx
Normal file
@ -0,0 +1,36 @@
|
|||||||
|
---
|
||||||
|
title: Welcome to the Project INCA Docs
|
||||||
|
description: Get started building your docs site with Starlight.
|
||||||
|
template: splash
|
||||||
|
hero:
|
||||||
|
tagline: Learn how to deploy INCA nodes to earn rewards!
|
||||||
|
image:
|
||||||
|
file: ../../assets/hero_host3.png
|
||||||
|
actions:
|
||||||
|
- text: Get Started
|
||||||
|
link: /start_here/getting_started/
|
||||||
|
icon: right-arrow
|
||||||
|
variant: primary
|
||||||
|
- text: Visit the website
|
||||||
|
link: https://internetcapacity.org/
|
||||||
|
icon: external
|
||||||
|
---
|
||||||
|
|
||||||
|
import { Card, CardGrid } from '@astrojs/starlight/components';
|
||||||
|
|
||||||
|
## Become a Cloud Service Provider
|
||||||
|
|
||||||
|
<CardGrid stagger>
|
||||||
|
<Card title="Learn about INCA" icon="open-book">
|
||||||
|
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">
|
||||||
|
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 with thousands of nodes!
|
||||||
|
</Card>
|
||||||
|
<Card title="Earn INCA Rewards" icon="star">
|
||||||
|
When you deploy INCA nodes, you contribute to the growth of the ThreeFold Grid and earn INCA rewards!
|
||||||
|
</Card>
|
||||||
|
</CardGrid>
|
||||||
115
src/content/docs/legal/privacy_policy.md
Normal file
115
src/content/docs/legal/privacy_policy.md
Normal file
@ -0,0 +1,115 @@
|
|||||||
|
---
|
||||||
|
title: Privacy Policy
|
||||||
|
description: Privacy Policy concerning Project INCA
|
||||||
|
---
|
||||||
|
|
||||||
|
*This privacy policy will explain how ThreeFold Movement ("companies", "we", or "us") uses the personal data we collect from you when you use our websites, including the Project INCA website.*
|
||||||
|
|
||||||
|
### What data do we collect?
|
||||||
|
|
||||||
|
All websites using the ThreeFold Movement Privacy Policy do not collect any data on a personal level by default. All data being processed is anonymized. When signing up for our newsletter we collect your: *email address*.
|
||||||
|
|
||||||
|
**How do we collect your data?**
|
||||||
|
|
||||||
|
Browsing data:
|
||||||
|
We automatically collect data and process data when you use or view our website via your browser's cookies.
|
||||||
|
|
||||||
|
Newsletter Signups:
|
||||||
|
Collected only with your permission through our sign-up form that uses a double opt-in mechanism for you to explicitly accept.
|
||||||
|
|
||||||
|
### How will we use your data?
|
||||||
|
|
||||||
|
We use this information to monitor and analyze your use of our website and for the website's technical administration, to increase our website's functionality and user-friendliness, and to better tailor it to our visitors needs.
|
||||||
|
|
||||||
|
If you agree, our companies will share your data with the following partner companies so that they may offer you or us their products and services:
|
||||||
|
|
||||||
|
* Matomo: offers us services relating to monitoring and measuring website traffic and access, creating user navigation reports, etc. All information processed here is anonymized. We run this service within our own environments. The data being processed does not leave our servers and is not shared with any thrid parties.
|
||||||
|
|
||||||
|
* Mailerlite: offers us services relating newsletter sending and monitoring.
|
||||||
|
|
||||||
|
**We do not track individual IP's or any other personal data.**
|
||||||
|
|
||||||
|
The aforementioned processors operate independently from us and have their own privacy policy, which we strongly suggest you review. These processors may use the information collected through their services to evaluate visitors’ activity, as set out in their respective privacy policies.
|
||||||
|
|
||||||
|
### How do we store your data?
|
||||||
|
|
||||||
|
We store the anonmyzed data in Matomo for us to research usage and improve user experience on our websites.
|
||||||
|
We store email addresses in Mailerlite's system.
|
||||||
|
|
||||||
|
### Marketing
|
||||||
|
|
||||||
|
We will not use your information for any (re)marketing reasons, nor send you information about products and/or services of ours or any partner companies unless you explicitly agreed to signing up for our newsletter.
|
||||||
|
|
||||||
|
### What are your data protection rights?
|
||||||
|
|
||||||
|
We would like to make sure you are fully aware of all of your data protection rights. Every user is entitled to the following:
|
||||||
|
|
||||||
|
#### The right to access
|
||||||
|
|
||||||
|
You have the right to request from us copies of your personal data. We may charge you a small fee for this service.
|
||||||
|
|
||||||
|
#### The right to rectification
|
||||||
|
|
||||||
|
You have the right to request that we correct any information you believe is inaccurate. You also have the right to request us to complete information you believe is incomplete.
|
||||||
|
|
||||||
|
#### The right to erasure
|
||||||
|
|
||||||
|
You have the right to request that we erase your personal data, under certain conditions.
|
||||||
|
|
||||||
|
#### The right to restrict processing
|
||||||
|
|
||||||
|
You have the right to request that we restrict the processing of your personal data, under certain conditions.
|
||||||
|
|
||||||
|
#### The right to object to processing
|
||||||
|
|
||||||
|
You have the right to object to our companies' processing of your personal data, under certain conditions.
|
||||||
|
|
||||||
|
#### The right to data portability
|
||||||
|
|
||||||
|
You have the right to request that we transfer the data that we have collected to another organization, or directly to you, under certain conditions.
|
||||||
|
|
||||||
|
If you make a request, we have one month to respond to you. If you would like to exercise any of these rights, please contact us:
|
||||||
|
|
||||||
|
* email: dataprivacy@threefold.io
|
||||||
|
|
||||||
|
### What are cookies?
|
||||||
|
|
||||||
|
Cookies are text files placed on your computer to collect standard Internet log information and visitor behavior information. When you visit our websites, we may collect information from you automatically through cookies or similar technology.
|
||||||
|
|
||||||
|
For further information, visit: http://allaboutcookies.org/
|
||||||
|
|
||||||
|
### How do we use cookies?
|
||||||
|
|
||||||
|
We use cookies in a range of ways to improve your experience on our website, including:
|
||||||
|
|
||||||
|
* understanding how you use our website
|
||||||
|
|
||||||
|
* for the websites technical administration
|
||||||
|
|
||||||
|
### What types of cookies do we use?
|
||||||
|
|
||||||
|
There are a number of different types of cookies, however, our websites use:
|
||||||
|
|
||||||
|
* Functionality - Our companies use these cookies so that we recognize you on our website and remember your previously selected preferences. These could include what language you prefer and the location you are in. A mix of first-party and third-party cookies are used.
|
||||||
|
|
||||||
|
* No Advertising - Our companies use these cookies to collect information about your visit to our website, the content you viewed, the links you followed and information about your browser, device, and your IP address. However, we will not share this data with third parties for advertising purposes.
|
||||||
|
|
||||||
|
* Analytics cookies - Our companies use these to monitor how users reached the Site, and how they interact with and move around once on the Site. These cookies let us know what features on the Site are working the best and what features on the Site can be improved.
|
||||||
|
|
||||||
|
### How to manage cookies
|
||||||
|
|
||||||
|
You can set your browser to not accept cookies, and the above website tells you how to remove cookies from your browser. However, in a few cases, some of our website features may not function as a result.
|
||||||
|
|
||||||
|
### Privacy policies of other websites
|
||||||
|
|
||||||
|
Our website contains links to other websites. Our privacy policy applies only to our website, so if you click on a link to another website, you should read their privacy policy.
|
||||||
|
|
||||||
|
### Changes to our privacy policy
|
||||||
|
|
||||||
|
We keep our privacy policy under regular review and places any updates on this web page.
|
||||||
|
|
||||||
|
### How to contact us
|
||||||
|
|
||||||
|
If you have any questions about our privacy policy, the data we hold on you, or you would like to exercise one of your data protection rights, please do not hesitate to contact us.
|
||||||
|
|
||||||
|
Email us at: dataprivacy@threefold.io
|
||||||
154
src/content/docs/legal/terms_and_conditions.md
Normal file
154
src/content/docs/legal/terms_and_conditions.md
Normal file
@ -0,0 +1,154 @@
|
|||||||
|
---
|
||||||
|
title: Terms and Conditions
|
||||||
|
description: Terms and Conditions for the Project INCA
|
||||||
|
---
|
||||||
|
|
||||||
|
These Terms of Use constitute a legally binding agreement made between you, whether personally or on behalf of an entity (“you”) and ThreeFold, doing business as ThreeFold (“ThreeFold“, “we”, “us”, or “our”), concerning your access to and use of the threefold related websites:
|
||||||
|
|
||||||
|
The project INCA website, websites/wikis/forums ending with threefold.io, threefold.me, grid.tf, threefold.tech, TFT.com, freeflownation.org, 3bot.org, incubaid.com or consciousinternet.org or any other website as used/promoted by the ThreeFold Foundation or any other site as originating from our open-source git repository on https://github.com/threefoldfoundation, as well as any other media form, media channel, forum, mobile website or mobile application related, linked, or otherwise connected thereto (collectively, the “Site”).
|
||||||
|
|
||||||
|
You agree that by accessing the Site, you have read, understood, and agreed to be bound by all of these Terms of Use.
|
||||||
|
|
||||||
|
IF YOU DO NOT AGREE WITH ALL OF THESE TERMS OF USE, THEN YOU ARE EXPRESSLY PROHIBITED FROM USING THE SITE AND YOU MUST DISCONTINUE USE IMMEDIATELY.
|
||||||
|
|
||||||
|
Supplemental terms and conditions or documents that may be posted on the Site from time to time are hereby expressly incorporated herein by reference. We reserve the right, in our sole discretion, to make changes or modifications to these Terms of Use at any time and for any reason. We will alert you about any changes by updating the “Last updated” date of these Terms of Use, and you waive any right to receive specific notice of each such change. It is your responsibility to periodically review these Terms of Use to stay informed of updates. You will be subject to, and will be deemed to have been made aware of and to have accepted, the changes in any revised Terms of Use by your continued use of the Site after the date such revised Terms of Use are posted.
|
||||||
|
|
||||||
|
The information provided on the Site is not intended for distribution to or use by any person or entity in any jurisdiction or country where such distribution or use would be contrary to law or regulation or which would subject us to any registration requirement within such jurisdiction or country. Accordingly, those persons who choose to access the Site from other locations do so on their own initiative and are solely responsible for compliance with local laws, if and to the extent local laws are applicable.
|
||||||
|
|
||||||
|
The Site is intended for users who are at least 18 years old. Persons under the age of 18 are not permitted to use or register for the Site.
|
||||||
|
|
||||||
|
**INTELLECTUAL PROPERTY RIGHTS**
|
||||||
|
|
||||||
|
Unless otherwise indicated, the Site is our proprietary property and all source code, databases, functionality, software, website designs, audio, video, text, photographs, and graphics on the Site (collectively, the “Content”) and the trademarks, service marks, and logos contained therein (the “Marks”) are owned or controlled by us or licensed to us, and are protected by copyright and trademark laws and various other intellectual property rights and EU competition laws, foreign jurisdictions, and international conventions. The Content and the Marks are provided on the Site “AS IS” for your information and personal use only. Except as expressly provided in these Terms of Use, no part of the Site and no Content or Marks may be copied, reproduced, aggregated, republished, uploaded, posted, publicly displayed, encoded, translated, transmitted, distributed, sold, licensed, or otherwise exploited for any commercial purpose whatsoever, without our express prior written permission.
|
||||||
|
|
||||||
|
Provided that you are eligible to use the Site, you are granted a limited license to access and use the Site and to download or print a copy of any portion of the Content to which you have properly gained access solely for your personal, non-commercial use. We reserve all rights not expressly granted to you in and to the Site, the Content and the Marks.
|
||||||
|
|
||||||
|
**USER REPRESENTATIONS**
|
||||||
|
|
||||||
|
By using the Site, you represent and warrant that: (1) all registration information you submit will be true, accurate, current, and complete; (2) you will maintain the accuracy of such information and promptly update such registration information as necessary; (3) you have the legal capacity and you agree to comply with these Terms of Use; (4) you are not a minor in the jurisdiction in which you reside; (5) you will not access the Site through automated or non-human means, whether through a bot, script, or otherwise; (6) you will not use the Site for any illegal or unauthorized purpose; and (7) your use of the Site will not violate any applicable law or regulation.
|
||||||
|
|
||||||
|
If you provide any information that is untrue, inaccurate, not current, or incomplete, we have the right to suspend or terminate your account and refuse any and all current or future use of the Site (or any portion thereof).
|
||||||
|
|
||||||
|
**USER REGISTRATION**
|
||||||
|
|
||||||
|
You may be required to register with the Site. You agree to keep your password confidential and will be responsible for all use of your account and password. We reserve the right to remove, reclaim, or change a username you select if we determine, in our sole discretion, that such username is inappropriate, obscene, or otherwise objectionable.
|
||||||
|
|
||||||
|
**PROHIBITED ACTIVITIES**
|
||||||
|
|
||||||
|
You may not access or use the Site for any purpose other than that for which we make the Site available. The Site may not be used in connection with any commercial endeavors except those that are specifically endorsed or approved by us.
|
||||||
|
|
||||||
|
As a user of the Site, you agree not to:
|
||||||
|
|
||||||
|
- Systematically retrieve data or other content from the Site to create or compile, directly or indirectly, a collection, compilation, database, or directory without written permission from us.
|
||||||
|
- Circumvent, disable, or otherwise interfere with security-related features of the Site, including features that prevent or restrict the use or copying of any Content or enforce limitations on the use of the Site and/or the Content contained therein.
|
||||||
|
- Engage in unauthorized framing of or linking to the Site.
|
||||||
|
- Trick, defraud, or mislead us and other users, especially in any attempt to learn sensitive account information such as user passwords.
|
||||||
|
- Engage in any automated use of the system, such as using scripts to send comments or messages, or using any data mining, robots, or similar data gathering and extraction tools.
|
||||||
|
- Interfere with, disrupt, or create an undue burden on the Site or the networks or services connected to the Site.
|
||||||
|
- Use the Site as part of any effort to compete with us or otherwise use the Site and/or the Content for any revenue-generating endeavor or commercial enterprise.
|
||||||
|
- Decipher, decompile, disassemble, or reverse engineer any of the software comprising or in any way making up a part of the Site.
|
||||||
|
- Upload or transmit (or attempt to upload or to transmit) viruses, Trojan horses, or other material, including excessive use of capital letters and spamming (continuous posting of repetitive text), that interferes with any party’s uninterrupted use and enjoyment of the Site or modifies, impairs, disrupts, alters, or interferes with the use, features, functions, operation, or maintenance of the Site.
|
||||||
|
- Upload or transmit (or attempt to upload or to transmit) any material that acts as a passive or active information collection or transmission mechanism, including without limitation, clear graphics interchange formats (“gifs”), 1×1 pixels, web bugs, cookies, or other similar devices (sometimes referred to as “spyware” or “passive collection mechanisms” or “pcms”).
|
||||||
|
- Except as may be the result of standard search engine or Internet browser usage, use, launch, develop, or distribute any automated system, including without limitation, any spider, robot, cheat utility, scraper, or offline reader that accesses the Site, or using or launching any unauthorized script or other software.
|
||||||
|
- Use the Site in a manner inconsistent with any applicable laws or regulations.
|
||||||
|
|
||||||
|
**USER GENERATED CONTRIBUTIONS**
|
||||||
|
|
||||||
|
The Site may invite you to chat, contribute to, or participate in blogs, message boards, online forums, and other functionality, and may provide you with the opportunity to create, submit, post, display, transmit, perform, publish, distribute, or broadcast content and materials to us or on the Site, including but not limited to text, writings, video, audio, photographs, graphics, comments, suggestions, or personal information or other material (collectively, “Contributions”). Contributions may be viewable by other users of the Site and through third-party websites. As such, any Contributions you transmit may be treated as non-confidential and non-proprietary. When you create or make available any Contributions, you thereby represent and warrant that:
|
||||||
|
|
||||||
|
- The creation, distribution, transmission, public display, or performance, and the accessing, downloading, or copying of your Contributions do not and will not infringe the proprietary rights, including but not limited to the copyright, patent, trademark, trade secret, or moral rights of any third party.
|
||||||
|
- You are the creator and owner of or have the necessary licenses, rights, consents, releases, and permissions to use and to authorize us, the Site, and other users of the Site to use your Contributions in any manner contemplated by the Site and these Terms of Use.
|
||||||
|
- You have the written consent, release, and/or permission of each and every identifiable individual person in your Contributions to use the name or likeness of each and every such identifiable individual person to enable inclusion and use of your Contributions in any manner contemplated by the Site and these Terms of Use.
|
||||||
|
- Your Contributions are not false, inaccurate, or misleading.
|
||||||
|
- Your Contributions are not unsolicited or unauthorized advertising, promotional materials, pyramid schemes, chain letters, spam, mass mailings, or other forms of solicitation.
|
||||||
|
- Your Contributions are not obscene, lewd, lascivious, filthy, violent, harassing, libelous, slanderous, or otherwise objectionable (as determined by us).
|
||||||
|
- Your Contributions do not ridicule, mock, disparage, intimidate, or abuse anyone. 98 Your Contributions do not advocate the violent overthrow of any government or incite, encourage, or threaten physical harm against another.
|
||||||
|
- Your Contributions do not violate any applicable law, regulation, or rule.
|
||||||
|
- Your Contributions do not violate the privacy or publicity rights of any third party.
|
||||||
|
- Your Contributions do not contain any material that solicits personal information from anyone under the age of 18 or exploits people under the age of 18 in a sexual or violent manner.
|
||||||
|
- Your Contributions do not violate any federal or state law concerning child pornography, or otherwise intended to protect the health or well-being of minors;
|
||||||
|
- Your Contributions do not include any offensive comments that are connected to race, national origin, gender, sexual preference, or physical handicap.
|
||||||
|
- Your Contributions do not otherwise violate, or link to material that violates, any provision of these Terms of Use, or any applicable law or regulation.
|
||||||
|
- Any use of the Site in violation of the foregoing violates these Terms of Use and may result in, among other things, termination or suspension of your rights to use the Site. CONTRIBUTION LICENSE
|
||||||
|
|
||||||
|
By posting your Contributions to any part of the Site or making Contributions accessible to the Site by linking your account from the Site to any of your social networking accounts, you automatically grant, and you represent and warrant that you have the right to grant, to us an unrestricted, unlimited, irrevocable, perpetual, non-exclusive, transferable, royalty-free, fully-paid, worldwide right, and license to host, use, copy, reproduce, disclose, sell, resell, publish, broadcast, retitle, archive, store, cache, publicly perform, publicly display, reformat, translate, transmit, excerpt (in whole or in part), and distribute such Contributions (including, without limitation, your image and voice) for any purpose, commercial, advertising, or otherwise, and to prepare derivative works of, or incorporate into other works, such Contributions, and grant and authorize sublicenses of the foregoing. The use and distribution may occur in any media formats and through any media channels.
|
||||||
|
|
||||||
|
This license will apply to any form, media, or technology now known or hereafter developed, and includes our use of your name, company name, and franchise name, as applicable, and any of the trademarks, service marks, trade names, logos, and personal and commercial images you provide. You waive all moral rights in your Contributions, and you warrant that moral rights have not otherwise been asserted in your Contributions.
|
||||||
|
|
||||||
|
We do not assert any ownership over your Contributions. You retain full ownership of all of your Contributions and any intellectual property rights or other proprietary rights associated with your Contributions. We are not liable for any statements or representations in your Contributions provided by you in any area on the Site. You are solely responsible for your Contributions to the Site and you expressly agree to exonerate us from any and all responsibility and to refrain from any legal action against us regarding your Contributions.
|
||||||
|
|
||||||
|
We have the right, in our sole and absolute discretion, (1) to edit, redact, or otherwise change any Contributions; (2) to re-categorize any Contributions to place them in more appropriate locations on the Site; and (3) to pre-screen or delete any Contributions at any time and for any reason, without notice. We have no obligation to monitor your Contributions.
|
||||||
|
|
||||||
|
**SOCIAL MEDIA**
|
||||||
|
|
||||||
|
As part of the functionality of the Site, you may link your account with online accounts you have with third-party service providers (each such account, a “Third-Party Account”) by either: (1) providing your Third-Party Account login information through the Site; or (2) allowing us to access your Third-Party Account, as is permitted under the applicable terms and conditions that govern your use of each Third-Party Account. You represent and warrant that you are entitled to disclose your Third-Party Account login information to us and/or grant us access to your Third-Party Account, without breach by you of any of the terms and conditions that govern your use of the applicable Third-Party Account, and without obligating us to pay any fees or making us subject to any usage limitations imposed by the third-party service provider of the Third-Party Account. By granting us access to any Third-Party Accounts, you understand that (1) we may access, make available, and store (if applicable) any content that you have provided to and stored in your Third-Party Account (the “Social Network Content”) so that it is available on and through the Site via your account, including without limitation any friend lists and (2) we may submit to and receive from your Third-Party Account additional information to the extent you are notified when you link your account with the Third-Party Account. Depending on the Third-Party Accounts you choose and subject to the privacy settings that you have set in such Third-Party Accounts, personally identifiable information that you post to your Third-Party Accounts may be available on and through your account on the Site. Please note that if a Third-Party Account or associated service becomes unavailable or our access to such Third Party Account is terminated by the third-party service provider, then Social Network Content may no longer be available on and through the Site. You will have the ability to disable the connection between your account on the Site and your Third-Party Accounts at any time.
|
||||||
|
|
||||||
|
PLEASE NOTE THAT YOUR RELATIONSHIP WITH THE THIRD-PARTY SERVICE PROVIDERS ASSOCIATED WITH YOUR THIRD-PARTY ACCOUNTS IS GOVERNED SOLELY BY YOUR AGREEMENT(S) WITH SUCH THIRD-PARTY SERVICE PROVIDERS.
|
||||||
|
|
||||||
|
We make no effort to review any Social Network Content for any purpose, including but not limited to, for accuracy, legality, or non-infringement, and we are not responsible for any Social Network Content. You acknowledge and agree that we may access your email address book associated with a Third-Party Account and your contacts list stored on your mobile device or tablet computer solely for purposes of identifying and informing you of those contacts who have also registered to use the Site. You can deactivate the connection between the Site and your Third-Party Account by contacting us using the contact information below or through your account settings (if applicable). We will attempt to delete any information stored on our servers that was obtained through such Third-Party Account, except the username and profile picture that become associated with your account.
|
||||||
|
|
||||||
|
**SUBMISSIONS**
|
||||||
|
|
||||||
|
You acknowledge and agree that any questions, comments, suggestions, ideas, feedback, or other information regarding the Site (“Submissions”) provided by you to us are non-confidential and shall become our sole property. We shall own exclusive rights, including all intellectual property rights, and shall be entitled to the unrestricted use and dissemination of these Submissions for any lawful purpose, commercial or otherwise, without acknowledgment or compensation to you. You hereby waive all moral rights to any such Submissions, and you hereby warrant that any such Submissions are original with you or that you have the right to submit such Submissions. You agree there shall be no recourse against us for any alleged or actual infringement or misappropriation of any proprietary right in your Submissions.
|
||||||
|
|
||||||
|
**THIRD-PARTY WEBSITES AND CONTENT**
|
||||||
|
|
||||||
|
The Site may contain (or you may be sent via the Site) links to other websites (“Third-Party Websites”) as well as articles, photographs, text, graphics, pictures, designs, music, sound, video, information, applications, software, and other content or items belonging to or originating from third parties (“Third-Party Content”). Such Third-Party Websites and Third-Party Content are not investigated, monitored, or checked for accuracy, appropriateness, or completeness by us, and we are not responsible for any Third-Party Websites accessed through the Site or any Third-Party Content posted on, available through, or installed from the Site, including the content, accuracy, offensiveness, opinions, reliability, privacy practices, or other policies of or contained in the Third-Party Websites or the Third-Party Content. Inclusion of, linking to, or permitting the use or installation of any Third-Party Websites or any Third-Party Content does not imply approval or endorsement thereof by us. If you decide to leave the Site and access the Third-Party Websites or to use or install any Third-Party Content, you do so at your own risk, and you should be aware these Terms of Use no longer govern. You should review the applicable terms and policies, including privacy and data gathering practices, of any website to which you navigate from the Site or relating to any applications you use or install from the Site. Any purchases you make through Third-Party Websites will be through other websites and from other companies, and we take no responsibility whatsoever in relation to such purchases which are exclusively between you and the applicable third party. You agree and acknowledge that we do not endorse the products or services offered on Third-Party Websites and you shall hold us harmless from any harm caused by your purchase of such products or services. Additionally, you shall hold us harmless from any losses sustained by you or harm caused to you relating to or resulting in any way from any Third-Party Content or any contact with Third-Party Websites.
|
||||||
|
|
||||||
|
**SITE MANAGEMENT**
|
||||||
|
|
||||||
|
We reserve the right, but not the obligation, to: (1) monitor the Site for violations of these Terms of Use; (2) take appropriate legal action against anyone who, in our sole discretion, violates the law or these Terms of Use, including without limitation, reporting such user to law enforcement authorities; (3) in our sole discretion and without limitation, refuse, restrict access to, limit the availability of, or disable (to the extent technologically feasible) any of your Contributions or any portion thereof; (4) in our sole discretion and without limitation, notice, or liability, to remove from the Site or otherwise disable all files and content that are excessive in size or are in any way burdensome to our systems; and (5) otherwise manage the Site in a manner designed to protect our rights and property and to facilitate the proper functioning of the Site.
|
||||||
|
|
||||||
|
**PRIVACY POLICY**
|
||||||
|
|
||||||
|
We care about data privacy and security. Please review our Privacy Policy.
|
||||||
|
|
||||||
|
By using the Site, you agree to be bound by our Privacy Policy, which is incorporated into these Terms of Use. Please be advised the Site is hosted in the United States. If you access the Site from the European Union, Asia, or any other region of the world with laws or other requirements governing personal data collection, use, or disclosure that differ from applicable laws in the United States, then through your continued use of the Site, you are transferring your data to the United States, and you expressly consent to have your data transferred to and processed in the United States. Further, we do not knowingly accept, request, or solicit information from children or knowingly market to children. Therefore, in accordance with the U.S. Children’s Online Privacy Protection Act, if we receive actual knowledge that anyone under the age of 13 has provided personal information to us without the requisite and verifiable parental consent, we will delete that information from the Site as quickly as is reasonably practical.
|
||||||
|
|
||||||
|
**TERM AND TERMINATION**
|
||||||
|
|
||||||
|
These Terms of Use shall remain in full force and effect while you use the Site. WITHOUT LIMITING ANY OTHER PROVISION OF THESE TERMS OF USE, WE RESERVE THE RIGHT TO, IN OUR SOLE DISCRETION AND WITHOUT NOTICE OR LIABILITY, DENY ACCESS TO AND USE OF THE SITE (INCLUDING BLOCKING CERTAIN IP ADDRESSES), TO ANY PERSON FOR ANY REASON OR FOR NO REASON, INCLUDING WITHOUT LIMITATION FOR BREACH OF ANY REPRESENTATION, WARRANTY, OR COVENANT CONTAINED IN THESE TERMS OF USE OR OF ANY APPLICABLE LAW OR REGULATION. WE MAY TERMINATE YOUR USE OR PARTICIPATION IN THE SITE OR DELETE YOUR ACCOUNT AND ANY CONTENT OR INFORMATION THAT YOU POSTED AT ANY TIME, WITHOUT WARNING, IN OUR SOLE DISCRETION.
|
||||||
|
|
||||||
|
If we terminate or suspend your account for any reason, you are prohibited from registering and creating a new account under your name, a fake or borrowed name, or the name of any third party, even if you may be acting on behalf of the third party. In addition to terminating or suspending your account, we reserve the right to take appropriate legal action, including without limitation pursuing civil, criminal, and injunctive redress.
|
||||||
|
|
||||||
|
**MODIFICATIONS AND INTERRUPTIONS**
|
||||||
|
|
||||||
|
We reserve the right to change, modify, or remove the contents of the Site at any time or for any reason at our sole discretion without notice. However, we have no obligation to update any information on our Site. We also reserve the right to modify or discontinue all or part of the Site without notice at any time. We will not be liable to you or any third party for any modification, price change, suspension, or discontinuance of the Site.
|
||||||
|
|
||||||
|
We cannot guarantee the Site will be available at all times. We may experience hardware, software, or other problems or need to perform maintenance related to the Site, resulting in interruptions, delays, or errors. We reserve the right to change, revise, update, suspend, discontinue, or otherwise modify the Site at any time or for any reason without notice to you. You agree that we have no liability whatsoever for any loss, damage, or inconvenience caused by your inability to access or use the Site during any downtime or discontinuance of the Site. Nothing in these Terms of Use will be construed to obligate us to maintain and support the Site or to supply any corrections, updates, or releases in connection therewith.
|
||||||
|
|
||||||
|
**GOVERNING LAW**
|
||||||
|
|
||||||
|
These Terms of Use and your use of the Site are governed by and construed in accordance with the laws of Belgium, without regard to its conflict of law principles. DISPUTE RESOLUTION
|
||||||
|
|
||||||
|
Any legal action of whatever nature brought by either you or us (collectively, the “Parties” and individually, a “Party”) shall be commenced or prosecuted in courts located in Belgium, Ghent, and the Parties hereby consent to, and waive all defenses of lack of personal jurisdiction and forum non conveniens with respect to venue and jurisdiction in such state and federal courts. Application of the United Nations Convention on Contracts for the International Sale of Goods and the Uniform Computer Information Transaction Act (UCITA) are excluded from these Terms of Use. In no event shall any claim, action, or proceeding brought by either Party related in any way to the Site be commenced more than one (1) years after the cause of action arose.
|
||||||
|
|
||||||
|
**CORRECTIONS**
|
||||||
|
|
||||||
|
There may be information on the Site that contains typographical errors, inaccuracies, or omissions, including descriptions, pricing, availability, and various other information. We reserve the right to correct any errors, inaccuracies, or omissions and to change or update the information on the Site at any time, without prior notice.
|
||||||
|
|
||||||
|
**DISCLAIMER**
|
||||||
|
|
||||||
|
THE SITE IS PROVIDED ON AN AS-IS AND AS-AVAILABLE BASIS. YOU AGREE THAT YOUR USE OF THE SITE AND OUR SERVICES WILL BE AT YOUR SOLE RISK. TO THE FULLEST EXTENT PERMITTED BY LAW, WE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, IN CONNECTION WITH THE SITE AND YOUR USE THEREOF, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. WE MAKE NO WARRANTIES OR REPRESENTATIONS ABOUT THE ACCURACY OR COMPLETENESS OF THE SITE’S CONTENT OR THE CONTENT OF ANY WEBSITES LINKED TO THE SITE AND WE WILL ASSUME NO LIABILITY OR RESPONSIBILITY FOR ANY (1) ERRORS, MISTAKES, OR INACCURACIES OF CONTENT AND MATERIALS, (2) PERSONAL INJURY OR PROPERTY DAMAGE, OF ANY NATURE WHATSOEVER, RESULTING FROM YOUR ACCESS TO AND USE OF THE SITE, (3) ANY UNAUTHORIZED ACCESS TO OR USE OF OUR SECURE SERVERS AND/OR ANY AND ALL PERSONAL INFORMATION AND/OR FINANCIAL INFORMATION STORED THEREIN, (4) ANY INTERRUPTION OR CESSATION OF TRANSMISSION TO OR FROM THE SITE, (5) ANY BUGS, VIRUSES, TROJAN HORSES, OR THE LIKE WHICH MAY BE TRANSMITTED TO OR THROUGH THE SITE BY ANY THIRD PARTY, AND/OR (6) ANY ERRORS OR OMISSIONS IN ANY CONTENT AND MATERIALS OR FOR ANY LOSS OR DAMAGE OF ANY KIND INCURRED AS A RESULT OF THE USE OF ANY CONTENT POSTED, TRANSMITTED, OR OTHERWISE MADE AVAILABLE VIA THE SITE. WE DO NOT WARRANT, ENDORSE, GUARANTEE, OR ASSUME RESPONSIBILITY FOR ANY PRODUCT OR SERVICE ADVERTISED OR OFFERED BY A THIRD PARTY THROUGH THE SITE, ANY HYPERLINKED WEBSITE, OR ANY WEBSITE OR MOBILE APPLICATION FEATURED IN ANY BANNER OR OTHER ADVERTISING, AND WE WILL NOT BE A PARTY TO OR IN ANY WAY BE RESPONSIBLE FOR MONITORING ANY TRANSACTION BETWEEN YOU AND ANY THIRD-PARTY PROVIDERS OF PRODUCTS OR SERVICES. AS WITH THE PURCHASE OF A PRODUCT OR SERVICE THROUGH ANY MEDIUM OR IN ANY ENVIRONMENT, YOU SHOULD USE YOUR BEST JUDGMENT AND EXERCISE CAUTION WHERE APPROPRIATE. LIMITATIONS OF LIABILITY
|
||||||
|
|
||||||
|
IN NO EVENT WILL WE OR OUR DIRECTORS, EMPLOYEES, OR AGENTS BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL, EXEMPLARY, INCIDENTAL, SPECIAL, OR PUNITIVE DAMAGES, INCLUDING LOST PROFIT, LOST REVENUE, LOSS OF DATA, OR OTHER DAMAGES ARISING FROM YOUR USE OF THE SITE, EVEN IF WE HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. NOTWITHSTANDING ANYTHING TO THE CONTRARY CONTAINED HEREIN, OUR LIABILITY TO YOU FOR ANY CAUSE WHATSOEVER AND REGARDLESS OF THE FORM OF THE ACTION, WILL AT ALL TIMES BE LIMITED TO $1.00 USD. CERTAIN STATE LAWS DO NOT ALLOW LIMITATIONS ON IMPLIED WARRANTIES OR THE EXCLUSION OR LIMITATION OF CERTAIN DAMAGES. IF THESE LAWS APPLY TO YOU, SOME OR ALL OF THE ABOVE DISCLAIMERS OR LIMITATIONS MAY NOT APPLY TO YOU, AND YOU MAY HAVE ADDITIONAL RIGHTS. INDEMNIFICATION
|
||||||
|
|
||||||
|
You agree to defend, indemnify, and hold us harmless, including our subsidiaries, affiliates, and all of our respective officers, agents, partners, and employees, from and against any loss, damage, liability, claim, or demand, including reasonable attorneys’ fees and expenses, made by any third party due to or arising out of: (1) your Contributions; (2) use of the Site; (3) breach of these Terms of Use; (4) any breach of your representations and warranties set forth in these Terms of Use; (5) your violation of the rights of a third party, including but not limited to intellectual property rights; or (6) any overt harmful act toward any other user of the Site with whom you connected via the Site. Notwithstanding the foregoing, we reserve the right, at your expense, to assume the exclusive defense and control of any matter for which you are required to indemnify us, and you agree to cooperate, at your expense, with our defense of such claims. We will use reasonable efforts to notify you of any such claim, action, or proceeding which is subject to this indemnification upon becoming aware of it.
|
||||||
|
|
||||||
|
**USER DATA**
|
||||||
|
|
||||||
|
We will maintain certain data that you transmit to the Site for the purpose of managing the performance of the Site, as well as data relating to your use of the Site. Although we perform regular routine backups of data, you are solely responsible for all data that you transmit or that relates to any activity you have undertaken using the Site. You agree that we shall have no liability to you for any loss or corruption of any such data, and you hereby waive any right of action against us arising from any such loss or corruption of such data.
|
||||||
|
|
||||||
|
**ELECTRONIC COMMUNICATIONS, TRANSACTIONS, AND SIGNATURES**
|
||||||
|
|
||||||
|
Visiting the Site, sending us emails, and completing online forms constitute electronic communications. You consent to receive electronic communications, and you agree that all agreements, notices, disclosures, and other communications we provide to you electronically, via email and on the Site, satisfy any legal requirement that such communication be in writing. YOU HEREBY AGREE TO THE USE OF ELECTRONIC SIGNATURES, CONTRACTS, ORDERS, AND OTHER RECORDS, AND TO ELECTRONIC DELIVERY OF NOTICES, POLICIES, AND RECORDS OF TRANSACTIONS INITIATED OR COMPLETED BY US OR VIA THE SITE. You hereby waive any rights or requirements under any statutes, regulations, rules, ordinances, or other laws in any jurisdiction which require an original signature or delivery or retention of non-electronic records, or to payments or the granting of credits by any means other than electronic means. MISCELLANEOUS
|
||||||
|
|
||||||
|
These Terms of Use and any policies or operating rules posted by us on the Site or in respect to the Site constitute the entire agreement and understanding between you and us. Our failure to exercise or enforce any right or provision of these Terms of Use shall not operate as a waiver of such right or provision. These Terms of Use operate to the fullest extent permissible by law. We may assign any or all of our rights and obligations to others at any time. We shall not be responsible or liable for any loss, damage, delay, or failure to act caused by any cause beyond our reasonable control. If any provision or part of a provision of these Terms of Use is determined to be unlawful, void, or unenforceable, that provision or part of the provision is deemed severable from these Terms of Use and does not affect the validity and enforceability of any remaining provisions. There is no joint venture, partnership, employment or agency relationship created between you and us as a result of these Terms of Use or use of the Site. You agree that these Terms of Use will not be construed against us by virtue of having drafted them. You hereby waive any and all defenses you may have based on the electronic form of these Terms of Use and the lack of signing by the parties hereto to execute these Terms of Use.
|
||||||
|
|
||||||
|
**CONTACT US**
|
||||||
|
|
||||||
|
In order to resolve a complaint regarding the Site or to receive further information regarding use of the Site, please contact us at:
|
||||||
|
|
||||||
|
- ThreeFold FCZ
|
||||||
|
- BA1120 DMCC BUSINESS CENTRE, LEVEL NO 1, JEWELLERY & GEMPLEX 3, DUBAI, UNITED EMIRATES ARAB
|
||||||
|
- info@threefold.io
|
||||||
10
src/content/docs/references/disclaimer.md
Normal file
10
src/content/docs/references/disclaimer.md
Normal file
@ -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.
|
||||||
35
src/content/docs/references/glossary.md
Normal file
35
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 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.
|
||||||
BIN
src/content/docs/references/img/devops.png
Normal file
BIN
src/content/docs/references/img/devops.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 428 KiB |
BIN
src/content/docs/references/img/image1.png
Normal file
BIN
src/content/docs/references/img/image1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 517 KiB |
BIN
src/content/docs/references/img/image4.png
Normal file
BIN
src/content/docs/references/img/image4.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 376 KiB |
BIN
src/content/docs/references/img/qsss_overview.png
Normal file
BIN
src/content/docs/references/img/qsss_overview.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 245 KiB |
BIN
src/content/docs/references/img/redundant_net.jpg
Normal file
BIN
src/content/docs/references/img/redundant_net.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 463 KiB |
BIN
src/content/docs/references/img/release_schedule.png
Normal file
BIN
src/content/docs/references/img/release_schedule.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 134 KiB |
BIN
src/content/docs/references/img/smartcontract3_flow.jpg
Normal file
BIN
src/content/docs/references/img/smartcontract3_flow.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 337 KiB |
BIN
src/content/docs/references/img/storage_today.png
Normal file
BIN
src/content/docs/references/img/storage_today.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 337 KiB |
BIN
src/content/docs/references/img/webgateway.jpg
Normal file
BIN
src/content/docs/references/img/webgateway.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 286 KiB |
BIN
src/content/docs/references/img/webgw_scaling.jpg
Normal file
BIN
src/content/docs/references/img/webgw_scaling.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 425 KiB |
BIN
src/content/docs/references/img/word_records.png
Normal file
BIN
src/content/docs/references/img/word_records.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 340 KiB |
BIN
src/content/docs/references/img/zero_knowledge_proof.png
Normal file
BIN
src/content/docs/references/img/zero_knowledge_proof.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 134 KiB |
1040
src/content/docs/references/inca_whitepaper.md
Normal file
1040
src/content/docs/references/inca_whitepaper.md
Normal file
File diff suppressed because it is too large
Load Diff
255
src/content/docs/resources/farmerbot.md
Normal file
255
src/content/docs/resources/farmerbot.md
Normal file
@ -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 `<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
|
||||||
|
```
|
||||||
|
|
||||||
|
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
|
||||||
|
```
|
||||||
|
|
||||||
|
### 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
|
||||||
|
```
|
||||||
115
src/content/docs/resources/node_status_bot.md
Normal file
115
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.
|
||||||
11
src/content/docs/resources/resources_introduction.md
Normal file
11
src/content/docs/resources/resources_introduction.md
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
---
|
||||||
|
title: How to Use the Bots
|
||||||
|
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.
|
||||||
28
src/content/docs/start_here/getting_started.md
Normal file
28
src/content/docs/start_here/getting_started.md
Normal file
@ -0,0 +1,28 @@
|
|||||||
|
---
|
||||||
|
title: Getting Started
|
||||||
|
description: Basic Steps to Farm INCA!
|
||||||
|
---
|
||||||
|
|
||||||
|
> IMPORTANT: Project INCA Docs will be updated for the launch of the project. The content of this website is not the final version and steps are not yet implemented for INCA nodes.
|
||||||
|
|
||||||
|
It's now easier than ever to become a farmer on the ThreeFold Grid thanks to Project **IN**ternet **CA**pacity.
|
||||||
|
|
||||||
|
Farmers are cloud service providers who offer compute, storage and network resources to the world. In exchange, farmers receive INCA rewards.
|
||||||
|
|
||||||
|
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 app
|
||||||
|
- 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!
|
||||||
2
src/env.d.ts
vendored
Normal file
2
src/env.d.ts
vendored
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
/// <reference path="../.astro/types.d.ts" />
|
||||||
|
/// <reference types="astro/client" />
|
||||||
3
tsconfig.json
Normal file
3
tsconfig.json
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"extends": "astro/tsconfigs/strict"
|
||||||
|
}
|
||||||
Loading…
Reference in New Issue
Block a user