Merge pull request 'manual, set internal collections to filename.md template' (#66) from development_manual2 into development_manual

Reviewed-on: #66
This commit is contained in:
mik-tf 2024-05-13 23:32:25 +00:00
commit a11893fcf0
169 changed files with 709 additions and 709 deletions

View File

@ -1,38 +1,38 @@
- [Introduction](tech/technology.md) - [Introduction](technology.md)
- [The Internet Today](tech/internet_today.md) - [The Internet Today](internet_today.md)
- [History of Computers](tech/history/c64.md) - [History of Computers](c64.md)
- [Too Many Layers](tech/history/layers.md) - [Too Many Layers](layers.md)
- [The Internet Re-invented](tech/how_does_it_work.md) - [The Internet Re-invented](how_does_it_work.md)
- [World Records](tech/world_records.md) - [World Records](world_records.md)
- [Key Innovations](tech/key_innovations_overview.md) - [Key Innovations](key_innovations_overview.md)
- [Mycelium Network](tech/mycelium_innovation.md) - [Mycelium Network](mycelium_innovation.md)
- [Zero-OS](tech/zos_innovation.md) - [Zero-OS](zos_innovation.md)
- [Quantum Safe Storage](tech/zstor_innovation.md) - [Quantum Safe Storage](zstor_innovation.md)
- [Quantum Safe Filesystem](tech/qsfs_innovation.md) - [Quantum Safe Filesystem](qsfs_innovation.md)
- [FList: Better OS Images](tech/flist_innovation.md) - [FList: Better OS Images](flist_innovation.md)
- [FungiStor](tech/fungistor_innovation.md) - [FungiStor](fungistor_innovation.md)
- [Network Wall](tech/network_wall_innovation.md) - [Network Wall](network_wall_innovation.md)
- [Architecture](tech/architecture.md) - [Architecture](architecture.md)
- [Energy Efficient](tech/energy_efficient.md) - [Energy Efficient](energy_efficient.md)
- [Decentralized Cloud Core Capabilities](tech/features.md) - [Decentralized Cloud Core Capabilities](features.md)
- [Storage](tech/qsss_home.md) - [Storage](qsss_home.md)
- [Quantum Safe Storage Algo](tech/qss_algorithm.md) - [Quantum Safe Storage Algo](qss_algorithm.md)
- [Zero Knowledge proof](tech/qss_zero_knowledge_proof.md) - [Zero Knowledge proof](qss_zero_knowledge_proof.md)
- [NFT Storage](tech/nft_storage.md) - [NFT Storage](nft_storage.md)
- [S3 Storage](tech/s3_interface) - [S3 Storage](tech/s3_interface)
- [File System](tech/qss_filesystem.md) - [File System](qss_filesystem.md)
- [Network](tech/networking.md) - [Network](networking.md)
- [Mycelium](tech/mycelium.md) - [Mycelium](mycelium.md)
- [Web Gateway](tech/webgw.md) - [Web Gateway](webgw.md)
- [Partners Utilization](partners_utilization/partners.md) - [Partners Utilization](partners.md)
- [Sikana](partners_utilization/sikana.md) - [Sikana](sikana.md)
- [Vindo](partners_utilization/vindo.md) - [Vindo](vindo.md)
- [Mkondo](partners_utilization/mkondo.md) - [Mkondo](mkondo.md)
- [Vverse](partners_utilization/vverse.md) - [Vverse](vverse.md)
- [Earth Wallet](partners_utilization/earth_wallet.md) - [Earth Wallet](earth_wallet.md)
- [Elestio](partners_utilization/elestio.md) - [Elestio](elestio.md)
- [OW Freezone](partners_utilization/freezone.md) - [OW Freezone](freezone.md)
- [Helium](partners_utilization/helium.md) - [Helium](helium.md)
- [Holochain](partners_utilization/holochain.md) - [Holochain](holochain.md)
- [TZG](partners_utilization/tanzania.md) - [TZG](tanzania.md)
- [Tier-S DC](partners_utilization/tier_s_datacenter.md) - [Tier-S DC](tier_s_datacenter.md)

View File

@ -6,8 +6,8 @@ It's a good place to start if you want to have an overview of ThreeFold since it
<h2> Table of Contents </h2> <h2> Table of Contents </h2>
- [ThreeFold History](./threefold_history.md) - [ThreeFold History](threefold_history.md)
- [ThreeFold Tech](./threefold_tech.md) - [ThreeFold Tech](threefold_tech.md)
- [Organisation Structure](./orgstructure.md) - [Organisation Structure](orgstructure.md)
- [ThreeFold Roadmap](./roadmap/roadmap_readme.md) - [ThreeFold Roadmap](roadmap_readme.md)
- [ThreeFold Token](./token_overview/token_overview.md) - [ThreeFold Token](token_overview.md)

View File

@ -15,7 +15,7 @@ European Farming Cooperative for the foundation:
- Operates a data center in Lochristi (Belgium) offering hosting and connectivity for TF Farmers - Operates a data center in Lochristi (Belgium) offering hosting and connectivity for TF Farmers
- Currently, 100+ nodes many of them are owned by TF farmers - Currently, 100+ nodes many of them are owned by TF farmers
- [ThreeFold Tech](./threefold_tech.md) NV uses some of their equipment today for development - [ThreeFold Tech](threefold_tech.md) NV uses some of their equipment today for development
- Sale of small servers to TF Farmers, was done mainly via an online webshop - Sale of small servers to TF Farmers, was done mainly via an online webshop
## Income ## Income

View File

@ -24,8 +24,8 @@ Amongst others the DAO needs to arrange
| Utility Token model | | | Utility Token model | |
| -------------------------------------------- | ------------------------------------------ | | -------------------------------------------- | ------------------------------------------ |
| [Proof Of Capacity](../../farming/proof_of_capacity.md) | Farming (creation) of TFT | | [Proof Of Capacity](proof_of_capacity.md) | Farming (creation) of TFT |
| [Proof Of Utilization](../../farming/proof_of_utilization.md) | Utilization (burning, distribution) of TFT | | [Proof Of Utilization](proof_of_utilization.md) | Utilization (burning, distribution) of TFT |
As well as As well as

View File

@ -32,12 +32,12 @@ Many hundreds of servers have been used to develop the technology which now make
Most of the servers are in Dubai and in Ghent (Belgium). Most of the servers are in Dubai and in Ghent (Belgium).
- To see the [genesis pool in Ghent, see here](./genesis_pool_ghent.md) - To see the [genesis pool in Ghent, see here](genesis_pool_ghent.md)
- To see the [genesis pool in Dubai, see here](./genesis_pool_dubai.md) - To see the [genesis pool in Dubai, see here](genesis_pool_dubai.md)
All genesis pools were owned by the foundation. Many of those servers are at this point no longer active. The operations were done by ThreeFold_Dubai and BetterToken as Farming Cooperative. All genesis pools were owned by the foundation. Many of those servers are at this point no longer active. The operations were done by ThreeFold_Dubai and BetterToken as Farming Cooperative.
> For information about genesis pool/block, see [here](./genesis_block_pool_details.md). > For information about genesis pool/block, see [here](genesis_block_pool_details.md).
## Genesis Pool Token Usage ## Genesis Pool Token Usage
@ -46,7 +46,7 @@ All genesis pools were owned by the foundation. Many of those servers are at thi
- This was a deal made mid 2018 and provided the ThreeFold Dubai with technology and a global engineering team. - This was a deal made mid 2018 and provided the ThreeFold Dubai with technology and a global engineering team.
- The other part went to ThreeFold Dubai, to allow the Foundation to promote & further grow the project. - The other part went to ThreeFold Dubai, to allow the Foundation to promote & further grow the project.
> [See Token Overview](./token_overview/token_overview.md) for more details. > [See Token Overview](token_overview.md) for more details.
The tokens were used from out of ThreeFold_Dubai to create value for the ThreeFold Grid. The tokens were used from out of ThreeFold_Dubai to create value for the ThreeFold Grid.

View File

@ -4,4 +4,4 @@
![](img/genesispool_2.jpg) ![](img/genesispool_2.jpg)
Read more about ThreeFold Dubai [here](./threefold_dubai.md). Read more about ThreeFold Dubai [here](threefold_dubai.md).

View File

@ -22,7 +22,7 @@ The project is grateful of the support of its community and the commercial entit
ThreeFold is fundamentally a decentralized initiative. Within this framework, ThreeFold Dubai plays a pivotal role in championing and advancing the ThreeFold Grid and the broader movement. ThreeFold is fundamentally a decentralized initiative. Within this framework, ThreeFold Dubai plays a pivotal role in championing and advancing the ThreeFold Grid and the broader movement.
For more information, read the [ThreeFold History](./threefold_history.md). For more information, read the [ThreeFold History](threefold_history.md).
## Type of Token ## Type of Token
@ -39,7 +39,7 @@ For more information, [read the legal opinions](https://drive.google.com/file/d/
## Governance Process ## Governance Process
To make sure that all our funds are used properly and that decisions are taken for the benefit of ThreeFold and its community as a whole, we make use of different tools and features, such as multi-signature wallets, the [ThreeFold DAO](./dao/tfdao.md) and the [ThreeFold Forum](https://forum.threefold.io/). To make sure that all our funds are used properly and that decisions are taken for the benefit of ThreeFold and its community as a whole, we make use of different tools and features, such as multi-signature wallets, the [ThreeFold DAO](tfdao.md) and the [ThreeFold Forum](https://forum.threefold.io/).
## Organic Growth ## Organic Growth
@ -51,7 +51,7 @@ The Genesis pool was based on real hardware located in Dubai and Ghent.
The tokens out of this pool are safe and well managed. We are acquiring a lot of them with ThreeFold Cloud (ThreeFold Dubai). The tokens out of this pool are safe and well managed. We are acquiring a lot of them with ThreeFold Cloud (ThreeFold Dubai).
For more information on the Genesis pool, [read this section](./genesis_pool.md). For more information on the Genesis pool, [read this section](genesis_pool.md).
## Decentralized and Open-Source ## Decentralized and Open-Source

View File

@ -10,7 +10,7 @@
## Introduction ## Introduction
Mazraa is a brand name of [ThreeFold Dubai](./threefold_dubai.md). You can read about ThreeFold Dubai for more details. Mazraa is a brand name of [ThreeFold Dubai](threefold_dubai.md). You can read about ThreeFold Dubai for more details.
## History ## History

View File

@ -2,13 +2,13 @@
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
- [Governance](./governance.md) - [Governance](governance.md)
- [ThreeFold Companies](./threefold_companies.md) - [ThreeFold Companies](threefold_companies.md)
- [ThreeFold Dubai](./threefold_dubai.md) - [ThreeFold Dubai](threefold_dubai.md)
- [ThreeFold VZW](./threefold_vzw.md) - [ThreeFold VZW](threefold_vzw.md)
- [ThreeFold AG](./threefold_ag.md) - [ThreeFold AG](threefold_ag.md)
- [Mazraa](./mazraa.md) - [Mazraa](mazraa.md)
- [BetterToken](./bettertoken.md) - [BetterToken](bettertoken.md)
- [DAO](./dao.md) - [DAO](dao.md)
- [ThreeFold DAO](./tfdao.md) - [ThreeFold DAO](tfdao.md)
- [TFChain](./tfchain.md) - [TFChain](tfchain.md)

View File

@ -7,13 +7,13 @@
Whether you're a developer, a farmer, a user, or simply curious about the cutting-edge advancements happening in the world of distributed computing, these release notes will provide you with valuable insights and keep you up to date with our progress. So dive in, explore the details, and join us in shaping the future of the ThreeFold Grid! Whether you're a developer, a farmer, a user, or simply curious about the cutting-edge advancements happening in the world of distributed computing, these release notes will provide you with valuable insights and keep you up to date with our progress. So dive in, explore the details, and join us in shaping the future of the ThreeFold Grid!
## ThreeFold TFGrid v3.x Release Notes ## ThreeFold TFGrid v3.x Release Notes
- [TFGrid v3.10.0](./tfgrid_release_3_10_0.md) - [TFGrid v3.10.0](tfgrid_release_3_10_0.md)
- [TFGrid v3.9.0](./tfgrid_release_3_9_0.md) - [TFGrid v3.9.0](tfgrid_release_3_9_0.md)
- [TFGrid v3.8.0](./tfgrid_release_3_8_0.md) - [TFGrid v3.8.0](tfgrid_release_3_8_0.md)
- [TFGrid v3.7.0](./tfgrid_release_3_7_0.md) - [TFGrid v3.7.0](tfgrid_release_3_7_0.md)
- [TFGrid v3.6.1](./tfgrid_release_3_6_1.md) - [TFGrid v3.6.1](tfgrid_release_3_6_1.md)
- [TFGrid v3.6.0](./tfgrid_release_3_6_0.md) - [TFGrid v3.6.0](tfgrid_release_3_6_0.md)
- [TFGrid v3.0.0 Alpha-5](./tfgrid_release_3_0_a5.md) - [TFGrid v3.0.0 Alpha-5](tfgrid_release_3_0_a5.md)
- [TFGrid v3.0.0 Alpha-4](./tfgrid_release_3_0_a4.md) - [TFGrid v3.0.0 Alpha-4](tfgrid_release_3_0_a4.md)
- [TFGrid v3.0.0 Alpha-2](./tfgrid_release_3_0_a2.md) - [TFGrid v3.0.0 Alpha-2](tfgrid_release_3_0_a2.md)
- [TFGrid v3.0.0](./tfgrid_release_3_0.md) - [TFGrid v3.0.0](tfgrid_release_3_0.md)

View File

@ -67,7 +67,7 @@ Below are some of the key highlights of the TFGrid v3.10.0 component upgrades an
#### TF-Grid-CLI #### TF-Grid-CLI
- Introduced a simple tool for creating virtual machines and Kubernetes clusters. Note that `TF-Grid-CLI` is now `TFCMD`. - Introduced a simple tool for creating virtual machines and Kubernetes clusters. Note that `TF-Grid-CLI` is now `TFCMD`.
- Get started [here](../../../../documentation/developers/tfcmd/tfcmd.md). - Get started [here](tfcmd.md).
#### Gridify #### Gridify

View File

@ -18,7 +18,7 @@ This release note includes updates, improvements and fixes of numerous grid comp
## Upgrades and Improvements ## Upgrades and Improvements
### TFChain v2.2.0 ### TFChain v2.2.0
- Added [Third Party Billing Services](https://github.com/threefoldtech/tfchain/blob/12bc8842c7c321d22e36667a91dfc5d3c7d04ab8/substrate-node/pallets/pallet-smart-contract/service_consumer_contract_flow.md), allowing defining contracts between TFChain users for a service and the billing. - Added [Third Party Billing Services](service_consumer_contract_flow.md), allowing defining contracts between TFChain users for a service and the billing.
- Reworked billing flow, see [details here](https://github.com/threefoldtech/tfchain/issues/269). - Reworked billing flow, see [details here](https://github.com/threefoldtech/tfchain/issues/269).
- Infrastructure wise, we have integrated [Firesquid](https://docs.subsquid.io/), which is showing promising improvements in regards of the storage and data syncing. - Infrastructure wise, we have integrated [Firesquid](https://docs.subsquid.io/), which is showing promising improvements in regards of the storage and data syncing.
- Added Bugfixes around data validations and improving migrations - Added Bugfixes around data validations and improving migrations

View File

@ -35,7 +35,7 @@ Reliable Message Bus Relay (RMB-RS) is a secure communication panel that allows
- End-to-end encryption support. - End-to-end encryption support.
- Support for third-party hosted Relays. Anyone can host a Relay and people can use it safely since there is no way messages can be inspected while using e2e. That's similar to home servers by matrix. - Support for third-party hosted Relays. Anyone can host a Relay and people can use it safely since there is no way messages can be inspected while using e2e. That's similar to home servers by matrix.
See [Specifications](https://github.com/threefoldtech/rmb-rs/blob/main/docs/readme.md) for more information. See [Specifications](readme.md) for more information.
> Below is the list of the __Public Relay Addresses__ hosted by Threefold: > Below is the list of the __Public Relay Addresses__ hosted by Threefold:

View File

@ -2,10 +2,10 @@
Welcome to ThreeFold's product roadmap! We are thrilled to have you on board as we journey towards a decentralized and sustainable future. Our product roadmap outlines the innovative solutions and technologies we are developing to revolutionize the way we compute, store data, and connect. Here, you will find a comprehensive overview of our latest and upcoming releases, enhancements, and advancements across our ecosystem. Welcome to ThreeFold's product roadmap! We are thrilled to have you on board as we journey towards a decentralized and sustainable future. Our product roadmap outlines the innovative solutions and technologies we are developing to revolutionize the way we compute, store data, and connect. Here, you will find a comprehensive overview of our latest and upcoming releases, enhancements, and advancements across our ecosystem.
> Click [here](../../technology/concepts/grid3_components.md) to see the complete TFGrid Component List > Click [here](grid3_components.md) to see the complete TFGrid Component List
## Table of Contents ## Table of Contents
- [TFGrid v3.x Announcement (Aug 2021 - Forum)](https://forum.threefold.io/t/announcement-of-tfgrid-3-0/1132) - [TFGrid v3.x Announcement (Aug 2021 - Forum)](https://forum.threefold.io/t/announcement-of-tfgrid-3-0/1132)
- [What's new on TFGrid v3.x](../../technology/concepts/grid3_whatsnew.md) - [What's new on TFGrid v3.x](grid3_whatsnew.md)
- [Release Notes](./releasenotes/releasenotes_readme.md) - [Release Notes](releasenotes_readme.md)

View File

@ -15,18 +15,18 @@ The following companies are related parties to ThreeFold. Our terms and conditio
| THREEFOLD RELATED COMPANIES | Description | | THREEFOLD RELATED COMPANIES | Description |
| --------------------------------------------------------------- | ---------------------------------------------------------------------------------- | | --------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| [ThreeFold Dubai or ThreeFold Cloud](./threefold_dubai.md) | Promotion of TFGrid + Delivery of ThreeFold Cloud | | [ThreeFold Dubai or ThreeFold Cloud](threefold_dubai.md) | Promotion of TFGrid + Delivery of ThreeFold Cloud |
| [Threefold_Tech](./threefold_tech.md) | Belgium-based tech company owns IP (Intellectual Property) of tech, is open source | | [Threefold_Tech](threefold_tech.md) | Belgium-based tech company owns IP (Intellectual Property) of tech, is open source |
| [ThreeFold_VZW](./threefold_vzw.md) | Non for profit organization in BE, intented to be used for grants work. | | [ThreeFold_VZW](threefold_vzw.md) | Non for profit organization in BE, intented to be used for grants work. |
| [ThreeFold_AG](./threefold_ag.md) | ThreeFold in Zug, Switzerland | | [ThreeFold_AG](threefold_ag.md) | ThreeFold in Zug, Switzerland |
| TF Hub Limited | ThreeFold in BVI | | TF Hub Limited | ThreeFold in BVI |
| Codescalers | Egypt-based software development team, creates a lot of code for ThreeFold | | Codescalers | Egypt-based software development team, creates a lot of code for ThreeFold |
| FARMING COOPERATIVES | | | FARMING COOPERATIVES | |
| ------------------------------------ | ------------------------------------------------ | | ------------------------------------ | ------------------------------------------------ |
| [Mazraa](./mazraa.md) | A farmer in Middle East who is part of ThreeFold_Dubai | | [Mazraa](mazraa.md) | A farmer in Middle East who is part of ThreeFold_Dubai |
| [BetterToken](./bettertoken.md) | BetterToken is the very first ThreeFold Farming Cooperative in Europe | | [BetterToken](bettertoken.md) | BetterToken is the very first ThreeFold Farming Cooperative in Europe |
| SOME LARGER FARMERS | | | SOME LARGER FARMERS | |
@ -36,5 +36,5 @@ The following companies are related parties to ThreeFold. Our terms and conditio
| Moresi | A neutral, technologically advanced data center in Switzerland | | Moresi | A neutral, technologically advanced data center in Switzerland |
| there are many more | ... | | there are many more | ... |
> Please note, ThreeFold Grid 3.x operates as a [DAO](./dao/dao.md) every party who wants to participate with the ThreeFold Grid uses the [TFChain](./tfchain.md) and our Forums. > Please note, ThreeFold Grid 3.x operates as a [DAO](dao.md) every party who wants to participate with the ThreeFold Grid uses the [TFChain](tfchain.md) and our Forums.
> [Click here for more info about our DAO](./dao/tfdao.md) > [Click here for more info about our DAO](tfdao.md)

View File

@ -18,7 +18,7 @@ ThreeFold Dubai is the original team of ThreeFold operated from Dubai and Belgiu
## Responsibilities ## Responsibilities
- Promote ThreeFold Grid and the ThreeFold Token - Promote ThreeFold Grid and the ThreeFold Token
- Work with [ThreeFold Tech](./threefold_tech.md) for the creation and maintenance of the technology. - Work with [ThreeFold Tech](threefold_tech.md) for the creation and maintenance of the technology.
- Legal: signing party with all T&C (terms and conditions) with all future farmers - Legal: signing party with all T&C (terms and conditions) with all future farmers
- Work with many people and companies around the world to grow the threefold ecosystem - Work with many people and companies around the world to grow the threefold ecosystem
- Look for partners who are willing to grow the threefold ecosystem - Look for partners who are willing to grow the threefold ecosystem

View File

@ -23,7 +23,7 @@ Our founders have largely retained their tokens, with only minimal sales, if any
In the earlier days of ThreeFold, there were multiple teams collaborating, but the two core teams were located in Dubai and Belgium. In the earlier days of ThreeFold, there were multiple teams collaborating, but the two core teams were located in Dubai and Belgium.
A group of early supporters bought IT capacity (through buying TFT) from our Genesis pool and our early farmers. These buyers could use their TFT to buy IT capacity from [ThreeFold Dubai](./threefold_dubai.md) or [BetterToken](./bettertoken.md) BV until April 2020, or from the TF Grid directly in a fully decentralized way starting May 2020. A group of early supporters bought IT capacity (through buying TFT) from our Genesis pool and our early farmers. These buyers could use their TFT to buy IT capacity from [ThreeFold Dubai](threefold_dubai.md) or [BetterToken](bettertoken.md) BV until April 2020, or from the TF Grid directly in a fully decentralized way starting May 2020.
The ThreeFold Grid is the result of many farmers using the open source technology of ThreeFold Tech. The ThreeFold Grid is the result of many farmers using the open source technology of ThreeFold Tech.
@ -47,13 +47,13 @@ How much funding was used to make the ThreeFold project possible?
We have worked with multiple regions over the years to look for appropriate structures, we realize we need more funding as such we have launched a venture creator in mauritius who will hopefully invest 7.5m EUR in TFTech as well as in TF Dubai. We have worked with multiple regions over the years to look for appropriate structures, we realize we need more funding as such we have launched a venture creator in mauritius who will hopefully invest 7.5m EUR in TFTech as well as in TF Dubai.
See our [overview of our companies](./threefold_companies.md) See our [overview of our companies](threefold_companies.md)
## Genesis Pool ## Genesis Pool
To kickstart the ThreeFold Grid back in 2017 the foundation committed large amounts of capacity to the grid. This was called the [Genesis Pool](./genesis_pool.md) and the tokens sold as mentioned could be used to use capacity from this pool and more. To kickstart the ThreeFold Grid back in 2017 the foundation committed large amounts of capacity to the grid. This was called the [Genesis Pool](genesis_pool.md) and the tokens sold as mentioned could be used to use capacity from this pool and more.
## History of Tokens ## History of Tokens
For more info about history of tokens, see [token history](./token_history.md). For more info about history of tokens, see [token history](token_history.md).

View File

@ -21,7 +21,7 @@ A **VZW** has no shareholders, only members.
## Functions ## Functions
- owner of the wisdom_council - owner of the wisdom_council
- eventuallly ThreeFold VZW will own some decentralized organizations as operating in the ThreeFold world e.g. [TF Dubai](./threefold_dubai.md) - eventuallly ThreeFold VZW will own some decentralized organizations as operating in the ThreeFold world e.g. [TF Dubai](threefold_dubai.md)
## Some History ## Some History

View File

@ -22,7 +22,7 @@ We present the ThreeFold token history and the path from TFT v1 towards TFT v2.
- More than 10 years ago, this project started from out of our incubator (see [Incubaid](https://www.incubaid.com)) - More than 10 years ago, this project started from out of our incubator (see [Incubaid](https://www.incubaid.com))
- More than 6 years ago TF Foundation started deploying capacity for development purposes - More than 6 years ago TF Foundation started deploying capacity for development purposes
- This became our ([our genesis pool](./genesis_pool.md)), which is the beginning of farming - This became our ([our genesis pool](genesis_pool.md)), which is the beginning of farming
- In 2017-18, value of the genesis pools were about 7m USD in TFT (tokens did not exist yet) - In 2017-18, value of the genesis pools were about 7m USD in TFT (tokens did not exist yet)
- Genesis pools are owned by ThreeFold Dubai (ThreeFold_Dubai). - Genesis pools are owned by ThreeFold Dubai (ThreeFold_Dubai).
- March 2018 our first-generation blockchain for the ThreeFold_Token saw daylight - March 2018 our first-generation blockchain for the ThreeFold_Token saw daylight

View File

@ -31,7 +31,7 @@ By farming, buying, holding, and utilizing ThreeFold Tokens, you are actively su
ThreeFold uses proof-of-capacity to mint tokens. Since the genenis pool, all tokens that are being minted are the result of farming. Minting will stop during 2024, to keep the total amount of TFT at 1 billion, instead of the previously planned 4 billion. Read more about this [here](https://forum.threefold.io/t/end-feb-2024-update-from-the-team/4233). ThreeFold uses proof-of-capacity to mint tokens. Since the genenis pool, all tokens that are being minted are the result of farming. Minting will stop during 2024, to keep the total amount of TFT at 1 billion, instead of the previously planned 4 billion. Read more about this [here](https://forum.threefold.io/t/end-feb-2024-update-from-the-team/4233).
> For more details, see [Proof of Capacity](../../farming/proof_of_capacity.md) > For more details, see [Proof of Capacity](proof_of_capacity.md)
## Proof-of-Utilization ## Proof-of-Utilization
@ -41,7 +41,7 @@ TFT is used on the TFGrid to purchase network, compute and storage resources thr
![](img/token_distribution.png) ![](img/token_distribution.png)
> For more details, see [Proof-of-Utilization](../../farming/proof_of_utilization.md) > For more details, see [Proof-of-Utilization](proof_of_utilization.md)
## TFT Distribution ## TFT Distribution
@ -80,9 +80,9 @@ The values here are subject to change. Check the current market conditions.
## Complemetary Information ## Complemetary Information
- [ThreeFold History](../../about/threefold_history.md) - [ThreeFold History](threefold_history.md)
- [Token History](../../about/token_history.md) - [Token History](token_history.md)
- [Special Wallets](./special_wallets/stats_special_wallets.md) - [Special Wallets](stats_special_wallets.md)
## Disclaimer ## Disclaimer

View File

@ -6,11 +6,11 @@ To deploy on the ThreeFold Grid, refer to the [System Administrators](system_adm
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
- [Cloud Units](./cloudunits.md) - [Cloud Units](cloudunits.md)
- [Pricing](./pricing_toc.md) - [Pricing](pricing_toc.md)
- [Pricing Overview](./pricing.md) - [Pricing Overview](pricing.md)
- [Staking Discounts](./staking_discount_levels.md) - [Staking Discounts](staking_discount_levels.md)
- [Cloud Pricing Compare](./cloud_pricing_compare.md) - [Cloud Pricing Compare](cloud_pricing_compare.md)
- [Grid Billing](./grid_billing.md) - [Grid Billing](grid_billing.md)
- [Resource Units](./resource_units_calc_cloudunits.md) - [Resource Units](resource_units_calc_cloudunits.md)
- [Resource Units Advanced](./resourceunits_advanced.md) - [Resource Units Advanced](resourceunits_advanced.md)

View File

@ -19,7 +19,7 @@ Cloud units are a unified way to account for virtual hardware resources on the T
- Storage Unit (SU): The amount of storage capacity in terms of Hard Disk Drives (HDDs) and Solid State Drives (SSDs) in Gigabytes (GB). - Storage Unit (SU): The amount of storage capacity in terms of Hard Disk Drives (HDDs) and Solid State Drives (SSDs) in Gigabytes (GB).
- Network Unit (NU): The amount of data that travels in and out of storage units or compute units expressed in GB. - Network Unit (NU): The amount of data that travels in and out of storage units or compute units expressed in GB.
> Note: [Resource units](./resource_units_calc_cloudunits.md) are used to calculate SU & CU. Resource Units are used to measure compute and storage capacity produced by hardware. > Note: [Resource units](resource_units_calc_cloudunits.md) are used to calculate SU & CU. Resource Units are used to measure compute and storage capacity produced by hardware.
When a solution is deployed on the ThreeFold Grid, the system automatically gathers the required amount of CU, SU, or NU. It is important to note that users are not billed upon reservation but only when utilizing the actualy CU, SU and NU. TF Certified Farmers can define the price of CU, SU, and NU they make available on the ThreeFold Grid. When a solution is deployed on the ThreeFold Grid, the system automatically gathers the required amount of CU, SU, or NU. It is important to note that users are not billed upon reservation but only when utilizing the actualy CU, SU and NU. TF Certified Farmers can define the price of CU, SU, and NU they make available on the ThreeFold Grid.
@ -42,7 +42,7 @@ Example of Compute unit:
- Recommended price on TF Grid = 10 USD - Recommended price on TF Grid = 10 USD
- Alternative cloud price = between 40 USD and 180 USD - Alternative cloud price = between 40 USD and 180 USD
See how we compare with the market compute prices [here](./pricing/pricing.md). See how we compare with the market compute prices [here](pricing.md).
### Storage Capacity ### Storage Capacity
@ -58,7 +58,7 @@ Example of Storage unit:
- Recommended price on TF Grid for 1 SU = 10 USD - Recommended price on TF Grid for 1 SU = 10 USD
- Alternative cloud price = between 20 USD and 200 USD - Alternative cloud price = between 20 USD and 200 USD
See how we compare with market storage prices [here](./pricing/pricing.md). See how we compare with market storage prices [here](pricing.md).
### Network ### Network
@ -66,4 +66,4 @@ See how we compare with market storage prices [here](./pricing/pricing.md).
| ------------------------------------------ | -------- | | ------------------------------------------ | -------- |
| GB transferred OUT or IN | 1 | | GB transferred OUT or IN | 1 |
> We use SU-month and CU-month to show SU monthly costs. This can be compared to kilowatts (kW) to see electricity usage per month. Learn more about how this is calculated with [Resource units](./resource_units_calc_cloudunits.md), a way to measure the compute and storage capacity produced by hardware. > We use SU-month and CU-month to show SU monthly costs. This can be compared to kilowatts (kW) to see electricity usage per month. Learn more about how this is calculated with [Resource units](resource_units_calc_cloudunits.md), a way to measure the compute and storage capacity produced by hardware.

View File

@ -130,7 +130,7 @@ Contract cost/hour = CU cost/hour + SU cost/hour
### Applying the Discounts ### Applying the Discounts
Before assuming that the price above is the final price, check first if your twin is eligible for any of the available staking discount levels. To understand more about discount levels, please read [this section](../pricing/staking_discount_levels.md). Before assuming that the price above is the final price, check first if your twin is eligible for any of the available staking discount levels. To understand more about discount levels, please read [this section](staking_discount_levels.md).
For this example, we assume that this twin has 18 months worth of TFTs staked, so the user will be eligible for a Gold discount level (60% discount). For this example, we assume that this twin has 18 months worth of TFTs staked, so the user will be eligible for a Gold discount level (60% discount).
@ -247,7 +247,7 @@ Contract cost/hour = CU cost/hour + SU cost/hour
### Applying the Dedicated Node Discount ### Applying the Dedicated Node Discount
There's a default `50%` discount for renting a node, this discount is not related to the staking discount. For more information on dedicated node discounts, please [read this section](../../../documentation/dashboard/deploy/dedicated_machines.md). There's a default `50%` discount for renting a node, this discount is not related to the staking discount. For more information on dedicated node discounts, please [read this section](dedicated_machines.md).
``` ```
Cost with 50% discount = 35.72532 * 0.5 Cost with 50% discount = 35.72532 * 0.5
@ -256,7 +256,7 @@ Cost with 50% discount = 35.72532 * 0.5
### Applying the Staking Discount ### Applying the Staking Discount
Before assuming that the price above is the final price, check first if your twin is eligible for any of the available staking discount levels. To understand more about discount levels, please read [this section](../pricing/staking_discount_levels.md). Before assuming that the price above is the final price, check first if your twin is eligible for any of the available staking discount levels. To understand more about discount levels, please read [this section](staking_discount_levels.md).
For this example, let's assume that this twin has 18 months worth of TFTs staked, so the user will be eligible for a Gold discount level (60% discount). For this example, let's assume that this twin has 18 months worth of TFTs staked, so the user will be eligible for a Gold discount level (60% discount).
@ -291,7 +291,7 @@ uniqueName in TFT = 0.00025 * 100
### Applying the Staking Discount ### Applying the Staking Discount
Before assuming that the price above is the final price, check first if your twin is eligible for any of the available staking discount levels. To understand more about discount levels, please read [this section](../pricing/staking_discount_levels.md). Before assuming that the price above is the final price, check first if your twin is eligible for any of the available staking discount levels. To understand more about discount levels, please read [this section](staking_discount_levels.md).
For this example, let's assume that this twin has 18 months worth of TFTs staked, so the user will be eligible for a Gold discount level (60% discount). For this example, let's assume that this twin has 18 months worth of TFTs staked, so the user will be eligible for a Gold discount level (60% discount).
@ -326,7 +326,7 @@ Public IP in TFT = 0.004 * 100
### Applying the Staking Discount ### Applying the Staking Discount
Before assuming that the price above is the final price, check first if your twin is eligible for any of the available staking discount levels. To understand more about discount levels, please read [this section](../pricing/staking_discount_levels.md). Before assuming that the price above is the final price, check first if your twin is eligible for any of the available staking discount levels. To understand more about discount levels, please read [this section](staking_discount_levels.md).
For this example, let's assume that this twin has 18 months worth of TFTs staked, so the user will be eligible for a Gold discount level (60% discount). For this example, let's assume that this twin has 18 months worth of TFTs staked, so the user will be eligible for a Gold discount level (60% discount).
@ -378,7 +378,7 @@ NU price in TFT = 0.0015 * 100
### Applying the Staking Discount ### Applying the Staking Discount
Before assuming that the price above is the final price, check first if your twin is eligible for any of the available staking discount levels. To understand more about discount levels, please read [this section](../pricing/staking_discount_levels.md). Before assuming that the price above is the final price, check first if your twin is eligible for any of the available staking discount levels. To understand more about discount levels, please read [this section](staking_discount_levels.md).
For this example, let's assume that this twin has 18 months worth of TFTs staked, so the user will be eligible for a Gold discount level (60% discount). For this example, let's assume that this twin has 18 months worth of TFTs staked, so the user will be eligible for a Gold discount level (60% discount).

View File

@ -2,7 +2,7 @@
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
- [Pricing Overview](./pricing.md) - [Pricing Overview](pricing.md)
- [Staking Discounts](./staking_discount_levels.md) - [Staking Discounts](staking_discount_levels.md)
- [Cloud Pricing Compare](./cloud_pricing_compare.md) - [Cloud Pricing Compare](cloud_pricing_compare.md)
- [Grid Billing](./grid_billing.md) - [Grid Billing](grid_billing.md)

View File

@ -29,7 +29,7 @@ Resource units are used to measure and convert capacity on the hardware level in
These are raw capacities as measured by the ThreeFold software running on Zero-OS. These are raw capacities as measured by the ThreeFold software running on Zero-OS.
To learn how they convert into cloudunits see [here](./resourceunits_advanced.md) To learn how they convert into cloudunits see [here](resourceunits_advanced.md)
### Compute ### Compute

View File

@ -13,4 +13,4 @@ Resource units are used to measure and convert capacity on the hardware level in
These are raw capacities as measured by the ThreeFold software running on Zero-OS. These are raw capacities as measured by the ThreeFold software running on Zero-OS.
To learn how they convert into cloudunits see [here](./resourceunits_advanced.md) To learn how they convert into cloudunits see [here](resourceunits_advanced.md)

View File

@ -6,8 +6,8 @@ To become a farmer, a developer or a sysadmin on the ThreeFold, read the [docume
<h2>Table of Contents</h2 <h2>Table of Contents</h2
- [How to Contribute](./contribute.md) - [How to Contribute](contribute.md)
- [Development Process](./development_process.md) - [Development Process](development_process.md)
- [Collaboration Tools](./collaboration_tools/collaboration_tools.md) - [Collaboration Tools](collaboration_tools.md)
- [How to Test](./testing/testing_readme.md) - [How to Test](testing_readme.md)
- [Code of Conduct](./code_conduct.md) - [Code of Conduct](code_conduct.md)

View File

@ -6,13 +6,13 @@ These tools play a crucial role in enhancing as well as simplifying collaboratio
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
- [Circle Tool](./circle_tool.md) - [Circle Tool](circle_tool.md)
- This ThreeFold's project management tool, made by using Taiga, is an open-source project management platform designed to facilitate collaboration and to streamline workflows for teams. It provides a comprehensive set of features and tools to help teams plan, track, and manage their projects effectively. - This ThreeFold's project management tool, made by using Taiga, is an open-source project management platform designed to facilitate collaboration and to streamline workflows for teams. It provides a comprehensive set of features and tools to help teams plan, track, and manage their projects effectively.
- [Website Deployer](./website_tool.md) - [Website Deployer](website_tool.md)
- This ThreeFold's website builder tool, made by using Zola, is a static site generator (SSG) and content management system (CMS) that empowers developers and content creators to build and manage websites efficiently. It is an open-source framework written in the Rust programming language, known for its performance, security, and reliability. - This ThreeFold's website builder tool, made by using Zola, is a static site generator (SSG) and content management system (CMS) that empowers developers and content creators to build and manage websites efficiently. It is an open-source framework written in the Rust programming language, known for its performance, security, and reliability.
- [Website Link Checker](./website_link_checker.md) - [Website Link Checker](website_link_checker.md)
- The ThreeFold website link checker is a wrapper around muffet to check for specific link errors on live websites written in Python. - The ThreeFold website link checker is a wrapper around muffet to check for specific link errors on live websites written in Python.

View File

@ -292,7 +292,7 @@ When you are in the main directory of your Zola website, you can check the follo
zola check zola check
``` ```
Once your website is online, you can also use the [Website Link Checker](./website_link_checker.md). Once your website is online, you can also use the [Website Link Checker](website_link_checker.md).
### Important Links ### Important Links

View File

@ -44,7 +44,7 @@ We present here the main steps to add content to the Threefold Manual by forking
* Make changes in the forked repository * Make changes in the forked repository
* To add a new section * To add a new section
* Add a new Markdown file to the [src](https://github.com/threefoldtech/info_grid/blob/development/src) directory * Add a new Markdown file to the [src](https://github.com/threefoldtech/info_grid/blob/development/src) directory
* Add the path of the Markdown file to [SUMMARY](https://github.com/threefoldtech/info_grid/blob/development/src/SUMMARY.md). * Add the path of the Markdown file to [SUMMARY](SUMMARY.md).
* To modify an existing section: * To modify an existing section:
* Make the changes directly in the Markdown file * Make the changes directly in the Markdown file
* Ask for a pull request * Ask for a pull request

View File

@ -101,8 +101,8 @@ Creating a repository involves establishing a foundation for collaborative devel
#### Github Templates #### Github Templates
- Use github templates to provide proper template for issues [bug_report](./bug_report.md) or [feature request](./feature_request.md) - Use github templates to provide proper template for issues [bug_report](bug_report.md) or [feature request](feature_request.md)
- Use github templates to provide proper template for [pull requests](./pull_request_template.md) - Use github templates to provide proper template for [pull requests](pull_request_template.md)
#### Expected Workflows #### Expected Workflows

View File

@ -14,11 +14,11 @@ The backend for the weblets is introduced with the [Javascript Client](developer
<h2> Table of Contents </h2> <h2> Table of Contents </h2>
- [Wallet Connector](./wallet_connector.md) - [Wallet Connector](wallet_connector.md)
- [TFGrid](./tfgrid/tfgrid.md) - [TFGrid](tfgrid.md)
- [Deploy](./deploy/deploy.md) - [Deploy](deploy.md)
- [Farms](./farms/farms.md) - [Farms](farms.md)
- [TFChain](./tfchain/tfchain.md) - [TFChain](tfchain.md)
## Advantages ## Advantages

View File

@ -2,10 +2,10 @@
Here you will find everything farming related. this includes: Here you will find everything farming related. this includes:
- Monitoring, creating, and updating your farms from the [Your Farms](./your_farms.md) section where you can also check your nodes and update multiple things like the public configuration and extra fees of the node. - Monitoring, creating, and updating your farms from the [Your Farms](your_farms.md) section where you can also check your nodes and update multiple things like the public configuration and extra fees of the node.
- Exploring and finding farms that are available on the ThreeFold grid from the [Farm Finder](./farms_finder.md) section. - Exploring and finding farms that are available on the ThreeFold grid from the [Farm Finder](farms_finder.md) section.
- Generating your own boot device for your system from the [Node Installer](./node_installer.md) section. - Generating your own boot device for your system from the [Node Installer](node_installer.md) section.
- Estimating and calculating potential earnings from farming on the ThreeFold Grid from the [Simulator](./simulator.md) section. - Estimating and calculating potential earnings from farming on the ThreeFold Grid from the [Simulator](simulator.md) section.
![](../img/sidebar_3.png) ![](../img/sidebar_3.png)
@ -13,7 +13,7 @@ Here you will find everything farming related. this includes:
## Table of Content ## Table of Content
- [Your Farms](./your_farms.md) - [Your Farms](your_farms.md)
- [Farm Finder](./farms_finder.md) - [Farm Finder](farms_finder.md)
- [Node Installer](./node_installer.md) - [Node Installer](node_installer.md)
- [Simulator](./simulator.md) - [Simulator](simulator.md)

View File

@ -14,11 +14,11 @@ The backend for the weblets is introduced with the [Javascript Client](developer
<h2> Table of Contents </h2> <h2> Table of Contents </h2>
- [Wallet Connector](./wallet_connector.md) - [Wallet Connector](wallet_connector.md)
- [TFGrid](./tfgrid/tfgrid.md) - [TFGrid](tfgrid.md)
- [Deploy](./deploy/deploy.md) - [Deploy](deploy.md)
- [Farms](./farms/farms.md) - [Farms](farms.md)
- [TFChain](./tfchain/tfchain.md) - [TFChain](tfchain.md)
## Advantages ## Advantages

View File

@ -19,7 +19,7 @@
## Prerequisites ## Prerequisites
- Make sure you have a [wallet](../wallet_connector.md) - Make sure you have a [wallet](wallet_connector.md)
- From the sidebar click on **Applications** - From the sidebar click on **Applications**
- Click on **Algorand** - Click on **Algorand**

View File

@ -2,10 +2,10 @@
<h2> Table of Contents </h2> <h2> Table of Contents </h2>
- [Virtual Machines](./vm_intro.md) - [Virtual Machines](vm_intro.md)
- [Micro and Full VM Differences ](./vm_differences.md) - [Micro and Full VM Differences ](vm_differences.md)
- [Full Virtual Machine](./fullVm.md) - [Full Virtual Machine](fullVm.md)
- [Micro Virtual Machine](./vm.md) - [Micro Virtual Machine](vm.md)
- [Kubernetes](./k8s.md) - [Kubernetes](k8s.md)
- [NixOS MicroVM](./nixos_micro.md) - [NixOS MicroVM](nixos_micro.md)
- [Add a Domain](./add_domain.md) - [Add a Domain](add_domain.md)

View File

@ -38,7 +38,7 @@ It has following benefits :
## Requirements ## Requirements
- Make sure you have a [wallet](../wallet_connector.md) - Make sure you have a [wallet](wallet_connector.md)
- From the sidebar click on **Orchestrators** - From the sidebar click on **Orchestrators**
- Click on **CapRover** - Click on **CapRover**
@ -161,5 +161,5 @@ Make sure that you've point a wildcard DNS entry to your CapRover IP address (e.
## How to Work with CapRover ## How to Work with CapRover
* [CapRover Admin Tutorial](./caprover_admin.md) * [CapRover Admin Tutorial](caprover_admin.md)
* [CapRover Worker Tutorial](./caprover_worker.md) * [CapRover Worker Tutorial](caprover_worker.md)

View File

@ -11,7 +11,7 @@
[Casper Network](https://casperlabs.io/) is a blockchain protocol built from the ground up to remain true to core Web3 principles and adapt to the needs of our evolving world. [Casper Network](https://casperlabs.io/) is a blockchain protocol built from the ground up to remain true to core Web3 principles and adapt to the needs of our evolving world.
- Make sure you have a [wallet](../wallet_connector.md) - Make sure you have a [wallet](wallet_connector.md)
- From the sidebar click on **Applications** - From the sidebar click on **Applications**
- Click on **Casperlabs** - Click on **Casperlabs**

View File

@ -11,7 +11,7 @@
[Discourse](https://www.discourse.org/) is the 100% open source discussion platform built for the next decade of the Internet. Use it as a mailing list, discussion forum, long-form chat room, and more! [Discourse](https://www.discourse.org/) is the 100% open source discussion platform built for the next decade of the Internet. Use it as a mailing list, discussion forum, long-form chat room, and more!
- Make sure you have a [wallet](../wallet_connector.md) - Make sure you have a [wallet](wallet_connector.md)
- From the sidebar click on **Applications** - From the sidebar click on **Applications**
- Click on **Discourse** - Click on **Discourse**

View File

@ -21,7 +21,7 @@ We present the steps to deploy a full VM on the TFGrid.
Deploy a new full virtual machine on the Threefold Grid Deploy a new full virtual machine on the Threefold Grid
- Make sure you have a [wallet](../wallet_connector.md) - Make sure you have a [wallet](wallet_connector.md)
- From the sidebar click on **Applications** - From the sidebar click on **Applications**
- Click on **Full Virtual Machine** - Click on **Full Virtual Machine**

View File

@ -15,7 +15,7 @@ Funkwhale is a community-driven project that lets you listen and share music and
## Prerequisites ## Prerequisites
- Make sure you have a [wallet](../wallet_connector.md) - Make sure you have a [wallet](wallet_connector.md)
- From the sidebar click on **Applications** - From the sidebar click on **Applications**
- Click on **Funkwhale** - Click on **Funkwhale**

View File

@ -19,7 +19,7 @@ On the TF grid, Kubernetes clusters can be deployed out of the box. We have impl
## Prerequisites ## Prerequisites
- Make sure you have a [wallet](../wallet_connector.md) - Make sure you have a [wallet](wallet_connector.md)
- From the sidebar click on **Applications** - From the sidebar click on **Applications**
- Click on **Kubernetes** - Click on **Kubernetes**

View File

@ -14,7 +14,7 @@
## Prerequisites ## Prerequisites
- Make sure you have a [wallet](../wallet_connector.md) - Make sure you have a [wallet](wallet_connector.md)
- From the sidebar click on **Applications** - From the sidebar click on **Applications**
- Click on **Mattermost** - Click on **Mattermost**

View File

@ -36,7 +36,7 @@ Nextcloud provides functionality similar to Dropbox, Office 365 or Google Drive
# Prerequisites # Prerequisites
- Make sure you have a [wallet](../wallet_connector.md) - Make sure you have a [wallet](wallet_connector.md)
- From the sidebar click on **Applications** - From the sidebar click on **Applications**
- Click on **Nextcloud** - Click on **Nextcloud**
@ -63,7 +63,7 @@ If you're not sure and just want the easiest, most affordable option, skip the p
* **Recommended**: {cpu: 4, memory: 16gb, diskSize: 1000gb } * **Recommended**: {cpu: 4, memory: 16gb, diskSize: 1000gb }
* Or choose a **Custom** plan * Or choose a **Custom** plan
* If want to reserve a public IPv4 address, click on Network then select **Public IPv4** * If want to reserve a public IPv4 address, click on Network then select **Public IPv4**
* If you want a [dedicated](../deploy/dedicated_machines.md) and/or a certified node, select the corresponding option * If you want a [dedicated](dedicated_machines.md) and/or a certified node, select the corresponding option
* Choose the location of the node * Choose the location of the node
* `Country` * `Country`
* `Farm Name` * `Farm Name`

View File

@ -26,7 +26,7 @@ For more information on Nix, you can read the [Nix Reference Manual](https://nix
* [Devnet](https://dashboard.dev.grid.tf) * [Devnet](https://dashboard.dev.grid.tf)
* [QAnet](https://dashboard.qa.grid.tf) * [QAnet](https://dashboard.qa.grid.tf)
* Make sure you have a [wallet](../wallet_connector.md) * Make sure you have a [wallet](wallet_connector.md)
* From the sidebar click on **Solutions** * From the sidebar click on **Solutions**
* Click on **Micro Virtual Machine** to start your NixOS MicroVM Deployment * Click on **Micro Virtual Machine** to start your NixOS MicroVM Deployment

View File

@ -14,7 +14,7 @@ This is a simple instance of upstream [Node Pilot](https://nodepilot.tech).
## Prerequisites ## Prerequisites
- Make sure you have a [wallet](../wallet_connector.md) - Make sure you have a [wallet](wallet_connector.md)
- From the sidebar click on **Applications** - From the sidebar click on **Applications**
- Click on **Node Pilot** - Click on **Node Pilot**

View File

@ -19,7 +19,7 @@
## Prerequisites ## Prerequisites
- Make sure you have a [wallet](../wallet_connector.md) - Make sure you have a [wallet](wallet_connector.md)
- From the sidebar click on **Solutions** - From the sidebar click on **Solutions**
- Click on **ownCloud** - Click on **ownCloud**

View File

@ -14,7 +14,7 @@
## Prerequisites ## Prerequisites
- Make sure you have a [wallet](../wallet_connector.md) - Make sure you have a [wallet](wallet_connector.md)
- From the sidebar click on **Applications** - From the sidebar click on **Applications**
- Click on **Peertube** - Click on **Peertube**

View File

@ -18,7 +18,7 @@
## Prerequisites ## Prerequisites
- Make sure you have a [wallet](../wallet_connector.md) - Make sure you have a [wallet](wallet_connector.md)
- From the sidebar click on **Applications** - From the sidebar click on **Applications**
- Click on **Presearch** - Click on **Presearch**

View File

@ -4,26 +4,26 @@ This section provides a non-code easy way to deploy a whole solution on the TFGr
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
- [Basic Environments](./basic_environments_readme.md) - [Basic Environments](basic_environments_readme.md)
- [Virtual Machines](./vm_intro.md) - [Virtual Machines](vm_intro.md)
- [Micro and Full VM Differences](./vm_differences.md) - [Micro and Full VM Differences](vm_differences.md)
- [Full Virtual Machine](./fullVm.md) - [Full Virtual Machine](fullVm.md)
- [Micro Virtual Machine](./vm.md) - [Micro Virtual Machine](vm.md)
- [Kubernetes](./k8s.md) - [Kubernetes](k8s.md)
- [NixOS MicroVM](./nixos_micro.md) - [NixOS MicroVM](nixos_micro.md)
- [Ready Community Solutions](./ready_community_readme.md) - [Ready Community Solutions](ready_community_readme.md)
- [Caprover](./caprover.md) - [Caprover](caprover.md)
- [Funkwhale](./funkwhale.md) - [Funkwhale](funkwhale.md)
- [Peertube](./peertube.md) - [Peertube](peertube.md)
- [Taiga](./taiga.md) - [Taiga](taiga.md)
- [Owncloud](./owncloud.md) - [Owncloud](owncloud.md)
- [Nextcloud](./nextcloud.md) - [Nextcloud](nextcloud.md)
- [Discourse](./discourse.md) - [Discourse](discourse.md)
- [Mattermost](./mattermost.md) - [Mattermost](mattermost.md)
- [Presearch](./presearch.md) - [Presearch](presearch.md)
- [CasperLabs](./casper.md) - [CasperLabs](casper.md)
- [Node Pilot](./nodepilot.md) - [Node Pilot](nodepilot.md)
- [Subsquid](./subsquid.md) - [Subsquid](subsquid.md)
- [Algorand](./algorand.md) - [Algorand](algorand.md)
- [Wordpress](./wordpress.md) - [Wordpress](wordpress.md)
- [Umbrel](./umbrel.md) - [Umbrel](umbrel.md)

View File

@ -14,7 +14,7 @@
## Prerequisites ## Prerequisites
- Make sure you have a [wallet](../wallet_connector.md) - Make sure you have a [wallet](wallet_connector.md)
- From the sidebar click on **Applications** - From the sidebar click on **Applications**
- Click on **Subsquid** - Click on **Subsquid**

View File

@ -14,7 +14,7 @@
## Prerequisites ## Prerequisites
- Make sure you have a [wallet](../wallet_connector.md) - Make sure you have a [wallet](wallet_connector.md)
- From the sidebar click on **Applications** - From the sidebar click on **Applications**
- Click on **Taiga** - Click on **Taiga**

View File

@ -13,7 +13,7 @@
## Prerequisites ## Prerequisites
- Make sure you have a [wallet](../wallet_connector.md) - Make sure you have a [wallet](wallet_connector.md)
- From the sidebar click on **Applications** - From the sidebar click on **Applications**
- Click on **Umbrel** - Click on **Umbrel**

View File

@ -16,7 +16,7 @@ We present the steps to deploy a micro VM on the TFGrid.
Deploy a new virtual machine on the Threefold Grid Deploy a new virtual machine on the Threefold Grid
- Make sure you have a [wallet](../wallet_connector.md) - Make sure you have a [wallet](wallet_connector.md)
- From the sidebar click on **Solutions** - From the sidebar click on **Solutions**
- Click on **Micro Virtual Machine** - Click on **Micro Virtual Machine**

View File

@ -4,8 +4,8 @@ On the TFGrid, you can deploy both micro and full virtual machines.
<h2> Table of Contents </h2> <h2> Table of Contents </h2>
- [Micro and Full VM Differences ](./vm_differences.md) - [Micro and Full VM Differences ](vm_differences.md)
- [Full Virtual Machine](./fullVm.md) - [Full Virtual Machine](fullVm.md)
- [Micro Virtual Machine](./vm.md) - [Micro Virtual Machine](vm.md)
- [Nixos MicroVM](./nixos_micro.md) - [Nixos MicroVM](nixos_micro.md)
- [Add a Domain](./add_domain.md) - [Add a Domain](add_domain.md)

View File

@ -24,7 +24,7 @@
# Prerequisites # Prerequisites
- Make sure you have a [wallet](../wallet_connector.md) - Make sure you have a [wallet](wallet_connector.md)
- From the sidebar click on **Solutions** - From the sidebar click on **Solutions**
- Click on **Wordpress** - Click on **Wordpress**

View File

@ -23,7 +23,7 @@ DAOs are internet-native organizations collectively owned and managed by their m
Voting for a DAO proposal is very simple. You first need to meet certain requirements to be able to vote. Voting for a DAO proposal is very simple. You first need to meet certain requirements to be able to vote.
- Have a [Threefold farm](../farms/farms.md) - Have a [Threefold farm](farms.md)
- Have at least one active [3node server](farmers@@3node_building) on the farm - Have at least one active [3node server](farmers@@3node_building) on the farm
- If you created your farm with the Threefold Connect app - If you created your farm with the Threefold Connect app
- [Import your farm on the Threefold Dashboard](threefold_token@@tf_connect_app.md#move-farm-from-the-tf-connect-app-to-the-tf-portal-polkadotjs) - [Import your farm on the Threefold Dashboard](threefold_token@@tf_connect_app.md#move-farm-from-the-tf-connect-app-to-the-tf-portal-polkadotjs)

View File

@ -2,19 +2,19 @@
Here you will find everything related to the ThreeFold chain. this includes: Here you will find everything related to the ThreeFold chain. this includes:
- Detailed account information from the [Your Profile](./your_profile.md) section. - Detailed account information from the [Your Profile](your_profile.md) section.
- Information about what DAO is and how to vote on DAO proposals from the [TF DAO](./tf_dao.md) section. - Information about what DAO is and how to vote on DAO proposals from the [TF DAO](tf_dao.md) section.
- Transferring TFTs on different chains from the [TF Token Bridge](./tf_token_bridge.md) section. - Transferring TFTs on different chains from the [TF Token Bridge](tf_token_bridge.md) section.
- Transferring TFTs on the TFChain from the [TF Token Transfer](./tf_token_transfer.md) section. - Transferring TFTs on the TFChain from the [TF Token Transfer](tf_token_transfer.md) section.
- getting miniting reports from the [TF Minting Reports](./tf_minting_reports.md) section. - getting miniting reports from the [TF Minting Reports](tf_minting_reports.md) section.
![](../img/sidebar_4.png) ![](../img/sidebar_4.png)
*** ***
## Table of Content ## Table of Content
- [Your Profile](./your_profile.md) - [Your Profile](your_profile.md)
- [TF DAO](./tf_dao.md) - [TF DAO](tf_dao.md)
- [TF Token Bridge](./tf_token_bridge.md) - [TF Token Bridge](tf_token_bridge.md)
- [TF Token Transfer](./tf_token_transfer.md) - [TF Token Transfer](tf_token_transfer.md)
- [TF Minting Reports](./tf_minting_reports.md) - [TF Minting Reports](tf_minting_reports.md)

View File

@ -10,4 +10,4 @@ The twin details consists of three main items.
- `Address` Your public address on the ThreeFold chain. - `Address` Your public address on the ThreeFold chain.
- `Relay` A relay is a component that facilitates the reliable and secure transfer of messages between different entities within the ThreeFold ecosystem. - `Relay` A relay is a component that facilitates the reliable and secure transfer of messages between different entities within the ThreeFold ecosystem.
To create a twin check the [Wallet Connector](../wallet_connector.md) Section. To create a twin check the [Wallet Connector](wallet_connector.md) Section.

View File

@ -2,9 +2,9 @@
Check and use all things related to the threefold grid. Including: Check and use all things related to the threefold grid. Including:
- The status of ThreeFold services from the [Grid Status](./grid_status.md) website. - The status of ThreeFold services from the [Grid Status](grid_status.md) website.
- The statistics of all nodes that are available on the ThreeFold grid from [Node Statistics](./node_statistics.md). - The statistics of all nodes that are available on the ThreeFold grid from [Node Statistics](node_statistics.md).
- The health and status of Zero-OS nodes that are available on the ThreeFold grid from [Node Monitoring](./node_monitoring.md). - The health and status of Zero-OS nodes that are available on the ThreeFold grid from [Node Monitoring](node_monitoring.md).
![](../img/sidebar_1.png) ![](../img/sidebar_1.png)
@ -12,6 +12,6 @@ Check and use all things related to the threefold grid. Including:
## Table of Content ## Table of Content
- [Grid Status](./grid_status.md) - [Grid Status](grid_status.md)
- [Node Statistics](./node_statistics.md) - [Node Statistics](node_statistics.md)
- [Node Monitoring](./node_monitoring.md) - [Node Monitoring](node_monitoring.md)

View File

@ -1,8 +1,8 @@
## Dashboard TOC ## Dashboard TOC
- [Home](./home.md) - [Home](home.md)
- [Wallet Connector](./wallet_connector.md) - [Wallet Connector](wallet_connector.md)
- [CapRover](./caprover.md) - [CapRover](caprover.md)
- [Virtual Machine](./vm.md) - [Virtual Machine](vm.md)
- [Funkwhale](./funkwhale.md) - [Funkwhale](funkwhale.md)
- [Peertube](./peertube.md) - [Peertube](peertube.md)

View File

@ -3,7 +3,7 @@
The fastest way to mount a Presearch node on TFGrid3 is inside a VM. The fastest way to mount a Presearch node on TFGrid3 is inside a VM.
Steps : Steps :
- Set up a VM, see [here](./vm.md). It is recommended to reserve a fix IP. You can also try out the planetary network (so reserve a VM without public IP), as long as the node you select is connected to the internet through an IPv4 address that isn't used yet for a Presearch node, you don't explicitly need to reserve a public IPv4 address. However, the planetary network is still in beta phase and might generate performance issues. - Set up a VM, see [here](vm.md). It is recommended to reserve a fix IP. You can also try out the planetary network (so reserve a VM without public IP), as long as the node you select is connected to the internet through an IPv4 address that isn't used yet for a Presearch node, you don't explicitly need to reserve a public IPv4 address. However, the planetary network is still in beta phase and might generate performance issues.
- 1 CPU is enough for a PRE node. As we still need to install Docker on the VM before deploying a PRE node, please choose 8192 memory size. - 1 CPU is enough for a PRE node. As we still need to install Docker on the VM before deploying a PRE node, please choose 8192 memory size.
- Once your VM is set up, SSH into our machine. - Once your VM is set up, SSH into our machine.

View File

@ -5,7 +5,7 @@
- [Zero-OS Hub](zos_hub.md) - [Zero-OS Hub](zos_hub.md)
- [Generate an API Token](api_token.md) - [Generate an API Token](api_token.md)
- [Convert Docker Image Into Flist](convert_docker_image.md) - [Convert Docker Image Into Flist](convert_docker_image.md)
- [Supported Flists](./grid3_supported_flists.md) - [Supported Flists](grid3_supported_flists.md)
- [Flist Case Studies](flist_case_studies.md) - [Flist Case Studies](flist_case_studies.md)
- [Case Study: Debian 12](flist_debian_case_study.md) - [Case Study: Debian 12](flist_debian_case_study.md)
- [Case Study: Nextcloud AIO](flist_nextcloud_case_study.md) - [Case Study: Nextcloud AIO](flist_nextcloud_case_study.md)

View File

@ -2,5 +2,5 @@
<h2> Table of Contents </h2> <h2> Table of Contents </h2>
- [Case Study: Debian 12](./flist_debian_case_study.md) - [Case Study: Debian 12](flist_debian_case_study.md)
- [Case Study: Nextcloud AIO](./flist_nextcloud_case_study.md) - [Case Study: Nextcloud AIO](flist_nextcloud_case_study.md)

View File

@ -39,7 +39,7 @@
# Introduction # Introduction
In this case study, we explain how to create a new flist on the ThreeFold ecosystem. We will show the process of creating a Nextcloud All-in-One flist and we will deploy a micro VM on the ThreeFold Playground to access our Nextcloud instance. As a reference, the official Nextcloud flist is available [here](https://hub.grid.tf/tf-official-apps/threefoldtech-nextcloudaio-latest.flist.md). In this case study, we explain how to create a new flist on the ThreeFold ecosystem. We will show the process of creating a Nextcloud All-in-One flist and we will deploy a micro VM on the ThreeFold Playground to access our Nextcloud instance. As a reference, the official Nextcloud flist is available [here](threefoldtech-nextcloudaio-latest.flist.md).
To achieve all this, we will need to create a Docker Hub account, create a Dockerfile and its associated files, a docker image and a docker container, then convert the docker image to a Zero-OS flist. After all this, we will be deploying our Nextcloud instance on the ThreeFold Playground. To achieve all this, we will need to create a Docker Hub account, create a Dockerfile and its associated files, a docker image and a docker container, then convert the docker image to a Zero-OS flist. After all this, we will be deploying our Nextcloud instance on the ThreeFold Playground.
@ -242,9 +242,9 @@ Finally, we set an entrypoint in our Dockerfile. As per the [Docker documentatio
The **README.md** file has the main goal of explaining clearly to the user the functioning of the Nextcloud directory and its associated flist. In this file, we can explain what our code is doing and offer steps to properly configure the whole deployment. The **README.md** file has the main goal of explaining clearly to the user the functioning of the Nextcloud directory and its associated flist. In this file, we can explain what our code is doing and offer steps to properly configure the whole deployment.
We also give the necessary steps to create the Docker image and convert it into an flist starting directly with the Nextcloud directory. This can be useful for users that want to create their own flist, instead of using the [official ThreeFold Nextcloud flist](https://hub.grid.tf/tf-official-apps/threefoldtech-nextcloudaio-latest.flist.md). We also give the necessary steps to create the Docker image and convert it into an flist starting directly with the Nextcloud directory. This can be useful for users that want to create their own flist, instead of using the [official ThreeFold Nextcloud flist](threefoldtech-nextcloudaio-latest.flist.md).
To read the complete README.md file, go to [this link](https://github.com/threefoldtech/tf-images/blob/development/tfgrid3/nextcloud/README.md). To read the complete README.md file, go to [this link](README.md).
## scripts Folder ## scripts Folder
@ -661,7 +661,7 @@ We will now convert the Docker image into a Zero-OS flist.
``` ```
* Example: * Example:
* ``` * ```
https://hub.grid.tf/tf-official-apps/threefoldtech-nextcloudaio-latest.flist threefoldtech-nextcloudaio-latest.flist
``` ```
# Deploy Nextcloud AIO on the TFGrid with Terraform # Deploy Nextcloud AIO on the TFGrid with Terraform
@ -693,7 +693,7 @@ gateway_id = "50"
vm1_id = "5453" vm1_id = "5453"
deployment_name = "nextcloudgateway" deployment_name = "nextcloudgateway"
nextcloud_flist = "https://hub.grid.tf/tf-official-apps/threefoldtech-nextcloudaio-latest.flist" nextcloud_flist = "threefoldtech-nextcloudaio-latest.flist"
``` ```
Make sure to add your own seed phrase and SSH public key. Simply replace the three dots by the content. Note that you can deploy on a different node than node 5453 for the **vm1** node. If you want to deploy on another node than node 5453 for the **gateway** node, make sure that you choose a gateway node. To find a gateway node, go on the [ThreeFold Dashboard](https://dashboard.grid.tf/) Nodes section of the Explorer and select **Gateways (Only)**. Make sure to add your own seed phrase and SSH public key. Simply replace the three dots by the content. Note that you can deploy on a different node than node 5453 for the **vm1** node. If you want to deploy on another node than node 5453 for the **gateway** node, make sure that you choose a gateway node. To find a gateway node, go on the [ThreeFold Dashboard](https://dashboard.grid.tf/) Nodes section of the Explorer and select **Gateways (Only)**.

View File

@ -40,7 +40,7 @@ You don't need to take care about the base system yourself, just merge it with t
The ZOS Hub allows you to convert Docker Hub images and Tar files into flists thanks to the Docker Hub Converter. The ZOS Hub allows you to convert Docker Hub images and Tar files into flists thanks to the Docker Hub Converter.
You can convert a docker image (eg: `busybox`, `ubuntu`, `fedora`, `couchdb`, ...) to an flist directly from the backend, this allows you to use your existing docker image in our infrastructure out-of-the-box. Go to the [Docker Hub Converter](https://hub.grid.tf/docker-convert) to use this feature. For more information on the process, read the section [Convert Docker Image to flist](./convert_docker_image.md) of the TF Manual. You can convert a docker image (eg: `busybox`, `ubuntu`, `fedora`, `couchdb`, ...) to an flist directly from the backend, this allows you to use your existing docker image in our infrastructure out-of-the-box. Go to the [Docker Hub Converter](https://hub.grid.tf/docker-convert) to use this feature. For more information on the process, read the section [Convert Docker Image to flist](convert_docker_image.md) of the TF Manual.
You can also easily convert a Tar file into an flist via the [Upload section](https://hub.grid.tf/upload) of the ZOS Hub. You can also easily convert a Tar file into an flist via the [Upload section](https://hub.grid.tf/upload) of the ZOS Hub.
@ -59,7 +59,7 @@ and gives you the full control of the chain. The only restriction is that the co
on the flist needs to exists on the backend, otherwise your flist will be rejected. on the flist needs to exists on the backend, otherwise your flist will be rejected.
## Authenticate via 3Bot ## Authenticate via 3Bot
All the operations on the ZOS Hub needs to be done via a `3Bot` (default) authentication. Only downloading a flist can be done anonymously. To authenticate request via the API, you need to generate an API Token as shown in the section [ZOS Hub API Token](./api_token.md). All the operations on the ZOS Hub needs to be done via a `3Bot` (default) authentication. Only downloading a flist can be done anonymously. To authenticate request via the API, you need to generate an API Token as shown in the section [ZOS Hub API Token](api_token.md).
## Get and Update Information Through the API ## Get and Update Information Through the API
The hub host a basic REST API which can gives you some informations about flists, renaming them, remove them, etc. The hub host a basic REST API which can gives you some informations about flists, renaming them, remove them, etc.

View File

@ -16,10 +16,10 @@ We provide basic information on the currently supported Flists.
|flist|entrypoint|env vars| |flist|entrypoint|env vars|
|:--:|:--:|--| |:--:|:--:|--|
|[Alpine](https://hub.grid.tf/tf-official-apps/threefoldtech-alpine-3.flist.md)|`/entrypoint.sh`|`SSH_KEY`| |[Alpine](threefoldtech-alpine-3.flist.md)|`/entrypoint.sh`|`SSH_KEY`|
|[Ubuntu](https://hub.grid.tf/tf-official-apps/threefoldtech-ubuntu-22.04.flist.md)|`/init.sh`|`SSH_KEY`| |[Ubuntu](threefoldtech-ubuntu-22.04.flist.md)|`/init.sh`|`SSH_KEY`|
|[CentOS](https://hub.grid.tf/tf-official-apps/threefoldtech-centos-8.flist.md)|`/entrypoint.sh`|`SSH_KEY`| |[CentOS](threefoldtech-centos-8.flist.md)|`/entrypoint.sh`|`SSH_KEY`|
|[K3s](https://hub.grid.tf/tf-official-apps/threefoldtech-k3s-latest.flist.md)|`/sbin/zinit init`|- `SSH_KEY` <br/>- `K3S_TOKEN` <br/>- `K3S_DATA_DIR`<br/>- `K3S_FLANNEL_IFACE`<br/>- `K3S_NODE_NAME`<br/> - `K3S_URL` `https://${masterIp}:6443`| |[K3s](threefoldtech-k3s-latest.flist.md)|`/sbin/zinit init`|- `SSH_KEY` <br/>- `K3S_TOKEN` <br/>- `K3S_DATA_DIR`<br/>- `K3S_FLANNEL_IFACE`<br/>- `K3S_NODE_NAME`<br/> - `K3S_URL` `https://${masterIp}:6443`|
## More Flists ## More Flists

View File

@ -12,7 +12,7 @@
## Introduction ## Introduction
After [deploying a VM](./grid3_go_vm.md) you can deploy Gateways to further expose your VM. After [deploying a VM](grid3_go_vm.md) you can deploy Gateways to further expose your VM.
## Gateway Name ## Gateway Name

View File

@ -4,6 +4,6 @@ The TFGrid whole source code is open-source and instances of the grid can be dep
## Table of Contents ## Table of Contents
- [TFGrid Stacks](./tfgrid_stacks.md) - [TFGrid Stacks](tfgrid_stacks.md)
- [Full VM Grid Deployment](./grid_deployment_full_vm.md) - [Full VM Grid Deployment](grid_deployment_full_vm.md)
- [Grid Snapshots](./snapshots.md) - [Grid Snapshots](snapshots.md)

View File

@ -18,7 +18,7 @@
To facilitate deploying grid backend services, we provide snapshots to significantly reduce sync time. This can be setup anywhere from scratch. Once all services are synced, one can use the scripts to create snapshots automatically. To facilitate deploying grid backend services, we provide snapshots to significantly reduce sync time. This can be setup anywhere from scratch. Once all services are synced, one can use the scripts to create snapshots automatically.
To learn how to deploy your own grid stack, read [this section](./grid_deployment_full_vm.md). To learn how to deploy your own grid stack, read [this section](grid_deployment_full_vm.md).
## Services ## Services

View File

@ -29,4 +29,4 @@ The overall ThreeFold ecosystem becomes more resilient to failures of individual
To set your own instance of the TFGrid, you can download a snapshot of the grid and deploy the TFGrid services with Docker. We even provide scripts to quicken the whole process! To set your own instance of the TFGrid, you can download a snapshot of the grid and deploy the TFGrid services with Docker. We even provide scripts to quicken the whole process!
Read more about snapshots in the [next section](./grid_deployment_full_vm.md). Read more about snapshots in the [next section](grid_deployment_full_vm.md).

View File

@ -48,7 +48,7 @@ Starting from this we came up with a more detailed requirements:
*** ***
## Specifications ## Specifications
For details about protocol itself please check the [specs](./rmb_specs.md). For details about protocol itself please check the [specs](rmb_specs.md).
*** ***
## How to Use RMB ## How to Use RMB
@ -83,7 +83,7 @@ think of `rmb-peer` as a gateway that stands between you and the `relay`. `rmb-p
Then it provide a simple (plain-text) api over `redis`. means to send messages (or handle requests) you just need to be able to push and pop messages from some redis queues. Messages are simple plain text json. Then it provide a simple (plain-text) api over `redis`. means to send messages (or handle requests) you just need to be able to push and pop messages from some redis queues. Messages are simple plain text json.
> More details can be found [here](./rmb_specs.md) > More details can be found [here](rmb_specs.md)
*** ***
## Download ## Download

View File

@ -1,6 +1,6 @@
Development Development
=========== ===========
* [Quick start](./quickstart.md) * [Quick start](quickstart.md)
* [Testing](./testing.md) * [Testing](testing.md)
* [Binary packages](./packages.md) * [Binary packages](packages.md)

View File

@ -85,4 +85,4 @@ Here is a list of the major ZOS modules.
## Capacity ## Capacity
In [this document](./capacity.md), you can find detail description of how ZOS does capacity planning. In [this document](capacity.md), you can find detail description of how ZOS does capacity planning.

View File

@ -2,7 +2,7 @@
<h2> Table of Contents </h2> <h2> Table of Contents </h2>
- [Introduction to networkd](./introduction.md) - [Introduction to networkd](introduction.md)
- [Vocabulary Definitions](./definitions.md) - [Vocabulary Definitions](definitions.md)
- [Wireguard Mesh Details](./mesh.md) - [Wireguard Mesh Details](mesh.md)
- [Farm Network Setup](./setup_farm_network.md) - [Farm Network Setup](setup_farm_network.md)

View File

@ -180,7 +180,7 @@ type Workload struct {
### API ### API
Node is always connected to the RMB network with the node `twin`. Means the node is always reachable over RMB with the node `twin-id` as an address. Node is always connected to the RMB network with the node `twin`. Means the node is always reachable over RMB with the node `twin-id` as an address.
The [node client](https://github.com/threefoldtech/zos/blob/main/client/node.go) should have a complete list of all available functions. documentations of the API can be found [here](./api.md) The [node client](https://github.com/threefoldtech/zos/blob/main/client/node.go) should have a complete list of all available functions. documentations of the API can be found [here](api.md)
## Raid Controller Configuration ## Raid Controller Configuration

View File

@ -66,7 +66,7 @@ For more details on all parameters needed to run a `zmachine` please refer to [`
#### Building your `flist` #### Building your `flist`
Please refer to [this document](./manual.md) here about how to build an compatible `zmachine flist` Please refer to [this document](manual.md) here about how to build an compatible `zmachine flist`
### `zlogs` type ### `zlogs` type

View File

@ -10,4 +10,4 @@
For more details on all parameters needed to run a `zmachine` please refer to [`zmachine` data](https://github.com/threefoldtech/zos/blob/main/pkg/gridtypes/zos/zmachine.go) For more details on all parameters needed to run a `zmachine` please refer to [`zmachine` data](https://github.com/threefoldtech/zos/blob/main/pkg/gridtypes/zos/zmachine.go)
# Building your `flist`. # Building your `flist`.
Please refer to [this document](../manual.md) here about how to build an compatible `zmachine flist` Please refer to [this document](manual.md) here about how to build an compatible `zmachine flist`

View File

@ -80,10 +80,10 @@ Notes:
## Registered Tests ## Registered Tests
- [Public IP Validation](./publicips.md) - [Public IP Validation](publicips.md)
- [CPUBenchmark](./cpubench.md) - [CPUBenchmark](cpubench.md)
- [IPerf](./iperf.md) - [IPerf](iperf.md)
- [Health Check](./healthcheck.md) - [Health Check](healthcheck.md)
## Test Suite ## Test Suite

View File

@ -3,7 +3,7 @@
We use a simple pipeline release workflow. Building and file distribution are made using GitHub Actions. We use a simple pipeline release workflow. Building and file distribution are made using GitHub Actions.
Usable files are available on the [Zero-OS Hub](https://hub.grid.tf/tf-zos). Usable files are available on the [Zero-OS Hub](https://hub.grid.tf/tf-zos).
This pipeline is made to match the 3 different type of running mode of 0-OS. For more information head to the [upgrade documentation](../identity/upgrade.md). This pipeline is made to match the 3 different type of running mode of 0-OS. For more information head to the [upgrade documentation](upgrade.md).
## Development build ## Development build

View File

@ -17,7 +17,7 @@
In this section, we show how to deploy CapRover with the Javascript client. In this section, we show how to deploy CapRover with the Javascript client.
This deployment is very similar to what we have in the section [Deploy a VM](./grid3_javascript_vm.md), but the environment variables are different. This deployment is very similar to what we have in the section [Deploy a VM](grid3_javascript_vm.md), but the environment variables are different.
## Leader Node ## Leader Node

View File

@ -21,7 +21,7 @@ We show how to deploy a Kubernetes cluster on the TFGrid with the Javascript cli
## Prerequisites ## Prerequisites
- Make sure you have your [client](./grid3_javascript_loadclient.md) prepared - Make sure you have your [client](grid3_javascript_loadclient.md) prepared
## Example code ## Example code

View File

@ -18,7 +18,7 @@ As part of the tfchain, we support a keyvalue store module that can be used for
## Prerequisites ## Prerequisites
- Make sure you have your [client](./grid3_javascript_loadclient.md) prepared - Make sure you have your [client](grid3_javascript_loadclient.md) prepared
## Example code ## Example code

View File

@ -60,7 +60,7 @@ using e2e. That's similar to home servers by matrix
- BackendStorage : can be `auto` which willl automatically adapt if running in node environment to use `filesystem backend` or the browser enviornment to use `localstorage backend`. Also you can set it to `kvstore` to use the tfchain keyvalue store module. - BackendStorage : can be `auto` which willl automatically adapt if running in node environment to use `filesystem backend` or the browser enviornment to use `localstorage backend`. Also you can set it to `kvstore` to use the tfchain keyvalue store module.
- keypairType: is defaulted to `sr25519`, most likely you will never need to change it. `ed25519` is supported too. - keypairType: is defaulted to `sr25519`, most likely you will never need to change it. `ed25519` is supported too.
for more details, check [client options](https://github.com/threefoldtech/tfgrid-sdk-ts/blob/development/packages/grid_client/docs/client_configuration.md) for more details, check [client options](client_configuration.md)
> Note: The choice of the node is completely up to the user at this point. They need to do the capacity planning. Check [Node Finder](dashboard@@node_finder) to know which nodes fits your deployment criteria. > Note: The choice of the node is completely up to the user at this point. They need to do the capacity planning. Check [Node Finder](dashboard@@node_finder) to know which nodes fits your deployment criteria.

View File

@ -15,7 +15,7 @@
## Prerequisites ## Prerequisites
First, make sure that you have your [client](./grid3_javascript_loadclient.md) prepared. First, make sure that you have your [client](grid3_javascript_loadclient.md) prepared.
## Code Example ## Code Example
@ -257,7 +257,7 @@ log(">>>>>>>>>>>>>>>vm has been created<<<<<<<<<<<<<<<");
log(vm_res); log(vm_res);
``` ```
So this deployment is almost similiar to what we have in the [vm deployment section](./grid3_javascript_vm.md). We only have a new section `qsfs_disks` So this deployment is almost similiar to what we have in the [vm deployment section](grid3_javascript_vm.md). We only have a new section `qsfs_disks`
```ts ```ts
qsfs_disks: [{ qsfs_disks: [{

View File

@ -21,7 +21,7 @@ We show how to deploy ZDBs for QSFS on the TFGrid with the Javascript client.
## Prerequisites ## Prerequisites
- Make sure you have your [client](./grid3_javascript_loadclient.md) prepared - Make sure you have your [client](grid3_javascript_loadclient.md) prepared
## Example code ## Example code

View File

@ -8,17 +8,17 @@ Please make sure to check the [basics](system_administrators@@tfgrid3_getstarted
<h2> Table of Contents </h2> <h2> Table of Contents </h2>
- [Installation](./grid3_javascript_installation.md) - [Installation](grid3_javascript_installation.md)
- [Loading Client](./grid3_javascript_loadclient.md) - [Loading Client](grid3_javascript_loadclient.md)
- [Deploy a VM](./grid3_javascript_vm.md) - [Deploy a VM](grid3_javascript_vm.md)
- [Capacity Planning](./grid3_javascript_capacity_planning.md) - [Capacity Planning](grid3_javascript_capacity_planning.md)
- [Deploy Multiple VMs](./grid3_javascript_vms.md) - [Deploy Multiple VMs](grid3_javascript_vms.md)
- [Deploy CapRover](./grid3_javascript_caprover.md) - [Deploy CapRover](grid3_javascript_caprover.md)
- [Gateways](./grid3_javascript_vm_gateways.md) - [Gateways](grid3_javascript_vm_gateways.md)
- [Deploy a Kubernetes Cluster](./grid3_javascript_kubernetes.md) - [Deploy a Kubernetes Cluster](grid3_javascript_kubernetes.md)
- [Deploy a ZDB](./grid3_javascript_zdb.md) - [Deploy a ZDB](grid3_javascript_zdb.md)
- [Deploy ZDBs for QSFS](./grid3_javascript_qsfs_zdbs.md) - [Deploy ZDBs for QSFS](grid3_javascript_qsfs_zdbs.md)
- [QSFS](./grid3_javascript_qsfs.md) - [QSFS](grid3_javascript_qsfs.md)
- [Key Value Store](./grid3_javascript_kvstore.md) - [Key Value Store](grid3_javascript_kvstore.md)
- [VM with Wireguard and Gateway](./grid3_wireguard_gateway.md) - [VM with Wireguard and Gateway](grid3_wireguard_gateway.md)
- [GPU Support](./grid3_javascript_gpu_support.md) - [GPU Support](grid3_javascript_gpu_support.md)

View File

@ -19,7 +19,7 @@
## Introduction ## Introduction
After the [deployment of a VM](./grid3_javascript_vm.md), now it's time to expose it to the world After the [deployment of a VM](grid3_javascript_vm.md), now it's time to expose it to the world
## Example code ## Example code
@ -104,7 +104,7 @@ log(d);
## Deploying a VM and exposing it over a Gateway using a Full domain ## Deploying a VM and exposing it over a Gateway using a Full domain
After the [deployment of a VM](./grid3_javascript_vm.md), now it's time to expose it to the world After the [deployment of a VM](grid3_javascript_vm.md), now it's time to expose it to the world
## Example code ## Example code

View File

@ -21,7 +21,7 @@ We show how to deploy ZDB on the TFGrid with the Javascript client.
## Prerequisites ## Prerequisites
- Make sure you have your [client](./grid3_javascript_loadclient.md) prepared - Make sure you have your [client](grid3_javascript_loadclient.md) prepared
## Example code ## Example code

View File

@ -26,7 +26,7 @@ We present here the relevant information when it comes to deploying a virtual ma
## Client Configurations ## Client Configurations
To configure the client, have a look at [this section](./grid3_javascript_loadclient.md). To configure the client, have a look at [this section](grid3_javascript_loadclient.md).

View File

@ -45,11 +45,11 @@ The main structure of the code base is as follows:
Adding a new endpoint should be accompanied with a corresponding test. Ideally every change or bug fix should include a test to ensure the new behavior/fix is working as intended. Adding a new endpoint should be accompanied with a corresponding test. Ideally every change or bug fix should include a test to ensure the new behavior/fix is working as intended.
Since these are integration tests, you need to first make sure that your local db is already seeded with the ncessary data. See tools [doc](./db_testing.md) for more information about how to prepare your db. Since these are integration tests, you need to first make sure that your local db is already seeded with the ncessary data. See tools [doc](db_testing.md) for more information about how to prepare your db.
Testing tools offer two clients that are the basic of most tests: Testing tools offer two clients that are the basic of most tests:
- `local`: this client connects to the local db - `local`: this client connects to the local db
- `proxy client`: this client connects to the running local instance - `proxy client`: this client connects to the running local instance
You need to start an instance of the server before running the tests. Check [here](./commands.md) for how to start. You need to start an instance of the server before running the tests. Check [here](commands.md) for how to start.

View File

@ -50,7 +50,7 @@ By default, the instance runs against devnet. to configure that you will need to
3. **Docker**: Containerize the running services such as Postgres and Redis. 3. **Docker**: Containerize the running services such as Postgres and Redis.
4. **Mnemonics**: Secret seeds for adummy identity to use for the relay client. 4. **Mnemonics**: Secret seeds for adummy identity to use for the relay client.
For more about the prerequisites and how to set up and configure them. follow the [Setup guide](./setup.md) For more about the prerequisites and how to set up and configure them. follow the [Setup guide](setup.md)
<!-- Development --> <!-- Development -->
@ -90,7 +90,7 @@ To start the services for development or testing make sure first you have all th
make docs make docs
``` ```
To run in development environment see [here](./db_testing.md) how to generate test db or load a db dump then use: To run in development environment see [here](db_testing.md) how to generate test db or load a db dump then use:
```sh ```sh
go run cmds/proxy_server/main.go --address :8080 --log-level debug -no-cert --postgres-host 127.0.0.1 --postgres-db tfgrid-graphql --postgres-password postgres --postgres-user postgres --mnemonics <insert user mnemonics> go run cmds/proxy_server/main.go --address :8080 --log-level debug -no-cert --postgres-host 127.0.0.1 --postgres-db tfgrid-graphql --postgres-password postgres --postgres-user postgres --mnemonics <insert user mnemonics>
@ -98,7 +98,7 @@ go run cmds/proxy_server/main.go --address :8080 --log-level debug -no-cert --po
Then visit `http://localhost:8080/<endpoint>` Then visit `http://localhost:8080/<endpoint>`
For more illustrations about the commands needed to work on the project, see the section [Commands](./commands.md). For more info about the project structure and contributions guidelines check the section [Contributions](./contributions.md). For more illustrations about the commands needed to work on the project, see the section [Commands](commands.md). For more info about the project structure and contributions guidelines check the section [Contributions](contributions.md).
<!-- Production--> <!-- Production-->

View File

@ -14,12 +14,12 @@ To assist you on your journey, we have organized the content into distinct chapt
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
- [Introducing Grid Proxy](./proxy.md) - [Introducing Grid Proxy](proxy.md)
- [Setup](./setup.md) - [Setup](setup.md)
- [DB Testing](./db_testing.md) - [DB Testing](db_testing.md)
- [Commands](./commands.md) - [Commands](commands.md)
- [Contributions](./contributions.md) - [Contributions](contributions.md)
- [Explorer](./explorer.md) - [Explorer](explorer.md)
- [Database](./database.md) - [Database](database.md)
- [Production](./production.md) - [Production](production.md)
- [Release](./release.md) - [Release](release.md)

View File

@ -6,10 +6,10 @@ Consult the [ThreeFoldTech TFCMD repository](https://github.com/threefoldtech/tf
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
- [Getting Started](./tfcmd_basics.md) - [Getting Started](tfcmd_basics.md)
- [Deploy a VM](./tfcmd_vm.md) - [Deploy a VM](tfcmd_vm.md)
- [Deploy Kubernetes](./tfcmd_kubernetes.md) - [Deploy Kubernetes](tfcmd_kubernetes.md)
- [Deploy ZDB](./tfcmd_zdbs.md) - [Deploy ZDB](tfcmd_zdbs.md)
- [Gateway FQDN](./tfcmd_gateway_fqdn.md) - [Gateway FQDN](tfcmd_gateway_fqdn.md)
- [Gateway Name](./tfcmd_gateway_name.md) - [Gateway Name](tfcmd_gateway_name.md)
- [Contracts](./tfcmd_contracts.md) - [Contracts](tfcmd_contracts.md)

View File

@ -6,8 +6,8 @@ Consult the [ThreeFoldTech TFROBOT repository](https://github.com/threefoldtech/
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
- [Installation](./tfrobot_installation.md) - [Installation](tfrobot_installation.md)
- [Configuration File](./tfrobot_config.md) - [Configuration File](tfrobot_config.md)
- [Deployment](./tfrobot_deploy.md) - [Deployment](tfrobot_deploy.md)
- [Commands and Flags](./tfrobot_commands_flags.md) - [Commands and Flags](tfrobot_commands_flags.md)
- [Supported Configurations](./tfrobot_configurations.md) - [Supported Configurations](tfrobot_configurations.md)

View File

@ -20,7 +20,7 @@ We present how to deploy workloads on the ThreeFold Grid using TFROBOT.
## Prerequisites ## Prerequisites
To deploy workloads on the TFGrid with TFROBOT, you first need to [install TFROBOT](./tfrobot_installation.md) on your machine and create a [configuration file](./tfrobot_config.md). To deploy workloads on the TFGrid with TFROBOT, you first need to [install TFROBOT](tfrobot_installation.md) on your machine and create a [configuration file](tfrobot_config.md).
## Deploy Workloads ## Deploy Workloads

View File

@ -39,7 +39,7 @@ Note that you can run Zero-OS on a Virtual Machine (VM), but you won't farm any
Also, note that ThreeFold runs its own OS, which is Zero-OS. You thus need to start with completely wiped disks. You cannot farm TFT with Windows, Linux or MAC OS installed on your disks. If you need to use such OS temporarily, boot it in Try mode with a removable media (USB key). Also, note that ThreeFold runs its own OS, which is Zero-OS. You thus need to start with completely wiped disks. You cannot farm TFT with Windows, Linux or MAC OS installed on your disks. If you need to use such OS temporarily, boot it in Try mode with a removable media (USB key).
Note: Once you have the necessary hardware, you need to [create a farm](./1_create_farm.md), [create a Zero-OS bootstrap image](./2_bootstrap_image.md), [wipe your disks](./4_wipe_all_disks.md) and [set the BIOS/UEFI](./5_set_bios_uefi.md) . Then you can [boot your 3Node](./6_boot_3node.md). If you are planning in building a farm in data center, [read this section](advanced_networking_toc.md). Note: Once you have the necessary hardware, you need to [create a farm](1_create_farm.md), [create a Zero-OS bootstrap image](2_bootstrap_image.md), [wipe your disks](4_wipe_all_disks.md) and [set the BIOS/UEFI](5_set_bios_uefi.md) . Then you can [boot your 3Node](6_boot_3node.md). If you are planning in building a farm in data center, [read this section](advanced_networking_toc.md).

View File

@ -6,9 +6,9 @@ For advanced farming information, such as GPU farming and room parameters, refer
<h2> Table of Contents </h2> <h2> Table of Contents </h2>
- [1. Create a Farm](./1_create_farm.md) - [1. Create a Farm](1_create_farm.md)
- [2. Create a Zero-OS Bootstrap Image](./2_bootstrap_image.md) - [2. Create a Zero-OS Bootstrap Image](2_bootstrap_image.md)
- [3. Set the Hardware](./3_set_hardware.md) - [3. Set the Hardware](3_set_hardware.md)
- [4. Wipe All the Disks](./4_wipe_all_disks.md) - [4. Wipe All the Disks](4_wipe_all_disks.md)
- [5. Set the BIOS/UEFI](./5_set_bios_uefi.md) - [5. Set the BIOS/UEFI](5_set_bios_uefi.md)
- [6. Boot the 3Node](./6_boot_3node.md) - [6. Boot the 3Node](6_boot_3node.md)

View File

@ -159,7 +159,7 @@ Choices 1 and 2 are for UEFI (newer models).
Choices 4 and 5 are for BIOS (newer models). Choices 4 and 5 are for BIOS (newer models).
Choices 3 and 6 are mainly for network boot. Choices 3 and 6 are mainly for network boot.
Refer to [this previous section](./2_bootstrap_image.md) for more information on creating a Zero-OS bootstrap image. Refer to [this previous section](2_bootstrap_image.md) for more information on creating a Zero-OS bootstrap image.
For information on how to boot Zero-OS with iPXE, read [this section](./6_boot_3node.md#advanced-booting-methods-optional). For information on how to boot Zero-OS with iPXE, read [this section](./6_boot_3node.md#advanced-booting-methods-optional).

View File

@ -23,19 +23,19 @@ One of the great features of Zero-OS is that it can be completely run within the
## 1. Booting the 3Node with Zero-OS ## 1. Booting the 3Node with Zero-OS
To boot Zero-OS, insert your Zero-OS bootstrap image USB key, power on your computer and choose the right booting sequence and parameters ([BIOS or UEFI](./5_set_bios_uefi.md)) in your BIOS/UEFI settings. Then, restart the 3Node. Zero-OS should boot automatically. To boot Zero-OS, insert your Zero-OS bootstrap image USB key, power on your computer and choose the right booting sequence and parameters ([BIOS or UEFI](5_set_bios_uefi.md)) in your BIOS/UEFI settings. Then, restart the 3Node. Zero-OS should boot automatically.
Note that you need an ethernet cable connected to your router or switch. You cannot farm on the ThreeFold Grid with Wifi. Note that you need an ethernet cable connected to your router or switch. You cannot farm on the ThreeFold Grid with Wifi.
The first time you boot a 3Node, it will be written: “This node is not registered (farmer : NameOfFarm). This is normal. The Grid will create a node ID and you will be able to see it on screen. This can take a couple of minutes. The first time you boot a 3Node, it will be written: “This node is not registered (farmer : NameOfFarm). This is normal. The Grid will create a node ID and you will be able to see it on screen. This can take a couple of minutes.
If time passes (an hour and more) and the node does not get registered, in many cases, [wiping the disks](./4_wipe_all_disks.md) all over again and trying another reboot usually resolves this issue. If time passes (an hour and more) and the node does not get registered, in many cases, [wiping the disks](4_wipe_all_disks.md) all over again and trying another reboot usually resolves this issue.
Once you have your node ID, you can also go on the ThreeFold Dashboard to see your 3Node and verify that your 3Node is online. Once you have your node ID, you can also go on the ThreeFold Dashboard to see your 3Node and verify that your 3Node is online.
## 2. Check the 3Node Status Online ## 2. Check the 3Node Status Online
You can use the ThreeFold [Node Finder](../../dashboard/deploy/node_finder.md) to verify that your 3Node is online. You can use the ThreeFold [Node Finder](node_finder.md) to verify that your 3Node is online.
* [ThreeFold Main Net Dashboard](https://dashboard.grid.tf/) * [ThreeFold Main Net Dashboard](https://dashboard.grid.tf/)
* [ThreeFold Test Net Dashboard](https://dashboard.test.grid.tf/) * [ThreeFold Test Net Dashboard](https://dashboard.test.grid.tf/)

Some files were not shown because too many files have changed in this diff Show More