diff --git a/books/tech/SUMMARY.md b/books/tech/SUMMARY.md index 5158638..ac94582 100644 --- a/books/tech/SUMMARY.md +++ b/books/tech/SUMMARY.md @@ -1,38 +1,38 @@ -- [Introduction](tech/technology.md) -- [The Internet Today](tech/internet_today.md) - - [History of Computers](tech/history/c64.md) - - [Too Many Layers](tech/history/layers.md) -- [The Internet Re-invented](tech/how_does_it_work.md) - - [World Records](tech/world_records.md) -- [Key Innovations](tech/key_innovations_overview.md) - - [Mycelium Network](tech/mycelium_innovation.md) - - [Zero-OS](tech/zos_innovation.md) - - [Quantum Safe Storage](tech/zstor_innovation.md) - - [Quantum Safe Filesystem](tech/qsfs_innovation.md) - - [FList: Better OS Images](tech/flist_innovation.md) - - [FungiStor](tech/fungistor_innovation.md) - - [Network Wall](tech/network_wall_innovation.md) -- [Architecture](tech/architecture.md) -- [Energy Efficient](tech/energy_efficient.md) -- [Decentralized Cloud Core Capabilities](tech/features.md) - - [Storage](tech/qsss_home.md) - - [Quantum Safe Storage Algo](tech/qss_algorithm.md) - - [Zero Knowledge proof](tech/qss_zero_knowledge_proof.md) - - [NFT Storage](tech/nft_storage.md) +- [Introduction](technology.md) +- [The Internet Today](internet_today.md) + - [History of Computers](c64.md) + - [Too Many Layers](layers.md) +- [The Internet Re-invented](how_does_it_work.md) + - [World Records](world_records.md) +- [Key Innovations](key_innovations_overview.md) + - [Mycelium Network](mycelium_innovation.md) + - [Zero-OS](zos_innovation.md) + - [Quantum Safe Storage](zstor_innovation.md) + - [Quantum Safe Filesystem](qsfs_innovation.md) + - [FList: Better OS Images](flist_innovation.md) + - [FungiStor](fungistor_innovation.md) + - [Network Wall](network_wall_innovation.md) +- [Architecture](architecture.md) +- [Energy Efficient](energy_efficient.md) +- [Decentralized Cloud Core Capabilities](features.md) + - [Storage](qsss_home.md) + - [Quantum Safe Storage Algo](qss_algorithm.md) + - [Zero Knowledge proof](qss_zero_knowledge_proof.md) + - [NFT Storage](nft_storage.md) - [S3 Storage](tech/s3_interface) - - [File System](tech/qss_filesystem.md) - - [Network](tech/networking.md) - - [Mycelium](tech/mycelium.md) - - [Web Gateway](tech/webgw.md) -- [Partners Utilization](partners_utilization/partners.md) - - [Sikana](partners_utilization/sikana.md) - - [Vindo](partners_utilization/vindo.md) - - [Mkondo](partners_utilization/mkondo.md) - - [Vverse](partners_utilization/vverse.md) - - [Earth Wallet](partners_utilization/earth_wallet.md) - - [Elestio](partners_utilization/elestio.md) - - [OW Freezone](partners_utilization/freezone.md) - - [Helium](partners_utilization/helium.md) - - [Holochain](partners_utilization/holochain.md) - - [TZG](partners_utilization/tanzania.md) - - [Tier-S DC](partners_utilization/tier_s_datacenter.md) \ No newline at end of file + - [File System](qss_filesystem.md) + - [Network](networking.md) + - [Mycelium](mycelium.md) + - [Web Gateway](webgw.md) +- [Partners Utilization](partners.md) + - [Sikana](sikana.md) + - [Vindo](vindo.md) + - [Mkondo](mkondo.md) + - [Vverse](vverse.md) + - [Earth Wallet](earth_wallet.md) + - [Elestio](elestio.md) + - [OW Freezone](freezone.md) + - [Helium](helium.md) + - [Holochain](holochain.md) + - [TZG](tanzania.md) + - [Tier-S DC](tier_s_datacenter.md) \ No newline at end of file diff --git a/collections/about/about.md b/collections/about/about.md index ba76824..9e981f4 100644 --- a/collections/about/about.md +++ b/collections/about/about.md @@ -6,8 +6,8 @@ It's a good place to start if you want to have an overview of ThreeFold since it

Table of Contents

-- [ThreeFold History](./threefold_history.md) -- [ThreeFold Tech](./threefold_tech.md) -- [Organisation Structure](./orgstructure.md) -- [ThreeFold Roadmap](./roadmap/roadmap_readme.md) -- [ThreeFold Token](./token_overview/token_overview.md) \ No newline at end of file +- [ThreeFold History](threefold_history.md) +- [ThreeFold Tech](threefold_tech.md) +- [Organisation Structure](orgstructure.md) +- [ThreeFold Roadmap](roadmap_readme.md) +- [ThreeFold Token](token_overview.md) \ No newline at end of file diff --git a/collections/about/bettertoken.md b/collections/about/bettertoken.md index 81ff291..4e2fca5 100644 --- a/collections/about/bettertoken.md +++ b/collections/about/bettertoken.md @@ -15,7 +15,7 @@ European Farming Cooperative for the foundation: - 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 -- [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 ## Income diff --git a/collections/about/dao/tfdao.md b/collections/about/dao/tfdao.md index 79020b5..d50a01d 100644 --- a/collections/about/dao/tfdao.md +++ b/collections/about/dao/tfdao.md @@ -24,8 +24,8 @@ Amongst others the DAO needs to arrange | Utility Token model | | | -------------------------------------------- | ------------------------------------------ | -| [Proof Of Capacity](../../farming/proof_of_capacity.md) | Farming (creation) of TFT | -| [Proof Of Utilization](../../farming/proof_of_utilization.md) | Utilization (burning, distribution) of TFT | +| [Proof Of Capacity](proof_of_capacity.md) | Farming (creation) of TFT | +| [Proof Of Utilization](proof_of_utilization.md) | Utilization (burning, distribution) of TFT | As well as diff --git a/collections/about/genesis_pool.md b/collections/about/genesis_pool.md index 25552de..1923ad5 100644 --- a/collections/about/genesis_pool.md +++ b/collections/about/genesis_pool.md @@ -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). -- 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 Ghent, see here](genesis_pool_ghent.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. -> 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 @@ -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. - 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. diff --git a/collections/about/genesis_pool_dubai.md b/collections/about/genesis_pool_dubai.md index a25dc91..93ff1b9 100644 --- a/collections/about/genesis_pool_dubai.md +++ b/collections/about/genesis_pool_dubai.md @@ -4,4 +4,4 @@ ![](img/genesispool_2.jpg) -Read more about ThreeFold Dubai [here](./threefold_dubai.md). \ No newline at end of file +Read more about ThreeFold Dubai [here](threefold_dubai.md). \ No newline at end of file diff --git a/collections/about/governance.md b/collections/about/governance.md index 2381fa5..383d5aa 100644 --- a/collections/about/governance.md +++ b/collections/about/governance.md @@ -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. -For more information, read the [ThreeFold History](./threefold_history.md). +For more information, read the [ThreeFold History](threefold_history.md). ## Type of Token @@ -39,7 +39,7 @@ For more information, [read the legal opinions](https://drive.google.com/file/d/ ## 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 @@ -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). -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 diff --git a/collections/about/mazraa.md b/collections/about/mazraa.md index c280c8e..d9e6898 100644 --- a/collections/about/mazraa.md +++ b/collections/about/mazraa.md @@ -10,7 +10,7 @@ ## 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 diff --git a/collections/about/orgstructure.md b/collections/about/orgstructure.md index 5fb2686..b9e7a67 100644 --- a/collections/about/orgstructure.md +++ b/collections/about/orgstructure.md @@ -2,13 +2,13 @@

Table of Contents

-- [Governance](./governance.md) -- [ThreeFold Companies](./threefold_companies.md) -- [ThreeFold Dubai](./threefold_dubai.md) -- [ThreeFold VZW](./threefold_vzw.md) -- [ThreeFold AG](./threefold_ag.md) -- [Mazraa](./mazraa.md) -- [BetterToken](./bettertoken.md) -- [DAO](./dao.md) -- [ThreeFold DAO](./tfdao.md) -- [TFChain](./tfchain.md) \ No newline at end of file +- [Governance](governance.md) +- [ThreeFold Companies](threefold_companies.md) +- [ThreeFold Dubai](threefold_dubai.md) +- [ThreeFold VZW](threefold_vzw.md) +- [ThreeFold AG](threefold_ag.md) +- [Mazraa](mazraa.md) +- [BetterToken](bettertoken.md) +- [DAO](dao.md) +- [ThreeFold DAO](tfdao.md) +- [TFChain](tfchain.md) \ No newline at end of file diff --git a/collections/about/roadmap/releasenotes/releasenotes_readme.md b/collections/about/roadmap/releasenotes/releasenotes_readme.md index 21e8011..d2a0e20 100644 --- a/collections/about/roadmap/releasenotes/releasenotes_readme.md +++ b/collections/about/roadmap/releasenotes/releasenotes_readme.md @@ -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! ## ThreeFold TFGrid v3.x Release Notes -- [TFGrid v3.10.0](./tfgrid_release_3_10_0.md) -- [TFGrid v3.9.0](./tfgrid_release_3_9_0.md) -- [TFGrid v3.8.0](./tfgrid_release_3_8_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.0](./tfgrid_release_3_6_0.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-2](./tfgrid_release_3_0_a2.md) -- [TFGrid v3.0.0](./tfgrid_release_3_0.md) +- [TFGrid v3.10.0](tfgrid_release_3_10_0.md) +- [TFGrid v3.9.0](tfgrid_release_3_9_0.md) +- [TFGrid v3.8.0](tfgrid_release_3_8_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.0](tfgrid_release_3_6_0.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-2](tfgrid_release_3_0_a2.md) +- [TFGrid v3.0.0](tfgrid_release_3_0.md) diff --git a/collections/about/roadmap/releasenotes/tfgrid_release_3_10_0.md b/collections/about/roadmap/releasenotes/tfgrid_release_3_10_0.md index 8cad3e3..08fbf1b 100644 --- a/collections/about/roadmap/releasenotes/tfgrid_release_3_10_0.md +++ b/collections/about/roadmap/releasenotes/tfgrid_release_3_10_0.md @@ -67,7 +67,7 @@ Below are some of the key highlights of the TFGrid v3.10.0 component upgrades an #### TF-Grid-CLI - 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 diff --git a/collections/about/roadmap/releasenotes/tfgrid_release_3_8_0.md b/collections/about/roadmap/releasenotes/tfgrid_release_3_8_0.md index 9142adf..a1c51aa 100644 --- a/collections/about/roadmap/releasenotes/tfgrid_release_3_8_0.md +++ b/collections/about/roadmap/releasenotes/tfgrid_release_3_8_0.md @@ -18,7 +18,7 @@ This release note includes updates, improvements and fixes of numerous grid comp ## Upgrades and Improvements ### 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). - 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 diff --git a/collections/about/roadmap/releasenotes/tfgrid_release_3_9_0.md b/collections/about/roadmap/releasenotes/tfgrid_release_3_9_0.md index 972cb78..14a3b67 100644 --- a/collections/about/roadmap/releasenotes/tfgrid_release_3_9_0.md +++ b/collections/about/roadmap/releasenotes/tfgrid_release_3_9_0.md @@ -35,7 +35,7 @@ Reliable Message Bus Relay (RMB-RS) is a secure communication panel that allows - 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. -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: diff --git a/collections/about/roadmap/roadmap_readme.md b/collections/about/roadmap/roadmap_readme.md index acf698c..fc5cea9 100644 --- a/collections/about/roadmap/roadmap_readme.md +++ b/collections/about/roadmap/roadmap_readme.md @@ -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. -> 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 - [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) -- [Release Notes](./releasenotes/releasenotes_readme.md) \ No newline at end of file +- [What's new on TFGrid v3.x](grid3_whatsnew.md) +- [Release Notes](releasenotes_readme.md) \ No newline at end of file diff --git a/collections/about/threefold_companies.md b/collections/about/threefold_companies.md index 280a3f0..f1e7821 100644 --- a/collections/about/threefold_companies.md +++ b/collections/about/threefold_companies.md @@ -15,18 +15,18 @@ The following companies are related parties to ThreeFold. Our terms and conditio | THREEFOLD RELATED COMPANIES | Description | | --------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| [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_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 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_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 | | TF Hub Limited | ThreeFold in BVI | | Codescalers | Egypt-based software development team, creates a lot of code for ThreeFold | | FARMING COOPERATIVES | | | ------------------------------------ | ------------------------------------------------ | -| [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 | +| [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 | | 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 | | 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. -> [Click here for more info about our DAO](./dao/tfdao.md) \ No newline at end of file +> 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](tfdao.md) \ No newline at end of file diff --git a/collections/about/threefold_dubai.md b/collections/about/threefold_dubai.md index 9c1836b..e2e1abc 100644 --- a/collections/about/threefold_dubai.md +++ b/collections/about/threefold_dubai.md @@ -18,7 +18,7 @@ ThreeFold Dubai is the original team of ThreeFold operated from Dubai and Belgiu ## Responsibilities - 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 - 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 diff --git a/collections/about/threefold_history.md b/collections/about/threefold_history.md index df6c74c..d8fd5df 100644 --- a/collections/about/threefold_history.md +++ b/collections/about/threefold_history.md @@ -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. -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. @@ -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. -See our [overview of our companies](./threefold_companies.md) +See our [overview of our companies](threefold_companies.md) ## 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 -For more info about history of tokens, see [token history](./token_history.md). \ No newline at end of file +For more info about history of tokens, see [token history](token_history.md). \ No newline at end of file diff --git a/collections/about/threefold_vzw.md b/collections/about/threefold_vzw.md index 584653f..efd5a29 100644 --- a/collections/about/threefold_vzw.md +++ b/collections/about/threefold_vzw.md @@ -21,7 +21,7 @@ A **VZW** has no shareholders, only members. ## Functions - 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 diff --git a/collections/about/token_history.md b/collections/about/token_history.md index ee49ab4..8796dd9 100644 --- a/collections/about/token_history.md +++ b/collections/about/token_history.md @@ -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 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) - Genesis pools are owned by ThreeFold Dubai (ThreeFold_Dubai). - March 2018 our first-generation blockchain for the ThreeFold_Token saw daylight diff --git a/collections/about/token_overview/token_overview.md b/collections/about/token_overview/token_overview.md index c78c608..73d509b 100644 --- a/collections/about/token_overview/token_overview.md +++ b/collections/about/token_overview/token_overview.md @@ -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). -> 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 @@ -41,7 +41,7 @@ TFT is used on the TFGrid to purchase network, compute and storage resources thr ![](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 @@ -80,9 +80,9 @@ The values here are subject to change. Check the current market conditions. ## Complemetary Information -- [ThreeFold History](../../about/threefold_history.md) -- [Token History](../../about/token_history.md) -- [Special Wallets](./special_wallets/stats_special_wallets.md) +- [ThreeFold History](threefold_history.md) +- [Token History](token_history.md) +- [Special Wallets](stats_special_wallets.md) ## Disclaimer diff --git a/collections/cloud/cloud_toc.md b/collections/cloud/cloud_toc.md index d1a549f..48ae56a 100644 --- a/collections/cloud/cloud_toc.md +++ b/collections/cloud/cloud_toc.md @@ -6,11 +6,11 @@ To deploy on the ThreeFold Grid, refer to the [System Administrators](system_adm

Table of Contents

-- [Cloud Units](./cloudunits.md) -- [Pricing](./pricing_toc.md) - - [Pricing Overview](./pricing.md) - - [Staking Discounts](./staking_discount_levels.md) - - [Cloud Pricing Compare](./cloud_pricing_compare.md) - - [Grid Billing](./grid_billing.md) -- [Resource Units](./resource_units_calc_cloudunits.md) -- [Resource Units Advanced](./resourceunits_advanced.md) \ No newline at end of file +- [Cloud Units](cloudunits.md) +- [Pricing](pricing_toc.md) + - [Pricing Overview](pricing.md) + - [Staking Discounts](staking_discount_levels.md) + - [Cloud Pricing Compare](cloud_pricing_compare.md) + - [Grid Billing](grid_billing.md) +- [Resource Units](resource_units_calc_cloudunits.md) +- [Resource Units Advanced](resourceunits_advanced.md) \ No newline at end of file diff --git a/collections/cloud/cloudunits.md b/collections/cloud/cloudunits.md index e9f34c4..7f216c8 100644 --- a/collections/cloud/cloudunits.md +++ b/collections/cloud/cloudunits.md @@ -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). - 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. @@ -42,7 +42,7 @@ Example of Compute unit: - Recommended price on TF Grid = 10 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 @@ -58,7 +58,7 @@ Example of Storage unit: - Recommended price on TF Grid for 1 SU = 10 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 @@ -66,4 +66,4 @@ See how we compare with market storage prices [here](./pricing/pricing.md). | ------------------------------------------ | -------- | | 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. \ No newline at end of file +> 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. \ No newline at end of file diff --git a/collections/cloud/grid_billing/grid_billing.md b/collections/cloud/grid_billing/grid_billing.md index 771d59d..f1d56bc 100644 --- a/collections/cloud/grid_billing/grid_billing.md +++ b/collections/cloud/grid_billing/grid_billing.md @@ -130,7 +130,7 @@ Contract cost/hour = CU cost/hour + SU cost/hour ### 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). @@ -247,7 +247,7 @@ Contract cost/hour = CU cost/hour + SU cost/hour ### 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 @@ -256,7 +256,7 @@ Cost with 50% discount = 35.72532 * 0.5 ### 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). @@ -291,7 +291,7 @@ uniqueName in TFT = 0.00025 * 100 ### 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). @@ -326,7 +326,7 @@ Public IP in TFT = 0.004 * 100 ### 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). @@ -378,7 +378,7 @@ NU price in TFT = 0.0015 * 100 ### 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). diff --git a/collections/cloud/pricing/pricing_toc.md b/collections/cloud/pricing/pricing_toc.md index 50903e1..5a00fd6 100644 --- a/collections/cloud/pricing/pricing_toc.md +++ b/collections/cloud/pricing/pricing_toc.md @@ -2,7 +2,7 @@

Table of Contents

-- [Pricing Overview](./pricing.md) -- [Staking Discounts](./staking_discount_levels.md) -- [Cloud Pricing Compare](./cloud_pricing_compare.md) -- [Grid Billing](./grid_billing.md) \ No newline at end of file +- [Pricing Overview](pricing.md) +- [Staking Discounts](staking_discount_levels.md) +- [Cloud Pricing Compare](cloud_pricing_compare.md) +- [Grid Billing](grid_billing.md) \ No newline at end of file diff --git a/collections/cloud/resource_units_calc_cloudunits.md b/collections/cloud/resource_units_calc_cloudunits.md index 87a2b99..2c39555 100644 --- a/collections/cloud/resource_units_calc_cloudunits.md +++ b/collections/cloud/resource_units_calc_cloudunits.md @@ -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. -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 diff --git a/collections/cloud/resourceunits.md b/collections/cloud/resourceunits.md index 7265f41..9c7b71c 100644 --- a/collections/cloud/resourceunits.md +++ b/collections/cloud/resourceunits.md @@ -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. -To learn how they convert into cloudunits see [here](./resourceunits_advanced.md) \ No newline at end of file +To learn how they convert into cloudunits see [here](resourceunits_advanced.md) \ No newline at end of file diff --git a/collections/collaboration/collaboration_toc.md b/collections/collaboration/collaboration_toc.md index b99597c..38c110a 100644 --- a/collections/collaboration/collaboration_toc.md +++ b/collections/collaboration/collaboration_toc.md @@ -6,8 +6,8 @@ To become a farmer, a developer or a sysadmin on the ThreeFold, read the [docume

Table of Contents

Table of Contents -- [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. -- [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. -- [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. \ No newline at end of file diff --git a/collections/collaboration/collaboration_tools/website_tool.md b/collections/collaboration/collaboration_tools/website_tool.md index c3b997f..c118299 100644 --- a/collections/collaboration/collaboration_tools/website_tool.md +++ b/collections/collaboration/collaboration_tools/website_tool.md @@ -292,7 +292,7 @@ When you are in the main directory of your Zola website, you can check the follo 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 diff --git a/collections/collaboration/contribute.md b/collections/collaboration/contribute.md index 698a477..796b7f5 100644 --- a/collections/collaboration/contribute.md +++ b/collections/collaboration/contribute.md @@ -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 * To add a new section * 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: * Make the changes directly in the Markdown file * Ask for a pull request diff --git a/collections/collaboration/development_process.md b/collections/collaboration/development_process.md index a8a16b2..9bb3bda 100644 --- a/collections/collaboration/development_process.md +++ b/collections/collaboration/development_process.md @@ -101,8 +101,8 @@ Creating a repository involves establishing a foundation for collaborative devel #### 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 [pull requests](./pull_request_template.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) #### Expected Workflows diff --git a/collections/dashboard/dashboard.md b/collections/dashboard/dashboard.md index 1ad728b..007707f 100644 --- a/collections/dashboard/dashboard.md +++ b/collections/dashboard/dashboard.md @@ -14,11 +14,11 @@ The backend for the weblets is introduced with the [Javascript Client](developer

Table of Contents

-- [Wallet Connector](./wallet_connector.md) -- [TFGrid](./tfgrid/tfgrid.md) -- [Deploy](./deploy/deploy.md) -- [Farms](./farms/farms.md) -- [TFChain](./tfchain/tfchain.md) +- [Wallet Connector](wallet_connector.md) +- [TFGrid](tfgrid.md) +- [Deploy](deploy.md) +- [Farms](farms.md) +- [TFChain](tfchain.md) ## Advantages diff --git a/collections/dashboard/farms/farms.md b/collections/dashboard/farms/farms.md index 7faedd3..11dc72d 100644 --- a/collections/dashboard/farms/farms.md +++ b/collections/dashboard/farms/farms.md @@ -2,10 +2,10 @@ 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. -- 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. -- Estimating and calculating potential earnings from farming on the ThreeFold Grid from the [Simulator](./simulator.md) section. +- 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. +- 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. ![](../img/sidebar_3.png) @@ -13,7 +13,7 @@ Here you will find everything farming related. this includes: ## Table of Content -- [Your Farms](./your_farms.md) -- [Farm Finder](./farms_finder.md) -- [Node Installer](./node_installer.md) -- [Simulator](./simulator.md) \ No newline at end of file +- [Your Farms](your_farms.md) +- [Farm Finder](farms_finder.md) +- [Node Installer](node_installer.md) +- [Simulator](simulator.md) \ No newline at end of file diff --git a/collections/dashboard/home.md b/collections/dashboard/home.md index 0b70c98..2f8bcad 100644 --- a/collections/dashboard/home.md +++ b/collections/dashboard/home.md @@ -14,11 +14,11 @@ The backend for the weblets is introduced with the [Javascript Client](developer

Table of Contents

-- [Wallet Connector](./wallet_connector.md) -- [TFGrid](./tfgrid/tfgrid.md) -- [Deploy](./deploy/deploy.md) -- [Farms](./farms/farms.md) -- [TFChain](./tfchain/tfchain.md) +- [Wallet Connector](wallet_connector.md) +- [TFGrid](tfgrid.md) +- [Deploy](deploy.md) +- [Farms](farms.md) +- [TFChain](tfchain.md) ## Advantages diff --git a/collections/dashboard/solutions/algorand.md b/collections/dashboard/solutions/algorand.md index 21c25c7..5660fbd 100644 --- a/collections/dashboard/solutions/algorand.md +++ b/collections/dashboard/solutions/algorand.md @@ -19,7 +19,7 @@ ## 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** - Click on **Algorand** diff --git a/collections/dashboard/solutions/basic_environments_readme.md b/collections/dashboard/solutions/basic_environments_readme.md index d1bd532..5bbd8c9 100644 --- a/collections/dashboard/solutions/basic_environments_readme.md +++ b/collections/dashboard/solutions/basic_environments_readme.md @@ -2,10 +2,10 @@

Table of Contents

-- [Virtual Machines](./vm_intro.md) - - [Micro and Full VM Differences ](./vm_differences.md) - - [Full Virtual Machine](./fullVm.md) - - [Micro Virtual Machine](./vm.md) -- [Kubernetes](./k8s.md) -- [NixOS MicroVM](./nixos_micro.md) -- [Add a Domain](./add_domain.md) \ No newline at end of file +- [Virtual Machines](vm_intro.md) + - [Micro and Full VM Differences ](vm_differences.md) + - [Full Virtual Machine](fullVm.md) + - [Micro Virtual Machine](vm.md) +- [Kubernetes](k8s.md) +- [NixOS MicroVM](nixos_micro.md) +- [Add a Domain](add_domain.md) \ No newline at end of file diff --git a/collections/dashboard/solutions/caprover.md b/collections/dashboard/solutions/caprover.md index 32034d7..99c295b 100644 --- a/collections/dashboard/solutions/caprover.md +++ b/collections/dashboard/solutions/caprover.md @@ -38,7 +38,7 @@ It has following benefits : ## 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** - 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 -* [CapRover Admin Tutorial](./caprover_admin.md) -* [CapRover Worker Tutorial](./caprover_worker.md) +* [CapRover Admin Tutorial](caprover_admin.md) +* [CapRover Worker Tutorial](caprover_worker.md) diff --git a/collections/dashboard/solutions/casper.md b/collections/dashboard/solutions/casper.md index 5071c09..9d10e8a 100644 --- a/collections/dashboard/solutions/casper.md +++ b/collections/dashboard/solutions/casper.md @@ -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. -- Make sure you have a [wallet](../wallet_connector.md) +- Make sure you have a [wallet](wallet_connector.md) - From the sidebar click on **Applications** - Click on **Casperlabs** diff --git a/collections/dashboard/solutions/discourse.md b/collections/dashboard/solutions/discourse.md index 9bdff3c..3ffa093 100644 --- a/collections/dashboard/solutions/discourse.md +++ b/collections/dashboard/solutions/discourse.md @@ -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! -- Make sure you have a [wallet](../wallet_connector.md) +- Make sure you have a [wallet](wallet_connector.md) - From the sidebar click on **Applications** - Click on **Discourse** diff --git a/collections/dashboard/solutions/fullvm.md b/collections/dashboard/solutions/fullvm.md index 774714f..1137273 100644 --- a/collections/dashboard/solutions/fullvm.md +++ b/collections/dashboard/solutions/fullvm.md @@ -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 -- Make sure you have a [wallet](../wallet_connector.md) +- Make sure you have a [wallet](wallet_connector.md) - From the sidebar click on **Applications** - Click on **Full Virtual Machine** diff --git a/collections/dashboard/solutions/funkwhale.md b/collections/dashboard/solutions/funkwhale.md index 8940728..c095388 100644 --- a/collections/dashboard/solutions/funkwhale.md +++ b/collections/dashboard/solutions/funkwhale.md @@ -15,7 +15,7 @@ Funkwhale is a community-driven project that lets you listen and share music and ## 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** - Click on **Funkwhale** diff --git a/collections/dashboard/solutions/k8s.md b/collections/dashboard/solutions/k8s.md index 11197ec..44a96c3 100644 --- a/collections/dashboard/solutions/k8s.md +++ b/collections/dashboard/solutions/k8s.md @@ -19,7 +19,7 @@ On the TF grid, Kubernetes clusters can be deployed out of the box. We have impl ## 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** - Click on **Kubernetes** diff --git a/collections/dashboard/solutions/mattermost.md b/collections/dashboard/solutions/mattermost.md index 0e9528c..cbd7f99 100644 --- a/collections/dashboard/solutions/mattermost.md +++ b/collections/dashboard/solutions/mattermost.md @@ -14,7 +14,7 @@ ## 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** - Click on **Mattermost** diff --git a/collections/dashboard/solutions/nextcloud.md b/collections/dashboard/solutions/nextcloud.md index d25dd79..72f9cb1 100644 --- a/collections/dashboard/solutions/nextcloud.md +++ b/collections/dashboard/solutions/nextcloud.md @@ -36,7 +36,7 @@ Nextcloud provides functionality similar to Dropbox, Office 365 or Google Drive # 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** - 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 } * Or choose a **Custom** plan * 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 * `Country` * `Farm Name` diff --git a/collections/dashboard/solutions/nixos_micro.md b/collections/dashboard/solutions/nixos_micro.md index 2e6a91f..da4574c 100644 --- a/collections/dashboard/solutions/nixos_micro.md +++ b/collections/dashboard/solutions/nixos_micro.md @@ -26,7 +26,7 @@ For more information on Nix, you can read the [Nix Reference Manual](https://nix * [Devnet](https://dashboard.dev.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** * Click on **Micro Virtual Machine** to start your NixOS MicroVM Deployment diff --git a/collections/dashboard/solutions/nodepilot.md b/collections/dashboard/solutions/nodepilot.md index 1fc212a..aa8da14 100644 --- a/collections/dashboard/solutions/nodepilot.md +++ b/collections/dashboard/solutions/nodepilot.md @@ -14,7 +14,7 @@ This is a simple instance of upstream [Node Pilot](https://nodepilot.tech). ## 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** - Click on **Node Pilot** diff --git a/collections/dashboard/solutions/owncloud.md b/collections/dashboard/solutions/owncloud.md index 16726a0..1ef716d 100644 --- a/collections/dashboard/solutions/owncloud.md +++ b/collections/dashboard/solutions/owncloud.md @@ -19,7 +19,7 @@ ## 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** - Click on **ownCloud** diff --git a/collections/dashboard/solutions/peertube.md b/collections/dashboard/solutions/peertube.md index 79a74ee..f9fc947 100644 --- a/collections/dashboard/solutions/peertube.md +++ b/collections/dashboard/solutions/peertube.md @@ -14,7 +14,7 @@ ## 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** - Click on **Peertube** diff --git a/collections/dashboard/solutions/presearch.md b/collections/dashboard/solutions/presearch.md index c0c3f55..a1f2d65 100644 --- a/collections/dashboard/solutions/presearch.md +++ b/collections/dashboard/solutions/presearch.md @@ -18,7 +18,7 @@ ## 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** - Click on **Presearch** diff --git a/collections/dashboard/solutions/solutions.md b/collections/dashboard/solutions/solutions.md index 60732e3..1a10b1c 100644 --- a/collections/dashboard/solutions/solutions.md +++ b/collections/dashboard/solutions/solutions.md @@ -4,26 +4,26 @@ This section provides a non-code easy way to deploy a whole solution on the TFGr

Table of Contents

-- [Basic Environments](./basic_environments_readme.md) - - [Virtual Machines](./vm_intro.md) - - [Micro and Full VM Differences](./vm_differences.md) - - [Full Virtual Machine](./fullVm.md) - - [Micro Virtual Machine](./vm.md) - - [Kubernetes](./k8s.md) - - [NixOS MicroVM](./nixos_micro.md) -- [Ready Community Solutions](./ready_community_readme.md) - - [Caprover](./caprover.md) - - [Funkwhale](./funkwhale.md) - - [Peertube](./peertube.md) - - [Taiga](./taiga.md) - - [Owncloud](./owncloud.md) - - [Nextcloud](./nextcloud.md) - - [Discourse](./discourse.md) - - [Mattermost](./mattermost.md) - - [Presearch](./presearch.md) - - [CasperLabs](./casper.md) - - [Node Pilot](./nodepilot.md) - - [Subsquid](./subsquid.md) - - [Algorand](./algorand.md) - - [Wordpress](./wordpress.md) - - [Umbrel](./umbrel.md) +- [Basic Environments](basic_environments_readme.md) + - [Virtual Machines](vm_intro.md) + - [Micro and Full VM Differences](vm_differences.md) + - [Full Virtual Machine](fullVm.md) + - [Micro Virtual Machine](vm.md) + - [Kubernetes](k8s.md) + - [NixOS MicroVM](nixos_micro.md) +- [Ready Community Solutions](ready_community_readme.md) + - [Caprover](caprover.md) + - [Funkwhale](funkwhale.md) + - [Peertube](peertube.md) + - [Taiga](taiga.md) + - [Owncloud](owncloud.md) + - [Nextcloud](nextcloud.md) + - [Discourse](discourse.md) + - [Mattermost](mattermost.md) + - [Presearch](presearch.md) + - [CasperLabs](casper.md) + - [Node Pilot](nodepilot.md) + - [Subsquid](subsquid.md) + - [Algorand](algorand.md) + - [Wordpress](wordpress.md) + - [Umbrel](umbrel.md) diff --git a/collections/dashboard/solutions/subsquid.md b/collections/dashboard/solutions/subsquid.md index 063ff35..5a59b44 100644 --- a/collections/dashboard/solutions/subsquid.md +++ b/collections/dashboard/solutions/subsquid.md @@ -14,7 +14,7 @@ ## 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** - Click on **Subsquid** diff --git a/collections/dashboard/solutions/taiga.md b/collections/dashboard/solutions/taiga.md index 4291e12..17d7e3c 100644 --- a/collections/dashboard/solutions/taiga.md +++ b/collections/dashboard/solutions/taiga.md @@ -14,7 +14,7 @@ ## 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** - Click on **Taiga** diff --git a/collections/dashboard/solutions/umbrel.md b/collections/dashboard/solutions/umbrel.md index 21075ca..dd9bd5d 100644 --- a/collections/dashboard/solutions/umbrel.md +++ b/collections/dashboard/solutions/umbrel.md @@ -13,7 +13,7 @@ ## 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** - Click on **Umbrel** diff --git a/collections/dashboard/solutions/vm.md b/collections/dashboard/solutions/vm.md index 5e8db2f..0eec151 100644 --- a/collections/dashboard/solutions/vm.md +++ b/collections/dashboard/solutions/vm.md @@ -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 -- Make sure you have a [wallet](../wallet_connector.md) +- Make sure you have a [wallet](wallet_connector.md) - From the sidebar click on **Solutions** - Click on **Micro Virtual Machine** diff --git a/collections/dashboard/solutions/vm_intro.md b/collections/dashboard/solutions/vm_intro.md index d9cc0a7..be0bf5f 100644 --- a/collections/dashboard/solutions/vm_intro.md +++ b/collections/dashboard/solutions/vm_intro.md @@ -4,8 +4,8 @@ On the TFGrid, you can deploy both micro and full virtual machines.

Table of Contents

-- [Micro and Full VM Differences ](./vm_differences.md) -- [Full Virtual Machine](./fullVm.md) -- [Micro Virtual Machine](./vm.md) -- [Nixos MicroVM](./nixos_micro.md) -- [Add a Domain](./add_domain.md) \ No newline at end of file +- [Micro and Full VM Differences ](vm_differences.md) +- [Full Virtual Machine](fullVm.md) +- [Micro Virtual Machine](vm.md) +- [Nixos MicroVM](nixos_micro.md) +- [Add a Domain](add_domain.md) \ No newline at end of file diff --git a/collections/dashboard/solutions/wordpress.md b/collections/dashboard/solutions/wordpress.md index 57f2938..c8c72d4 100644 --- a/collections/dashboard/solutions/wordpress.md +++ b/collections/dashboard/solutions/wordpress.md @@ -24,7 +24,7 @@ # 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** - Click on **Wordpress** diff --git a/collections/dashboard/tfchain/tf_dao.md b/collections/dashboard/tfchain/tf_dao.md index be2cf0e..4803f4c 100644 --- a/collections/dashboard/tfchain/tf_dao.md +++ b/collections/dashboard/tfchain/tf_dao.md @@ -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. -- 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 - 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) diff --git a/collections/dashboard/tfchain/tfchain.md b/collections/dashboard/tfchain/tfchain.md index bda6640..d94c90f 100644 --- a/collections/dashboard/tfchain/tfchain.md +++ b/collections/dashboard/tfchain/tfchain.md @@ -2,19 +2,19 @@ Here you will find everything related to the ThreeFold chain. this includes: -- 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. -- 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. -- getting miniting reports from the [TF Minting Reports](./tf_minting_reports.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. +- 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. +- getting miniting reports from the [TF Minting Reports](tf_minting_reports.md) section. ![](../img/sidebar_4.png) *** ## Table of Content -- [Your Profile](./your_profile.md) -- [TF DAO](./tf_dao.md) -- [TF Token Bridge](./tf_token_bridge.md) -- [TF Token Transfer](./tf_token_transfer.md) -- [TF Minting Reports](./tf_minting_reports.md) \ No newline at end of file +- [Your Profile](your_profile.md) +- [TF DAO](tf_dao.md) +- [TF Token Bridge](tf_token_bridge.md) +- [TF Token Transfer](tf_token_transfer.md) +- [TF Minting Reports](tf_minting_reports.md) \ No newline at end of file diff --git a/collections/dashboard/tfchain/your_profile.md b/collections/dashboard/tfchain/your_profile.md index 091cffe..4299c03 100644 --- a/collections/dashboard/tfchain/your_profile.md +++ b/collections/dashboard/tfchain/your_profile.md @@ -10,4 +10,4 @@ The twin details consists of three main items. - `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. -To create a twin check the [Wallet Connector](../wallet_connector.md) Section. \ No newline at end of file +To create a twin check the [Wallet Connector](wallet_connector.md) Section. \ No newline at end of file diff --git a/collections/dashboard/tfgrid/tfgrid.md b/collections/dashboard/tfgrid/tfgrid.md index 2b06d9b..f9f2dde 100644 --- a/collections/dashboard/tfgrid/tfgrid.md +++ b/collections/dashboard/tfgrid/tfgrid.md @@ -2,9 +2,9 @@ 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 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 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 health and status of Zero-OS nodes that are available on the ThreeFold grid from [Node Monitoring](node_monitoring.md). ![](../img/sidebar_1.png) @@ -12,6 +12,6 @@ Check and use all things related to the threefold grid. Including: ## Table of Content -- [Grid Status](./grid_status.md) -- [Node Statistics](./node_statistics.md) -- [Node Monitoring](./node_monitoring.md) \ No newline at end of file +- [Grid Status](grid_status.md) +- [Node Statistics](node_statistics.md) +- [Node Monitoring](node_monitoring.md) \ No newline at end of file diff --git a/collections/dashboard/toc.md b/collections/dashboard/toc.md index 5507842..f71eac7 100644 --- a/collections/dashboard/toc.md +++ b/collections/dashboard/toc.md @@ -1,8 +1,8 @@ ## Dashboard TOC -- [Home](./home.md) -- [Wallet Connector](./wallet_connector.md) -- [CapRover](./caprover.md) -- [Virtual Machine](./vm.md) -- [Funkwhale](./funkwhale.md) -- [Peertube](./peertube.md) +- [Home](home.md) +- [Wallet Connector](wallet_connector.md) +- [CapRover](caprover.md) +- [Virtual Machine](vm.md) +- [Funkwhale](funkwhale.md) +- [Peertube](peertube.md) diff --git a/collections/dashboard/vm_presearch.md b/collections/dashboard/vm_presearch.md index f438507..e04ea53 100644 --- a/collections/dashboard/vm_presearch.md +++ b/collections/dashboard/vm_presearch.md @@ -3,7 +3,7 @@ The fastest way to mount a Presearch node on TFGrid3 is inside a VM. 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. - Once your VM is set up, SSH into our machine. diff --git a/collections/developers/flist/flist.md b/collections/developers/flist/flist.md index 7a59391..7845bd5 100644 --- a/collections/developers/flist/flist.md +++ b/collections/developers/flist/flist.md @@ -5,7 +5,7 @@ - [Zero-OS Hub](zos_hub.md) - [Generate an API Token](api_token.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) - [Case Study: Debian 12](flist_debian_case_study.md) - [Case Study: Nextcloud AIO](flist_nextcloud_case_study.md) \ No newline at end of file diff --git a/collections/developers/flist/flist_case_studies/flist_case_studies.md b/collections/developers/flist/flist_case_studies/flist_case_studies.md index b258836..db29990 100644 --- a/collections/developers/flist/flist_case_studies/flist_case_studies.md +++ b/collections/developers/flist/flist_case_studies/flist_case_studies.md @@ -2,5 +2,5 @@

Table of Contents

-- [Case Study: Debian 12](./flist_debian_case_study.md) -- [Case Study: Nextcloud AIO](./flist_nextcloud_case_study.md) \ No newline at end of file +- [Case Study: Debian 12](flist_debian_case_study.md) +- [Case Study: Nextcloud AIO](flist_nextcloud_case_study.md) \ No newline at end of file diff --git a/collections/developers/flist/flist_case_studies/flist_nextcloud_case_study.md b/collections/developers/flist/flist_case_studies/flist_nextcloud_case_study.md index 86964bf..fce105f 100644 --- a/collections/developers/flist/flist_case_studies/flist_nextcloud_case_study.md +++ b/collections/developers/flist/flist_case_studies/flist_nextcloud_case_study.md @@ -39,7 +39,7 @@ # 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. @@ -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. -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 @@ -661,7 +661,7 @@ We will now convert the Docker image into a Zero-OS flist. ``` * Example: * ``` - https://hub.grid.tf/tf-official-apps/threefoldtech-nextcloudaio-latest.flist + threefoldtech-nextcloudaio-latest.flist ``` # Deploy Nextcloud AIO on the TFGrid with Terraform @@ -693,7 +693,7 @@ gateway_id = "50" vm1_id = "5453" 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)**. diff --git a/collections/developers/flist/flist_hub/zos_hub.md b/collections/developers/flist/flist_hub/zos_hub.md index 98d398c..8f79973 100644 --- a/collections/developers/flist/flist_hub/zos_hub.md +++ b/collections/developers/flist/flist_hub/zos_hub.md @@ -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. -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. @@ -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. ## 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 The hub host a basic REST API which can gives you some informations about flists, renaming them, remove them, etc. diff --git a/collections/developers/flist/grid3_supported_flists.md b/collections/developers/flist/grid3_supported_flists.md index 537d0b3..d41403c 100644 --- a/collections/developers/flist/grid3_supported_flists.md +++ b/collections/developers/flist/grid3_supported_flists.md @@ -16,10 +16,10 @@ We provide basic information on the currently supported Flists. |flist|entrypoint|env vars| |:--:|:--:|--| -|[Alpine](https://hub.grid.tf/tf-official-apps/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`| -|[CentOS](https://hub.grid.tf/tf-official-apps/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`
- `K3S_TOKEN`
- `K3S_DATA_DIR`
- `K3S_FLANNEL_IFACE`
- `K3S_NODE_NAME`
- `K3S_URL` `https://${masterIp}:6443`| +|[Alpine](threefoldtech-alpine-3.flist.md)|`/entrypoint.sh`|`SSH_KEY`| +|[Ubuntu](threefoldtech-ubuntu-22.04.flist.md)|`/init.sh`|`SSH_KEY`| +|[CentOS](threefoldtech-centos-8.flist.md)|`/entrypoint.sh`|`SSH_KEY`| +|[K3s](threefoldtech-k3s-latest.flist.md)|`/sbin/zinit init`|- `SSH_KEY`
- `K3S_TOKEN`
- `K3S_DATA_DIR`
- `K3S_FLANNEL_IFACE`
- `K3S_NODE_NAME`
- `K3S_URL` `https://${masterIp}:6443`| ## More Flists diff --git a/collections/developers/go/grid3_go_gateways.md b/collections/developers/go/grid3_go_gateways.md index 66f5f68..23ecf77 100644 --- a/collections/developers/go/grid3_go_gateways.md +++ b/collections/developers/go/grid3_go_gateways.md @@ -12,7 +12,7 @@ ## 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 diff --git a/collections/developers/grid_deployment/grid_deployment.md b/collections/developers/grid_deployment/grid_deployment.md index 14fa506..2680eb5 100644 --- a/collections/developers/grid_deployment/grid_deployment.md +++ b/collections/developers/grid_deployment/grid_deployment.md @@ -4,6 +4,6 @@ The TFGrid whole source code is open-source and instances of the grid can be dep ## Table of Contents -- [TFGrid Stacks](./tfgrid_stacks.md) -- [Full VM Grid Deployment](./grid_deployment_full_vm.md) -- [Grid Snapshots](./snapshots.md) \ No newline at end of file +- [TFGrid Stacks](tfgrid_stacks.md) +- [Full VM Grid Deployment](grid_deployment_full_vm.md) +- [Grid Snapshots](snapshots.md) \ No newline at end of file diff --git a/collections/developers/grid_deployment/snapshots.md b/collections/developers/grid_deployment/snapshots.md index 1e8f0ff..f88da46 100644 --- a/collections/developers/grid_deployment/snapshots.md +++ b/collections/developers/grid_deployment/snapshots.md @@ -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 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 diff --git a/collections/developers/grid_deployment/tfgrid_stacks.md b/collections/developers/grid_deployment/tfgrid_stacks.md index 7845722..6f3b6e8 100644 --- a/collections/developers/grid_deployment/tfgrid_stacks.md +++ b/collections/developers/grid_deployment/tfgrid_stacks.md @@ -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! -Read more about snapshots in the [next section](./grid_deployment_full_vm.md). \ No newline at end of file +Read more about snapshots in the [next section](grid_deployment_full_vm.md). \ No newline at end of file diff --git a/collections/developers/internals/rmb/rmb_intro.md b/collections/developers/internals/rmb/rmb_intro.md index bb08f99..23ec314 100644 --- a/collections/developers/internals/rmb/rmb_intro.md +++ b/collections/developers/internals/rmb/rmb_intro.md @@ -48,7 +48,7 @@ Starting from this we came up with a more detailed requirements: *** ## 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 @@ -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. -> More details can be found [here](./rmb_specs.md) +> More details can be found [here](rmb_specs.md) *** ## Download diff --git a/collections/developers/internals/zos/development/readme.md b/collections/developers/internals/zos/development/readme.md index 63b7034..c12493d 100644 --- a/collections/developers/internals/zos/development/readme.md +++ b/collections/developers/internals/zos/development/readme.md @@ -1,6 +1,6 @@ Development =========== -* [Quick start](./quickstart.md) -* [Testing](./testing.md) -* [Binary packages](./packages.md) \ No newline at end of file +* [Quick start](quickstart.md) +* [Testing](testing.md) +* [Binary packages](packages.md) \ No newline at end of file diff --git a/collections/developers/internals/zos/internals/internals.md b/collections/developers/internals/zos/internals/internals.md index 21ec057..25c5fca 100644 --- a/collections/developers/internals/zos/internals/internals.md +++ b/collections/developers/internals/zos/internals/internals.md @@ -85,4 +85,4 @@ Here is a list of the major ZOS modules. ## 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. diff --git a/collections/developers/internals/zos/internals/network/network_readme.md b/collections/developers/internals/zos/internals/network/network_readme.md index 3958cf6..bab6c1e 100644 --- a/collections/developers/internals/zos/internals/network/network_readme.md +++ b/collections/developers/internals/zos/internals/network/network_readme.md @@ -2,7 +2,7 @@

Table of Contents

-- [Introduction to networkd](./introduction.md) -- [Vocabulary Definitions](./definitions.md) -- [Wireguard Mesh Details](./mesh.md) -- [Farm Network Setup](./setup_farm_network.md) \ No newline at end of file +- [Introduction to networkd](introduction.md) +- [Vocabulary Definitions](definitions.md) +- [Wireguard Mesh Details](mesh.md) +- [Farm Network Setup](setup_farm_network.md) \ No newline at end of file diff --git a/collections/developers/internals/zos/manual/manual.md b/collections/developers/internals/zos/manual/manual.md index f2f39c2..89058d3 100644 --- a/collections/developers/internals/zos/manual/manual.md +++ b/collections/developers/internals/zos/manual/manual.md @@ -180,7 +180,7 @@ type Workload struct { ### 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. -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 diff --git a/collections/developers/internals/zos/manual/workload_types.md b/collections/developers/internals/zos/manual/workload_types.md index a9e2d85..9d1f540 100644 --- a/collections/developers/internals/zos/manual/workload_types.md +++ b/collections/developers/internals/zos/manual/workload_types.md @@ -66,7 +66,7 @@ For more details on all parameters needed to run a `zmachine` please refer to [` #### 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 diff --git a/collections/developers/internals/zos/manual/zmachine/readme.md b/collections/developers/internals/zos/manual/zmachine/readme.md index e94a0e7..99e01e3 100644 --- a/collections/developers/internals/zos/manual/zmachine/readme.md +++ b/collections/developers/internals/zos/manual/zmachine/readme.md @@ -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) # 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` diff --git a/collections/developers/internals/zos/performance/performance.md b/collections/developers/internals/zos/performance/performance.md index 7f3ea76..f9585f6 100644 --- a/collections/developers/internals/zos/performance/performance.md +++ b/collections/developers/internals/zos/performance/performance.md @@ -80,10 +80,10 @@ Notes: ## Registered Tests -- [Public IP Validation](./publicips.md) -- [CPUBenchmark](./cpubench.md) -- [IPerf](./iperf.md) -- [Health Check](./healthcheck.md) +- [Public IP Validation](publicips.md) +- [CPUBenchmark](cpubench.md) +- [IPerf](iperf.md) +- [Health Check](healthcheck.md) ## Test Suite diff --git a/collections/developers/internals/zos/release/readme.md b/collections/developers/internals/zos/release/readme.md index 6af1a51..09ddc7b 100644 --- a/collections/developers/internals/zos/release/readme.md +++ b/collections/developers/internals/zos/release/readme.md @@ -3,7 +3,7 @@ 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). -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 diff --git a/collections/developers/javascript/grid3_javascript_caprover.md b/collections/developers/javascript/grid3_javascript_caprover.md index 1b1e1e3..ccdaacb 100644 --- a/collections/developers/javascript/grid3_javascript_caprover.md +++ b/collections/developers/javascript/grid3_javascript_caprover.md @@ -17,7 +17,7 @@ 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 diff --git a/collections/developers/javascript/grid3_javascript_kubernetes.md b/collections/developers/javascript/grid3_javascript_kubernetes.md index 645f3e2..e9eeab7 100644 --- a/collections/developers/javascript/grid3_javascript_kubernetes.md +++ b/collections/developers/javascript/grid3_javascript_kubernetes.md @@ -21,7 +21,7 @@ We show how to deploy a Kubernetes cluster on the TFGrid with the Javascript cli ## 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 diff --git a/collections/developers/javascript/grid3_javascript_kvstore.md b/collections/developers/javascript/grid3_javascript_kvstore.md index 5075086..25b6208 100644 --- a/collections/developers/javascript/grid3_javascript_kvstore.md +++ b/collections/developers/javascript/grid3_javascript_kvstore.md @@ -18,7 +18,7 @@ As part of the tfchain, we support a keyvalue store module that can be used for ## 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 diff --git a/collections/developers/javascript/grid3_javascript_loadclient.md b/collections/developers/javascript/grid3_javascript_loadclient.md index 6376d67..11956c3 100644 --- a/collections/developers/javascript/grid3_javascript_loadclient.md +++ b/collections/developers/javascript/grid3_javascript_loadclient.md @@ -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. - 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. diff --git a/collections/developers/javascript/grid3_javascript_qsfs.md b/collections/developers/javascript/grid3_javascript_qsfs.md index df6b02a..1ef0d68 100644 --- a/collections/developers/javascript/grid3_javascript_qsfs.md +++ b/collections/developers/javascript/grid3_javascript_qsfs.md @@ -15,7 +15,7 @@ ## 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 @@ -257,7 +257,7 @@ log(">>>>>>>>>>>>>>>vm has been created<<<<<<<<<<<<<<<"); 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 qsfs_disks: [{ diff --git a/collections/developers/javascript/grid3_javascript_qsfs_zdbs.md b/collections/developers/javascript/grid3_javascript_qsfs_zdbs.md index 9c3a3f2..e7a02a6 100644 --- a/collections/developers/javascript/grid3_javascript_qsfs_zdbs.md +++ b/collections/developers/javascript/grid3_javascript_qsfs_zdbs.md @@ -21,7 +21,7 @@ We show how to deploy ZDBs for QSFS on the TFGrid with the Javascript client. ## 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 diff --git a/collections/developers/javascript/grid3_javascript_readme.md b/collections/developers/javascript/grid3_javascript_readme.md index 62dc875..dc98621 100644 --- a/collections/developers/javascript/grid3_javascript_readme.md +++ b/collections/developers/javascript/grid3_javascript_readme.md @@ -8,17 +8,17 @@ Please make sure to check the [basics](system_administrators@@tfgrid3_getstarted

Table of Contents

-- [Installation](./grid3_javascript_installation.md) -- [Loading Client](./grid3_javascript_loadclient.md) -- [Deploy a VM](./grid3_javascript_vm.md) -- [Capacity Planning](./grid3_javascript_capacity_planning.md) -- [Deploy Multiple VMs](./grid3_javascript_vms.md) -- [Deploy CapRover](./grid3_javascript_caprover.md) -- [Gateways](./grid3_javascript_vm_gateways.md) -- [Deploy a Kubernetes Cluster](./grid3_javascript_kubernetes.md) -- [Deploy a ZDB](./grid3_javascript_zdb.md) -- [Deploy ZDBs for QSFS](./grid3_javascript_qsfs_zdbs.md) -- [QSFS](./grid3_javascript_qsfs.md) -- [Key Value Store](./grid3_javascript_kvstore.md) -- [VM with Wireguard and Gateway](./grid3_wireguard_gateway.md) -- [GPU Support](./grid3_javascript_gpu_support.md) \ No newline at end of file +- [Installation](grid3_javascript_installation.md) +- [Loading Client](grid3_javascript_loadclient.md) +- [Deploy a VM](grid3_javascript_vm.md) +- [Capacity Planning](grid3_javascript_capacity_planning.md) +- [Deploy Multiple VMs](grid3_javascript_vms.md) +- [Deploy CapRover](grid3_javascript_caprover.md) +- [Gateways](grid3_javascript_vm_gateways.md) +- [Deploy a Kubernetes Cluster](grid3_javascript_kubernetes.md) +- [Deploy a ZDB](grid3_javascript_zdb.md) +- [Deploy ZDBs for QSFS](grid3_javascript_qsfs_zdbs.md) +- [QSFS](grid3_javascript_qsfs.md) +- [Key Value Store](grid3_javascript_kvstore.md) +- [VM with Wireguard and Gateway](grid3_wireguard_gateway.md) +- [GPU Support](grid3_javascript_gpu_support.md) \ No newline at end of file diff --git a/collections/developers/javascript/grid3_javascript_vm_gateways.md b/collections/developers/javascript/grid3_javascript_vm_gateways.md index 052d9f3..ef02a78 100644 --- a/collections/developers/javascript/grid3_javascript_vm_gateways.md +++ b/collections/developers/javascript/grid3_javascript_vm_gateways.md @@ -19,7 +19,7 @@ ## 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 @@ -104,7 +104,7 @@ log(d); ## 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 diff --git a/collections/developers/javascript/grid3_javascript_zdb.md b/collections/developers/javascript/grid3_javascript_zdb.md index d773269..12466ef 100644 --- a/collections/developers/javascript/grid3_javascript_zdb.md +++ b/collections/developers/javascript/grid3_javascript_zdb.md @@ -21,7 +21,7 @@ We show how to deploy ZDB on the TFGrid with the Javascript client. ## 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 diff --git a/collections/developers/javascript/grid3_wireguard_gateway.md b/collections/developers/javascript/grid3_wireguard_gateway.md index 7677789..449b08d 100644 --- a/collections/developers/javascript/grid3_wireguard_gateway.md +++ b/collections/developers/javascript/grid3_wireguard_gateway.md @@ -26,7 +26,7 @@ We present here the relevant information when it comes to deploying a virtual ma ## 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). diff --git a/collections/developers/proxy/contributions.md b/collections/developers/proxy/contributions.md index 3960676..1b4a132 100644 --- a/collections/developers/proxy/contributions.md +++ b/collections/developers/proxy/contributions.md @@ -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. -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: - `local`: this client connects to the local db - `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. diff --git a/collections/developers/proxy/proxy.md b/collections/developers/proxy/proxy.md index ac87fbc..8962912 100644 --- a/collections/developers/proxy/proxy.md +++ b/collections/developers/proxy/proxy.md @@ -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. 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) @@ -90,7 +90,7 @@ To start the services for development or testing make sure first you have all th 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 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 @@ -98,7 +98,7 @@ go run cmds/proxy_server/main.go --address :8080 --log-level debug -no-cert --po Then visit `http://localhost:8080/` -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). diff --git a/collections/developers/proxy/proxy_readme.md b/collections/developers/proxy/proxy_readme.md index aaf4266..3e74412 100644 --- a/collections/developers/proxy/proxy_readme.md +++ b/collections/developers/proxy/proxy_readme.md @@ -14,12 +14,12 @@ To assist you on your journey, we have organized the content into distinct chapt

Table of Contents

-- [Introducing Grid Proxy](./proxy.md) -- [Setup](./setup.md) -- [DB Testing](./db_testing.md) -- [Commands](./commands.md) -- [Contributions](./contributions.md) -- [Explorer](./explorer.md) -- [Database](./database.md) -- [Production](./production.md) -- [Release](./release.md) \ No newline at end of file +- [Introducing Grid Proxy](proxy.md) +- [Setup](setup.md) +- [DB Testing](db_testing.md) +- [Commands](commands.md) +- [Contributions](contributions.md) +- [Explorer](explorer.md) +- [Database](database.md) +- [Production](production.md) +- [Release](release.md) \ No newline at end of file diff --git a/collections/developers/tfcmd/tfcmd.md b/collections/developers/tfcmd/tfcmd.md index b0653ae..5389038 100644 --- a/collections/developers/tfcmd/tfcmd.md +++ b/collections/developers/tfcmd/tfcmd.md @@ -6,10 +6,10 @@ Consult the [ThreeFoldTech TFCMD repository](https://github.com/threefoldtech/tf

Table of Contents

-- [Getting Started](./tfcmd_basics.md) -- [Deploy a VM](./tfcmd_vm.md) -- [Deploy Kubernetes](./tfcmd_kubernetes.md) -- [Deploy ZDB](./tfcmd_zdbs.md) -- [Gateway FQDN](./tfcmd_gateway_fqdn.md) -- [Gateway Name](./tfcmd_gateway_name.md) -- [Contracts](./tfcmd_contracts.md) \ No newline at end of file +- [Getting Started](tfcmd_basics.md) +- [Deploy a VM](tfcmd_vm.md) +- [Deploy Kubernetes](tfcmd_kubernetes.md) +- [Deploy ZDB](tfcmd_zdbs.md) +- [Gateway FQDN](tfcmd_gateway_fqdn.md) +- [Gateway Name](tfcmd_gateway_name.md) +- [Contracts](tfcmd_contracts.md) \ No newline at end of file diff --git a/collections/developers/tfrobot/tfrobot.md b/collections/developers/tfrobot/tfrobot.md index 40ba063..0f7aa92 100644 --- a/collections/developers/tfrobot/tfrobot.md +++ b/collections/developers/tfrobot/tfrobot.md @@ -6,8 +6,8 @@ Consult the [ThreeFoldTech TFROBOT repository](https://github.com/threefoldtech/

Table of Contents

-- [Installation](./tfrobot_installation.md) -- [Configuration File](./tfrobot_config.md) -- [Deployment](./tfrobot_deploy.md) -- [Commands and Flags](./tfrobot_commands_flags.md) -- [Supported Configurations](./tfrobot_configurations.md) \ No newline at end of file +- [Installation](tfrobot_installation.md) +- [Configuration File](tfrobot_config.md) +- [Deployment](tfrobot_deploy.md) +- [Commands and Flags](tfrobot_commands_flags.md) +- [Supported Configurations](tfrobot_configurations.md) \ No newline at end of file diff --git a/collections/developers/tfrobot/tfrobot_deploy.md b/collections/developers/tfrobot/tfrobot_deploy.md index 2c7d62a..eb7a19f 100644 --- a/collections/developers/tfrobot/tfrobot_deploy.md +++ b/collections/developers/tfrobot/tfrobot_deploy.md @@ -20,7 +20,7 @@ We present how to deploy workloads on the ThreeFold Grid using TFROBOT. ## 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 diff --git a/collections/farmers/3node_building/3_set_hardware.md b/collections/farmers/3node_building/3_set_hardware.md index 1dfd77d..7e19e5a 100644 --- a/collections/farmers/3node_building/3_set_hardware.md +++ b/collections/farmers/3node_building/3_set_hardware.md @@ -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). -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). diff --git a/collections/farmers/3node_building/3node_building.md b/collections/farmers/3node_building/3node_building.md index c7fe3f9..bf94262 100644 --- a/collections/farmers/3node_building/3node_building.md +++ b/collections/farmers/3node_building/3node_building.md @@ -6,9 +6,9 @@ For advanced farming information, such as GPU farming and room parameters, refer

Table of Contents

-- [1. Create a Farm](./1_create_farm.md) -- [2. Create a Zero-OS Bootstrap Image](./2_bootstrap_image.md) -- [3. Set the Hardware](./3_set_hardware.md) -- [4. Wipe All the Disks](./4_wipe_all_disks.md) -- [5. Set the BIOS/UEFI](./5_set_bios_uefi.md) -- [6. Boot the 3Node](./6_boot_3node.md) \ No newline at end of file +- [1. Create a Farm](1_create_farm.md) +- [2. Create a Zero-OS Bootstrap Image](2_bootstrap_image.md) +- [3. Set the Hardware](3_set_hardware.md) +- [4. Wipe All the Disks](4_wipe_all_disks.md) +- [5. Set the BIOS/UEFI](5_set_bios_uefi.md) +- [6. Boot the 3Node](6_boot_3node.md) \ No newline at end of file diff --git a/collections/farmers/3node_building/5_set_bios_uefi.md b/collections/farmers/3node_building/5_set_bios_uefi.md index 4c6c3e9..fa45624 100644 --- a/collections/farmers/3node_building/5_set_bios_uefi.md +++ b/collections/farmers/3node_building/5_set_bios_uefi.md @@ -159,7 +159,7 @@ Choices 1 and 2 are for UEFI (newer models). Choices 4 and 5 are for BIOS (newer models). 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). diff --git a/collections/farmers/3node_building/6_boot_3node.md b/collections/farmers/3node_building/6_boot_3node.md index 404e2e9..0b5a6be 100644 --- a/collections/farmers/3node_building/6_boot_3node.md +++ b/collections/farmers/3node_building/6_boot_3node.md @@ -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 -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. 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. ## 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 Test Net Dashboard](https://dashboard.test.grid.tf/) diff --git a/collections/farmers/3node_building/gpu_farming.md b/collections/farmers/3node_building/gpu_farming.md index f355525..f0096d8 100644 --- a/collections/farmers/3node_building/gpu_farming.md +++ b/collections/farmers/3node_building/gpu_farming.md @@ -48,7 +48,7 @@ If you are using the Farmerbot, it might be a good idea to first boot the GPU no ## Set a Price for the GPU Node -You can [set additional fees](../farming_optimization/set_additional_fees.md) for your GPU dedicated node on the [TF Dashboard](https://dashboard.grid.tf/). +You can [set additional fees](set_additional_fees.md) for your GPU dedicated node on the [TF Dashboard](https://dashboard.grid.tf/). When a user reserves your 3Node as a dedicated node, you will receive TFT payments once every 24 hours. These TFT payments will be sent to the TFChain account of your farm's twin. @@ -65,7 +65,7 @@ You can use the [Node Finder](dashboard@@node_finder) on the [TF Dashboard](http ## Reserving the GPU Node -Now, users can reserve the node in the **Dedicated Nodes** section of the Dashboard and then deploy workloads using the GPU. For more information, read [this documentation](../../dashboard/deploy/dedicated_machines.md). +Now, users can reserve the node in the **Dedicated Nodes** section of the Dashboard and then deploy workloads using the GPU. For more information, read [this documentation](dedicated_machines.md). ## Questions and Feedback diff --git a/collections/farmers/advanced_networking/advanced_networking_toc.md b/collections/farmers/advanced_networking/advanced_networking_toc.md index f30a86f..4aecc82 100644 --- a/collections/farmers/advanced_networking/advanced_networking_toc.md +++ b/collections/farmers/advanced_networking/advanced_networking_toc.md @@ -6,8 +6,8 @@ In this section, we provide advanced networking tips for farms with public IPs a

Table of Contents

-- [Networking Overview](./networking_overview.md) -- [Network Considerations](./network_considerations.md) -- [Network Setup](./network_setup.md) +- [Networking Overview](networking_overview.md) +- [Network Considerations](network_considerations.md) +- [Network Setup](network_setup.md) > Note: This documentation does not constitute a complete set of knowledge on setting farms with public IP addresses in a data center. Please make sure to do your own research and communicate with your data center and your Internet service provider for any additional information. \ No newline at end of file diff --git a/collections/farmers/advanced_networking/networking_overview.md b/collections/farmers/advanced_networking/networking_overview.md index c4bc322..8a9f68f 100644 --- a/collections/farmers/advanced_networking/networking_overview.md +++ b/collections/farmers/advanced_networking/networking_overview.md @@ -22,7 +22,7 @@ In this section, we provide advanced networking tips for farms with public IPs a For farmers who have public IPs, extra considerations are needed in setting up the network of the farm. We will go through the main considerations in this section. -First, we must acknowledge that by the open-source and design of ThreeFold farming, a farm can range from a simple [single 3Node](../3node_building/3node_building.md) setup, to a multi-rack farm hosted in a typical data center, and everything in-between, from the farmer experiencing with public IP blocks, to the entrepreneur who builds their own data center at home. +First, we must acknowledge that by the open-source and design of ThreeFold farming, a farm can range from a simple [single 3Node](3node_building.md) setup, to a multi-rack farm hosted in a typical data center, and everything in-between, from the farmer experiencing with public IP blocks, to the entrepreneur who builds their own data center at home. There are thus many types of farms and each will have varying configurations. The simplest way to set up a farm has been extensively discussed in the first steps of creating a farm. But what are the other more complex configurations possible? Let's go through some of those: diff --git a/collections/farmers/complete_diy_guides/3node_diy_rack_server/3node_diy_rack_server.md b/collections/farmers/complete_diy_guides/3node_diy_rack_server/3node_diy_rack_server.md index e7e1c5e..27cd910 100644 --- a/collections/farmers/complete_diy_guides/3node_diy_rack_server/3node_diy_rack_server.md +++ b/collections/farmers/complete_diy_guides/3node_diy_rack_server/3node_diy_rack_server.md @@ -280,7 +280,7 @@ You can [create a ThreeFold farm](threefold_token@@tf_connect_app) with the Thre ## Wiping All the Disks -You might need to wipe your disks if they are not brand new. To wipe your disks, read the section [Wipe All the Disks](../../3node_building/4_wipe_all_disks.md) of the ThreeFold Farming Documentation. +You might need to wipe your disks if they are not brand new. To wipe your disks, read the section [Wipe All the Disks](4_wipe_all_disks.md) of the ThreeFold Farming Documentation. ## Downloading the Zero-OS Bootstrap Image @@ -319,7 +319,7 @@ When you start the server, press F2 to get into System Setup. Then, select System BIOS. In System BIOS settings, select Processor Settings. -Note: More details are available for BIOS Settings in this [documentation](../../3node_building/5_set_bios_uefi.md). +Note: More details are available for BIOS Settings in this [documentation](5_set_bios_uefi.md). ## Processor Settings diff --git a/collections/farmers/farmerbot/farmerbot_information.md b/collections/farmers/farmerbot/farmerbot_information.md index ef86e19..ced9b35 100644 --- a/collections/farmers/farmerbot/farmerbot_information.md +++ b/collections/farmers/farmerbot/farmerbot_information.md @@ -191,7 +191,7 @@ To download the Zero-OS bootstrap image, go to the usual bootstrap link [https:/ ![test_net|690x422](img/farmerbot_5.png) -Once you have your new bootstrap image for the new network, [wipe your disks](../3node_building/4_wipe_all_disks.md), insert the new bootstrap image and reboot the 3Node. +Once you have your new bootstrap image for the new network, [wipe your disks](4_wipe_all_disks.md), insert the new bootstrap image and reboot the 3Node. ## The differences between power "state" and power "target" @@ -282,7 +282,7 @@ Note that each node managed by the Farmerbot will randomly wakeup on average 10 ## Upgrade to the new Farmerbot -If you are still running the old version of the Farmerbot (written in V), you can easily upgrade to the new Farmerbot (written in Go). You simply need to properly stop the old Farmerbot and then follow the new [Farmerbot guide](./farmerbot_quick.md). +If you are still running the old version of the Farmerbot (written in V), you can easily upgrade to the new Farmerbot (written in Go). You simply need to properly stop the old Farmerbot and then follow the new [Farmerbot guide](farmerbot_quick.md). Here are the steps to properly stop the old Farmerbot. @@ -299,7 +299,7 @@ Here are the steps to properly stop the old Farmerbot. docker container rm -f -v NAME_OF_CONTAINER ``` -Once the old Farmerbot is properly stopped and deleted, follow the new [Farmerbot guide](./farmerbot_quick.md). +Once the old Farmerbot is properly stopped and deleted, follow the new [Farmerbot guide](farmerbot_quick.md). ## Set the Farmerbot without the mnemonics of a ThreeFold Dashboard account diff --git a/collections/farmers/farmerbot/farmerbot_intro.md b/collections/farmers/farmerbot/farmerbot_intro.md index 96d19b3..b398313 100644 --- a/collections/farmers/farmerbot/farmerbot_intro.md +++ b/collections/farmers/farmerbot/farmerbot_intro.md @@ -8,8 +8,8 @@ For more information on the Farmerbot, you can visit the [Farmerbot repository](

Table of Contents

-- [Quick Guide](./farmerbot_quick.md) -- [Additional Information](./farmerbot_information.md) -- [Minting and the Farmerbot](./farmerbot_minting.md) +- [Quick Guide](farmerbot_quick.md) +- [Additional Information](farmerbot_information.md) +- [Minting and the Farmerbot](farmerbot_minting.md) > Note: The Farmerbot is an optional feature developed by ThreeFold. Please use at your own risk. While ThreeFold will do its best to fix any issues with the Farmerbot and minting, if minting is affected by the use of the Farmerbot, ThreeFold cannot be held responsible. \ No newline at end of file diff --git a/collections/farmers/farmerbot/farmerbot_quick.md b/collections/farmers/farmerbot/farmerbot_quick.md index 4177ef8..8094789 100644 --- a/collections/farmers/farmerbot/farmerbot_quick.md +++ b/collections/farmers/farmerbot/farmerbot_quick.md @@ -285,7 +285,7 @@ farmerbot2.service This guide is meant to get you started quickly with the Farmerbot. That being said, there is a lot more that can be done with the Farmerbot. -For more information on the Farmerbot, please refer to the [Additional Information section](./farmerbot_information.md). You can also consult the [official Farmerbot Go repository](https://github.com/threefoldtech/tfgrid-sdk-go/tree/development/farmerbot). +For more information on the Farmerbot, please refer to the [Additional Information section](farmerbot_information.md). You can also consult the [official Farmerbot Go repository](https://github.com/threefoldtech/tfgrid-sdk-go/tree/development/farmerbot). If you have any questions, you can ask the ThreeFold community for help on the [ThreeFold Forum](https://forum.threefold.io/) or on the [ThreeFold Farmers Chat](https://t.me/threefoldfarmers) on Telegram. diff --git a/collections/farmers/farmers.md b/collections/farmers/farmers.md index f9428a7..3571faa 100644 --- a/collections/farmers/farmers.md +++ b/collections/farmers/farmers.md @@ -8,29 +8,29 @@ To buy a certified node from an official ThreeFold vendor, check the [ThreeFold

Table of Contents

-- [Build a 3Node](./3node_building/3node_building.md) - - [1. Create a Farm](./3node_building/1_create_farm.md) - - [2. Create a Zero-OS Bootstrap Image](./3node_building/2_bootstrap_image.md) - - [3. Set the Hardware](./3node_building/3_set_hardware.md) - - [4. Wipe All the Disks](./3node_building/4_wipe_all_disks.md) - - [5. Set the BIOS/UEFI](./3node_building/5_set_bios_uefi.md) - - [6. Boot the 3Node](./3node_building/6_boot_3node.md) -- [Farming Optimization](./farming_optimization/farming_optimization.md) - - [GPU Farming](./3node_building/gpu_farming.md) - - [Set Additional Fees](./farming_optimization/set_additional_fees.md) - - [Minting Receipts](./3node_building/minting_receipts.md) - - [Minting Periods](./farming_optimization/minting_periods.md) - - [Room Parameters](./farming_optimization/farm_room_parameters.md) - - [Farming Costs](./farming_optimization/farming_costs.md) - - [Calculate Your ROI](./farming_optimization/calculate_roi.md) -- [Advanced Networking](./advanced_networking/advanced_networking_toc.md) - - [Networking Overview](./advanced_networking/networking_overview.md) - - [Network Considerations](./advanced_networking/network_considerations.md) - - [Network Setup](./advanced_networking/network_setup.md) -- [Farmerbot](./farmerbot/farmerbot_intro.md) - - [Quick Guide](./farmerbot/farmerbot_quick.md) - - [Additional Information](./farmerbot/farmerbot_information.md) - - [Minting and the Farmerbot](./farmerbot/farmerbot_minting.md) +- [Build a 3Node](3node_building.md) + - [1. Create a Farm](1_create_farm.md) + - [2. Create a Zero-OS Bootstrap Image](2_bootstrap_image.md) + - [3. Set the Hardware](3_set_hardware.md) + - [4. Wipe All the Disks](4_wipe_all_disks.md) + - [5. Set the BIOS/UEFI](5_set_bios_uefi.md) + - [6. Boot the 3Node](6_boot_3node.md) +- [Farming Optimization](farming_optimization.md) + - [GPU Farming](gpu_farming.md) + - [Set Additional Fees](set_additional_fees.md) + - [Minting Receipts](minting_receipts.md) + - [Minting Periods](minting_periods.md) + - [Room Parameters](farm_room_parameters.md) + - [Farming Costs](farming_costs.md) + - [Calculate Your ROI](calculate_roi.md) +- [Advanced Networking](advanced_networking_toc.md) + - [Networking Overview](networking_overview.md) + - [Network Considerations](network_considerations.md) + - [Network Setup](network_setup.md) +- [Farmerbot](farmerbot_intro.md) + - [Quick Guide](farmerbot_quick.md) + - [Additional Information](farmerbot_information.md) + - [Minting and the Farmerbot](farmerbot_minting.md) - [Farmers FAQ](faq@@faq) > Note: Bugs in the code (e.g. ZOS or other components) can happen. If this is the case, there might be a loss of tokens during minting which won't be refunded by ThreeFold. If there are minting code errors, ThreeFold will try its best to fix the minting code and remint nodes that were affected by such errors. diff --git a/collections/farmers/farming_optimization/farming_costs.md b/collections/farmers/farming_optimization/farming_costs.md index f10e6a8..0bef500 100644 --- a/collections/farmers/farming_optimization/farming_costs.md +++ b/collections/farmers/farming_optimization/farming_costs.md @@ -178,7 +178,7 @@ Then within 9 months, this farm would have paid itself and from now on, it would We note that this takes into consideration that we are using the AC system 24/7. This would surely not be the case in real life. This means that the real ROI would be even better. It is a common practice to do estimates with stricter parameters. If you predict being profitable with strict parameters, you will surely be profitable in real life, even when "things" happen and not everything goes as planned. As always, this is not financial advice. -We recall that in the section [Calculate the ROI of a DIY 3Node](./calculate_roi.md), we found a simpler ROI of 6.25 months, say 7 months, that wasn't taking into consideration the additional costs of Internet and electricity. We now have a more realistic ROI of 9 months based on a fixed TFT price of 0.08$ USD. You will need to use to equations and check with your current TF farm and 3Nodes, as well as the current TFT market price. +We recall that in the section [Calculate the ROI of a DIY 3Node](calculate_roi.md), we found a simpler ROI of 6.25 months, say 7 months, that wasn't taking into consideration the additional costs of Internet and electricity. We now have a more realistic ROI of 9 months based on a fixed TFT price of 0.08$ USD. You will need to use to equations and check with your current TF farm and 3Nodes, as well as the current TFT market price. ### Check Revenue with the ThreeFold Simulator diff --git a/collections/farmers/farming_optimization/farming_optimization.md b/collections/farmers/farming_optimization/farming_optimization.md index 10f14b0..1097c24 100644 --- a/collections/farmers/farming_optimization/farming_optimization.md +++ b/collections/farmers/farming_optimization/farming_optimization.md @@ -1,13 +1,13 @@

Farming Optimization

-The section [Build a 3Node](../3node_building/3node_building.md) covered the notions necessary to build a DIY 3Node server. The following section will give you additional information with the goal of optimizing your farm while also being able to plan ahead the costs in terms of energy and capitals. We also cover how to set a GPU node and more. +The section [Build a 3Node](3node_building.md) covered the notions necessary to build a DIY 3Node server. The following section will give you additional information with the goal of optimizing your farm while also being able to plan ahead the costs in terms of energy and capitals. We also cover how to set a GPU node and more.

Table of Contents

-- [GPU Farming](../3node_building/gpu_farming.md) -- [Set Additional Fees](./set_additional_fees.md) -- [Minting Receipts](../3node_building/minting_receipts.md) -- [Minting Periods](./minting_periods.md) -- [Room Parameters](./farm_room_parameters.md) -- [Farming Costs](./farming_costs.md) -- [Calculate Your ROI](./calculate_roi.md) \ No newline at end of file +- [GPU Farming](gpu_farming.md) +- [Set Additional Fees](set_additional_fees.md) +- [Minting Receipts](minting_receipts.md) +- [Minting Periods](minting_periods.md) +- [Room Parameters](farm_room_parameters.md) +- [Farming Costs](farming_costs.md) +- [Calculate Your ROI](calculate_roi.md) \ No newline at end of file diff --git a/collections/farming/farming_reward_disclaimer.md b/collections/farming/farming_reward_disclaimer.md index 5485865..d8ca3ef 100644 --- a/collections/farming/farming_reward_disclaimer.md +++ b/collections/farming/farming_reward_disclaimer.md @@ -2,7 +2,7 @@ > Important note: The ThreeFold Token (TFT) is not an investment instrument. > TFTs are used to buy and sell IT capacity on the ThreeFold Grid. -> More info: see [Proof of Capacity DAO rules](./poc_dao_rules.md) +> More info: see [Proof of Capacity DAO rules](poc_dao_rules.md) diff --git a/collections/farming/farming_toc.md b/collections/farming/farming_toc.md index 166db4f..b53b9cd 100644 --- a/collections/farming/farming_toc.md +++ b/collections/farming/farming_toc.md @@ -6,7 +6,7 @@ To farm on the ThreeFold Grid, refer to the [Farmers](farmers@@farmers) section.

Table of Contents

-- [Farming Rewards](./farming_reward.md) -- [Proof-of-Capacity](./proof_of_capacity.md) -- [Proof-of-Utilization](./proof_of_utilization.md) -- [PoC DAO Rules](./poc_dao_rules.md) \ No newline at end of file +- [Farming Rewards](farming_reward.md) +- [Proof-of-Capacity](proof_of_capacity.md) +- [Proof-of-Utilization](proof_of_utilization.md) +- [PoC DAO Rules](poc_dao_rules.md) \ No newline at end of file diff --git a/collections/farming/proof_of_capacity.md b/collections/farming/proof_of_capacity.md index 01b3824..bceaa3d 100644 --- a/collections/farming/proof_of_capacity.md +++ b/collections/farming/proof_of_capacity.md @@ -50,7 +50,7 @@ The main advantage of PoC to farmers it makes it really easy to run a 3Node. It ## PoC Rewards -100% of specified [farming rewards](./farming_reward.md) goes to the farmer. +100% of specified [farming rewards](farming_reward.md) goes to the farmer. ## Farming Reward Calculation diff --git a/collections/farming/proof_of_utilization.md b/collections/farming/proof_of_utilization.md index 5b0a25e..abadba4 100644 --- a/collections/farming/proof_of_utilization.md +++ b/collections/farming/proof_of_utilization.md @@ -15,7 +15,7 @@ ## Introduction -ThreeFold Token ("TFT") is an Utility token and gets generated by ThreeFold Farmers, see [proof-of-capacity](./proof_of_capacity.md) for more information. +ThreeFold Token ("TFT") is an Utility token and gets generated by ThreeFold Farmers, see [proof-of-capacity](proof_of_capacity.md) for more information. Each ThreeFold Grid user can now use this capacity. The ThreeFold Chain ("TFChain") - ThreeFold Blockchain will track the utilization of this capacity. This process is called Proof-of-Utilization. Each hour the utilization is being tracked on the blockchain and charged to the capacity's user. diff --git a/collections/legal/terms_conditions_toc.md b/collections/legal/terms_conditions_toc.md index de9638f..2ee43de 100644 --- a/collections/legal/terms_conditions_toc.md +++ b/collections/legal/terms_conditions_toc.md @@ -2,8 +2,8 @@

Table of Contents

-- [Terms & Conditions ThreeFold Related Websites](./terms_conditions_websites.md) -- [Terms & Conditions TFGrid Users TFGrid 3](./terms_conditions_griduser.md) - - [TFTA to TFT](./tfta_to_tft.md) -- [Terms & Conditions TFGrid Farmers TFGrid 3](./terms_conditions_farmer3.md) -- [Terms & Conditions Sales](./terms_conditions_sales.md) \ No newline at end of file +- [Terms & Conditions ThreeFold Related Websites](terms_conditions_websites.md) +- [Terms & Conditions TFGrid Users TFGrid 3](terms_conditions_griduser.md) + - [TFTA to TFT](tfta_to_tft.md) +- [Terms & Conditions TFGrid Farmers TFGrid 3](terms_conditions_farmer3.md) +- [Terms & Conditions Sales](terms_conditions_sales.md) \ No newline at end of file diff --git a/collections/legal/tf_grid_testnet_disclaimer.md b/collections/legal/tf_grid_testnet_disclaimer.md index 6541f1c..4bfd2c1 100644 --- a/collections/legal/tf_grid_testnet_disclaimer.md +++ b/collections/legal/tf_grid_testnet_disclaimer.md @@ -5,7 +5,7 @@ ThreeFold_Grid is currently running on a demo version, here referred to as **Demo**, **TF Grid Demo**, or **ThreeFold_Grid Demo**, as well as **3Bot Admin Panel**, **3Bot Sys-Admin**, **3Bot**, to demonstrate the capabilities of our new marketplace and deployable solutions. This version of ThreeFold_Grid is running on both Main Net and Testnet. As a demo version, there would be no guarantees whatsoever provided to users including but not limited to uptime, or data availability. -By using this early version of all products, including but not limited to **Demo**, **3Bot** on Main Net and Test Net, you (the User) agree to **Threefold's** [**Terms & Conditions**](https://github.com/threefoldfoundation/info_legal/blob/master/wiki/terms_conditions_all.md). +By using this early version of all products, including but not limited to **Demo**, **3Bot** on Main Net and Test Net, you (the User) agree to **Threefold's** [**Terms & Conditions**](terms_conditions_all.md). All content provided on all products, including but not limited to Demo, 3Bot on Main Net and Testnet are provided without any representations or warranties of any kind. No Party involved in, or having contributed to the development of Demo and Testnet accept any responsibility or liability to Users or any third parties in relation to materials or information accessed or downloaded via the Demo and Testnet, and their related websites or information sources. diff --git a/collections/system_administrators/advanced/advanced.md b/collections/system_administrators/advanced/advanced.md index 92a95c3..fbe0fc7 100644 --- a/collections/system_administrators/advanced/advanced.md +++ b/collections/system_administrators/advanced/advanced.md @@ -4,11 +4,11 @@ In this section, we delve into sophisticated topics and powerful functionalities

Table of Contents

-- [Token Transfer Keygenerator](./token_transfer_keygenerator.md) -- [Cancel Contracts](./cancel_contracts.md) -- [Contract Bills Reports](./contract_bill_report.md) -- [Listing Free Public IPs](./list_public_ips.md) -- [Redis](./grid3_redis.md) -- [IPFS](./ipfs/ipfs_toc.md) - - [IPFS on a Full VM](./ipfs/ipfs_fullvm.md) - - [IPFS on a Micro VM](./ipfs/ipfs_microvm.md) +- [Token Transfer Keygenerator](token_transfer_keygenerator.md) +- [Cancel Contracts](cancel_contracts.md) +- [Contract Bills Reports](contract_bill_report.md) +- [Listing Free Public IPs](list_public_ips.md) +- [Redis](grid3_redis.md) +- [IPFS](ipfs_toc.md) + - [IPFS on a Full VM](ipfs_fullvm.md) + - [IPFS on a Micro VM](ipfs_microvm.md) diff --git a/collections/system_administrators/advanced/cancel_contracts.md b/collections/system_administrators/advanced/cancel_contracts.md index efab0ff..1cbf826 100644 --- a/collections/system_administrators/advanced/cancel_contracts.md +++ b/collections/system_administrators/advanced/cancel_contracts.md @@ -45,4 +45,4 @@ Go to `Extrinsics`, choose the `smartContract` module and `cancelContract` extri In order to use the `grid3_client_ts` module, it is essential to first clone our official mono-repo containing the module and then navigate to it. If you are looking for a quick and efficient way to cancel contracts, we offer a code-based solution that can be found [here](https://github.com/threefoldtech/tfgrid-sdk-ts/blob/development/packages/grid_client/scripts/delete_all_contracts.ts). -To make the most of `grid_client`, we highly recommend following our [Grid-Client guide](https://github.com/threefoldtech/tfgrid-sdk-ts/blob/development/packages/grid_client/README.md) for a comprehensive overview of the many advanced capabilities offered by this powerful tool. With features like contract creation, modification, and retrieval, `grid_client` provides an intuitive and easy-to-use solution for managing your contracts effectively. +To make the most of `grid_client`, we highly recommend following our [Grid-Client guide](README.md) for a comprehensive overview of the many advanced capabilities offered by this powerful tool. With features like contract creation, modification, and retrieval, `grid_client` provides an intuitive and easy-to-use solution for managing your contracts effectively. diff --git a/collections/system_administrators/advanced/ipfs/ipfs_toc.md b/collections/system_administrators/advanced/ipfs/ipfs_toc.md index 15d9c4a..95d1893 100644 --- a/collections/system_administrators/advanced/ipfs/ipfs_toc.md +++ b/collections/system_administrators/advanced/ipfs/ipfs_toc.md @@ -2,5 +2,5 @@

Table of Contents

-- [IPFS on a Full VM](./ipfs_fullvm.md) -- [IPFS on a Micro VM](./ipfs_microvm.md) \ No newline at end of file +- [IPFS on a Full VM](ipfs_fullvm.md) +- [IPFS on a Micro VM](ipfs_microvm.md) \ No newline at end of file diff --git a/collections/system_administrators/computer_it_basics/computer_it_basics.md b/collections/system_administrators/computer_it_basics/computer_it_basics.md index c1dfdfd..a78bebd 100644 --- a/collections/system_administrators/computer_it_basics/computer_it_basics.md +++ b/collections/system_administrators/computer_it_basics/computer_it_basics.md @@ -6,10 +6,10 @@ In this section, tailored specifically for system administrators, we'll delve in

Table of Contents

-- [CLI and Scripts Basics](./cli_scripts_basics.md) -- [Docker Basics](./docker_basics.md) -- [Git and GitHub Basics](./git_github_basics.md) -- [Firewall Basics](./firewall_basics/firewall_basics.md) - - [UFW Basics](./firewall_basics/ufw_basics.md) - - [Firewalld Basics](./firewall_basics/firewalld_basics.md) -- [File Transfer](./file_transfer.md) \ No newline at end of file +- [CLI and Scripts Basics](cli_scripts_basics.md) +- [Docker Basics](docker_basics.md) +- [Git and GitHub Basics](git_github_basics.md) +- [Firewall Basics](firewall_basics.md) + - [UFW Basics](ufw_basics.md) + - [Firewalld Basics](firewalld_basics.md) +- [File Transfer](file_transfer.md) \ No newline at end of file diff --git a/collections/system_administrators/computer_it_basics/docker_basics.md b/collections/system_administrators/computer_it_basics/docker_basics.md index 5a7f297..ede603f 100644 --- a/collections/system_administrators/computer_it_basics/docker_basics.md +++ b/collections/system_administrators/computer_it_basics/docker_basics.md @@ -164,7 +164,7 @@ docker run --rm quay.io/skopeo/stable list-tags docker://ghcr.io// Table of Contents -- [UFW Basics](./ufw_basics.md) -- [Firewalld Basics](./firewalld_basics.md) \ No newline at end of file +- [UFW Basics](ufw_basics.md) +- [Firewalld Basics](firewalld_basics.md) \ No newline at end of file diff --git a/collections/system_administrators/getstarted/remote-desktop_gui/cockpit_guide/cockpit_guide.md b/collections/system_administrators/getstarted/remote-desktop_gui/cockpit_guide/cockpit_guide.md index 6a08a66..fb7bae4 100644 --- a/collections/system_administrators/getstarted/remote-desktop_gui/cockpit_guide/cockpit_guide.md +++ b/collections/system_administrators/getstarted/remote-desktop_gui/cockpit_guide/cockpit_guide.md @@ -17,9 +17,9 @@ In this Threefold Guide, we show how easy it is to deploy a full VM and access Cockpit, a web-based interface to manage servers. For more information on Cockpit, visit this [link](https://cockpit-project.org/). -For more information on deploying a full VM and using SSH remote connection, read [this SSH guide](../../ssh_guide/ssh_guide.md). +For more information on deploying a full VM and using SSH remote connection, read [this SSH guide](ssh_guide.md). -If you are new to the Threefold ecosystem and you want to deploy workloads on the Threefold Grid, read the [Get Started section](../../tfgrid3_getstarted.md) of the Threefold Manual. +If you are new to the Threefold ecosystem and you want to deploy workloads on the Threefold Grid, read the [Get Started section](tfgrid3_getstarted.md) of the Threefold Manual. Note that the two sections [Change the Network System Daemon](#change-the-network-system-daemon) and [Set a Firewall](#set-a-firewall) are optional. That being said, they provide more features and security to the deployment. @@ -27,7 +27,7 @@ Note that the two sections [Change the Network System Daemon](#change-the-networ ## Deploy a Full VM and Create a Root-Access User -To start, you must [deploy and SSH into a full VM](../../ssh_guide/ssh_guide.md). +To start, you must [deploy and SSH into a full VM](ssh_guide.md). * Go to the [Threefold dashboard](https://dashboard.grid.tf/#/) * Deploy a full VM (e.g. Ubuntu 22.04) diff --git a/collections/system_administrators/getstarted/remote-desktop_gui/guacamole_guide/guacamole_guide.md b/collections/system_administrators/getstarted/remote-desktop_gui/guacamole_guide/guacamole_guide.md index d41569e..6a6738e 100644 --- a/collections/system_administrators/getstarted/remote-desktop_gui/guacamole_guide/guacamole_guide.md +++ b/collections/system_administrators/getstarted/remote-desktop_gui/guacamole_guide/guacamole_guide.md @@ -21,9 +21,9 @@ The Apache Guacamole instance has a two-factor authorization to give further sec With Apache Guacamole, a user can access different deployments and command servers remotely, with desktop access. -This guide can be done on a Windows, MAC, or Linux computer. For more information on deploying a full VM and using SSH remote connection, read this [SSH guide](../../ssh_guide/ssh_guide.md). +This guide can be done on a Windows, MAC, or Linux computer. For more information on deploying a full VM and using SSH remote connection, read this [SSH guide](ssh_guide.md). -If you are new to the Threefold ecosystem and you want to deploy workloads on the Threefold Grid, read the [Get Started section](../../tfgrid3_getstarted.md) of the Threefold Manual. +If you are new to the Threefold ecosystem and you want to deploy workloads on the Threefold Grid, read the [Get Started section](tfgrid3_getstarted.md) of the Threefold Manual. diff --git a/collections/system_administrators/getstarted/remote-desktop_gui/remote_desktop_gui.md b/collections/system_administrators/getstarted/remote-desktop_gui/remote_desktop_gui.md index d801b48..a06c016 100644 --- a/collections/system_administrators/getstarted/remote-desktop_gui/remote_desktop_gui.md +++ b/collections/system_administrators/getstarted/remote-desktop_gui/remote_desktop_gui.md @@ -6,6 +6,6 @@ If you have any questions, or if you would like to see a specific guide on remot

Table of Contents

-- [Cockpit: a Web-based Graphical Interface for Servers](./cockpit_guide/cockpit_guide.md) -- [XRDP: an Open-Source Remote Desktop Procol](./xrdp_guide/xrdp_guide.md) -- [Apache Guacamole: a Clientless Remote Desktop Gateway.](./guacamole_guide/guacamole_guide.md) +- [Cockpit: a Web-based Graphical Interface for Servers](cockpit_guide.md) +- [XRDP: an Open-Source Remote Desktop Procol](xrdp_guide.md) +- [Apache Guacamole: a Clientless Remote Desktop Gateway.](guacamole_guide.md) diff --git a/collections/system_administrators/getstarted/remote-desktop_gui/xrdp_guide/xrdp_guide.md b/collections/system_administrators/getstarted/remote-desktop_gui/xrdp_guide/xrdp_guide.md index e1648ab..24f2389 100644 --- a/collections/system_administrators/getstarted/remote-desktop_gui/xrdp_guide/xrdp_guide.md +++ b/collections/system_administrators/getstarted/remote-desktop_gui/xrdp_guide/xrdp_guide.md @@ -18,9 +18,9 @@ We access Ubuntu with a desktop environment to offer a graphical user interface This guide can be done on a Windows, MAC, or Linux computer. The only difference will be in the Remote Desktop app. The steps are very similar. -For more information on deploying a full VM and using SSH remote connection, read this [SSH guide](../../ssh_guide/ssh_guide.md). +For more information on deploying a full VM and using SSH remote connection, read this [SSH guide](ssh_guide.md). -If you are new to the Threefold ecosystem and you want to deploy workloads on the Threefold Grid, read the [Get Started section](../../tfgrid3_getstarted.md) of the Threefold Manual. +If you are new to the Threefold ecosystem and you want to deploy workloads on the Threefold Grid, read the [Get Started section](tfgrid3_getstarted.md) of the Threefold Manual. diff --git a/collections/system_administrators/getstarted/ssh_guide/ssh_guide.md b/collections/system_administrators/getstarted/ssh_guide/ssh_guide.md index 020e2ad..62b83a4 100644 --- a/collections/system_administrators/getstarted/ssh_guide/ssh_guide.md +++ b/collections/system_administrators/getstarted/ssh_guide/ssh_guide.md @@ -4,7 +4,7 @@ SSH is a secure protocol used as the primary means of connecting to Linux server

Table of Contents

-- [SSH with OpenSSH](./ssh_openssh.md) -- [SSH with PuTTY](./ssh_putty.md) -- [SSH with WSL](./ssh_wsl.md) -- [WireGuard Access](./ssh_wireguard.md) \ No newline at end of file +- [SSH with OpenSSH](ssh_openssh.md) +- [SSH with PuTTY](ssh_putty.md) +- [SSH with WSL](ssh_wsl.md) +- [WireGuard Access](ssh_wireguard.md) \ No newline at end of file diff --git a/collections/system_administrators/getstarted/ssh_guide/ssh_openssh.md b/collections/system_administrators/getstarted/ssh_guide/ssh_openssh.md index 6598350..4762cf2 100644 --- a/collections/system_administrators/getstarted/ssh_guide/ssh_openssh.md +++ b/collections/system_administrators/getstarted/ssh_guide/ssh_openssh.md @@ -20,7 +20,7 @@ # Introduction -In this Threefold Guide, we show how easy it is to deploy a full virtual machine (VM) and SSH into a 3Node with [OpenSSH](https://www.openssh.com/) on Linux, MAC and Windows with both an IPv4 and a Planetary Network connection. To connect to the 3Node with WireGuard, read [this documentation](./ssh_wireguard.md). +In this Threefold Guide, we show how easy it is to deploy a full virtual machine (VM) and SSH into a 3Node with [OpenSSH](https://www.openssh.com/) on Linux, MAC and Windows with both an IPv4 and a Planetary Network connection. To connect to the 3Node with WireGuard, read [this documentation](ssh_wireguard.md). To deploy different workloads, the SSH connection process should be very similar. diff --git a/collections/system_administrators/getstarted/ssh_guide/ssh_wireguard.md b/collections/system_administrators/getstarted/ssh_guide/ssh_wireguard.md index 260fab0..69fa20a 100644 --- a/collections/system_administrators/getstarted/ssh_guide/ssh_wireguard.md +++ b/collections/system_administrators/getstarted/ssh_guide/ssh_wireguard.md @@ -19,7 +19,7 @@ In this Threefold Guide, we show how to set up [WireGuard](https://www.wireguard.com/) to access a 3Node deployment with an SSH connection. -Note that WireGuard provides the connection to the 3Node deployment. It is up to you to decide which SSH client you want to use. This means that the steps to SSH into a 3Node deployment will be similar to the steps proposed in the guides for [Open-SSH](./ssh_openssh.md), [PuTTy](ssh_putty.md) and [WSL](./ssh_wsl.md). Please refer to [this documentation](./ssh_guide.md) if you have any questions concerning SSH clients. The main difference will be that we connect to the 3Node deployment using a WireGuard connection instead of an IPv4 or a Planetary Network connection. +Note that WireGuard provides the connection to the 3Node deployment. It is up to you to decide which SSH client you want to use. This means that the steps to SSH into a 3Node deployment will be similar to the steps proposed in the guides for [Open-SSH](ssh_openssh.md), [PuTTy](ssh_putty.md) and [WSL](ssh_wsl.md). Please refer to [this documentation](ssh_guide.md) if you have any questions concerning SSH clients. The main difference will be that we connect to the 3Node deployment using a WireGuard connection instead of an IPv4 or a Planetary Network connection. @@ -28,15 +28,15 @@ Note that WireGuard provides the connection to the 3Node deployment. It is up to Make sure to [read the introduction](../tfgrid3_getstarted.md#get-started---your-first-deployment) before going further. * SSH client of your choice - * [Open-SSH](./ssh_openssh.md) + * [Open-SSH](ssh_openssh.md) * [PuTTy](ssh_putty.md) - * [WSL](./ssh_wsl.md) + * [WSL](ssh_wsl.md) # Deploy a Weblet with WireGuard Access -For this guide on WireGuard access, we deploy a [Full VM](../../../dashboard/solutions/fullVm.md). Note that the whole process is similar with other types of ThreeFold weblets on the Dashboard. +For this guide on WireGuard access, we deploy a [Full VM](fullVm.md). Note that the whole process is similar with other types of ThreeFold weblets on the Dashboard. * On the [Threefold Dashboard](https://dashboard.grid.tf/), go to: Deploy -> Virtual Machines -> Full Virtual Machine * Choose the parameters you want diff --git a/collections/system_administrators/getstarted/tfgrid3_getstarted.md b/collections/system_administrators/getstarted/tfgrid3_getstarted.md index d7ef097..d479cb3 100644 --- a/collections/system_administrators/getstarted/tfgrid3_getstarted.md +++ b/collections/system_administrators/getstarted/tfgrid3_getstarted.md @@ -8,11 +8,11 @@ It's easy to get started on the TFGrid and deploy applications. - [Get TFT](threefold_token@@buy_sell_tft) - [Bridge TFT to TChain](threefold_token@@tft_bridges) - [Deploy an Application](dashboard@@deploy) -- [SSH Remote Connection](./ssh_guide/ssh_guide.md) - - [SSH with OpenSSH](./ssh_guide/ssh_openssh.md) - - [SSH with PuTTY](./ssh_guide/ssh_putty.md) - - [SSH with WSL](./ssh_guide/ssh_wsl.md) - - [SSH and WireGuard](./ssh_guide/ssh_wireguard.md) +- [SSH Remote Connection](ssh_guide.md) + - [SSH with OpenSSH](ssh_openssh.md) + - [SSH with PuTTY](ssh_putty.md) + - [SSH with WSL](ssh_wsl.md) + - [SSH and WireGuard](ssh_wireguard.md) ## Grid Platforms @@ -21,11 +21,11 @@ It's easy to get started on the TFGrid and deploy applications. ## TFGrid Services and Resources -- [TFGrid Services](./tfgrid_services/tf_grid_services_readme.md) +- [TFGrid Services](tf_grid_services_readme.md) ## Advanced Deployment Techniques -- [Advanced Topics](../advanced/advanced.md) +- [Advanced Topics](advanced.md) *** diff --git a/collections/system_administrators/getstarted/tfgrid3_what_to_know.md b/collections/system_administrators/getstarted/tfgrid3_what_to_know.md index 2a47adf..a72590b 100644 --- a/collections/system_administrators/getstarted/tfgrid3_what_to_know.md +++ b/collections/system_administrators/getstarted/tfgrid3_what_to_know.md @@ -1,13 +1,13 @@ # TFGrid 3.0 Whats There To Know -- [Storage Concepts](./tfgrid3_storage_concepts.md) -- [Network Concepts](./tfgrid3_network_concepts.md) +- [Storage Concepts](tfgrid3_storage_concepts.md) +- [Network Concepts](tfgrid3_network_concepts.md) ## Networking ### Private network (ZNET) -For a project that needs a private network, we need a network that can span across multiple nodes, this can be achieved by the network workload reservation [Network](/getstarted/tfgrid3_network_concepts.md) +For a project that needs a private network, we need a network that can span across multiple nodes, this can be achieved by the network workload reservation [Network](tfgrid3_network_concepts.md) ### Planetary network @@ -35,7 +35,7 @@ As a user, you have two options ## Compute -VM workload is the only workload that you will need to run a full blown VM or an [flist-based](/flist_hub/flist_hub.md) container +VM workload is the only workload that you will need to run a full blown VM or an [flist-based](flist_hub.md) container ### How can I create an flist? @@ -54,5 +54,5 @@ You can easily check using [explorer-ui](dashboard@@explorer_home) , also to pla ## Getting started -Please check [Getting started](/getstarted/tfgrid3_getstarted.md) to get the necessary software / configurations +Please check [Getting started](tfgrid3_getstarted.md) to get the necessary software / configurations diff --git a/collections/system_administrators/gpu/gpu.md b/collections/system_administrators/gpu/gpu.md index 96c5112..581d26f 100644 --- a/collections/system_administrators/gpu/gpu.md +++ b/collections/system_administrators/gpu/gpu.md @@ -52,7 +52,7 @@ When you have decided which node to reserve, click on **Reserve** under the colu ## Deploy a VM with GPU -Now that you've reserverd a dedicated GPU node, it's time to deploy a VM to make use of the GPU! There are many ways to proceed. You can use the [Dashboard](../../dashboard/solutions/fullVm.md), [Go](developers@@grid3_go_gpu), [Terraform](../terraform/terraform_gpu_support.md), etc. +Now that you've reserverd a dedicated GPU node, it's time to deploy a VM to make use of the GPU! There are many ways to proceed. You can use the [Dashboard](fullVm.md), [Go](developers@@grid3_go_gpu), [Terraform](terraform_gpu_support.md), etc. For example, deploying a VM with GPU on the Dashboard is easy. Simply set the GPU option and make sure to select your dedicated node, as show here: ![image](./img/gpu_3.png) @@ -120,4 +120,4 @@ Here are some useful links to troubleshoot your GPU installation. ## GPU Support Links -You can consult the [GPU Table of Contents](./gpu_toc.md) to see all available GPU support links on the ThreeFold Manual. \ No newline at end of file +You can consult the [GPU Table of Contents](gpu_toc.md) to see all available GPU support links on the ThreeFold Manual. \ No newline at end of file diff --git a/collections/system_administrators/gpu/gpu_toc.md b/collections/system_administrators/gpu/gpu_toc.md index ea2a846..b0ccaca 100644 --- a/collections/system_administrators/gpu/gpu_toc.md +++ b/collections/system_administrators/gpu/gpu_toc.md @@ -6,14 +6,14 @@ Feel free to explore the different possibilities!

Table of Contents

-- [GPU Support](./gpu.md) +- [GPU Support](gpu.md) - [Node Finder and GPU](dashboard@@node_finder) - [Javascript Client and GPU](developers@@grid3_javascript_gpu_support) - [GPU and Go](developers@@grid3_go_gpu) - [GPU Support](developers@@grid3_go_gpu_support) - [Deploy a VM with GPU](developers@@grid3_go_vm_with_gpu) - [TFCMD and GPU](developers@@tfcmd_vm) -- [Terraform and GPU](../terraform/terraform_gpu_support.md) +- [Terraform and GPU](terraform_gpu_support.md) - [Full VM and GPU](dashboard@@fullvm) - [Zero-OS API and GPU](developers@@api) - [GPU Farming](farmers@@gpu_farming) \ No newline at end of file diff --git a/collections/system_administrators/mycelium/information.md b/collections/system_administrators/mycelium/information.md index d900e82..890c0db 100644 --- a/collections/system_administrators/mycelium/information.md +++ b/collections/system_administrators/mycelium/information.md @@ -116,8 +116,8 @@ same data stream used by L3 packets. As such, intermediate nodes can't distingui and message data. The primary way to interact with the message system is through [the API](#API). The message API is -documented in [here](./api_yaml.md). For some more info about how to -use the message system, see [the Message section](./message.md). +documented in [here](api_yaml.md). For some more info about how to +use the message system, see [the Message section](message.md). ## Inspecting Node Keys diff --git a/collections/system_administrators/mycelium/message.md b/collections/system_administrators/mycelium/message.md index f132367..c7edbd3 100644 --- a/collections/system_administrators/mycelium/message.md +++ b/collections/system_administrators/mycelium/message.md @@ -13,7 +13,7 @@ The message subsystem can be used to send arbitrary length messages to receivers. A receiver is any other node in the network. It can be identified both by its public key, or an IP address in its announced range. The message subsystem can be interacted with both via the HTTP API, which is -[documented here](./api_yaml.md), or via the `mycelium` binary. By default, the messages do not interpret +[documented here](api_yaml.md), or via the `mycelium` binary. By default, the messages do not interpret the data in any way. When using the binary, the message is slightly modified to include an optional topic at the start of the message. Note that in the HTTP API, all messages are encoded in base64. This might make it difficult to consume these messages without additional tooling. diff --git a/collections/system_administrators/mycelium/mycelium_toc.md b/collections/system_administrators/mycelium/mycelium_toc.md index 817771d..c95199e 100644 --- a/collections/system_administrators/mycelium/mycelium_toc.md +++ b/collections/system_administrators/mycelium/mycelium_toc.md @@ -5,10 +5,10 @@ In this section, we present [Mycelium](https://github.com/threefoldtech/mycelium

Table of Contents

-- [Overview](./overview.md) -- [Installation](./installation.md) -- [Additional Information](./information.md) -- [Message](./message.md) -- [Packet](./packet.md) -- [Data Packet](./data_packet.md) -- [API YAML](./api_yaml.md) \ No newline at end of file +- [Overview](overview.md) +- [Installation](installation.md) +- [Additional Information](information.md) +- [Message](message.md) +- [Packet](packet.md) +- [Data Packet](data_packet.md) +- [API YAML](api_yaml.md) \ No newline at end of file diff --git a/collections/system_administrators/pulumi/pulumi_deployment_details.md b/collections/system_administrators/pulumi/pulumi_deployment_details.md index 5dc808c..282fd49 100644 --- a/collections/system_administrators/pulumi/pulumi_deployment_details.md +++ b/collections/system_administrators/pulumi/pulumi_deployment_details.md @@ -29,7 +29,7 @@ Please note that the Pulumi plugin for ThreeFold Grid is not yet officially publ ## Installation -If this isn't already done, [install Pulumi](./pulumi_install.md) on your machine. +If this isn't already done, [install Pulumi](pulumi_install.md) on your machine. ## Essential Workflow diff --git a/collections/system_administrators/pulumi/pulumi_examples.md b/collections/system_administrators/pulumi/pulumi_examples.md index 73363c3..ee8ab14 100644 --- a/collections/system_administrators/pulumi/pulumi_examples.md +++ b/collections/system_administrators/pulumi/pulumi_examples.md @@ -23,7 +23,7 @@ Please note that the Pulumi plugin for ThreeFold Grid is not yet officially publ There are a few things to set up before exploring Pulumi. Since we will be using the examples in the ThreeFold Pulumi repository, we must clone the repository before going further. -* [Install Pulumi](./pulumi_install.md) on your machine +* [Install Pulumi](pulumi_install.md) on your machine * Clone the **Pulumi-ThreeFold** repository * ``` git clone https://github.com/threefoldtech/pulumi-threefold diff --git a/collections/system_administrators/pulumi/pulumi_readme.md b/collections/system_administrators/pulumi/pulumi_readme.md index 0cc318c..31b4cf0 100644 --- a/collections/system_administrators/pulumi/pulumi_readme.md +++ b/collections/system_administrators/pulumi/pulumi_readme.md @@ -6,7 +6,7 @@ In this section, we will explore the dynamic world of infrastructure as code (Ia

Table of Contents

-- [Introduction to Pulumi](./pulumi_intro.md) -- [Installing Pulumi](./pulumi_install.md) -- [Deployment Examples](./pulumi_examples.md) -- [Deployment Details](./pulumi_deployment_details.md) \ No newline at end of file +- [Introduction to Pulumi](pulumi_intro.md) +- [Installing Pulumi](pulumi_install.md) +- [Deployment Examples](pulumi_examples.md) +- [Deployment Details](pulumi_deployment_details.md) \ No newline at end of file diff --git a/collections/system_administrators/system_administrators.md b/collections/system_administrators/system_administrators.md index 8d133d6..f76b33a 100644 --- a/collections/system_administrators/system_administrators.md +++ b/collections/system_administrators/system_administrators.md @@ -6,78 +6,78 @@ For complementary information on ThreeFold grid and its cloud component, refer t

Table of Contents

-- [Getting Started](./getstarted/tfgrid3_getstarted.md) - - [SSH Remote Connection](./getstarted/ssh_guide/ssh_guide.md) - - [SSH with OpenSSH](./getstarted/ssh_guide/ssh_openssh.md) - - [SSH with PuTTY](./getstarted/ssh_guide/ssh_putty.md) - - [SSH with WSL](./getstarted/ssh_guide/ssh_wsl.md) - - [WireGuard Access](./getstarted/ssh_guide/ssh_wireguard.md) - - [Remote Desktop and GUI](./getstarted/remote-desktop_gui/remote-desktop_gui.md) - - [Cockpit: a Web-based Interface for Servers](./getstarted/remote-desktop_gui/cockpit_guide/cockpit_guide.md) - - [XRDP: an Open-Source Remote Desktop Protocol](./getstarted/remote-desktop_gui/xrdp_guide/xrdp_guide.md) - - [Apache Guacamole: a Clientless Remote Desktop Gateway](./getstarted/remote-desktop_gui/guacamole_guide/guacamole_guide.md) -- [Planetary Network](./getstarted/planetarynetwork.md) -- [TFGrid Services](./getstarted/tfgrid_services/tf_grid_services_readme.md) -- [GPU](./gpu/gpu_toc.md) - - [GPU Support](./gpu/gpu.md) -- [Terraform](./terraform/terraform_toc.md) - - [Overview](./terraform/terraform_readme.md) - - [Installing Terraform](./terraform/terraform_install.md) - - [Terraform Basics](./terraform/terraform_basics.md) - - [Full VM Deployment](./terraform/terraform_full_vm.md) - - [GPU Support](./terraform/terraform_gpu_support.md) - - [Resources](./terraform/resources/terraform_resources_readme.md) - - [Using Scheduler](./terraform/resources/terraform_scheduler.md) - - [Virtual Machine](./terraform/resources/terraform_vm.md) - - [Web Gateway](./terraform/resources/terraform_vm_gateway.md) - - [Kubernetes Cluster](./terraform/resources/terraform_k8s.md) - - [ZDB](./terraform/resources/terraform_zdb.md) - - [Quantum Safe Filesystem](./terraform/resources/terraform_qsfs.md) - - [QSFS on Micro VM](./terraform/resources/terraform_qsfs_on_microvm.md) - - [QSFS on Full VM](./terraform/resources/terraform_qsfs_on_full_vm.md) - - [CapRover](./terraform/resources/terraform_caprover.md) - - [Advanced](./terraform/advanced/terraform_advanced_readme.md) - - [Terraform Provider](./terraform/advanced/terraform_provider.md) - - [Terraform Provisioners](./terraform/advanced/terraform_provisioners.md) - - [Mounts](./terraform/advanced/terraform_mounts.md) - - [Capacity Planning](./terraform/advanced/terraform_capacity_planning.md) - - [Updates](./terraform/advanced/terraform_updates.md) - - [SSH Connection with Wireguard](./terraform/advanced/terraform_wireguard_ssh.md) - - [Set a Wireguard VPN](./terraform/advanced/terraform_wireguard_vpn.md) - - [Synced MariaDB Databases](./terraform/advanced/terraform_mariadb_synced_databases.md) - - [Nomad](./terraform/advanced/terraform_nomad.md) - - [Nextcloud Deployments](./terraform/advanced/terraform_nextcloud_toc.md) - - [Nextcloud All-in-One Deployment](./terraform/advanced/terraform_nextcloud_aio.md) - - [Nextcloud Single Deployment](./terraform/advanced/terraform_nextcloud_single.md) - - [Nextcloud Redundant Deployment](./terraform/advanced/terraform_nextcloud_redundant.md) - - [Nextcloud 2-Node VPN Deployment](./terraform/advanced/terraform_nextcloud_vpn.md) -- [Pulumi](./pulumi/pulumi_readme.md) - - [Introduction to Pulumi](./pulumi/pulumi_intro.md) - - [Installing Pulumi](./pulumi/pulumi_install.md) - - [Deployment Examples](./pulumi/pulumi_examples.md) - - [Deployment Details](./pulumi/pulumi_deployment_details.md) -- [Mycelium](./mycelium/mycelium_toc.md) - - [Overview](./mycelium/overview.md) - - [Installation](./mycelium/installation.md) - - [Additional Information](./mycelium/information.md) - - [Message](./mycelium/message.md) - - [Packet](./mycelium/packet.md) - - [Data Packet](./mycelium/data_packet.md) - - [API YAML](./mycelium/api_yaml.md) -- [Computer and IT Basics](./computer_it_basics/computer_it_basics.md) - - [CLI and Scripts Basics](./computer_it_basics/cli_scripts_basics.md) - - [Docker Basics](./computer_it_basics/docker_basics.md) - - [Git and GitHub Basics](./computer_it_basics/git_github_basics.md) - - [Firewall Basics](./computer_it_basics/firewall_basics/firewall_basics.md) - - [UFW Basics](./computer_it_basics/firewall_basics/ufw_basics.md) - - [Firewalld Basics](./computer_it_basics/firewall_basics/firewalld_basics.md) - - [File Transfer](./computer_it_basics/file_transfer.md) -- [Advanced](./advanced/advanced.md) - - [Token Transfer Keygenerator](./advanced/token_transfer_keygenerator.md) - - [Cancel Contracts](./advanced/cancel_contracts.md) - - [Contract Bills Reports](./advanced/contract_bill_report.md) - - [Listing Free Public IPs](./advanced/list_public_ips.md) - - [Redis](./advanced/grid3_redis.md) - - [IPFS](./advanced/ipfs/ipfs_toc.md) - - [IPFS on a Full VM](./advanced/ipfs/ipfs_fullvm.md) - - [IPFS on a Micro VM](./advanced/ipfs/ipfs_microvm.md) \ No newline at end of file +- [Getting Started](tfgrid3_getstarted.md) + - [SSH Remote Connection](ssh_guide.md) + - [SSH with OpenSSH](ssh_openssh.md) + - [SSH with PuTTY](ssh_putty.md) + - [SSH with WSL](ssh_wsl.md) + - [WireGuard Access](ssh_wireguard.md) + - [Remote Desktop and GUI](remote-desktop_gui.md) + - [Cockpit: a Web-based Interface for Servers](cockpit_guide.md) + - [XRDP: an Open-Source Remote Desktop Protocol](xrdp_guide.md) + - [Apache Guacamole: a Clientless Remote Desktop Gateway](guacamole_guide.md) +- [Planetary Network](planetarynetwork.md) +- [TFGrid Services](tf_grid_services_readme.md) +- [GPU](gpu_toc.md) + - [GPU Support](gpu.md) +- [Terraform](terraform_toc.md) + - [Overview](terraform_readme.md) + - [Installing Terraform](terraform_install.md) + - [Terraform Basics](terraform_basics.md) + - [Full VM Deployment](terraform_full_vm.md) + - [GPU Support](terraform_gpu_support.md) + - [Resources](terraform_resources_readme.md) + - [Using Scheduler](terraform_scheduler.md) + - [Virtual Machine](terraform_vm.md) + - [Web Gateway](terraform_vm_gateway.md) + - [Kubernetes Cluster](terraform_k8s.md) + - [ZDB](terraform_zdb.md) + - [Quantum Safe Filesystem](terraform_qsfs.md) + - [QSFS on Micro VM](terraform_qsfs_on_microvm.md) + - [QSFS on Full VM](terraform_qsfs_on_full_vm.md) + - [CapRover](terraform_caprover.md) + - [Advanced](terraform_advanced_readme.md) + - [Terraform Provider](terraform_provider.md) + - [Terraform Provisioners](terraform_provisioners.md) + - [Mounts](terraform_mounts.md) + - [Capacity Planning](terraform_capacity_planning.md) + - [Updates](terraform_updates.md) + - [SSH Connection with Wireguard](terraform_wireguard_ssh.md) + - [Set a Wireguard VPN](terraform_wireguard_vpn.md) + - [Synced MariaDB Databases](terraform_mariadb_synced_databases.md) + - [Nomad](terraform_nomad.md) + - [Nextcloud Deployments](terraform_nextcloud_toc.md) + - [Nextcloud All-in-One Deployment](terraform_nextcloud_aio.md) + - [Nextcloud Single Deployment](terraform_nextcloud_single.md) + - [Nextcloud Redundant Deployment](terraform_nextcloud_redundant.md) + - [Nextcloud 2-Node VPN Deployment](terraform_nextcloud_vpn.md) +- [Pulumi](pulumi_readme.md) + - [Introduction to Pulumi](pulumi_intro.md) + - [Installing Pulumi](pulumi_install.md) + - [Deployment Examples](pulumi_examples.md) + - [Deployment Details](pulumi_deployment_details.md) +- [Mycelium](mycelium_toc.md) + - [Overview](overview.md) + - [Installation](installation.md) + - [Additional Information](information.md) + - [Message](message.md) + - [Packet](packet.md) + - [Data Packet](data_packet.md) + - [API YAML](api_yaml.md) +- [Computer and IT Basics](computer_it_basics.md) + - [CLI and Scripts Basics](cli_scripts_basics.md) + - [Docker Basics](docker_basics.md) + - [Git and GitHub Basics](git_github_basics.md) + - [Firewall Basics](firewall_basics.md) + - [UFW Basics](ufw_basics.md) + - [Firewalld Basics](firewalld_basics.md) + - [File Transfer](file_transfer.md) +- [Advanced](advanced.md) + - [Token Transfer Keygenerator](token_transfer_keygenerator.md) + - [Cancel Contracts](cancel_contracts.md) + - [Contract Bills Reports](contract_bill_report.md) + - [Listing Free Public IPs](list_public_ips.md) + - [Redis](grid3_redis.md) + - [IPFS](ipfs_toc.md) + - [IPFS on a Full VM](ipfs_fullvm.md) + - [IPFS on a Micro VM](ipfs_microvm.md) \ No newline at end of file diff --git a/collections/system_administrators/terraform/advanced/terraform_advanced_readme.md b/collections/system_administrators/terraform/advanced/terraform_advanced_readme.md index 67168e0..b3d5f25 100644 --- a/collections/system_administrators/terraform/advanced/terraform_advanced_readme.md +++ b/collections/system_administrators/terraform/advanced/terraform_advanced_readme.md @@ -7,12 +7,12 @@ - [Mounts](./terraform_mounts.html) - [Capacity Planning](./terraform_capacity_planning.html) - [Updates](./terraform_updates.html) -- [SSH Connection with Wireguard](./terraform_wireguard_ssh.md) -- [Set a Wireguard VPN](./terraform_wireguard_vpn.md) -- [Synced MariaDB Databases](./terraform_mariadb_synced_databases.md) -- [Nomad](./terraform_nomad.md) -- [Nextcloud Deployments](./terraform_nextcloud_toc.md) - - [Nextcloud All-in-One Deployment](./terraform_nextcloud_aio.md) - - [Nextcloud Single Deployment](./terraform_nextcloud_single.md) - - [Nextcloud Redundant Deployment](./terraform_nextcloud_redundant.md) - - [Nextcloud 2-Node VPN Deployment](./terraform_nextcloud_vpn.md) \ No newline at end of file +- [SSH Connection with Wireguard](terraform_wireguard_ssh.md) +- [Set a Wireguard VPN](terraform_wireguard_vpn.md) +- [Synced MariaDB Databases](terraform_mariadb_synced_databases.md) +- [Nomad](terraform_nomad.md) +- [Nextcloud Deployments](terraform_nextcloud_toc.md) + - [Nextcloud All-in-One Deployment](terraform_nextcloud_aio.md) + - [Nextcloud Single Deployment](terraform_nextcloud_single.md) + - [Nextcloud Redundant Deployment](terraform_nextcloud_redundant.md) + - [Nextcloud 2-Node VPN Deployment](terraform_nextcloud_vpn.md) \ No newline at end of file diff --git a/collections/system_administrators/terraform/advanced/terraform_capacity_planning.md b/collections/system_administrators/terraform/advanced/terraform_capacity_planning.md index 63c96ad..61b1d65 100644 --- a/collections/system_administrators/terraform/advanced/terraform_capacity_planning.md +++ b/collections/system_administrators/terraform/advanced/terraform_capacity_planning.md @@ -117,7 +117,7 @@ resource "grid_scheduler" "sched" { Here we define a `list` of requests, each request has a name and filter options e.g `cru`, `sru`, `mru`, `hru`, having `public_config` or not, `public_ips_count` for this deployment, whether or not this node should be `dedicated`, whether or not this node should be `distinct` from other nodes in this plannder, `farm_id` to search in, nodes to exlude from search in `node_exclude`, and whether or not this node should be `certified`. -The full docs for the capacity planner `scheduler` are found [here](https://github.com/threefoldtech/terraform-provider-grid/blob/development/docs/resources/scheduler.md) +The full docs for the capacity planner `scheduler` are found [here](scheduler.md) And after that in our code we can reference the grid_scheduler object with the request name to be used instead of node_id. diff --git a/collections/system_administrators/terraform/advanced/terraform_mariadb_synced_databases.md b/collections/system_administrators/terraform/advanced/terraform_mariadb_synced_databases.md index 2fe3394..bf911db 100644 --- a/collections/system_administrators/terraform/advanced/terraform_mariadb_synced_databases.md +++ b/collections/system_administrators/terraform/advanced/terraform_mariadb_synced_databases.md @@ -305,7 +305,7 @@ Note that, at any moment, if you want to see the information on your Terraform d ### SSH into the 3Nodes -* To [SSH into the 3Nodes](../../getstarted/ssh_guide/ssh_guide.md), write the following while making sure to set the proper IP address for each VM: +* To [SSH into the 3Nodes](ssh_guide.md), write the following while making sure to set the proper IP address for each VM: * ``` ssh root@3node_IPv4_Address ``` @@ -362,7 +362,7 @@ This should set everything properly. If you correctly receive the packets for the two VMs, you know that the VPN is properly set. -For more information on WireGuard, notably in relation to Windows, please read [this documentation](../../getstarted/ssh_guide/ssh_wireguard.md). +For more information on WireGuard, notably in relation to Windows, please read [this documentation](ssh_wireguard.md). diff --git a/collections/system_administrators/terraform/advanced/terraform_nextcloud_aio.md b/collections/system_administrators/terraform/advanced/terraform_nextcloud_aio.md index 16f3390..87dcf9b 100644 --- a/collections/system_administrators/terraform/advanced/terraform_nextcloud_aio.md +++ b/collections/system_administrators/terraform/advanced/terraform_nextcloud_aio.md @@ -20,7 +20,7 @@ We present a quick way to install Nextcloud All-in-One on the TFGrid. This guide ## Deploy a Full VM -* Deploy a Full VM with the [TF Dashboard](../../getstarted/ssh_guide/ssh_openssh.md) or [Terraform](../terraform_full_vm.md) +* Deploy a Full VM with the [TF Dashboard](ssh_openssh.md) or [Terraform](terraform_full_vm.md) * Minimum specs: * IPv4 Address * 2 vcores diff --git a/collections/system_administrators/terraform/advanced/terraform_nextcloud_redundant.md b/collections/system_administrators/terraform/advanced/terraform_nextcloud_redundant.md index 940a270..b052848 100644 --- a/collections/system_administrators/terraform/advanced/terraform_nextcloud_redundant.md +++ b/collections/system_administrators/terraform/advanced/terraform_nextcloud_redundant.md @@ -75,7 +75,7 @@ To get an overview of the whole process, we present the main steps: # Prerequisites -* [Install Terraform](../terraform_install.md) +* [Install Terraform](terraform_install.md) * [Install Wireguard](https://www.wireguard.com/install/) You need to download and install properly Terraform and Wireguard on your local computer. Simply follow the documentation depending on your operating system (Linux, MAC and Windows). @@ -320,7 +320,7 @@ After deployments, take note of the 3nodes' IPv4 address. You will need those ad ### SSH into the 3nodes -* To [SSH into the 3nodes](../../getstarted/ssh_guide/ssh_guide.md), write the following: +* To [SSH into the 3nodes](ssh_guide.md), write the following: * ``` ssh root@VM_IPv4_Address ``` @@ -343,7 +343,7 @@ After deployments, take note of the 3nodes' IPv4 address. You will need those ad We now want to ping the VMs using Wireguard. This will ensure the connection is properly established. -For more information on WireGuard, notably in relation to Windows, please read [this documentation](../../getstarted/ssh_guide/ssh_wireguard.md). +For more information on WireGuard, notably in relation to Windows, please read [this documentation](ssh_wireguard.md). First, we set Wireguard with the Terraform output. diff --git a/collections/system_administrators/terraform/advanced/terraform_nextcloud_single.md b/collections/system_administrators/terraform/advanced/terraform_nextcloud_single.md index 5ad8116..9c54dea 100644 --- a/collections/system_administrators/terraform/advanced/terraform_nextcloud_single.md +++ b/collections/system_administrators/terraform/advanced/terraform_nextcloud_single.md @@ -61,7 +61,7 @@ To get an overview of the whole process, we present the main steps: # Prerequisites -- [Install Terraform](../terraform_install.md) +- [Install Terraform](terraform_install.md) You need to download and install properly Terraform on your local computer. Simply follow the documentation depending on your operating system (Linux, MAC and Windows). @@ -262,7 +262,7 @@ After deployments, take note of the 3Node's IPv4 address. You will need this add ## SSH into the 3Node -* To [SSH into the 3Node](../../getstarted/ssh_guide/ssh_guide.md), write the following: +* To [SSH into the 3Node](ssh_guide.md), write the following: * ``` ssh root@VM_IPv4_Address ``` diff --git a/collections/system_administrators/terraform/advanced/terraform_nextcloud_toc.md b/collections/system_administrators/terraform/advanced/terraform_nextcloud_toc.md index 4152838..195f04e 100644 --- a/collections/system_administrators/terraform/advanced/terraform_nextcloud_toc.md +++ b/collections/system_administrators/terraform/advanced/terraform_nextcloud_toc.md @@ -4,7 +4,7 @@ We present here different Nextcloud deployments. While this section is focused o

Table of Contents

-- [Nextcloud All-in-One Deployment](./terraform_nextcloud_aio.md) -- [Nextcloud Single Deployment](./terraform_nextcloud_single.md) -- [Nextcloud Redundant Deployment](./terraform_nextcloud_redundant.md) -- [Nextcloud 2-Node VPN Deployment](./terraform_nextcloud_vpn.md) \ No newline at end of file +- [Nextcloud All-in-One Deployment](terraform_nextcloud_aio.md) +- [Nextcloud Single Deployment](terraform_nextcloud_single.md) +- [Nextcloud Redundant Deployment](terraform_nextcloud_redundant.md) +- [Nextcloud 2-Node VPN Deployment](terraform_nextcloud_vpn.md) \ No newline at end of file diff --git a/collections/system_administrators/terraform/advanced/terraform_nomad.md b/collections/system_administrators/terraform/advanced/terraform_nomad.md index debc309..13fbde5 100644 --- a/collections/system_administrators/terraform/advanced/terraform_nomad.md +++ b/collections/system_administrators/terraform/advanced/terraform_nomad.md @@ -42,7 +42,7 @@ Nomad's versatility extends beyond its user-friendliness. It seamlessly handles You need to download and install properly Terraform and Wireguard on your local computer. Simply follow the documentation depending on your operating system (Linux, MAC and Windows). -If you are new to Terraform, feel free to read this basic [Terraform Full VM guide](../terraform_full_vm.md) to get you started. +If you are new to Terraform, feel free to read this basic [Terraform Full VM guide](terraform_full_vm.md) to get you started. @@ -299,7 +299,7 @@ Note that the IP addresses will be shown under `Outputs` after running the comma ### SSH with the Planetary Network -* To [SSH with the Planetary network](../../getstarted/ssh_guide/ssh_openssh.md), write the following with the proper IP address +* To [SSH with the Planetary network](ssh_openssh.md), write the following with the proper IP address * ``` ssh root@planetary_ip ``` @@ -334,7 +334,7 @@ We are now ready to SSH into the client and server nodes with WireGuard. ssh root@wg_ip ``` -You now have an SSH connection access over WireGuard to the client and server nodes of your Nomad cluster. For more information on connecting with WireGuard, read [this documentation](../../getstarted/ssh_guide/ssh_wireguard.md). +You now have an SSH connection access over WireGuard to the client and server nodes of your Nomad cluster. For more information on connecting with WireGuard, read [this documentation](ssh_wireguard.md). diff --git a/collections/system_administrators/terraform/advanced/terraform_provider.md b/collections/system_administrators/terraform/advanced/terraform_provider.md index eafe66c..03ac574 100644 --- a/collections/system_administrators/terraform/advanced/terraform_provider.md +++ b/collections/system_administrators/terraform/advanced/terraform_provider.md @@ -49,5 +49,5 @@ The *_URL variables can be used to override the dafault urls associated with the ## Remarks - Grid terraform provider is hosted on terraform registry [here](https://registry.terraform.io/providers/threefoldtech/grid/latest/docs?pollNotifications=true) -- All provider input variables and their description can be found [here](https://github.com/threefoldtech/terraform-provider-grid/blob/development/docs/index.md) +- All provider input variables and their description can be found [here](index.md) - Capitalized environment variables can be used instead of writing them in the provider (e.g. MNEMONICS) diff --git a/collections/system_administrators/terraform/advanced/terraform_wireguard_ssh.md b/collections/system_administrators/terraform/advanced/terraform_wireguard_ssh.md index 174bc3a..b357ad1 100644 --- a/collections/system_administrators/terraform/advanced/terraform_wireguard_ssh.md +++ b/collections/system_administrators/terraform/advanced/terraform_wireguard_ssh.md @@ -22,7 +22,7 @@ In this ThreeFold Guide, we show how simple it is to deploy a micro VM on the Th ## Prerequisites -* [Install Terraform](../terraform_install.md) +* [Install Terraform](terraform_install.md) * [Install Wireguard](https://www.wireguard.com/install/) You need to download and install properly Terraform and Wireguard on your local computer. Simply follow the linked documentation depending on your operating system (Linux, MAC and Windows). @@ -220,7 +220,7 @@ Note that, at any moment, if you want to see the information on your Terraform d To set the Wireguard connection, on your local computer, you will need to take the Terraform `wg_config` output and create a `wg.conf` file in the directory: `/usr/local/etc/wireguard/wg.conf`. Note that the Terraform output starts and ends with EOT. -For more information on WireGuard, notably in relation to Windows, please read [this documentation](../../getstarted/ssh_guide/ssh_wireguard.md). +For more information on WireGuard, notably in relation to Windows, please read [this documentation](ssh_wireguard.md). * Create a file named `wg.conf` in the directory: `/usr/local/etc/wireguard/wg.conf`. * ``` diff --git a/collections/system_administrators/terraform/advanced/terraform_wireguard_vpn.md b/collections/system_administrators/terraform/advanced/terraform_wireguard_vpn.md index d8d27ea..7c6d3ef 100644 --- a/collections/system_administrators/terraform/advanced/terraform_wireguard_vpn.md +++ b/collections/system_administrators/terraform/advanced/terraform_wireguard_vpn.md @@ -23,7 +23,7 @@ Note that this concept can be extended with more than two micro VMs. Once you un ## Prerequisites -* [Install Terraform](../terraform_install.md) +* [Install Terraform](terraform_install.md) * [Install Wireguard](https://www.wireguard.com/install/) You need to download and install properly Terraform and Wireguard on your local computer. Simply follow the linked documentation depending on your operating system (Linux, MAC and Windows). @@ -276,7 +276,7 @@ Note that, at any moment, if you want to see the information on your Terraform d To set the Wireguard connection, on your local computer, you will need to take the terraform `wg_config` output and create a `wg.conf` file in the directory: `/usr/local/etc/wireguard/wg.conf`. Note that the Terraform output starts and ends with EOT. -For more information on WireGuard, notably in relation to Windows, please read [this documentation](../../getstarted/ssh_guide/ssh_wireguard.md). +For more information on WireGuard, notably in relation to Windows, please read [this documentation](ssh_wireguard.md). * Create a file named `wg.conf` in the directory: `/usr/local/etc/wireguard/wg.conf`. * ``` diff --git a/collections/system_administrators/terraform/resources/terraform_k8s.md b/collections/system_administrators/terraform/resources/terraform_k8s.md index 2b3f992..7f0f004 100644 --- a/collections/system_administrators/terraform/resources/terraform_k8s.md +++ b/collections/system_administrators/terraform/resources/terraform_k8s.md @@ -199,7 +199,7 @@ We will be mainly interested in the master node public ip `computed IP` and the ## More Info -A complete list of k8s resource parameters can be found [here](https://github.com/threefoldtech/terraform-provider-grid/blob/development/docs/resources/kubernetes.md). +A complete list of k8s resource parameters can be found [here](kubernetes.md). ## Demo Video diff --git a/collections/system_administrators/terraform/resources/terraform_qsfs.md b/collections/system_administrators/terraform/resources/terraform_qsfs.md index 3dcffc7..ff125ef 100644 --- a/collections/system_administrators/terraform/resources/terraform_qsfs.md +++ b/collections/system_administrators/terraform/resources/terraform_qsfs.md @@ -2,8 +2,8 @@

Table of Contents

-- [QSFS on Micro VM](./terraform_qsfs_on_microvm.md) -- [QSFS on Full VM](./terraform_qsfs_on_full_vm.md) +- [QSFS on Micro VM](terraform_qsfs_on_microvm.md) +- [QSFS on Full VM](terraform_qsfs_on_full_vm.md) *** diff --git a/collections/system_administrators/terraform/resources/terraform_qsfs_on_full_vm.md b/collections/system_administrators/terraform/resources/terraform_qsfs_on_full_vm.md index 8fe3628..d68973b 100644 --- a/collections/system_administrators/terraform/resources/terraform_qsfs_on_full_vm.md +++ b/collections/system_administrators/terraform/resources/terraform_qsfs_on_full_vm.md @@ -23,7 +23,7 @@ The main goal of this guide is to show you all the necessary steps to deploy a F ## Prerequisites -- [Install Terraform](../terraform_install.md) +- [Install Terraform](terraform_install.md) You need to download and install properly Terraform. Simply follow the documentation depending on your operating system (Linux, MAC and Windows). @@ -36,7 +36,7 @@ Deploying a FullVM is a bit different than deploying a MicroVM, let take a look - QSFS disk is based on `virtiofs`, and you can't use QSFS disk as the first mount in a FullVM, instead you need a regular disk. - Any extra disks/mounts will be available on the vm but unlike mounts on MicroVMs, extra disks won't be mounted automatically. you will need to mount it manually after the deployment. -Let modify the qsfs-on-microVM [example](./terraform_qsfs_on_microvm.md) to deploy a QSFS on FullVM this time: +Let modify the qsfs-on-microVM [example](terraform_qsfs_on_microvm.md) to deploy a QSFS on FullVM this time: - Inside the `grid_deployment` resource we will need to add a disk for the vm root fs. diff --git a/collections/system_administrators/terraform/resources/terraform_qsfs_on_microvm.md b/collections/system_administrators/terraform/resources/terraform_qsfs_on_microvm.md index 9b3a609..dcc2a18 100644 --- a/collections/system_administrators/terraform/resources/terraform_qsfs_on_microvm.md +++ b/collections/system_administrators/terraform/resources/terraform_qsfs_on_microvm.md @@ -23,7 +23,7 @@ In this ThreeFold Guide, we will learn how to deploy a Quantum Safe File System In this guide, we will be using Terraform to deploy a QSFS workload on a micro VM that runs on the TFGrid. Make sure to have the latest Terraform version. -- [Install Terraform](../terraform_install.md) +- [Install Terraform](terraform_install.md) diff --git a/collections/system_administrators/terraform/resources/terraform_resources_readme.md b/collections/system_administrators/terraform/resources/terraform_resources_readme.md index 6f11322..abf43bc 100644 --- a/collections/system_administrators/terraform/resources/terraform_resources_readme.md +++ b/collections/system_administrators/terraform/resources/terraform_resources_readme.md @@ -2,12 +2,12 @@

Table of Contents

-- [Using Scheduler](./terraform_scheduler.md) +- [Using Scheduler](terraform_scheduler.md) - [Virtual Machine](./terraform_vm.html) - [Web Gateway](./terraform_vm_gateway.html) - [Kubernetes Cluster](./terraform_k8s.html) - [ZDB](./terraform_zdb.html) -- [Quantum Safe Filesystem](./terraform_qsfs.md) - - [QSFS on Micro VM](./terraform_qsfs_on_microvm.md) - - [QSFS on Full VM](./terraform_qsfs_on_full_vm.md) +- [Quantum Safe Filesystem](terraform_qsfs.md) + - [QSFS on Micro VM](terraform_qsfs_on_microvm.md) + - [QSFS on Full VM](terraform_qsfs_on_full_vm.md) - [CapRover](./terraform_caprover.html) diff --git a/collections/system_administrators/terraform/resources/terraform_vm.md b/collections/system_administrators/terraform/resources/terraform_vm.md index 1b88f43..03ab0db 100644 --- a/collections/system_administrators/terraform/resources/terraform_vm.md +++ b/collections/system_administrators/terraform/resources/terraform_vm.md @@ -171,7 +171,7 @@ It's bit long for sure but let's try to dissect it a bit ## Which flists to use -see [list of flists](../../../developers/flist/grid3_supported_flists.md) +see [list of flists](grid3_supported_flists.md) ## Remark multiple VMs @@ -204,7 +204,7 @@ So to add a VM ``` - We give it a name within our deployment `vm1` -- `flist` is used to define the flist to run within the VM. Check the [list of flists](../../../developers/flist/grid3_supported_flists.md) +- `flist` is used to define the flist to run within the VM. Check the [list of flists](grid3_supported_flists.md) - `cpu` and `memory` are used to define the cpu and memory - `publicip` is usued to define if it requires a public IP or not - `entrypoint` is used define the entrypoint which in most of the cases in `/sbin/zinit init`, but in case of flists based on vms it can be specific to each flist diff --git a/collections/system_administrators/terraform/resources/terraform_vm_gateway.md b/collections/system_administrators/terraform/resources/terraform_vm_gateway.md index d7feb5d..d7dc709 100644 --- a/collections/system_administrators/terraform/resources/terraform_vm_gateway.md +++ b/collections/system_administrators/terraform/resources/terraform_vm_gateway.md @@ -15,7 +15,7 @@ In this section, we provide the basic information for a VM web gateway using Ter ## Expose with Prefix -A complete list of gateway name workload parameters can be found [here](https://github.com/threefoldtech/terraform-provider-grid/blob/development/docs/resources/name_proxy.md). +A complete list of gateway name workload parameters can be found [here](name_proxy.md). ``` terraform { @@ -93,7 +93,7 @@ Here ## Expose with Full Domain -A complete list of gateway fqdn workload parameters can be found [here](https://github.com/threefoldtech/terraform-provider-grid/blob/development/docs/resources/fqdn_proxy.md). +A complete list of gateway fqdn workload parameters can be found [here](fqdn_proxy.md). it is more like the above example the only difference is you need to create an `A record` on your name provider for `remote.omar.grid.tf` to gateway node `7` IPv4. diff --git a/collections/system_administrators/terraform/terraform_basics.md b/collections/system_administrators/terraform/terraform_basics.md index 4102d2a..9d6e34e 100644 --- a/collections/system_administrators/terraform/terraform_basics.md +++ b/collections/system_administrators/terraform/terraform_basics.md @@ -24,14 +24,14 @@ We cover some important aspects of Terraform deployments on the ThreeFold Grid. -For a complete guide on deploying a full VM on the TFGrid, read [this documentation](./terraform_full_vm.md). +For a complete guide on deploying a full VM on the TFGrid, read [this documentation](terraform_full_vm.md). ## Requirements Here are the requirements to use Terraform on the TFGrid: -- [Set your TFGrid account](../getstarted/tfgrid3_getstarted.md) -- [Install Terraform](../terraform/terraform_install.md) +- [Set your TFGrid account](tfgrid3_getstarted.md) +- [Install Terraform](terraform_install.md) ## Basic Commands @@ -48,7 +48,7 @@ Here are some very useful commands to use with Terraform: There are two options when it comes to finding a node to deploy on. You can use the scheduler or search for a node with the Nodes Explorer. -- Use the [scheduler](resources/terraform_scheduler.md) +- Use the [scheduler](terraform_scheduler.md) - Scheduler will help you find a node that matches your criteria - Use the Nodes Explorer - You can check the [Node Finder](dashboard@@node_finder) to know which nodes fits your deployment criteria. @@ -117,7 +117,7 @@ When writing the main file, you can decide to leave a variable content empty. In export NETWORK="..." ``` -For more info, consult the [Provider Manual](./advanced/terraform_provider.md). +For more info, consult the [Provider Manual](terraform_provider.md). ### Output Section @@ -184,4 +184,4 @@ This gives you the following benefits: ## Conclusion -This was a quick introduction to Terraform, for a complete guide, please read [this documentation](./terraform_full_vm.md). For advanced tutorials and deployments, read [this section](./advanced/terraform_advanced_readme.md). To learn more about the different resources to deploy with Terraform on the TFGrid, read [this section](./resources/terraform_resources_readme.md). \ No newline at end of file +This was a quick introduction to Terraform, for a complete guide, please read [this documentation](terraform_full_vm.md). For advanced tutorials and deployments, read [this section](terraform_advanced_readme.md). To learn more about the different resources to deploy with Terraform on the TFGrid, read [this section](terraform_resources_readme.md). \ No newline at end of file diff --git a/collections/system_administrators/terraform/terraform_full_vm.md b/collections/system_administrators/terraform/terraform_full_vm.md index 42ceee2..860fc76 100644 --- a/collections/system_administrators/terraform/terraform_full_vm.md +++ b/collections/system_administrators/terraform/terraform_full_vm.md @@ -42,7 +42,7 @@ Once this is done, initialize and apply Terraform to deploy your workload, then ## Prerequisites -- [Install Terraform](./terraform_install.md) +- [Install Terraform](terraform_install.md) You need to download and install properly Terraform. Simply follow the documentation depending on your operating system (Linux, MAC and Windows). @@ -58,7 +58,7 @@ We present two options to find a suitable node: the scheduler and the TFGrid Exp ### Using the Grid Scheduler -Using the TFGrid scheduler can be very efficient depending on what you are trying to achieve. To learn more about the scheduler, please refer to this [Scheduler Guide](resources/terraform_scheduler.md). +Using the TFGrid scheduler can be very efficient depending on what you are trying to achieve. To learn more about the scheduler, please refer to this [Scheduler Guide](terraform_scheduler.md). @@ -254,7 +254,7 @@ After deployments, take note of the 3Node' IPv4 address. You will need this addr ## SSH into the 3Node -- To [SSH into the 3Node](../getstarted/ssh_guide/ssh_guide.md), write the following: +- To [SSH into the 3Node](ssh_guide.md), write the following: - ``` ssh root@VM_IPv4_Address ``` diff --git a/collections/system_administrators/terraform/terraform_get_started.md b/collections/system_administrators/terraform/terraform_get_started.md index a4693da..98036cd 100644 --- a/collections/system_administrators/terraform/terraform_get_started.md +++ b/collections/system_administrators/terraform/terraform_get_started.md @@ -56,7 +56,7 @@ export NETWORK="....." ``` -For more info see [Provider Manual](./advanced/terraform_provider.md) +For more info see [Provider Manual](terraform_provider.md) ### output section @@ -84,4 +84,4 @@ Output parameters show what has been done: ### Which flists to use in VM -see [list of flists](../manual3_iac/grid3_supported_flists.md) +see [list of flists](grid3_supported_flists.md) diff --git a/collections/system_administrators/terraform/terraform_toc.md b/collections/system_administrators/terraform/terraform_toc.md index 15a7c78..dbccb0c 100644 --- a/collections/system_administrators/terraform/terraform_toc.md +++ b/collections/system_administrators/terraform/terraform_toc.md @@ -2,33 +2,33 @@

Table of Contents

-- [Overview](./terraform_readme.md) -- [Installing Terraform](./terraform_install.md) -- [Terraform Basics](./terraform_basics.md) -- [Full VM Deployment](./terraform_full_vm.md) -- [GPU Support](./terraform_gpu_support.md) -- [Resources](./resources/terraform_resources_readme.md) - - [Using Scheduler](./resources/terraform_scheduler.md) - - [Virtual Machine](./resources/terraform_vm.md) - - [Web Gateway](./resources/terraform_vm_gateway.md) - - [Kubernetes Cluster](./resources/terraform_k8s.md) - - [ZDB](./resources/terraform_zdb.md) - - [Quantum Safe Filesystem](./resources/terraform_qsfs.md) -- [QSFS on Micro VM](./resources/terraform_qsfs_on_microvm.md) -- [QSFS on Full VM](./resources/terraform_qsfs_on_full_vm.md) - - [CapRover](./resources/terraform_caprover.md) -- [Advanced](./advanced/terraform_advanced_readme.md) - - [Terraform Provider](./advanced/terraform_provider.md) - - [Terraform Provisioners](./advanced/terraform_provisioners.md) - - [Mounts](./advanced/terraform_mounts.md) - - [Capacity Planning](./advanced/terraform_capacity_planning.md) - - [Updates](./advanced/terraform_updates.md) - - [SSH Connection with Wireguard](./advanced/terraform_wireguard_ssh.md) - - [Set a Wireguard VPN](./advanced/terraform_wireguard_vpn.md) - - [Synced MariaDB Databases](./advanced/terraform_mariadb_synced_databases.md) - - [Nomad](./advanced/terraform_nomad.md) - - [Nextcloud Deployments](./advanced/terraform_nextcloud_toc.md) - - [Nextcloud All-in-One Deployment](./advanced/terraform_nextcloud_aio.md) - - [Nextcloud Single Deployment](./advanced/terraform_nextcloud_single.md) - - [Nextcloud Redundant Deployment](./advanced/terraform_nextcloud_redundant.md) - - [Nextcloud 2-Node VPN Deployment](./advanced/terraform_nextcloud_vpn.md) \ No newline at end of file +- [Overview](terraform_readme.md) +- [Installing Terraform](terraform_install.md) +- [Terraform Basics](terraform_basics.md) +- [Full VM Deployment](terraform_full_vm.md) +- [GPU Support](terraform_gpu_support.md) +- [Resources](terraform_resources_readme.md) + - [Using Scheduler](terraform_scheduler.md) + - [Virtual Machine](terraform_vm.md) + - [Web Gateway](terraform_vm_gateway.md) + - [Kubernetes Cluster](terraform_k8s.md) + - [ZDB](terraform_zdb.md) + - [Quantum Safe Filesystem](terraform_qsfs.md) +- [QSFS on Micro VM](terraform_qsfs_on_microvm.md) +- [QSFS on Full VM](terraform_qsfs_on_full_vm.md) + - [CapRover](terraform_caprover.md) +- [Advanced](terraform_advanced_readme.md) + - [Terraform Provider](terraform_provider.md) + - [Terraform Provisioners](terraform_provisioners.md) + - [Mounts](terraform_mounts.md) + - [Capacity Planning](terraform_capacity_planning.md) + - [Updates](terraform_updates.md) + - [SSH Connection with Wireguard](terraform_wireguard_ssh.md) + - [Set a Wireguard VPN](terraform_wireguard_vpn.md) + - [Synced MariaDB Databases](terraform_mariadb_synced_databases.md) + - [Nomad](terraform_nomad.md) + - [Nextcloud Deployments](terraform_nextcloud_toc.md) + - [Nextcloud All-in-One Deployment](terraform_nextcloud_aio.md) + - [Nextcloud Single Deployment](terraform_nextcloud_single.md) + - [Nextcloud Redundant Deployment](terraform_nextcloud_redundant.md) + - [Nextcloud 2-Node VPN Deployment](terraform_nextcloud_vpn.md) \ No newline at end of file diff --git a/collections/tech/innovations/key_innovations_overview.md b/collections/tech/innovations/key_innovations_overview.md index 20c07b3..5ee8c07 100644 --- a/collections/tech/innovations/key_innovations_overview.md +++ b/collections/tech/innovations/key_innovations_overview.md @@ -1,15 +1,15 @@ -

Key Innovations

- -Throughout the years, we've built innovative products that are now part of a whole ecosystem. - -![](dream_comes_true.png) - -

Table of Contents

- -- [Mycelium: a new network layer for the internet](mycelium_innovation.md) -- [Zero-OS: a minimalistic and more efficient server operating system](zos_innovation) -- [Quantum Safe Storage](zstor_innovation.md) -- [Quantum Safe Filesystem](qsfs_innovation.md) -- [FList: a new way to deal with OS Images](flist_innovation.md) -- [FungiStor](fungistor_innovation.md) +

Key Innovations

+ +Throughout the years, we've built innovative products that are now part of a whole ecosystem. + +![](dream_comes_true.png) + +

Table of Contents

+ +- [Mycelium: a new network layer for the internet](mycelium_innovation.md) +- [Zero-OS: a minimalistic and more efficient server operating system](zos_innovation) +- [Quantum Safe Storage](zstor_innovation.md) +- [Quantum Safe Filesystem](qsfs_innovation.md) +- [FList: a new way to deal with OS Images](flist_innovation.md) +- [FungiStor](fungistor_innovation.md) - [Network Wall](network_wall_innovation.md) \ No newline at end of file diff --git a/collections/tech/innovations/mycelium_innovation_short.md b/collections/tech/innovations/mycelium_innovation_short.md index c982d6d..9b58836 100644 --- a/collections/tech/innovations/mycelium_innovation_short.md +++ b/collections/tech/innovations/mycelium_innovation_short.md @@ -1,25 +1,25 @@ - -### The Problem - -The current centralized state of the internet poses significant security risks, with compromised routers and growing cyber threats (trillions of USD per year now), making everyone vulnerable to hacking. Industry responses involve disabling original features, hindering true peer-to-peer connectivity and personal server capabilities. Workarounds and system hacks have become the norm. - -**Our Internet is seriously broken. We need new ways to communicate** - -### Introducing Mycelium - -Mycelium is an overlay network layer designed to enhance the existing internet infrastructure while remaining compatible with all current applications. It empowers true peer-to-peer communication. By installing a Network Agent on your device, you gain the ability to securely connect with any other participant on this network. Mycelium intelligently reroutes traffic to maintain connectivity taking location of you and your peer into consideration. - -### The Benefits - -- **Continuous connectivity:** Mycelium ensures uninterrupted connectivity by dynamically rerouting traffic through available connections (friends, satellites, 4/5G, fiber). -- **End-to-end encryption:** robust encryption stops man-in-the-middle attacks, guaranteeing secure communication. -- **Proof of authenticity ([POA](p2p:poa.md))**: ensures that we know who we are communicating with -- **Optimized routing:** Mycelium finds the shortest path between network participants, reducing latency and keeping traffic localized. -- **Universal server capability:** empowers individuals to act as servers, a foundational element for any peer-to-peer system. -- **Full Compatibility:** Mycelium seamlessly integrates with the current internet, supporting any application. -- **Impressive speed:** achieves 1 Gbps per Network Agent, ensuring rapid data transfer. - -### Status - -In beta and usable from TFGrid 3.13, its our 3e generation approach to networking and took us years to do. We are looking forward to your feedback. - + +### The Problem + +The current centralized state of the internet poses significant security risks, with compromised routers and growing cyber threats (trillions of USD per year now), making everyone vulnerable to hacking. Industry responses involve disabling original features, hindering true peer-to-peer connectivity and personal server capabilities. Workarounds and system hacks have become the norm. + +**Our Internet is seriously broken. We need new ways to communicate** + +### Introducing Mycelium + +Mycelium is an overlay network layer designed to enhance the existing internet infrastructure while remaining compatible with all current applications. It empowers true peer-to-peer communication. By installing a Network Agent on your device, you gain the ability to securely connect with any other participant on this network. Mycelium intelligently reroutes traffic to maintain connectivity taking location of you and your peer into consideration. + +### The Benefits + +- **Continuous connectivity:** Mycelium ensures uninterrupted connectivity by dynamically rerouting traffic through available connections (friends, satellites, 4/5G, fiber). +- **End-to-end encryption:** robust encryption stops man-in-the-middle attacks, guaranteeing secure communication. +- **Proof of authenticity ([POA](p2p:poa.md))**: ensures that we know who we are communicating with +- **Optimized routing:** Mycelium finds the shortest path between network participants, reducing latency and keeping traffic localized. +- **Universal server capability:** empowers individuals to act as servers, a foundational element for any peer-to-peer system. +- **Full Compatibility:** Mycelium seamlessly integrates with the current internet, supporting any application. +- **Impressive speed:** achieves 1 Gbps per Network Agent, ensuring rapid data transfer. + +### Status + +In beta and usable from TFGrid 3.13, its our 3e generation approach to networking and took us years to do. We are looking forward to your feedback. + diff --git a/collections/tech/primitives/primitives.md b/collections/tech/primitives/primitives.md index e83845e..8769ba2 100644 --- a/collections/tech/primitives/primitives.md +++ b/collections/tech/primitives/primitives.md @@ -9,35 +9,35 @@ Any application which can run on linux can run on the TFGrid. ### Compute (uses CU) -- [ZKube](compute/zkube.md) +- [ZKube](zkube.md) - kubernetes deployment -- [ZMachine](compute/zmachine.md) +- [ZMachine](zmachine.md) - the container or virtual machine running inside ZOS -- [CoreX](compute/corex.md) +- [CoreX](corex.md) - process manager (optional), can be used to get remote access to your zmachine A 3Node is a Zero-OS enabled computer which is hosted by any cloud operator. ### There are 4 storage mechanisms which can be used to store your data: -- [ZOS FS](storage/zos_fs.md) +- [ZOS FS](zos_fs.md) - is our dedupe unique filesystem, replaces docker images -- [ZOS Mount](storage/zmount.md) +- [ZOS Mount](zmount.md) - is a mounted disk location on SSD, this can be used as faster storage location -- [Quamtum Safe Filesystem](../qsss/qss_filesystem.md) +- [Quamtum Safe Filesystem](qss_filesystem.md) - this is a super unique storage system, data can never be lost or corrupted. Please be reminded that this storage layer is only meant to be used for secondary storage applications -- [ZOS Disk](storage/zdisk.md) +- [ZOS Disk](zdisk.md) - a virtual disk technology, only for TFTech OEM partners ### There are 4 ways how networks can be connected to a Z-Machine. -- [Planetary network](network/planetary_network.md): +- [Planetary network](planetary_network.md): - is a planetary scalable network, we have clients for windows, osx, android and iphone -- [ZOS Net](network/znet.md): +- [ZOS Net](znet.md): - is a fast end2end encrypted network technology, keep your traffic between your z_machines 100% private -- [ZOS NIC](network/znic.md): +- [ZOS NIC](znic.md): - connection to a public ipaddress -- [WEB GW](network/webgw.md): +- [WEB GW](webgw.md): - web gateway, a secure way to allow internet traffic reach your secure Z-Machine. diff --git a/collections/tech/primitives/storage/qsfs.md b/collections/tech/primitives/storage/qsfs.md index b596424..08b160e 100644 --- a/collections/tech/primitives/storage/qsfs.md +++ b/collections/tech/primitives/storage/qsfs.md @@ -23,7 +23,7 @@ presents itself as a filesystem to the ZMachine. see how its implemented in: -- [Quantum Safe Storage](../../qsss/qsss_home.md) -- [Quantum Safe Filesystem](../../qsss/qss_filesystem.md) -- [Quantum Safe Algo](../../qsss/qss_algorithm.md) +- [Quantum Safe Storage](qsss_home.md) +- [Quantum Safe Filesystem](qss_filesystem.md) +- [Quantum Safe Algo](qss_algorithm.md) diff --git a/collections/tech/primitives/storage/storage.md b/collections/tech/primitives/storage/storage.md index e8dec2e..488113e 100644 --- a/collections/tech/primitives/storage/storage.md +++ b/collections/tech/primitives/storage/storage.md @@ -6,4 +6,4 @@ - [Zero-DB](zdb.md) : the lowest level storage primitive, is a key value stor, used underneath other storage mechanisms typically - [Zero-Disk](zdisk.md) : OEM only, virtual disk format -Uses [Storage Units = SU](../../../grid/concepts/cloudunits.md). \ No newline at end of file +Uses [Storage Units = SU](cloudunits.md). \ No newline at end of file diff --git a/collections/tech/technology_toc.md b/collections/tech/technology_toc.md index 53db78c..b8085da 100644 --- a/collections/tech/technology_toc.md +++ b/collections/tech/technology_toc.md @@ -6,32 +6,32 @@ To build on the ThreeFold Grid, refer to the [Developers](developers@@developers

Table of Contents

-- [Introduction](tech/technology.md) -- [The Internet Today](tech/internet_today.md) - - [History of Computers](tech/history/c64.md) - - [Too Many Layers](tech/history/layers.md) -- [The Internet Re-invented](tech/how_does_it_work.md) - - [World Records](tech/world_records.md) -- [Key Innovations](tech/key_innovations_overview.md) - - [Mycelium Network](tech/mycelium_innovation.md) - - [Zero-OS](tech/zos_innovation.md) - - [Quantum Safe Storage](tech/zstor_innovation.md) - - [Quantum Safe Filesystem](tech/qsfs_innovation.md) - - [FList: Better OS Images](tech/flist_innovation.md) - - [FungiStor](tech/fungistor_innovation.md) - - [Network Wall](tech/network_wall_innovation.md) -- [Architecture](tech/architecture.md) -- [Energy Efficient](tech/energy_efficient.md) -- [Decentralized Cloud Core Capabilities](tech/features.md) - - [Storage](tech/qsss_home.md) - - [Quantum Safe Storage Algo](tech/qss_algorithm.md) - - [Zero Knowledge proof](tech/qss_zero_knowledge_proof.md) - - [NFT Storage](tech/nft_storage.md) +- [Introduction](technology.md) +- [The Internet Today](internet_today.md) + - [History of Computers](c64.md) + - [Too Many Layers](layers.md) +- [The Internet Re-invented](how_does_it_work.md) + - [World Records](world_records.md) +- [Key Innovations](key_innovations_overview.md) + - [Mycelium Network](mycelium_innovation.md) + - [Zero-OS](zos_innovation.md) + - [Quantum Safe Storage](zstor_innovation.md) + - [Quantum Safe Filesystem](qsfs_innovation.md) + - [FList: Better OS Images](flist_innovation.md) + - [FungiStor](fungistor_innovation.md) + - [Network Wall](network_wall_innovation.md) +- [Architecture](architecture.md) +- [Energy Efficient](energy_efficient.md) +- [Decentralized Cloud Core Capabilities](features.md) + - [Storage](qsss_home.md) + - [Quantum Safe Storage Algo](qss_algorithm.md) + - [Zero Knowledge proof](qss_zero_knowledge_proof.md) + - [NFT Storage](nft_storage.md) - [S3 Storage](tech/s3_interface) - - [File System](tech/qss_filesystem.md) - - [Network](tech/networking.md) - - [Mycelium](tech/mycelium.md) - - [Web Gateway](tech/webgw.md) + - [File System](qss_filesystem.md) + - [Network](networking.md) + - [Mycelium](mycelium.md) + - [Web Gateway](webgw.md) - [Partners Utilization](partners_utilization@@partners) - [Sikana](partners_utilization@@sikana) - [Vindo](partners_utilization@@vindo) diff --git a/collections/tech/zos/benefits/unbreakable_storage.md b/collections/tech/zos/benefits/unbreakable_storage.md index e06e85c..69ba1de 100644 --- a/collections/tech/zos/benefits/unbreakable_storage.md +++ b/collections/tech/zos/benefits/unbreakable_storage.md @@ -13,7 +13,7 @@ If you deploy a container with simple disk access, you don’t have it. Performance is around 50MB/second, if a bit more CPU is given for the distributed storage encoder, we achieve this performance. -More info see [Quantum Safe Storage](../../qsss/qsss_home.md). +More info see [Quantum Safe Storage](qsss_home.md).