diff --git a/README.md b/README.md index f86b00c..cf4b941 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,47 @@ -# INFO for TFGrid +

TFGrid Docs

-> todo: kristof some content does not belong here, move to other repo +

Table of Contents

-## To preview new changes on local browser +- [Overview](#overview) +- [Basic Hero mdBook Commands](#basic-hero-mdbook-commands) +- [Install and Use Hero](#install-and-use-hero) +- [Create a New mdBook](#create-a-new-mdbook) +- [Notes for Repo Owners](#notes-for-repo-owners) -1. Pull new changes from local +## Overview -(please make sure commit / save your local changes first ) +This repository contains TFGrid docs in the form of mdbooks generated with the [Hero](https://github.com/freeflowuniverse/crystallib/tree/development/cli/hero) tool. -hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/nameofyourbook -gp +To see the whole list of books, check the [heroscript directory](https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript). -2. Build the book locally +## Basic Hero mdBook Commands -hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/nameofyourbook +Once Hero is set on your machine, you can run the following commands to preview mdbooks on your local browser: -3. Preview on web browser +- Pull new changes + ``` + hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/nameofyourbook -gp + ``` -hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/nameofyourbook -o \ No newline at end of file +- Build the book + ``` + hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/nameofyourbook + ``` +- Preview on a web browser + ``` + hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/nameofyourbook -o + ``` + +> Note: You can use -p instead of -u and set a path to your heroscript directory, as explained in the [docs](https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/docs). + +## Install and Use Hero + +To install and use Hero on a full VM running on the grid, read the [full VM guide](https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/docs/hero_mdbook_fullvm.md). + +## Create a New mdBook + +To create a new mdbook, read the [mdbook creation guide](https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/docs/hero_create_mdbook.md). + +## Notes for Repo Owners + +> todo: kristof some content does not belong here, move to other repo \ No newline at end of file diff --git a/books/new_mdbook/SUMMARY.md b/books/new_mdbook/SUMMARY.md new file mode 100644 index 0000000..f1b73f3 --- /dev/null +++ b/books/new_mdbook/SUMMARY.md @@ -0,0 +1,2 @@ +- [Example 1](new_mdbook/new_mdbook_example1.md) +- [Example 2](new_mdbook/new_mdbook_example2.md) \ No newline at end of file diff --git a/books/tfmanual/SUMMARY.md b/books/tfmanual/SUMMARY.md new file mode 100644 index 0000000..25fee32 --- /dev/null +++ b/books/tfmanual/SUMMARY.md @@ -0,0 +1,379 @@ +- [Introduction](intro/intro_readme.md) +- [Documentation](documentation/documentation.md) + - [Dashboard](documentation/dashboard/dashboard.md) + - [Wallet Connector](documentation/dashboard/wallet_connector.md) + - [TFGrid](documentation/dashboard/tfgrid/tfgrid.md) + - [Grid Status](documentation/dashboard/tfgrid/grid_status.md) + - [Node Statistics](documentation/dashboard/tfgrid/node_statistics.md) + - [Node Monitoring](documentation/dashboard/tfgrid/node_monitoring.md) + - [Deploy](documentation/dashboard/deploy/deploy.md) + - [Pricing Calculator](documentation/dashboard/deploy/pricing_calculator.md) + - [Node Finder](documentation/dashboard/deploy/node_finder.md) + - [Virtual Machines](documentation/dashboard/solutions/vm_intro.md) + - [Micro and Full VM Differences ](documentation/dashboard/solutions/vm_differences.md) + - [Full Virtual Machine](documentation/dashboard/solutions/fullVm.md) + - [Micro Virtual Machine](documentation/dashboard/solutions/vm.md) + - [Nixos MicroVM](documentation/dashboard/solutions/nixos_micro.md) + - [Add a Domain](documentation/dashboard/solutions/add_domain.md) + - [Orchestrators](documentation/dashboard/deploy/orchestrators.md) + - [Kubernetes](documentation/dashboard/solutions/k8s.md) + - [Caprover](documentation/dashboard/solutions/caprover.md) + - [Caprover Admin](documentation/dashboard/solutions/caprover_admin.md) + - [Caprover Worker](documentation/dashboard/solutions/caprover_worker.md) + - [Dedicated Machines](documentation/dashboard/deploy/dedicated_machines.md) + - [Applications](documentation/dashboard/deploy/applications.md) + - [Algorand](documentation/dashboard/solutions/algorand.md) + - [CasperLabs](documentation/dashboard/solutions/casper.md) + - [Discourse](documentation/dashboard/solutions/discourse.md) + - [Funkwhale](documentation/dashboard/solutions/funkwhale.md) + - [Mattermost](documentation/dashboard/solutions/mattermost.md) + - [Nextcloud](documentation/dashboard/solutions/nextcloud.md) + - [Node Pilot](documentation/dashboard/solutions/nodepilot.md) + - [ownCloud](documentation/dashboard/solutions/owncloud.md) + - [Peertube](documentation/dashboard/solutions/peertube.md) + - [Presearch](documentation/dashboard/solutions/presearch.md) + - [Subsquid](documentation/dashboard/solutions/subsquid.md) + - [Taiga](documentation/dashboard/solutions/taiga.md) + - [Umbrel](documentation/dashboard/solutions/umbrel.md) + - [WordPress](documentation/dashboard/solutions/wordpress.md) + - [Your Contracts](documentation/dashboard/deploy/your_contracts.md) + - [Images](documentation/dashboard/deploy/images.md) + - [SSH Keys](documentation/dashboard/deploy/ssh_keys.md) + - [Farms](documentation/dashboard/farms/farms.md) + - [Your Farms](documentation/dashboard/farms/your_farms.md) + - [Farm Finder](documentation/dashboard/farms/farms_finder.md) + - [Node Installer](documentation/dashboard/farms/node_installer.md) + - [Simulator](documentation/dashboard/farms/simulator.md) + - [TFChain](documentation/dashboard/tfchain/tfchain.md) + - [Your Profile](documentation/dashboard/tfchain/your_profile.md) + - [TF DAO](documentation/dashboard/tfchain/tf_dao.md) + - [TF Token Bridge](documentation/dashboard/tfchain/tf_token_bridge.md) + - [TF Token Transfer](documentation/dashboard/tfchain/tf_token_transfer.md) + - [TF Minting Reports](documentation/dashboard/tfchain/tf_minting_reports.md) + - [Developers](documentation/developers/developers.md) + - [Javascript Client](documentation/developers/javascript/grid3_javascript_readme.md) + - [Installation](documentation/developers/javascript/grid3_javascript_installation.md) + - [Loading Client](documentation/developers/javascript/grid3_javascript_loadclient.md) + - [Deploy a VM](documentation/developers/javascript/grid3_javascript_vm.md) + - [Capacity Planning](documentation/developers/javascript/grid3_javascript_capacity_planning.md) + - [Deploy Multiple VMs](documentation/developers/javascript/grid3_javascript_vms.md) + - [Deploy CapRover](documentation/developers/javascript/grid3_javascript_caprover.md) + - [Gateways](documentation/developers/javascript/grid3_javascript_vm_gateways.md) + - [Deploy a Kubernetes Cluster](documentation/developers/javascript/grid3_javascript_kubernetes.md) + - [Deploy a ZDB](documentation/developers/javascript/grid3_javascript_zdb.md) + - [Deploy ZDBs for QSFS](documentation/developers/javascript/grid3_javascript_qsfs_zdbs.md) + - [QSFS](documentation/developers/javascript/grid3_javascript_qsfs.md) + - [Key Value Store](documentation/developers/javascript/grid3_javascript_kvstore.md) + - [VM with Wireguard and Gateway](documentation/developers/javascript/grid3_wireguard_gateway.md) + - [GPU Support](documentation/developers/javascript/grid3_javascript_gpu_support.md) + - [Go Client](documentation/developers/go/grid3_go_readme.md) + - [Installation](documentation/developers/go/grid3_go_installation.md) + - [Loading Client](documentation/developers/go/grid3_go_load_client.md) + - [Deploy a VM](documentation/developers/go/grid3_go_vm.md) + - [Deploy Multiple VMs](documentation/developers/go/grid3_go_vms.md) + - [Deploy Gateways](documentation/developers/go/grid3_go_gateways.md) + - [Deploy Kubernetes](documentation/developers/go/grid3_go_kubernetes.md) + - [Deploy a QSFS](documentation/developers/go/grid3_go_qsfs.md) + - [GPU and Go](documentation/developers/go/grid3_go_gpu.md) + - [GPU Support](documentation/developers/go/grid3_go_gpu_support.md) + - [Deploy a VM with GPU](documentation/developers/go/grid3_go_vm_with_gpu.md) + - [TFCMD](documentation/developers/tfcmd/tfcmd.md) + - [Getting Started](documentation/developers/tfcmd/tfcmd_basics.md) + - [Deploy a VM](documentation/developers/tfcmd/tfcmd_vm.md) + - [Deploy Kubernetes](documentation/developers/tfcmd/tfcmd_kubernetes.md) + - [Deploy ZDB](documentation/developers/tfcmd/tfcmd_zdbs.md) + - [Gateway FQDN](documentation/developers/tfcmd/tfcmd_gateway_fqdn.md) + - [Gateway Name](documentation/developers/tfcmd/tfcmd_gateway_name.md) + - [Contracts](documentation/developers/tfcmd/tfcmd_contracts.md) + - [TFROBOT](documentation/developers/tfrobot/tfrobot.md) + - [Installation](documentation/developers/tfrobot/tfrobot_installation.md) + - [Configuration File](documentation/developers/tfrobot/tfrobot_config.md) + - [Deployment](documentation/developers/tfrobot/tfrobot_deploy.md) + - [Commands and Flags](documentation/developers/tfrobot/tfrobot_commands_flags.md) + - [Supported Configurations](documentation/developers/tfrobot/tfrobot_configurations.md) + - [ThreeFold Chain](documentation/developers/tfchain/tfchain.md) + - [Introduction](documentation/developers/tfchain/introduction.md) + - [Farming Policies](documentation/developers/tfchain/farming_policies.md) + - [External Service Contract](documentation/developers/tfchain/tfchain_external_service_contract.md) + - [Solution Provider](documentation/developers/tfchain/tfchain_solution_provider.md) + - [Grid Proxy](documentation/developers/proxy/proxy_readme.md) + - [Introducing Grid Proxy](documentation/developers/proxy/proxy.md) + - [Setup](documentation/developers/proxy/setup.md) + - [DB Testing](documentation/developers/proxy/db_testing.md) + - [Commands](documentation/developers/proxy/commands.md) + - [Contributions](documentation/developers/proxy/contributions.md) + - [Explorer](documentation/developers/proxy/explorer.md) + - [Database](documentation/developers/proxy/database.md) + - [Production](documentation/developers/proxy/production.md) + - [Release](documentation/developers/proxy/release.md) + - [Flist](documentation/developers/flist/flist.md) + - [Zero-OS Hub](documentation/developers/flist/flist_hub/zos_hub.md) + - [Generate an API Token](documentation/developers/flist/flist_hub/api_token.md) + - [Convert Docker Image Into Flist](documentation/developers/flist/flist_hub/convert_docker_image.md) + - [Supported Flists](documentation/developers/flist/grid3_supported_flists.md) + - [Flist Case Studies](documentation/developers/flist/flist_case_studies/flist_case_studies.md) + - [Case Study: Debian 12](documentation/developers/flist/flist_case_studies/flist_debian_case_study.md) + - [Case Study: Nextcloud AIO](documentation/developers/flist/flist_case_studies/flist_nextcloud_case_study.md) + - [Internals](documentation/developers/internals/internals.md) + - [Reliable Message Bus (RMB)](documentation/developers/internals/rmb/rmb_toc.md) + - [Introduction to RMB](documentation/developers/internals/rmb/rmb_intro.md) + - [RMB Specs](documentation/developers/internals/rmb/rmb_specs.md) + - [RMB Peer](documentation/developers/internals/rmb/uml/peer.md) + - [RMB Relay](documentation/developers/internals/rmb/uml/relay.md) + - [Zero-OS](documentation/developers/internals/zos/readme.md) + - [Manual](documentation/developers/internals/zos/manual/manual.md) + - [Workload Types](documentation/developers/internals/zos/manual/workload_types.md) + - [Internal Modules](documentation/developers/internals/zos/internals/internals.md) + - [Identity](documentation/developers/internals/zos/internals/identity/readme.md) + - [Node ID Generation](documentation/developers/internals/zos/internals/identity/identity.md) + - [Node Upgrade](documentation/developers/internals/zos/internals/identity/upgrade.md) + - [Node](documentation/developers/internals/zos/internals/node/readme.md) + - [Storage](documentation/developers/internals/zos/internals/storage/readme.md) + - [Network](documentation/developers/internals/zos/internals/network/readme.md) + - [Introduction](documentation/developers/internals/zos/internals/network/introduction.md) + - [Definitions](documentation/developers/internals/zos/internals/network/definitions.md) + - [Mesh](documentation/developers/internals/zos/internals/network/mesh.md) + - [Setup](documentation/developers/internals/zos/internals/network/setup_farm_network.md) + - [Flist](documentation/developers/internals/zos/internals/flist/readme.md) + - [Container](documentation/developers/internals/zos/internals/container/readme.md) + - [VM](documentation/developers/internals/zos/internals/vmd/readme.md) + - [Provision](documentation/developers/internals/zos/internals/provision/readme.md) + - [Capacity](documentation/developers/internals/zos/internals/capacity.md) + - [Performance Monitor Package](documentation/developers/internals/zos/performance/performance.md) + - [Public IPs Validation Task](documentation/developers/internals/zos/performance/publicips.md) + - [CPUBenchmark](documentation/developers/internals/zos/performance/cpubench.md) + - [IPerf](documentation/developers/internals/zos/performance/iperf.md) + - [Health Check](documentation/developers/internals/zos/performance/healthcheck.md) + - [API](documentation/developers/internals/zos/manual/api.md) + - [Grid Deployment](documentation/developers/grid_deployment/grid_deployment.md) + - [TFGrid Stacks](documentation/developers/grid_deployment/tfgrid_stacks.md) + - [Full VM Grid Deployment](documentation/developers/grid_deployment/grid_deployment_full_vm.md) + - [Grid Snapshots](documentation/developers/grid_deployment/snapshots.md) + - [Farmers](documentation/farmers/farmers.md) + - [Build a 3Node](documentation/farmers/3node_building/3node_building.md) + - [1. Create a Farm](documentation/farmers/3node_building/1_create_farm.md) + - [2. Create a Zero-OS Bootstrap Image](documentation/farmers/3node_building/2_bootstrap_image.md) + - [3. Set the Hardware](documentation/farmers/3node_building/3_set_hardware.md) + - [4. Wipe All the Disks](documentation/farmers/3node_building/4_wipe_all_disks.md) + - [5. Set the BIOS/UEFI](documentation/farmers/3node_building/5_set_bios_uefi.md) + - [6. Boot the 3Node](documentation/farmers/3node_building/6_boot_3node.md) + - [Farming Optimization](documentation/farmers/farming_optimization/farming_optimization.md) + - [GPU Farming](documentation/farmers/3node_building/gpu_farming.md) + - [Set Additional Fees](documentation/farmers/farming_optimization/set_additional_fees.md) + - [Minting Receipts](documentation/farmers/3node_building/minting_receipts.md) + - [Minting Periods](documentation/farmers/farming_optimization/minting_periods.md) + - [Room Parameters](documentation/farmers/farming_optimization/farm_room_parameters.md) + - [Farming Costs](documentation/farmers/farming_optimization/farming_costs.md) + - [Calculate Your ROI](documentation/farmers/farming_optimization/calculate_roi.md) + - [Advanced Networking](documentation/farmers/advanced_networking/advanced_networking_toc.md) + - [Networking Overview](documentation/farmers/advanced_networking/networking_overview.md) + - [Network Considerations](documentation/farmers/advanced_networking/network_considerations.md) + - [Network Setup](documentation/farmers/advanced_networking/network_setup.md) + - [Farmerbot](documentation/farmers/farmerbot/farmerbot_intro.md) + - [Quick Guide](documentation/farmers/farmerbot/farmerbot_quick.md) + - [Additional Information](documentation/farmers/farmerbot/farmerbot_information.md) + - [Minting and the Farmerbot](documentation/farmers/farmerbot/farmerbot_minting.md) + - [System Administrators](documentation/system_administrators/system_administrators.md) + - [Getting Started](documentation/system_administrators/getstarted/tfgrid3_getstarted.md) + - [SSH Remote Connection](documentation/system_administrators/getstarted/ssh_guide/ssh_guide.md) + - [SSH with OpenSSH](documentation/system_administrators/getstarted/ssh_guide/ssh_openssh.md) + - [SSH with PuTTY](documentation/system_administrators/getstarted/ssh_guide/ssh_putty.md) + - [SSH with WSL](documentation/system_administrators/getstarted/ssh_guide/ssh_wsl.md) + - [WireGuard Access](documentation/system_administrators/getstarted/ssh_guide/ssh_wireguard.md) + - [Remote Desktop and GUI](documentation/system_administrators/getstarted/remote-desktop_gui/remote-desktop_gui.md) + - [Cockpit: a Web-based Interface for Servers](documentation/system_administrators/getstarted/remote-desktop_gui/cockpit_guide/cockpit_guide.md) + - [XRDP: an Open-Source Remote Desktop Protocol](documentation/system_administrators/getstarted/remote-desktop_gui/xrdp_guide/xrdp_guide.md) + - [Apache Guacamole: a Clientless Remote Desktop Gateway](documentation/system_administrators/getstarted/remote-desktop_gui/guacamole_guide/guacamole_guide.md) + - [Planetary Network](documentation/system_administrators/getstarted/planetarynetwork.md) + - [TFGrid Services](documentation/system_administrators/getstarted/tfgrid_services/tf_grid_services_readme.md) + - [GPU](documentation/system_administrators/gpu/gpu_toc.md) + - [GPU Support](documentation/system_administrators/gpu/gpu.md) + - [Terraform](documentation/system_administrators/terraform/terraform_toc.md) + - [Overview](documentation/system_administrators/terraform/terraform_readme.md) + - [Installing Terraform](documentation/system_administrators/terraform/terraform_install.md) + - [Terraform Basics](documentation/system_administrators/terraform/terraform_basics.md) + - [Full VM Deployment](documentation/system_administrators/terraform/terraform_full_vm.md) + - [GPU Support](documentation/system_administrators/terraform/terraform_gpu_support.md) + - [Resources](documentation/system_administrators/terraform/resources/terraform_resources_readme.md) + - [Using Scheduler](documentation/system_administrators/terraform/resources/terraform_scheduler.md) + - [Virtual Machine](documentation/system_administrators/terraform/resources/terraform_vm.md) + - [Web Gateway](documentation/system_administrators/terraform/resources/terraform_vm_gateway.md) + - [Kubernetes Cluster](documentation/system_administrators/terraform/resources/terraform_k8s.md) + - [ZDB](documentation/system_administrators/terraform/resources/terraform_zdb.md) + - [Quantum Safe Filesystem](documentation/system_administrators/terraform/resources/terraform_qsfs.md) + - [QSFS on Micro VM](documentation/system_administrators/terraform/resources/terraform_qsfs_on_microvm.md) + - [QSFS on Full VM](documentation/system_administrators/terraform/resources/terraform_qsfs_on_full_vm.md) + - [CapRover](documentation/system_administrators/terraform/resources/terraform_caprover.md) + - [Advanced](documentation/system_administrators/terraform/advanced/terraform_advanced_readme.md) + - [Terraform Provider](documentation/system_administrators/terraform/advanced/terraform_provider.md) + - [Terraform Provisioners](documentation/system_administrators/terraform/advanced/terraform_provisioners.md) + - [Mounts](documentation/system_administrators/terraform/advanced/terraform_mounts.md) + - [Capacity Planning](documentation/system_administrators/terraform/advanced/terraform_capacity_planning.md) + - [Updates](documentation/system_administrators/terraform/advanced/terraform_updates.md) + - [SSH Connection with Wireguard](documentation/system_administrators/terraform/advanced/terraform_wireguard_ssh.md) + - [Set a Wireguard VPN](documentation/system_administrators/terraform/advanced/terraform_wireguard_vpn.md) + - [Synced MariaDB Databases](documentation/system_administrators/terraform/advanced/terraform_mariadb_synced_databases.md) + - [Nomad](documentation/system_administrators/terraform/advanced/terraform_nomad.md) + - [Nextcloud Deployments](documentation/system_administrators/terraform/advanced/terraform_nextcloud_toc.md) + - [Nextcloud All-in-One Deployment](documentation/system_administrators/terraform/advanced/terraform_nextcloud_aio.md) + - [Nextcloud Single Deployment](documentation/system_administrators/terraform/advanced/terraform_nextcloud_single.md) + - [Nextcloud Redundant Deployment](documentation/system_administrators/terraform/advanced/terraform_nextcloud_redundant.md) + - [Nextcloud 2-Node VPN Deployment](documentation/system_administrators/terraform/advanced/terraform_nextcloud_vpn.md) + - [Pulumi](documentation/system_administrators/pulumi/pulumi_readme.md) + - [Introduction to Pulumi](documentation/system_administrators/pulumi/pulumi_intro.md) + - [Installing Pulumi](documentation/system_administrators/pulumi/pulumi_install.md) + - [Deployment Examples](documentation/system_administrators/pulumi/pulumi_examples.md) + - [Deployment Details](documentation/system_administrators/pulumi/pulumi_deployment_details.md) + - [Mycelium](documentation/system_administrators/mycelium/mycelium_toc.md) + - [Overview](documentation/system_administrators/mycelium/overview.md) + - [Installation](documentation/system_administrators/mycelium/installation.md) + - [Additional Information](documentation/system_administrators/mycelium/information.md) + - [Message](documentation/system_administrators/mycelium/message.md) + - [Packet](documentation/system_administrators/mycelium/packet.md) + - [Data Packet](documentation/system_administrators/mycelium/data_packet.md) + - [API YAML](documentation/system_administrators/mycelium/api_yaml.md) + - [Computer and IT Basics](documentation/system_administrators/computer_it_basics/computer_it_basics.md) + - [CLI and Scripts Basics](documentation/system_administrators/computer_it_basics/cli_scripts_basics.md) + - [Docker Basics](documentation/system_administrators/computer_it_basics/docker_basics.md) + - [Git and GitHub Basics](documentation/system_administrators/computer_it_basics/git_github_basics.md) + - [Firewall Basics](documentation/system_administrators/computer_it_basics/firewall_basics/firewall_basics.md) + - [UFW Basics](documentation/system_administrators/computer_it_basics/firewall_basics/ufw_basics.md) + - [Firewalld Basics](documentation/system_administrators/computer_it_basics/firewall_basics/firewalld_basics.md) + - [File Transfer](documentation/system_administrators/computer_it_basics/file_transfer.md) + - [Advanced](documentation/system_administrators/advanced/advanced.md) + - [Token Transfer Keygenerator](documentation/system_administrators/advanced/token_transfer_keygenerator.md) + - [Cancel Contracts](documentation/system_administrators/advanced/cancel_contracts.md) + - [Contract Bills Reports](documentation/system_administrators/advanced/contract_bill_report.md) + - [Listing Free Public IPs](documentation/system_administrators/advanced/list_public_ips.md) + - [Redis](documentation/system_administrators/advanced/grid3_redis.md) + - [IPFS](documentation/system_administrators/advanced/ipfs/ipfs_toc.md) + - [IPFS on a Full VM](documentation/system_administrators/advanced/ipfs/ipfs_fullvm.md) + - [IPFS on a Micro VM](documentation/system_administrators/advanced/ipfs/ipfs_microvm.md) + - [ThreeFold Token](documentation/threefold_token/threefold_token.md) + - [TFT Bridges](documentation/threefold_token/tft_bridges/tft_bridges.md) + - [TFChain-Stellar Bridge](documentation/threefold_token/tft_bridges/tfchain_stellar_bridge.md) + - [BSC-Stellar Bridge](documentation/threefold_token/tft_bridges/bsc_stellar_bridge.md) + - [BSC-Stellar Bridge Verification](documentation/threefold_token/tft_bridges/bsc_stellar_bridge_verification.md) + - [Ethereum-Stellar Bridge](documentation/threefold_token/tft_bridges/tft_ethereum/tft_ethereum.md) + - [Storing TFT](documentation/threefold_token/storing_tft/storing_tft.md) + - [ThreeFold Connect App (Stellar)](documentation/threefold_token/storing_tft/tf_connect_app.md) + - [Lobstr Wallet (Stellar)](documentation/threefold_token/storing_tft/lobstr_wallet.md) + - [MetaMask (BSC & ETH)](documentation/threefold_token/storing_tft/metamask.md) + - [Hardware Wallet](documentation/threefold_token/storing_tft/hardware_wallet.md) + - [Buy and Sell TFT](documentation/threefold_token/buy_sell_tft/buy_sell_tft.md) + - [Quick Start (Stellar)](documentation/threefold_token/buy_sell_tft/tft_lobstr/tft_lobstr_short_guide.md) + - [Lobstr Wallet (Stellar)](documentation/threefold_token/buy_sell_tft/tft_lobstr/tft_lobstr_complete_guide.md) + - [MetaMask (BSC & ETH)](documentation/threefold_token/buy_sell_tft/tft_metamask/tft_metamask.md) + - [Pancake Swap (BSC)](documentation/threefold_token/buy_sell_tft/pancakeswap.md) + - [Liquidity Provider (LP)](documentation/threefold_token/liquidity/liquidity_readme.md) + - [Pancake Swap LP](documentation/threefold_token/liquidity/liquidity_pancake.md) + - [1inch.io LP](documentation/threefold_token/liquidity/liquidity_1inch.md) + - [Albedo LP](documentation/threefold_token/liquidity/liquidity_albedo.md) + - [Transaction Fees](documentation/threefold_token/transaction_fees.md) + - [FAQ](documentation/faq/faq.md) +- [Knowledge Base](knowledge_base/knowledge_base.md) + - [About](knowledge_base/about/about.md) + - [ThreeFold History](knowledge_base/about/threefold_history.md) + - [Token History](knowledge_base/about/token_history.md) + - [Genesis Pool](knowledge_base/about/genesis_pool.md) + - [Genesis Pool Dubai](knowledge_base/about/genesis_pool_dubai.md) + - [Genesis Pool Ghent](knowledge_base/about/genesis_pool_ghent.md) + - [Genesis Pool Details](knowledge_base/about/genesis_block_pool_details.md) + - [ThreeFold Tech](knowledge_base/about/threefold_tech.md) + - [Organisation Structure](knowledge_base/about/orgstructure.md) + - [Governance](knowledge_base/about/governance.md) + - [ThreeFold Companies](knowledge_base/about/threefold_companies.md) + - [ThreeFold Dubai](knowledge_base/about/threefold_dubai.md) + - [ThreeFold VZW](knowledge_base/about/threefold_vzw.md) + - [ThreeFold AG](knowledge_base/about/threefold_ag.md) + - [Mazraa](knowledge_base/about/mazraa.md) + - [BetterToken](knowledge_base/about/bettertoken.md) + - [DAO](knowledge_base/about/dao/dao.md) + - [ThreeFold DAO](knowledge_base/about/dao/tfdao.md) + - [TFChain](knowledge_base/about/tfchain.md) + - [ThreeFold Roadmap](knowledge_base/about/roadmap/roadmap_readme.md) + - [Release Notes](knowledge_base/about/roadmap/releasenotes/releasenotes_readme.md) + - [TFGrid v3.10.0](knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_10_0.md) + - [TFGrid v3.9.0](knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_9_0.md) + - [TFGrid v3.8.0](knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_8_0.md) + - [TFGrid v3.7.0](knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_7_0.md) + - [TFGrid v3.6.1](knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_6_1.md) + - [TFGrid v3.6.0](knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_6_0.md) + - [TFGrid v3.0.0 Alpha-5](knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_0_a5.md) + - [TFGrid v3.0.0 Alpha-4](knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_0_a4.md) + - [TFGrid v3.0.0 Alpha-2](knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_0_a2.md) + - [TFGrid v3.0.0](knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_0.md) + - [ThreeFold Token](knowledge_base/about/token_overview/token_overview.md) + - [Special Wallets](knowledge_base/about/token_overview/special_wallets/stats_special_wallets.md) + - [Technology](knowledge_base/technology/technology_toc.md) + - [How It Works](knowledge_base/technology/grid3_howitworks.md) + - [Grid Concepts](knowledge_base/technology/concepts/concepts_readme.md) + - [TFGrid Primitives](knowledge_base/technology/concepts/grid_primitives.md) + - [TFGrid Component List](knowledge_base/technology/concepts/grid3_components.md) + - [Infrastructure as Code](knowledge_base/technology/concepts/grid3_iac.md) + - [Proof of Utilization](knowledge_base/technology/concepts/proof_of_utilization.md) + - [Contract Grace Period](knowledge_base/technology/concepts/contract_grace_period.md) + - [What's New on TFGrid v3.x](knowledge_base/technology/concepts/grid3_whatsnew.md) + - [TFChain](knowledge_base/technology/concepts/tfchain.md) + - [TFGrid by Design](knowledge_base/technology/concepts/tfgrid_by_design.md) + - [Primitives](knowledge_base/technology/primitives/primitives_toc.md) + - [Compute](knowledge_base/technology/primitives/compute/compute_toc.md) + - [ZKube](knowledge_base/technology/primitives/compute/zkube.md) + - [ZMachine](knowledge_base/technology/primitives/compute/zmachine.md) + - [CoreX](knowledge_base/technology/primitives/compute/corex.md) + - [Storage](knowledge_base/technology/primitives/storage/storage_toc.md) + - [ZOS Filesystem](knowledge_base/technology/primitives/storage/zos_fs.md) + - [ZOS Mount](knowledge_base/technology/primitives/storage/zmount.md) + - [Quantum Safe File System](knowledge_base/technology/primitives/storage/qsfs.md) + - [Zero-DB](knowledge_base/technology/primitives/storage/zdb.md) + - [Zero-Disk](knowledge_base/technology/primitives/storage/zdisk.md) + - [Network](knowledge_base/technology/primitives/network/network_toc.md) + - [ZNET](knowledge_base/technology/primitives/network/znet.md) + - [ZNIC](knowledge_base/technology/primitives/network/znic.md) + - [WebGateway](knowledge_base/technology/primitives/network/webgw3.md) + - [Zero-OS Advantages](knowledge_base/technology/zos/benefits/zos_advantages.md) + - [Quantum Safe Storage](knowledge_base/technology/qsss/qsss_home.md) + - [Smart Contract IT](knowledge_base/technology/smartcontract_it/smartcontract_toc.md) + - [Introduction](knowledge_base/technology/smartcontract_it/smartcontract_tfgrid3.md) + - [Infrastructure As Code (IAC)](knowledge_base/technology/smartcontract_it/smartcontract_iac.md) + - [3Bot Integration](knowledge_base/technology/smartcontract_it/smartcontract_3bot.md) + - [Farming](knowledge_base/farming/farming_toc.md) + - [Farming Rewards](knowledge_base/farming/farming_reward.md) + - [Proof-of-Capacity](knowledge_base/farming/proof_of_capacity.md) + - [Proof-of-Utilization](knowledge_base/farming/proof_of_utilization.md) + - [PoC DAO Rules](knowledge_base/farming/poc_dao_rules.md) + - [Cloud](knowledge_base/cloud/cloud_toc.md) + - [Cloud Units](knowledge_base/cloud/cloudunits.md) + - [Pricing](knowledge_base/cloud/pricing/pricing_toc.md) + - [Pricing Overview](knowledge_base/cloud/pricing/pricing.md) + - [Staking Discounts](knowledge_base/cloud/pricing/staking_discount_levels.md) + - [Cloud Pricing Compare](knowledge_base/cloud/pricing/cloud_pricing_compare.md) + - [Grid Billing](knowledge_base/cloud/grid_billing/grid_billing.md) + - [Resource Units](knowledge_base/cloud/resource_units_calc_cloudunits.md) + - [Resource Units Advanced](knowledge_base/cloud/resourceunits_advanced.md) + - [Collaboration](knowledge_base/collaboration/collaboration_toc.md) + - [How to Contribute](knowledge_base/collaboration/contribute.md) + - [Development Process](knowledge_base/collaboration/development_process.md) + - [Feature Request](knowledge_base/collaboration/feature_request.md) + - [Bug Report](knowledge_base/collaboration/bug_report.md) + - [Issue Labels](knowledge_base/collaboration/issue_labels.md) + - [Development Cycle](knowledge_base/collaboration/development_cycle.md) + - [Release Process](knowledge_base/collaboration/release_process.md) + - [Pull Request Template](knowledge_base/collaboration/PULL_REQUEST_TEMPLATE.md) + - [Collaboration Tools](knowledge_base/collaboration/collaboration_tools/collaboration_tools.md) + - [Circle Tool](knowledge_base/collaboration/collaboration_tools/circle_tool.md) + - [Website Deployer](knowledge_base/collaboration/collaboration_tools/website_tool.md) + - [Website Link Checker](knowledge_base/collaboration/collaboration_tools/website_link_checker.md) + - [How to Test](knowledge_base/collaboration/testing/testing_readme.md) + - [TestLodge](knowledge_base/collaboration/testing/testlodge.md) + - [Code of Conduct](knowledge_base/collaboration/code_conduct.md) + - [Legal](knowledge_base/legal/terms_conditions_all3.md) + - [Disclaimer](knowledge_base/legal/disclaimer.md) + - [Definitions](knowledge_base/legal/definitions_legal.md) + - [Privacy Policy](knowledge_base/legal/privacypolicy.md) + - [Terms & Conditions](knowledge_base/legal/terms_conditions/terms_conditions_toc.md) + - [Terms & Conditions ThreeFold Related Websites](knowledge_base/legal/terms_conditions/terms_conditions_websites.md) + - [Terms & Conditions TFGrid Users TFGrid 3](knowledge_base/legal/terms_conditions/terms_conditions_griduser.md) + - [TFTA to TFT](knowledge_base/legal/terms_conditions/tfta_to_tft.md) + - [Terms & Conditions TFGrid Farmers TFGrid 3](knowledge_base/legal/terms_conditions/terms_conditions_farmer3.md) + - [Terms & Conditions Sales](knowledge_base/legal/terms_conditions/terms_conditions_sales.md) \ No newline at end of file diff --git a/books/tfmanual/sync_production.sh b/books/tfmanual/sync_production.sh new file mode 100644 index 0000000..b1323b0 --- /dev/null +++ b/books/tfmanual/sync_production.sh @@ -0,0 +1,2 @@ +#!/bin/bash +rsync -rv ~/hero/www/info/tfmanual/ root@info.ourworld.tf:/root/hero/www/info/tfmanual/ \ No newline at end of file diff --git a/collections/documentation/developers/internals/zos/assets/.keep b/collections/documentation/.collection similarity index 100% rename from collections/documentation/developers/internals/zos/assets/.keep rename to collections/documentation/.collection diff --git a/collections/documentation/dashboard/img/.done b/collections/documentation/dashboard/img/.done new file mode 100644 index 0000000..d8eefe3 --- /dev/null +++ b/collections/documentation/dashboard/img/.done @@ -0,0 +1,3 @@ +dashboard_tc.png +dashboard_portal_terms_conditions.png +profile_manager1.png diff --git a/collections/documentation/dashboard/img/0_Bootstrap.png b/collections/documentation/dashboard/img/0_bootstrap.png similarity index 100% rename from collections/documentation/dashboard/img/0_Bootstrap.png rename to collections/documentation/dashboard/img/0_bootstrap.png diff --git a/collections/documentation/dashboard/img/dashboard_portal_terms_conditions.png b/collections/documentation/dashboard/img/dashboard_portal_terms_conditions.png index 82f6c3e..b784fef 100644 Binary files a/collections/documentation/dashboard/img/dashboard_portal_terms_conditions.png and b/collections/documentation/dashboard/img/dashboard_portal_terms_conditions.png differ diff --git a/collections/documentation/dashboard/img/dashboard_tc.png b/collections/documentation/dashboard/img/dashboard_tc.png new file mode 100644 index 0000000..f58af46 Binary files /dev/null and b/collections/documentation/dashboard/img/dashboard_tc.png differ diff --git a/collections/documentation/dashboard/img/Minting.png b/collections/documentation/dashboard/img/minting.png similarity index 100% rename from collections/documentation/dashboard/img/Minting.png rename to collections/documentation/dashboard/img/minting.png diff --git a/collections/documentation/dashboard/img/Monitoring.png b/collections/documentation/dashboard/img/monitoring.png similarity index 100% rename from collections/documentation/dashboard/img/Monitoring.png rename to collections/documentation/dashboard/img/monitoring.png diff --git a/collections/documentation/dashboard/img/profile_manager1.png b/collections/documentation/dashboard/img/profile_manager1.png index 73d59d5..c34e966 100644 Binary files a/collections/documentation/dashboard/img/profile_manager1.png and b/collections/documentation/dashboard/img/profile_manager1.png differ diff --git a/collections/documentation/dashboard/img/sidebar_1 (copy)_full.png b/collections/documentation/dashboard/img/sidebar_1_copy_full.png similarity index 100% rename from collections/documentation/dashboard/img/sidebar_1 (copy)_full.png rename to collections/documentation/dashboard/img/sidebar_1_copy_full.png diff --git a/collections/documentation/dashboard/img/sidebar_2 (copy)_full.png b/collections/documentation/dashboard/img/sidebar_2_copy_full.png similarity index 100% rename from collections/documentation/dashboard/img/sidebar_2 (copy)_full.png rename to collections/documentation/dashboard/img/sidebar_2_copy_full.png diff --git a/collections/documentation/dashboard/img/sidebar_3 (copy)_full.png b/collections/documentation/dashboard/img/sidebar_3_copy_full.png similarity index 100% rename from collections/documentation/dashboard/img/sidebar_3 (copy)_full.png rename to collections/documentation/dashboard/img/sidebar_3_copy_full.png diff --git a/collections/documentation/dashboard/img/sidebar_4 (copy)_full.png b/collections/documentation/dashboard/img/sidebar_4_copy_full.png similarity index 100% rename from collections/documentation/dashboard/img/sidebar_4 (copy)_full.png rename to collections/documentation/dashboard/img/sidebar_4_copy_full.png diff --git a/collections/documentation/dashboard/img/SSH_Key.png b/collections/documentation/dashboard/img/ssh_key.png similarity index 100% rename from collections/documentation/dashboard/img/SSH_Key.png rename to collections/documentation/dashboard/img/ssh_key.png diff --git a/collections/documentation/dashboard/solutions/fullVm.md b/collections/documentation/dashboard/solutions/fullvm.md similarity index 100% rename from collections/documentation/dashboard/solutions/fullVm.md rename to collections/documentation/dashboard/solutions/fullvm.md diff --git a/collections/documentation/dashboard/solutions/img/captain_login+weblet_caprover_.png b/collections/documentation/dashboard/solutions/img/captain_loginweblet_caprover_.png similarity index 100% rename from collections/documentation/dashboard/solutions/img/captain_login+weblet_caprover_.png rename to collections/documentation/dashboard/solutions/img/captain_loginweblet_caprover_.png diff --git a/collections/documentation/dashboard/solutions/img/deleted_contract_info copy.png b/collections/documentation/dashboard/solutions/img/deleted_contract_info_copy.png similarity index 100% rename from collections/documentation/dashboard/solutions/img/deleted_contract_info copy.png rename to collections/documentation/dashboard/solutions/img/deleted_contract_info_copy.png diff --git a/collections/documentation/dashboard/solutions/img/nixos-micro1.png b/collections/documentation/dashboard/solutions/img/nixos_micro1.png similarity index 100% rename from collections/documentation/dashboard/solutions/img/nixos-micro1.png rename to collections/documentation/dashboard/solutions/img/nixos_micro1.png diff --git a/collections/documentation/dashboard/solutions/img/nixos-micro2.png b/collections/documentation/dashboard/solutions/img/nixos_micro2.png similarity index 100% rename from collections/documentation/dashboard/solutions/img/nixos-micro2.png rename to collections/documentation/dashboard/solutions/img/nixos_micro2.png diff --git a/collections/documentation/dashboard/solutions/img/nixos-micro3.png b/collections/documentation/dashboard/solutions/img/nixos_micro3.png similarity index 100% rename from collections/documentation/dashboard/solutions/img/nixos-micro3.png rename to collections/documentation/dashboard/solutions/img/nixos_micro3.png diff --git a/collections/documentation/dashboard/solutions/img/nodeP_2.png b/collections/documentation/dashboard/solutions/img/nodep_2.png similarity index 100% rename from collections/documentation/dashboard/solutions/img/nodeP_2.png rename to collections/documentation/dashboard/solutions/img/nodep_2.png diff --git a/collections/documentation/dashboard/solutions/img/nodePilot_2.png b/collections/documentation/dashboard/solutions/img/nodepilot_2.png similarity index 100% rename from collections/documentation/dashboard/solutions/img/nodePilot_2.png rename to collections/documentation/dashboard/solutions/img/nodepilot_2.png diff --git a/collections/documentation/dashboard/solutions/img/nodePilot_3.png b/collections/documentation/dashboard/solutions/img/nodepilot_3.png similarity index 100% rename from collections/documentation/dashboard/solutions/img/nodePilot_3.png rename to collections/documentation/dashboard/solutions/img/nodepilot_3.png diff --git a/collections/documentation/dashboard/solutions/img/nxios-micro1.png b/collections/documentation/dashboard/solutions/img/nxios_micro1.png similarity index 100% rename from collections/documentation/dashboard/solutions/img/nxios-micro1.png rename to collections/documentation/dashboard/solutions/img/nxios_micro1.png diff --git a/collections/documentation/dashboard/solutions/img/subsquid_list.jpeg b/collections/documentation/dashboard/solutions/img/subsquid_list.jpg similarity index 100% rename from collections/documentation/dashboard/solutions/img/subsquid_list.jpeg rename to collections/documentation/dashboard/solutions/img/subsquid_list.jpg diff --git a/collections/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/lobstr_swap.jpeg b/collections/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/lobstr_swap.jpg similarity index 100% rename from collections/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/lobstr_swap.jpeg rename to collections/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/lobstr_swap.jpg diff --git a/collections/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/lobstr_trade.jpeg b/collections/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/lobstr_trade.jpg similarity index 100% rename from collections/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/lobstr_trade.jpeg rename to collections/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/lobstr_trade.jpg diff --git a/collections/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/threefold__lobstr_swap_tft_.jpg b/collections/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/threefold_lobstr_swap_tft_.jpg similarity index 100% rename from collections/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/threefold__lobstr_swap_tft_.jpg rename to collections/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/threefold_lobstr_swap_tft_.jpg diff --git a/collections/documentation/threefold_token/img/threefold__albedo_send_receive.png b/collections/documentation/threefold_token/img/threefold_albedo_send_receive.png similarity index 100% rename from collections/documentation/threefold_token/img/threefold__albedo_send_receive.png rename to collections/documentation/threefold_token/img/threefold_albedo_send_receive.png diff --git a/collections/documentation/threefold_token/liquidity/img/.done b/collections/documentation/threefold_token/liquidity/img/.done new file mode 100644 index 0000000..d8cecb7 --- /dev/null +++ b/collections/documentation/threefold_token/liquidity/img/.done @@ -0,0 +1,2 @@ +albedo_confirm.png +albedo_liquidity.png diff --git a/collections/documentation/threefold_token/liquidity/img/liquidity_approve.jpeg b/collections/documentation/threefold_token/liquidity/img/liquidity_approve.jpg similarity index 100% rename from collections/documentation/threefold_token/liquidity/img/liquidity_approve.jpeg rename to collections/documentation/threefold_token/liquidity/img/liquidity_approve.jpg diff --git a/collections/documentation/threefold_token/liquidity/img/liquidity_busd.jpeg b/collections/documentation/threefold_token/liquidity/img/liquidity_busd.jpg similarity index 100% rename from collections/documentation/threefold_token/liquidity/img/liquidity_busd.jpeg rename to collections/documentation/threefold_token/liquidity/img/liquidity_busd.jpg diff --git a/collections/documentation/threefold_token/liquidity/img/threefold__confirmation.jpg b/collections/documentation/threefold_token/liquidity/img/threefold_confirmation.jpg similarity index 100% rename from collections/documentation/threefold_token/liquidity/img/threefold__confirmation.jpg rename to collections/documentation/threefold_token/liquidity/img/threefold_confirmation.jpg diff --git a/collections/documentation/threefold_token/liquidity/img/threefold__lp_tokens.jpg b/collections/documentation/threefold_token/liquidity/img/threefold_lp_tokens.jpg similarity index 100% rename from collections/documentation/threefold_token/liquidity/img/threefold__lp_tokens.jpg rename to collections/documentation/threefold_token/liquidity/img/threefold_lp_tokens.jpg diff --git a/collections/documentation/threefold_token/liquidity/img/threefold__supply.jpg b/collections/documentation/threefold_token/liquidity/img/threefold_supply.jpg similarity index 100% rename from collections/documentation/threefold_token/liquidity/img/threefold__supply.jpg rename to collections/documentation/threefold_token/liquidity/img/threefold_supply.jpg diff --git a/collections/documentation/threefold_token/storing_tft/img/.done b/collections/documentation/threefold_token/storing_tft/img/.done new file mode 100644 index 0000000..1918246 --- /dev/null +++ b/collections/documentation/threefold_token/storing_tft/img/.done @@ -0,0 +1,9 @@ +alpha_signup.png +alpha_trade.png +alpha_wallet.png +inter_funded.png +lobstr_assets.png +metamask_installed.png +metamask_new.png +metamask_pass.png +metamask_privatekey.png diff --git a/collections/documentation/threefold_token/storing_tft/img/alpha_signup.png b/collections/documentation/threefold_token/storing_tft/img/alpha_signup.png index 5840e77..95419d2 100644 Binary files a/collections/documentation/threefold_token/storing_tft/img/alpha_signup.png and b/collections/documentation/threefold_token/storing_tft/img/alpha_signup.png differ diff --git a/collections/documentation/threefold_token/storing_tft/img/alpha_wallet.png b/collections/documentation/threefold_token/storing_tft/img/alpha_wallet.png index 01b2916..081e25a 100644 Binary files a/collections/documentation/threefold_token/storing_tft/img/alpha_wallet.png and b/collections/documentation/threefold_token/storing_tft/img/alpha_wallet.png differ diff --git a/collections/documentation/threefold_token/storing_tft/img/inter_funded.png b/collections/documentation/threefold_token/storing_tft/img/inter_funded.png index 3fe4ef6..0c4dc43 100644 Binary files a/collections/documentation/threefold_token/storing_tft/img/inter_funded.png and b/collections/documentation/threefold_token/storing_tft/img/inter_funded.png differ diff --git a/collections/documentation/threefold_token/storing_tft/img/INTER_TFT.png b/collections/documentation/threefold_token/storing_tft/img/inter_tft.png similarity index 100% rename from collections/documentation/threefold_token/storing_tft/img/INTER_TFT.png rename to collections/documentation/threefold_token/storing_tft/img/inter_tft.png diff --git a/collections/documentation/threefold_token/storing_tft/img/lobstr_asset.jpeg b/collections/documentation/threefold_token/storing_tft/img/lobstr_asset.jpg similarity index 100% rename from collections/documentation/threefold_token/storing_tft/img/lobstr_asset.jpeg rename to collections/documentation/threefold_token/storing_tft/img/lobstr_asset.jpg diff --git a/collections/documentation/threefold_token/storing_tft/img/solar_copy.jpeg b/collections/documentation/threefold_token/storing_tft/img/solar_copy.jpg similarity index 100% rename from collections/documentation/threefold_token/storing_tft/img/solar_copy.jpeg rename to collections/documentation/threefold_token/storing_tft/img/solar_copy.jpg diff --git a/collections/documentation/threefold_token/storing_tft/img/solar_desktop.jpeg b/collections/documentation/threefold_token/storing_tft/img/solar_desktop.jpg similarity index 100% rename from collections/documentation/threefold_token/storing_tft/img/solar_desktop.jpeg rename to collections/documentation/threefold_token/storing_tft/img/solar_desktop.jpg diff --git a/collections/documentation/threefold_token/storing_tft/img/solar_home.jpeg b/collections/documentation/threefold_token/storing_tft/img/solar_home.jpg similarity index 100% rename from collections/documentation/threefold_token/storing_tft/img/solar_home.jpeg rename to collections/documentation/threefold_token/storing_tft/img/solar_home.jpg diff --git a/collections/documentation/threefold_token/storing_tft/img/solar_receive.jpeg b/collections/documentation/threefold_token/storing_tft/img/solar_receive.jpg similarity index 100% rename from collections/documentation/threefold_token/storing_tft/img/solar_receive.jpeg rename to collections/documentation/threefold_token/storing_tft/img/solar_receive.jpg diff --git a/collections/documentation/threefold_token/storing_tft/img/solar_secret.jpeg b/collections/documentation/threefold_token/storing_tft/img/solar_secret.jpg similarity index 100% rename from collections/documentation/threefold_token/storing_tft/img/solar_secret.jpeg rename to collections/documentation/threefold_token/storing_tft/img/solar_secret.jpg diff --git a/collections/documentation/threefold_token/storing_tft/img/solar_xlm.jpeg b/collections/documentation/threefold_token/storing_tft/img/solar_xlm.jpg similarity index 100% rename from collections/documentation/threefold_token/storing_tft/img/solar_xlm.jpeg rename to collections/documentation/threefold_token/storing_tft/img/solar_xlm.jpg diff --git a/collections/documentation/threefold_token/storing_tft/img/threefold__trustwallet_overview.jpg b/collections/documentation/threefold_token/storing_tft/img/threefold_trustwallet_overview.jpg similarity index 100% rename from collections/documentation/threefold_token/storing_tft/img/threefold__trustwallet_overview.jpg rename to collections/documentation/threefold_token/storing_tft/img/threefold_trustwallet_overview.jpg diff --git a/collections/documentation/threefold_token/storing_tft/img/threefold__trustwallet_tft_added.jpg b/collections/documentation/threefold_token/storing_tft/img/threefold_trustwallet_tft_added.jpg similarity index 100% rename from collections/documentation/threefold_token/storing_tft/img/threefold__trustwallet_tft_added.jpg rename to collections/documentation/threefold_token/storing_tft/img/threefold_trustwallet_tft_added.jpg diff --git a/collections/documentation/threefold_token/storing_tft/img/threefold__trustwallet_tft_config.jpg b/collections/documentation/threefold_token/storing_tft/img/threefold_trustwallet_tft_config.jpg similarity index 100% rename from collections/documentation/threefold_token/storing_tft/img/threefold__trustwallet_tft_config.jpg rename to collections/documentation/threefold_token/storing_tft/img/threefold_trustwallet_tft_config.jpg diff --git a/collections/documentation/threefold_token/storing_tft/img/threefold__xlm_solar_tft_manual_image_19.jpg b/collections/documentation/threefold_token/storing_tft/img/threefold_xlm_solar_tft_manual_image_19.jpg similarity index 100% rename from collections/documentation/threefold_token/storing_tft/img/threefold__xlm_solar_tft_manual_image_19.jpg rename to collections/documentation/threefold_token/storing_tft/img/threefold_xlm_solar_tft_manual_image_19.jpg diff --git a/collections/documentation/threefold_token/storing_tft/img/trust_notfound.jpeg b/collections/documentation/threefold_token/storing_tft/img/trust_notfound.jpg similarity index 100% rename from collections/documentation/threefold_token/storing_tft/img/trust_notfound.jpeg rename to collections/documentation/threefold_token/storing_tft/img/trust_notfound.jpg diff --git a/collections/documentation/threefold_token/tft_bridges/img/BSC to Stellar1.jpeg b/collections/documentation/threefold_token/tft_bridges/img/bsc_to_stellar1.jpg similarity index 100% rename from collections/documentation/threefold_token/tft_bridges/img/BSC to Stellar1.jpeg rename to collections/documentation/threefold_token/tft_bridges/img/bsc_to_stellar1.jpg diff --git a/collections/documentation/threefold_token/tft_bridges/img/BSC to Stellar2.png b/collections/documentation/threefold_token/tft_bridges/img/bsc_to_stellar2.png similarity index 100% rename from collections/documentation/threefold_token/tft_bridges/img/BSC to Stellar2.png rename to collections/documentation/threefold_token/tft_bridges/img/bsc_to_stellar2.png diff --git a/collections/documentation/threefold_token/tft_bridges/img/BSC to Stellar3.png b/collections/documentation/threefold_token/tft_bridges/img/bsc_to_stellar3.png similarity index 100% rename from collections/documentation/threefold_token/tft_bridges/img/BSC to Stellar3.png rename to collections/documentation/threefold_token/tft_bridges/img/bsc_to_stellar3.png diff --git a/collections/documentation/threefold_token/tft_bridges/img/BSC to Stellar4.png b/collections/documentation/threefold_token/tft_bridges/img/bsc_to_stellar4.png similarity index 100% rename from collections/documentation/threefold_token/tft_bridges/img/BSC to Stellar4.png rename to collections/documentation/threefold_token/tft_bridges/img/bsc_to_stellar4.png diff --git a/collections/intro/.collection b/collections/intro/.collection new file mode 100644 index 0000000..e69de29 diff --git a/collections/intro/img/.done b/collections/intro/img/.done new file mode 100644 index 0000000..8cdf234 --- /dev/null +++ b/collections/intro/img/.done @@ -0,0 +1 @@ +intro_header.png diff --git a/collections/intro/img/intro_header.png b/collections/intro/img/intro_header.png index 2944708..d57f520 100644 Binary files a/collections/intro/img/intro_header.png and b/collections/intro/img/intro_header.png differ diff --git a/collections/mbweni/about/intro.md b/collections/mbweni/about/intro.md index e69de29..e0e3881 100644 --- a/collections/mbweni/about/intro.md +++ b/collections/mbweni/about/intro.md @@ -0,0 +1,23 @@ +# Mbweni Ruins and Gardens Wiki + +## Introduction + +Welcome to the Mbweni Ruins and Gardens Wiki, your ultimate guide to discovering the beauty, history, and community spirit of Mbweni. Previously known as Jungle Paradise, Mbweni Ruins and Gardens is a vibrant and experimental regeneration hub in the heart of Zanzibar, with the desire to inspire, nurture, and embrace sustainable tourism as a catalyst for transformation. More than just a resort, we are a diverse community of passionate individuals with exciting projects, dedicated to doing good and having a good time + + +Nestled in a serene coastal area, Mbweni offers a unique blend of historical ruins, lush gardens, and vibrant community life. Whether you're a curious traveler, a history enthusiast, or someone seeking a peaceful retreat, Mbweni has something special to offer you. + +## Navigation + +Navigate easily through the different aspects of Mbweni: + +- [Introduction](mbweni/about/intro.md): Learn more about Mbweni, its location, and our story. +- [History](mbweni/history/history.md): Delve into the rich history of Mbweni, including its ruins, gardens, and cultural significance. +- [Community](mbweni/community/community.md): Discover the diverse people, projects, and partnerships that shape our vibrant community. +- [Initiatives](mbweni/initiatives/initiatives.md): Explore our commitment to sustainability and quality of life initiatives. +- [Facilities](mbweni/facilities/facilities.md): Find out about diverse work and leisure facilities at Mbweni. +- [Activities](mbweni/activities/activities.md): From water sports to yoga and community events, experience the fulfilling life at Mbweni. +- [Tours](mbweni/tours/tours.md): Embark on guided tours to explore the surrounding areas, from Mbweni to Kilimanjaro, and immerse yourself in the local culture. +- [Freeflow Nation](freeflow/freeflow_movement.md): Learn about the Freeflow Movement, the driving force behind our core principles and philosophy. + +Explore Mbweni Ruins and Gardens Wiki to uncover the treasures that await you in this enchanting corner of the world. diff --git a/collections/mbweni/about/mbweni.md b/collections/mbweni/about/mbweni.md index e69de29..66e1ee4 100644 --- a/collections/mbweni/about/mbweni.md +++ b/collections/mbweni/about/mbweni.md @@ -0,0 +1,21 @@ +# About Mbweni Ruins and Gardens + +Welcome to Mbweni Ruins and Gardens, formerly known as Jungle Paradise. Situated in the heart of Zanzibar, we are more than just a resort – we are a vibrant and experimental regeneration hub. Our mission is to inspire, nurture, and embrace sustainable tourism as a catalyst for transformation. At Mbweni, we're not only dedicated to providing a memorable experience for our guests but also to making a positive impact on our community and the environment. + +## Location + +Located in the upmarket suburb of Mbweni, just 5km south of Zanzibar Town, our establishment holds a rich historical significance. Once a base for the Universities Mission to Central Africa (UMCA) and a settlement for former slaves in the 19th century, Mbweni is steeped in history. The ruins of St Mary’s School for Girls, originally built by missionaries for girls freed from slave ships, now stand amidst the lush gardens of Mbweni Ruins Hotel. While it may be a trek from Stone Town, a visit to Mbweni is well worth it, offering visitors the chance to explore this evocative spot and enjoy the amenities of the hotel, including its restaurant and private beach. + +Nearby, visitors can also find St John's Anglican Church, another poignant reminder of Zanzibar's colonial missionary era. The caretaker-guide, a direct descendant of a freed slave who became the UMCA's first African deacon, offers insights into the church's history and significance. + +## What We Offer + +Mbweni Ruins and Gardens is a coliving space consisting of 13 rooms and 3 apartments. Our community-driven approach sets us apart, as we strive to create a welcoming environment for travelers and nomads alike. Beyond providing comfortable accommodations, we are committed to supporting various noble causes and initiatives aimed at making a positive impact on our community. + +## Address and Contact Information + +- **Address:** Mbweni Rd, Unguja Urban West. P.O BOX 3775, Zanzibar, Tanzania +- **Contact:** +255 778 242 424 +**Website:** [mbweniruinsandgardens.com](https://mbweniruinsandgardens.com) + +Whether you're seeking a tranquil retreat, a cultural experience, or an opportunity to engage with like-minded individuals, Mbweni Ruins and Gardens offers a unique and fulfilling experience. Join us in our journey towards sustainability, community, and adventure. diff --git a/collections/mbweni/about/story.md b/collections/mbweni/about/story.md index e69de29..dd10951 100644 --- a/collections/mbweni/about/story.md +++ b/collections/mbweni/about/story.md @@ -0,0 +1,25 @@ +## Our Story + +Formerly known as the Jungle Paradise Resort, 2024 marked a profound shift in our vision and purpose at Mbweni. In this transformation time, we aspire to transform Mbweni from a commercial resort into a regeneration hub; a thriving community woven together by a shared dedication to history, nature, and the boundless possibilities of regeneration. We would like to invite you to join hands in crafting a narrative that transcends time. + +More than just a resort, Mbweni is a coliving space where individuals come together to form a dynamic and interconnected community. Here, guests are not merely visitors but active participants in shaping the vibrant culture and ethos of Mbweni. + +## Our Philosophy + +At Mbweni, we live by the mantra "Create, Play, Grow." We wholeheartedly believe in the power of co-creation, the joy of play, and the constant pursuit of personal growth. This mantra encapsulates our commitment to fostering a community where creativity knows no bounds, where the spirit of play is celebrated for everyone, and where growth extends beyond individual aspirations to embrace the collective flourishing of both people and the environment. + + +## Our Commitment + +More than just a hospitality establishment; as a regenerative hub, we are committed to setting a model for transformative change within the broader landscape of the industry. + +We pledge to cultivate a harmonious community that fosters creating impact, personal growth, and at the same time, having a good time. This is our pathway towards regenerative living, where the essence lies in not just sustaining but actively contributing to the well-being of our community and the places we touch. + +### Learn More About Our Manifesto and Philosophies: + +- [Freeflow Nation](freeflow/freeflow_movement.md) + - [Manifesto](freeflow/manifesto/manifesto.md) + - [Digital Nation](freeflow/manifesto/digital_nation_info_laws.md) + +### Learn More About Our Community: +- [Community](mbweni/community/community.md) diff --git a/collections/mbweni/about/zanzibar.md b/collections/mbweni/about/zanzibar.md index e69de29..a96ee1a 100644 --- a/collections/mbweni/about/zanzibar.md +++ b/collections/mbweni/about/zanzibar.md @@ -0,0 +1,21 @@ +# Location + +## Mbweni + +Mbweni Ruins & Gardens is situated in the scenic region of Mbweni, which lies approximately 5 kilometers south of the bustling hub of Zanzibar Town, Tanzania. Tucked away from the hustle and bustle of urban life, Mbweni offers visitors a tranquil retreat amidst lush greenery and historical ruins. The area is steeped in history, with remnants of ancient structures providing a glimpse into its storied past. + +The landscape of Mbweni is characterized by its verdant gardens, swaying palm trees, and pristine coastline. The gardens surrounding the ruins exude a sense of tranquility, making them the perfect setting for leisurely strolls and moments of quiet reflection. Visitors to Mbweni can explore the ruins of St Mary’s School for Girls, a poignant reminder of the area's colonial history and its role in the abolition of the slave trade. + +## Zanzibar + +Mbweni Ruins & Gardens is located on the main island of Zanzibar, an archipelago known for its stunning beaches, vibrant culture, and rich history. Zanzibar, often referred to as the "Spice Island," is famous for its aromatic spices, which have been traded in the region for centuries. Visitors to Zanzibar can immerse themselves in the island's cultural heritage by exploring its historic Stone Town, a UNESCO World Heritage Site renowned for its labyrinthine streets and Arab-influenced architecture. + +In addition to its cultural attractions, Zanzibar boasts an array of natural wonders, including pristine beaches, coral reefs, and lush forests. Travelers to Zanzibar can enjoy a variety of outdoor activities, such as snorkeling, diving, and hiking, amidst the island's breathtaking scenery. + +## Tanzania + +Mbweni Ruins & Gardens is located within the United Republic of Tanzania, a diverse and culturally rich country in East Africa. Tanzania is home to an abundance of natural wonders, including Mount Kilimanjaro, the highest peak in Africa, and the Serengeti National Park, famous for its annual wildebeest migration. With its stunning landscapes, diverse wildlife, and warm hospitality, Tanzania offers visitors an unforgettable safari experience. + +In addition to its natural beauty, Tanzania is also known for its vibrant culture and friendly people. Travelers to Tanzania can explore traditional Maasai villages, sample delicious Tanzanian cuisine, and learn about the country's rich history and heritage. + +Mbweni Ruins & Gardens is proud to be a part of Tanzania's thriving tourism industry, offering guests a unique and memorable experience in this enchanting corner of the world. diff --git a/collections/mbweni/activities/activities.md b/collections/mbweni/activities/activities.md index e69de29..ae5f6f5 100644 --- a/collections/mbweni/activities/activities.md +++ b/collections/mbweni/activities/activities.md @@ -0,0 +1,23 @@ +# Fun and Productive Activities at Mbweni + +Welcome to Mbweni, where every day is filled with excitement, adventure, and productivity. Whether you're seeking thrilling outdoor sports, peaceful yoga sessions, or engaging community events, there's something for everyone at Mbweni. Join us as we explore a variety of activities designed to enhance your experience and make your stay both enjoyable and fulfilling. + +## Navigate Through Exciting Activities + +Embark on a journey of exploration and discovery as you navigate through our diverse range of activities: + +- [**Sailing:**](mbweni/activities/sailing.md) Set sail on the crystal-clear waters surrounding Mbweni and experience the thrill of navigating the waves. + +- [**Community Events:**](mbweni/activities/events.md) Immerse yourself in the vibrant community spirit of Mbweni by participating in our engaging and inclusive events. + +- [**Outdoor Sports:**](mbweni/activities/sports.md) Get your adrenaline pumping with a variety of outdoor sports activities, including beach volleyball, kayaking, and more. + +- [**Yoga:**](mbweni/activities/yoga.md) Find inner peace and balance with rejuvenating yoga sessions set against the backdrop of Mbweni's natural beauty. + +- [**Outdoor Cinema:**](mbweni/activities/cinema.md) Sit back, relax, and enjoy movie evenings with our outdoor cinema experience at Mbweni Ruins, perfect for cozy evenings with friends and family. + +## Explore Enriching Tours + +In addition to our on-site activities, Mbweni offers enriching [tours](mbweni/tours/tours.md) that allow you to explore the surrounding area and immerse yourself in the local culture and heritage. Join us as we embark on guided tours to nearby attractions, cultural landmarks, and natural wonders, enriching your understanding of the region and creating lasting memories. + +Join us at Mbweni and experience the perfect blend of fun, relaxation, and productivity. Whether you're seeking adventure, wellness, or simply a sense of community, our diverse range of activities has something for everyone. Welcome to a world of endless possibilities at Mbweni. diff --git a/collections/mbweni/activities/cinema.md b/collections/mbweni/activities/cinema.md index e69de29..8717da4 100644 --- a/collections/mbweni/activities/cinema.md +++ b/collections/mbweni/activities/cinema.md @@ -0,0 +1,20 @@ +# Ruins Movie Nights: Where Sustainability Meets Cinema + +Join us for a cinematic experience like no other at Ruins Movie Nights, held monthly amidst the lush surroundings of Mbweni Ruins and Botanical Gardens. Each month, we carefully select a movie that promotes sustainability and inspires positive change, creating an engaging and thought-provoking community meetup under the stars. + +## Enjoy Movie Magic in a Serene Setting + +Set against the backdrop of historic ruins and vibrant botanical gardens, Ruins Movie Nights offer a unique outdoor cinema experience that combines natural beauty with cinematic charm. Gather with friends and fellow movie enthusiasts to enjoy an unforgettable evening under the open sky. + +## Open to All + +Ruins Movie Nights are open to the public, inviting everyone to come together and enjoy an evening of entertainment and inspiration. Whether you're a local resident or a visitor to Mbweni, you're welcome to join us for an evening of movie magic and community camaraderie. + +## Food and Beverage Options + +Indulge in delicious food and beverages from Mbweni Restaurant, available upon request during Ruins Movie Nights. Treat yourself to a selection of culinary delights as you relax and unwind in the enchanting atmosphere of the ruins and gardens. + +## RSVP and More Information + +To RSVP for Ruins Movie Nights or for more information, please contact us at +255 778 242 424 or email info@mbweniruinsandgardens.com. Stay updated on upcoming movie screenings by following us on Instagram at [@mbweni.ruins.and.gardens](https://www.instagram.com/mbweni.ruins.and.gardens/). + diff --git a/collections/mbweni/activities/events.md b/collections/mbweni/activities/events.md index e69de29..3133a7d 100644 --- a/collections/mbweni/activities/events.md +++ b/collections/mbweni/activities/events.md @@ -0,0 +1,23 @@ +# Community Events at Mbweni Ruins and Gardens + +Join us every week for vibrant community events followed by a delicious buffet lunch, priced at 25,000 Tanzanian Shillings. + +## What to Expect + +- **Workshops:** Engage in hands-on learning experiences covering a variety of topics, from sustainability practices to cultural traditions. + +- **Seminars:** Dive deep into discussions on ecology, culture, and music, led by experts in their respective fields. + +- **Music Concerts:** Immerse yourself in the enchanting melodies of live music performances, showcasing local talent and international artists. + +- **Cooking Classes:** Learn the art of culinary creation with our cooking classes, where you'll discover new flavors and techniques. + +## Get Involved + +If you're a teacher, mentor, or simply passionate about contributing to our vibrant community, we welcome you to join us. Contact us at +255 778 242 424 or email info@mbweniruinsandgardens.com to learn more and get involved. + +## RSVP and Information + +For event RSVPs and more information, please reach out to us at +255 778 242 424 or email info@mbweniruinsandgardens.com. + +Be sure to check our schedule on [Instagram](https://www.instagram.com/mbweni.ruins.and.gardens) for upcoming events and updates! diff --git a/collections/mbweni/activities/sailing.md b/collections/mbweni/activities/sailing.md index e69de29..9fbedd8 100644 --- a/collections/mbweni/activities/sailing.md +++ b/collections/mbweni/activities/sailing.md @@ -0,0 +1,21 @@ +# Sailing at Mbweni Ruins and Gardens + +Set sail on the crystal-clear waters surrounding Mbweni Ruins and Gardens aboard our boats, Freeflow and Galaxy. Whether you're looking for a leisurely cruise or an adventurous outing, our sailing experiences offer something for everyone. + +## What We Offer + +- **Boats:** Enjoy the freedom of sailing on our well-equipped boats, Freeflow and Galaxy, designed for comfort and safety. + +- **Private Charter:** Host your special events, celebrations, or corporate gatherings aboard our boats with our private charter options. + +- **Food and Beverage:** Enhance your sailing experience with our food and beverage services available upon request. + +- **Group Size:** Whether you're planning a large group outing or an intimate gathering, our boats can accommodate both big and small groups. + +- **Sailors:** Choose to have experienced sailors accompany you on your voyage, or take the helm yourself—it's your option. + +## RSVP and Information + +To book your sailing experience or inquire about our services, please contact us for reservations and more information. + +Contact us: +255778242424 or email [info@mbweniruinsandgardens.com](mailto:info@mbweniruinsandgardens.com). diff --git a/collections/mbweni/activities/yoga.md b/collections/mbweni/activities/yoga.md index e69de29..e640c36 100644 --- a/collections/mbweni/activities/yoga.md +++ b/collections/mbweni/activities/yoga.md @@ -0,0 +1,21 @@ +# Yoga at Mbweni Ruins and Gardens + +Experience the tranquility and serenity of yoga amidst the lush surroundings of Mbweni Ruins and Gardens. Our yoga sessions are held in two idyllic locations: the spacious terrace of our restaurant and the serene private beachfront. Whether you prefer to greet the day with a sunrise session or unwind as the sun sets, our yoga spaces offer the perfect setting for your practice. + +## What We Offer + +- **Perfect Settings:** Practice yoga in the perfect settings of our terrace overlooking green landscapes or on our private beachfront, surrounded by the calming sounds of the ocean. + +- **Tranquil Atmosphere:** Immerse yourself in a tranquil atmosphere that promotes relaxation, mindfulness, and inner peace. + +- **Sunrise and Sunset Sessions:** Choose from sunrise or sunset sessions, each offering a unique experience and energy. + +- **Ideal for All Levels:** Our yoga sessions are suitable for practitioners of all levels, from beginners to experienced yogis. + +- **Mentorship Opportunity:** We are currently seeking a mentor to participate in our yoga program. If you are a seasoned yoga instructor interested in sharing your expertise, please contact us. + +## Contact Us + +To join our yoga sessions or inquire about mentorship opportunities, please contact us for more information. + +Contact us: +255778242424 or email [info@mbweniruinsandgardens.com](mailto:info@mbweniruinsandgardens.com). diff --git a/collections/mbweni/community/community.md b/collections/mbweni/community/community.md index e69de29..98718cd 100644 --- a/collections/mbweni/community/community.md +++ b/collections/mbweni/community/community.md @@ -0,0 +1,16 @@ +# Community at Mbweni Ruins and Gardens + +Welcome to the community page of Mbweni Ruins and Gardens! Here, you'll discover the diverse and vibrant community that calls Mbweni home. Navigate easily through the different aspects of our community: + +- [Mbweni Community](mbweni/community/mbweni_community.md): Learn about the residents and contributors who make up the Mbweni community. +- [ThreeFold](mbweni/community/threefold.md): Explore the ThreeFold community and their initiatives at Mbweni. +- [H.E.R DAO](mbweni/community/her_dao.md): Discover the projects and activities of H.E.R DAO within the Mbweni community. +- [LIOS Labs](mbweni/community/lios_labs.md): Find out about the innovative projects and collaborations taking place at LIOS Labs in Mbweni. +- [Dunia Yetu](mbweni/community/duniayetu.md): Learn about Dunia Yetu and their efforts to empower local communities in Mbweni and beyond. +- [Msonge Farm](mbweni/community/msonge.md): Explore the sustainable farming practices and agricultural projects at Msonge Farm. +- [Ootopia](mbweni/community/ootopia.md): Discover the vision and initiatives of Ootopia in creating sustainable communities at Mbweni. +- [Sikana](mbweni/community/sikana.md): Learn about Sikana's educational programs and community outreach efforts in Mbweni. +- [Sunzibar](mbweni/community/sunzibar.md): Explore Sunzibar's solar power initiatives and projects aimed at promoting sustainable tourism and environmental conservation in Mbweni. +- [VEDA Egypt](mbweni/community/veda_egypt.md): Discover the cultural exchange and collaboration projects between Mbweni and VEDA Egypt. + +Join us as we celebrate diversity, collaboration, and community spirit at Mbweni Ruins and Gardens! diff --git a/collections/mbweni/community/duniayetu.md b/collections/mbweni/community/duniayetu.md index e69de29..580657f 100644 --- a/collections/mbweni/community/duniayetu.md +++ b/collections/mbweni/community/duniayetu.md @@ -0,0 +1,17 @@ +# Dunia Yetu + +Dunia Yetu is a tech initiative program adjoints of Tanzanian Government and Ourworld Holdings, based in Dar es Salaam and Zanzibar, and operating throughout Tanzania. With a vision to pioneer technological innovation in East Africa and beyond, Dunia Yetu provides a platform for aspiring entrepreneurs and tech enthusiasts to develop their ideas and bring them to fruition. + +## Mission and Activities + +Dunia Yetu's mission is to foster a culture of innovation and entrepreneurship in Tanzania by providing resources, mentorship, and networking opportunities to budding tech startups. Through workshops, hackathons, and networking events, Dunia Yetu empowers individuals to turn their ideas into reality and make a positive impact in their communities. + +## Workshops and Training + +One of Dunia Yetu's core activities is organizing workshops and training sessions aimed at equipping participants with the skills and knowledge needed to succeed in the tech industry. These workshops cover a wide range of topics, including coding, web development, app design, and digital marketing, among others. By providing hands-on training and mentorship, Dunia Yetu helps aspiring tech entrepreneurs develop the skills and confidence they need to launch their own ventures. + +## Future Initiatives + +In the future, Dunia Yetu plans to expand its offerings to include coding schools and retreats aimed at providing immersive learning experiences for aspiring tech professionals. These programs will provide participants with the opportunity to deepen their technical skills, collaborate with like-minded individuals, and gain real-world experience in the tech industry. By nurturing the next generation of tech talent, Dunia Yetu aims to play a leading role in shaping the future of technology in East Africa and beyond. + +Join Dunia Yetu on its mission to drive technological innovation and empower aspiring entrepreneurs in Tanzania and beyond! diff --git a/collections/mbweni/community/her_dao.md b/collections/mbweni/community/her_dao.md index e69de29..ae645b7 100644 --- a/collections/mbweni/community/her_dao.md +++ b/collections/mbweni/community/her_dao.md @@ -0,0 +1,19 @@ +# H.E.R DAO + +H.E.R. DAO is a dynamic developer and builder pipeline dedicated to championing innovation and diversity in the web3 space, with a special focus on women. The acronym "H.E.R" stands for Her Empowerment Revolution, reflecting the organization's commitment to empowering women and promoting inclusivity in the rapidly evolving world of decentralized technologies. + +## Mission and Vision + +H.E.R DAO's mission is to create a supportive ecosystem where women can thrive and excel in the web3 industry. By providing access to resources, mentorship, and networking opportunities, H.E.R DAO aims to bridge the gender gap in technology and empower women to become leaders and innovators in the blockchain and decentralized finance (DeFi) sectors. + +## Goals and Objectives + +- **Diversity and Inclusion:** H.E.R DAO is committed to fostering diversity and inclusion in the web3 space by providing opportunities for women from diverse backgrounds to enter and succeed in the industry. + +- **Education and Training:** Through workshops, hackathons, and educational programs, H.E.R DAO equips women with the skills and knowledge they need to thrive in the rapidly evolving world of decentralized technologies. + +- **Community Building:** H.E.R DAO fosters a strong sense of community among its members, providing a supportive network where women can connect, collaborate, and share ideas. + +## Learn More + +To learn more about H.E.R DAO and its initiatives, visit their website: [H.E.R DAO](https://www.her-dao.xyz/). Join the revolution and be part of a movement that is shaping the future of the web3 industry, one empowered woman at a time. diff --git a/collections/mbweni/community/lios_labs.md b/collections/mbweni/community/lios_labs.md index e69de29..0654728 100644 --- a/collections/mbweni/community/lios_labs.md +++ b/collections/mbweni/community/lios_labs.md @@ -0,0 +1,19 @@ +# LIOS Labs Arts of Ecology Platform + +LIOS Labs stands as a pioneering agency for transformative experiences, a vibrant ecosystem interweaving artists, cultural producers, researchers, and storytellers. Inspired by biomimetic systems, LIOS Labs propels sustainable models for cultural production and ecological education into the forefront. Driven by a community-led ethos and a not-for-profit foundation, LIOS Labs cultivates regenerative practices, amalgamating the potent forces of beyond-reason knowledge, art, healing modalities, science, and technology. + +## Mission and Vision + +Embracing a mission to prototype sustainable cultural models and ecological education platforms, LIOS Labs envisions a world where regenerative practices flourish. Their ethos revolves around harnessing the collective wisdom of diverse disciplines to foster positive societal transformation. Through community-driven initiatives, LIOS Labs aspires to ignite conversations, spark innovation, and catalyze action on critical environmental and social issues. + +## Endeavors + +- **Cultural Production:** Collaborating with a diverse array of artists and cultural producers, LIOS Labs crafts immersive and transformative experiences. These experiences, ranging from exhibitions to performances, serve as catalysts for dialogue and introspection, aiming to evoke profound shifts in perception and behavior. + +- **Ecological Education:** Recognizing the pivotal role of education in fostering sustainability, LIOS Labs is dedicated to providing accessible and engaging educational resources. Through workshops, seminars, and experiential learning opportunities, they empower individuals to deepen their understanding of ecology and embrace environmentally conscious practices. + +- **Biomimicry and Innovation:** Grounded in the principles of biomimicry, LIOS Labs explores nature's design solutions to inform their approach to innovation and problem-solving. By studying and emulating nature's strategies, they strive to develop sustainable solutions across various domains, from architecture and urban planning to renewable energy and waste management. + +## Learn More + +For further insights into LIOS Labs and their transformative initiatives, visit their website: [LIOS Labs](https://lios.io). Join the movement towards a more sustainable and regenerative future, where art, education, and innovation converge to create meaningful change. Together, we can build a world where harmony with nature and collective well-being are paramount. \ No newline at end of file diff --git a/collections/mbweni/community/mbweni_community.md b/collections/mbweni/community/mbweni_community.md index e69de29..a7252ca 100644 --- a/collections/mbweni/community/mbweni_community.md +++ b/collections/mbweni/community/mbweni_community.md @@ -0,0 +1,19 @@ +# Mbweni Community + +Within the vibrant community of Mbweni Ruins and Gardens, a diverse tapestry of individuals converges to create a harmonious and inclusive environment. Comprising 56 staff members and residents, the community reflects a blend of local Tanzanian and Zanzibari cultures, fostering a rich tapestry of traditions, languages, and perspectives. + +## Staff and Residents + +At the heart of the Mbweni community are the 56 individuals who call it home. Hailing from Tanzania, Zanzibar, and worldwide, each member brings a unique background and story, contributing to the vibrant tapestry of the community. From hospitality professionals to artists, educators, and environmentalists, the community is a melting pot of talents and passions. + +## Maasai Guards: Respecting Local Culture and Tradition + +In a nod to local culture and tradition, Mbweni Ruins and Gardens employs Maasai guards to ensure the safety and security of the community. The Maasai people, renowned for their distinctive dress, rich cultural heritage, and strong sense of identity, bring a sense of tradition and authenticity to Mbweni. By engaging Maasai guards, Mbweni pays homage to the indigenous cultures of Tanzania and Zanzibar, fostering respect and understanding within the community. + +## About the Maasai + +The Maasai are a semi-nomadic ethnic group inhabiting the regions of Kenya and Tanzania. Renowned for their distinctive attire, which includes vibrant shukas (blankets) and intricate beadwork, the Maasai have a rich cultural heritage that spans centuries. Traditionally, the Maasai are pastoralists, relying on cattle herding as their primary livelihood. They are known for their strong sense of community, oral traditions, and deep connection to the land. + +Employing Maasai guards at Mbweni Ruins and Gardens not only enhances security but also serves as a tribute to the rich cultural diversity of Tanzania and Zanzibar. It reflects Mbweni's commitment to fostering an inclusive and respectful community that honors and celebrates the traditions of the local people. + +Join us in celebrating the diversity and richness of the Mbweni community, where cultural exchange and mutual respect are at the forefront of community life. \ No newline at end of file diff --git a/collections/mbweni/community/msonge.md b/collections/mbweni/community/msonge.md index e69de29..c26e487 100644 --- a/collections/mbweni/community/msonge.md +++ b/collections/mbweni/community/msonge.md @@ -0,0 +1,19 @@ +# Msonge Organic Farm: Nurturing Sustainable Agriculture + +Nestled amidst the picturesque landscapes of Tanzania, Msonge Organic Farm stands as a beacon of sustainable agriculture and environmental stewardship. With a commitment to organic farming practices and community empowerment, Msonge Organic Farm is reshaping the agricultural landscape of the region. + +## Cultivating Sustainability + +At Msonge Organic Farm, sustainability is more than just a buzzword—it's a way of life. Through the use of organic farming methods and permaculture principles, the farm seeks to minimize its environmental footprint while maximizing productivity. From cultivating diverse crops without synthetic pesticides or fertilizers to implementing water-saving irrigation techniques, every aspect of farming at Msonge is guided by a deep respect for the land and its resources. + +## Empowering Communities + +Beyond its commitment to sustainable agriculture, Msonge Organic Farm is dedicated to empowering local communities. By providing employment opportunities and training programs, the farm not only supports livelihoods but also fosters a sense of pride and ownership among community members. Through initiatives such as farmer training workshops and educational outreach programs, Msonge Organic Farm is equipping individuals with the knowledge and skills they need to thrive in a changing agricultural landscape. + +## Nurturing Connection + +At the heart of Msonge Organic Farm is a deep connection—to the land, to the community, and to the broader ecosystem. By fostering a sense of stewardship and responsibility, the farm encourages individuals to see themselves not as separate from nature, but as integral parts of a larger whole. Through practices such as agroforestry and soil conservation, Msonge Organic Farm is working to regenerate the land and create a more resilient and vibrant ecosystem for future generations. + +## Learn More + +To discover more about Msonge Organic Farm and its initiatives, visit their website: [Msonge Organic Farm](https://www.msonge.co.tz/). Join them on their journey to cultivate sustainability, empower communities, and nurture connections—to the land and to each other. \ No newline at end of file diff --git a/collections/mbweni/community/ootopia.md b/collections/mbweni/community/ootopia.md index e69de29..63a3f85 100644 --- a/collections/mbweni/community/ootopia.md +++ b/collections/mbweni/community/ootopia.md @@ -0,0 +1,27 @@ +# OOTOPIA: Pioneering Purpose-Driven Innovation + +In the quest for purpose-driven projects, OOTOPIA emerges as a beacon of innovation and resilience. Conceived five years ago, amid the corridors of Apple, OOTOPIA represents the culmination of a transformative journey fueled by passion, determination, and a steadfast commitment to effecting positive change in the world. + +## A Journey of Discovery and Reflection + +The genesis of OOTOPIA traces back to a pivotal moment of its team, driven by a deep-seated belief in the transformative power of technology to improve lives, the founder sought to transcend the confines of corporate success and pursue a more meaningful endeavor. + +## Unveiling the Vision + +Central to the founding philosophy of OOTOPIA is the recognition that technology, while remarkable, possesses the potential to be a force for profound societal change. Inspired by the insight that smartphones could revolutionize access to education and, by extension, economic opportunity, the founder embarked on a mission to harness the power of digital platforms for the greater good. + +## Sikana: A Prelude to OOTOPIA + +Before the dawn of OOTOPIA, the seeds of innovation were sown through Sikana—a platform dedicated to democratizing access to life skills education. From first aid courses to agricultural tutorials, Sikana endeavored to empower individuals with the knowledge they needed to thrive in a rapidly changing world. Yet, despite its noble aspirations, Sikana encountered formidable challenges on its journey—a cautionary tale of the perils of prioritizing profit over purpose. + +## Embracing Failure, Embracing Growth + +The demise of Sikana was not merely a setback but a crucible of learning—a catalyst for introspection and growth. From the ashes of failure emerged invaluable lessons, guiding the team towards a renewed vision for the future. Armed with a newfound clarity of purpose, OOTOPIA emerged as a testament to resilience, innovation, and unwavering commitment to effecting positive change. + +## A New Dawn: Introducing OOTOPIA + +Today, OOTOPIA stands poised at the precipice of possibility—a beacon of hope and inspiration in an ever-changing world. More than an app, OOTOPIA represents a bold vision for the future—a platform that transcends boundaries, empowers individuals, and fosters meaningful connections. Through a rich tapestry of videos, articles, games, and guides, OOTOPIA invites users to explore the challenges of the world and be rewarded for their curiosity and engagement. + +## Join the Journey + +As OOTOPIA embarks on its maiden voyage, we invite you to join us on this transformative journey. Together, let us challenge the status quo, embrace innovation, and be the change we wish to see in the world. Welcome to OOTOPIA—where purpose meets possibility, and every journey begins with a single step. \ No newline at end of file diff --git a/collections/mbweni/community/sikana.md b/collections/mbweni/community/sikana.md index e69de29..44b9412 100644 --- a/collections/mbweni/community/sikana.md +++ b/collections/mbweni/community/sikana.md @@ -0,0 +1,23 @@ +# Sikana: Empowering Lives Through Practical Skills Education + +Sikana emerges as a beacon of hope and empowerment, dedicated to equipping individuals with practical skills that unlock their full potential and lead to dignified lives. Founded in 2014 as a non-profit organization, Sikana's mission is clear: to democratize access to education through free, high-quality video programs. + +## A Vision of Inclusion and Empowerment + +At the heart of Sikana's mission lies a profound understanding of the global challenges facing billions of people who lack access to formal education and vocational training. Recognizing the transformative power of technology, Sikana seeks to harness the ubiquity of screens—accessible to 3 billion people worldwide—as tools for instruction and empowerment. + +## Democratizing Education Through Video + +Sikana's innovative approach to education centers on the use of video as a powerful and cost-effective medium for promoting skill acquisition, health awareness, and environmental consciousness. By leveraging the visual and auditory capabilities of video, Sikana transcends language barriers and geographic boundaries, making education accessible to anyone with an internet connection. + +## Bridging the Skills Gap + +In a world where basic skills are often taken for granted, Sikana fills a crucial gap by providing practical knowledge and know-how to individuals who lack access to formal education and training. From first aid and cooking to gardening and home repair, Sikana's video programs cover a diverse range of topics, empowering individuals to take control of their lives and pursue their passions. + +## A Commitment to Impact + +Driven by a commitment to social impact, Sikana operates as a non-profit organization, ensuring that its educational resources remain free and accessible to all. By partnering with experts and organizations around the world, Sikana delivers high-quality content that meets the needs of diverse communities, fostering a culture of learning and empowerment. + +## Join the Movement + +As Sikana continues to expand its reach and impact, we invite you to join us in our mission to democratize education and empower individuals worldwide. Together, let us harness the power of video to transform lives, unlock potential, and build a brighter future for all. Welcome to Sikana—a world of opportunity, knowledge, and empowerment. \ No newline at end of file diff --git a/collections/mbweni/community/sunzibar.md b/collections/mbweni/community/sunzibar.md index e69de29..4c6322d 100644 --- a/collections/mbweni/community/sunzibar.md +++ b/collections/mbweni/community/sunzibar.md @@ -0,0 +1,23 @@ +# Sunzibar Solar: Illuminating Zanzibar with Sustainable Energy + +Sunzibar Solar emerges as a beacon of hope and innovation in the realm of renewable energy, dedicated to harnessing the power of the sun to illuminate the vibrant island of Zanzibar. With a mission to provide sustainable energy solutions to communities in need, Sunzibar Solar offers a range of solar products and services aimed at reducing reliance on fossil fuels and promoting environmental sustainability. + +## Powering Communities with Solar Energy + +At the core of Sunzibar Solar's mission lies a commitment to empowering communities with clean, reliable, and affordable energy solutions. By harnessing the abundant solar resources of Zanzibar, Sunzibar Solar seeks to address the energy challenges facing the island, including limited access to electricity and high dependence on costly and polluting fuels. + +## Sustainable Solutions for a Brighter Future + +Sunzibar Solar offers a comprehensive range of solar products and services designed to meet the diverse needs of individuals, businesses, and communities. From solar panels and inverters to solar water heaters and off-grid lighting systems, Sunzibar Solar provides turnkey solutions that enable customers to harness the power of the sun and reduce their carbon footprint. + +## Environmental Impact and Social Responsibility + +Driven by a commitment to environmental stewardship and social responsibility, Sunzibar Solar operates with sustainability at its core. By promoting the adoption of solar energy and reducing reliance on fossil fuels, Sunzibar Solar contributes to mitigating climate change and protecting the natural beauty and biodiversity of Zanzibar. + +## Partnering for Progress + +Sunzibar Solar collaborates with local communities, businesses, and government agencies to promote the adoption of solar energy and drive sustainable development across Zanzibar. Through partnerships and outreach initiatives, Sunzibar Solar aims to raise awareness about the benefits of solar energy and empower individuals and communities to embrace renewable energy solutions. + +## Join the Solar Revolution + +As Sunzibar Solar continues to expand its reach and impact, we invite you to join us in our mission to illuminate Zanzibar with sustainable energy. Whether you're a homeowner, business owner, or community leader, there's never been a better time to embrace solar power and build a brighter future for Zanzibar and beyond. Welcome to Sunzibar Solar—a beacon of light in a world powered by the sun. \ No newline at end of file diff --git a/collections/mbweni/community/threefold.md b/collections/mbweni/community/threefold.md index e69de29..3b97f03 100644 --- a/collections/mbweni/community/threefold.md +++ b/collections/mbweni/community/threefold.md @@ -0,0 +1,23 @@ +# ThreeFold: Pioneering the Decentralized Internet Revolution + +ThreeFold emerges as a trailblazer in the quest to revolutionize the internet landscape, championing decentralization, sustainability, and empowerment. With a vision to create a more equitable and accessible digital future, ThreeFold offers a groundbreaking decentralized cloud platform that empowers individuals and organizations to take control of their digital destinies. + +## Decentralizing the Internet + +At the heart of ThreeFold's mission lies a commitment to decentralization—a paradigm shift that challenges the centralized control and ownership of data and infrastructure. By leveraging blockchain technology and peer-to-peer networks, ThreeFold aims to democratize access to computing resources and create a more resilient, secure, and equitable internet ecosystem. + +## Building a Sustainable Future + +In addition to decentralization, sustainability is a core pillar of ThreeFold's philosophy. Recognizing the environmental impact of traditional data centers and cloud computing, ThreeFold has developed a sustainable alternative powered by renewable energy sources. By minimizing energy consumption and carbon emissions, ThreeFold's decentralized cloud platform offers a greener, more eco-friendly solution for hosting digital applications and services. + +## Empowering Individuals and Communities + +Centralized internet infrastructure often places control and decision-making power in the hands of a few large corporations. ThreeFold seeks to change this dynamic by empowering individuals and communities to own and manage their digital assets. Through its decentralized cloud platform, ThreeFold enables users to deploy, scale, and manage digital workloads with unprecedented ease and flexibility, putting the power of the internet back into the hands of the people. + +## Collaborating for Impact + +ThreeFold recognizes that meaningful change requires collaboration and collective action. That's why the company partners with like-minded organizations, developers, and communities to advance the cause of decentralization and sustainability. By fostering an open ecosystem of innovation and collaboration, ThreeFold aims to accelerate the adoption of decentralized technologies and create a more inclusive and resilient internet for all. + +## Join the Decentralized Revolution + +As ThreeFold continues to expand its reach and impact, we invite you to join us in building a better, more decentralized internet for the future. Whether you're a developer, entrepreneur, or simply passionate about creating positive change, there's a place for you in the ThreeFold community. Together, let's unlock the full potential of the decentralized internet and create a world where everyone has equal access to digital resources and opportunities. Welcome to ThreeFold—the future of the internet starts here. \ No newline at end of file diff --git a/collections/mbweni/community/veda_egypt.md b/collections/mbweni/community/veda_egypt.md index e69de29..37709f1 100644 --- a/collections/mbweni/community/veda_egypt.md +++ b/collections/mbweni/community/veda_egypt.md @@ -0,0 +1,23 @@ +# VEDA Egypt: Nurturing Wellness and Empowerment + +VEDA Egypt emerges as a beacon of holistic wellness and empowerment, dedicated to promoting physical, mental, and spiritual well-being through the ancient wisdom of Ayurveda. Rooted in the rich cultural heritage of Egypt and inspired by the timeless teachings of Ayurveda, VEDA Egypt offers a sanctuary for healing, rejuvenation, and self-discovery. + +## Embracing Ancient Wisdom + +At the heart of VEDA Egypt's philosophy lies a deep reverence for the ancient wisdom of Ayurveda—a holistic system of medicine that originated in India over 5,000 years ago. Drawing upon the principles of Ayurveda, VEDA Egypt seeks to restore balance and harmony to the body, mind, and spirit, guiding individuals on a transformative journey towards optimal health and vitality. + +## A Sanctuary for Healing and Rejuvenation + +Nestled amidst the serene landscapes of Egypt, VEDA Egypt offers a sanctuary for healing and rejuvenation, where guests can escape the stresses of modern life and reconnect with their inner selves. From luxurious spa treatments to personalized wellness programs, VEDA Egypt provides a range of services designed to promote relaxation, rejuvenation, and holistic well-being. + +## Empowering Individuals to Thrive + +Beyond physical healing, VEDA Egypt is committed to empowering individuals to take control of their health and wellness journey. Through educational workshops, seminars, and wellness retreats, VEDA Egypt equips participants with the knowledge and tools they need to cultivate a lifestyle of balance, vitality, and empowerment. + +## Cultivating Community and Connection + +At VEDA Egypt, community and connection are at the heart of everything we do. Through group classes, communal meals, and shared experiences, guests have the opportunity to connect with like-minded individuals and build meaningful relationships that support and inspire their wellness journey. + +## Join the Journey + +Whether you're seeking physical healing, emotional well-being, or spiritual growth, VEDA Egypt invites you to embark on a transformative journey towards wellness and empowerment. Step into our sanctuary and discover the healing power of Ayurveda in the heart of Egypt. Welcome to VEDA Egypt—where wellness meets wisdom, and transformation begins. \ No newline at end of file diff --git a/collections/mbweni/facilities/beach.md b/collections/mbweni/facilities/beach.md index e69de29..a39d715 100644 --- a/collections/mbweni/facilities/beach.md +++ b/collections/mbweni/facilities/beach.md @@ -0,0 +1,38 @@ +# Private Beach Area at Mbweni Ruins and Gardens + +Escape to our exclusive private beach area at Mbweni Ruins and Gardens, where tranquility meets luxury. Nestled along the picturesque Mbweni Bay, our private beach offers a serene retreat for relaxation and rejuvenation. + +## What We Offer + +- **Swimming Pool:** Take a refreshing dip in our sparkling swimming pool, perfect for cooling off on a hot day. + +- **Sunbeds and Towels:** Relax in comfort on our sunbeds and enjoy complimentary towels for your convenience. + +- **Food and Beverage Service:** Indulge in delicious food and refreshing beverages served right to your sunbed, ensuring a hassle-free beach experience. + +- **Sunset Views:** Witness breathtaking sunsets over Mbweni Bay, creating the perfect backdrop for an unforgettable evening. + +- **Quietness and Bonfire:** Embrace the tranquility of our private beach area, where the gentle sound of waves and crackling bonfire create an atmosphere of peace and relaxation. + +## Membership Benefits + +### Beach Club Membership + +Elevate your leisure time to new heights with Mbweni Ruins & Gardens Beach Club Membership. Immerse yourself in the tranquil ambiance and indulge in amenities that come with being part of our Beach Club family. + +- **Daily Access:** Enjoy access to our private beach area from 08:00 to 18:00 daily. + +- **Membership Options:** Choose between daily visit passes at TSH 25,000 per visit or monthly memberships at TSH 125,000. + +- **Exclusive Benefits:** Beach Club members gain access to an array of amenities, including: + - 15% discount on food and beverage purchases + - Access to spa services + - Discounts on watersport rentals + - Complimentary pool towel and Wi-Fi access + - Invitation to exclusive members' events + +## Join Us + +Become a member of our Beach Club and experience seaside luxury like never before. Contact us to inquire about membership options and start enjoying the perks of beachfront bliss. + +Contact us: +255778242424 or email [info@mbweniruinsandgardens.com](mailto:info@mbweniruinsandgardens.com). diff --git a/collections/mbweni/facilities/coworking.md b/collections/mbweni/facilities/coworking.md index e69de29..c500042 100644 --- a/collections/mbweni/facilities/coworking.md +++ b/collections/mbweni/facilities/coworking.md @@ -0,0 +1,33 @@ +# Coworking Space at Mbweni Ruins and Gardens + +Discover a productive and collaborative environment at our coworking space, where creativity flourishes and ideas come to life. Designed to meet the needs of modern professionals, our coworking space offers a range of amenities to enhance your work experience. + +## What We Offer + +- **Member Access:** Every member of Mbweni Ruins and Gardens has the right to access our coworking space, providing you with a dedicated area to focus on your projects and collaborate with others. + +- **High-Speed Wifi:** Stay connected and productive with fast-speed wifi available throughout the coworking space, ensuring seamless communication and workflow. + +- **Ergonomic Seating and Tables:** Work in comfort with ergonomic chairs and tables designed to support your posture and enhance productivity. + +- **Ample Lighting:** Enjoy ample natural light and well-placed artificial lighting to create a bright and conducive workspace. + +- **Resting Area:** Take breaks and recharge in our designated resting area, equipped with comfortable seating and a serene ambiance. + +- **Presentation Facilities:** Conduct meetings and presentations with ease using our LCD TV and presentation setup, perfect for sharing ideas and collaborating with colleagues. + +- **Sofa Area:** Collaborate and brainstorm in a relaxed setting with our cozy sofa area, ideal for informal meetings and discussions. + +- **24/7 Access for Residents:** Our coworking space is open 24/7 for residents, allowing you to work according to your schedule and preferences. + +- **Air Conditioning:** Stay cool and comfortable throughout the day with air conditioning available in our coworking space, ensuring a pleasant working environment. + +- **Fully Equipped Kitchen:** Fuel your productivity with access to a fully equipped kitchen, complete with a coffee machine and all the amenities you need to prepare snacks and meals. + +- **Restaurant Service Delivery:** Enjoy the convenience of restaurant service delivery to our coworking space, allowing you to dine on delicious meals without leaving your workspace. + +## Join Us + +Experience the benefits of our coworking space and take your work to new heights in a supportive and inspiring environment. Contact us to learn more about membership options and start coworking with us today. + +Contact us: +255778242424 or email [info@mbweniruinsandgardens.com](mailto:info@mbweniruinsandgardens.com). diff --git a/collections/mbweni/facilities/facilities.md b/collections/mbweni/facilities/facilities.md index e69de29..b02f354 100644 --- a/collections/mbweni/facilities/facilities.md +++ b/collections/mbweni/facilities/facilities.md @@ -0,0 +1,23 @@ +# Fun and Productive Activities at Mbweni + +Welcome to Mbweni, where every day is filled with excitement, adventure, and productivity. Whether you're seeking thrilling outdoor sports, peaceful yoga sessions, or engaging community events, there's something for everyone at Mbweni. Join us as we explore a variety of activities designed to enhance your experience and make your stay both enjoyable and fulfilling. + +## Navigate Through Exciting Activities + +Embark on a journey of exploration and discovery as you navigate through our diverse range of activities: + +- [**Sailing:**](mbweni/activities/sailing.md) Set sail on the crystal-clear waters surrounding Mbweni and experience the thrill of navigating the waves. + +- [**Community Events:**](mbweni/activities/events.md) Immerse yourself in the vibrant community spirit of Mbweni by participating in our engaging and inclusive events. + +- [**Outdoor Sports:**](mbweni/activities/sports.md) Get your adrenaline pumping with a variety of outdoor sports activities, including beach volleyball, kayaking, and more. + +- [**Yoga:**](mbweni/activities/yoga.md) Find inner peace and balance with rejuvenating yoga sessions set against the backdrop of Mbweni's natural beauty. + +- [**Outdoor Cinema:**](mbweni/activities/cinema.md) Sit back, relax, and enjoy movie nights under the stars with our outdoor cinema experience, perfect for cozy evenings with friends and family. + +## Explore Enriching Tours + +In addition to our on-site activities, Mbweni offers enriching tours that allow you to explore the surrounding area and immerse yourself in the local culture and heritage. Join us as we embark on guided tours to nearby attractions, cultural landmarks, and natural wonders, enriching your understanding of the region and creating lasting memories. + +Join us at Mbweni and experience the perfect blend of fun, relaxation, and productivity. Whether you're seeking adventure, wellness, or simply a sense of community, our diverse range of activities has something for everyone. Welcome to a world of endless possibilities at Mbweni. diff --git a/collections/mbweni/facilities/restaurant.md b/collections/mbweni/facilities/restaurant.md index e69de29..54c705e 100644 --- a/collections/mbweni/facilities/restaurant.md +++ b/collections/mbweni/facilities/restaurant.md @@ -0,0 +1,25 @@ +# Mbweni Ruins and Gardens Restaurant + +Also known as "The Wooden Table," our restaurant at Mbweni Ruins and Gardens offers a rich fusion of Zanzibar local, Tanzanian, and worldwide cuisine. With a commitment to providing diverse and flavorful dishes, we cater to a variety of dietary preferences, including vegan, organic, and gluten-free options. + +## Dining Experience + +Indulge in delectable flavors and breathtaking ocean views at our restaurant, where every bite is a symphony of taste. Unwind at Mbweni Bar, sipping on refreshing cocktails and soaking in the sun's warmth. With a fusion of exquisite cuisine and an idyllic ambiance, Mbweni Ruins & Gardens invites you to savor moments of pure culinary bliss. + +- **Operating Hours:** Daily from 07:00 to 22:30 + +- **Gastronomic Excellence:** Experience gastronomic excellence with breathtaking sunsets on Zanzibar's west coast. Whether it's a memorable meal or a candlelit romantic dinner for two, our restaurant offers an unparalleled dining experience that will leave you enchanted. + +## Menu + +Explore our menu offerings and tantalize your taste buds with our diverse selection of dishes: + +[View Menu](https://www2.mbweniruinsandgardens.com/docs/menu.pdf) + +## Join Us + +We look forward to welcoming you to Mbweni Ruins and Gardens Restaurant, where culinary delights await amidst stunning surroundings. + +For reservations or inquiries, please contact us: + +Contact us: +255778242424 or email [info@mbweniruinsandgardens.com](mailto:info@mbweniruinsandgardens.com). diff --git a/collections/mbweni/facilities/sports.md b/collections/mbweni/facilities/sports.md index e69de29..1109ce2 100644 --- a/collections/mbweni/facilities/sports.md +++ b/collections/mbweni/facilities/sports.md @@ -0,0 +1,23 @@ +# Sport Equipment Rental at Mbweni Ruins and Gardens + +Support your active lifestyle and explore exciting adventures with our sport equipment rental services. Whether you're craving water sports or land activities, we offer a variety of equipment to cater to your interests and preferences. + +## Available Equipment + +- **Water Sports:** Dive into the crystal-clear waters of Mbweni Bay with our selection of water sports equipment, including paddleboards, snorkeling gear, and swim shoes. + +- **Land Activities:** Get your adrenaline pumping with a game of volleyball or football on our pristine beach. Or challenge your friends to a friendly match on our pool table. + +- **Yoga Mats:** Find your inner peace and harmony with our yoga mats, perfect for practicing yoga sessions amidst the tranquil surroundings of Mbweni Ruins and Gardens. + +## Personal Trainers + +Enhance your fitness journey with the assistance of our personal trainers, available upon request and depending on the season. Whether you're a beginner or a seasoned athlete, our trainers will provide expert guidance and support to help you achieve your fitness goals. + +## How to Rent + +To rent sport equipment or inquire about personal trainers, please contact us for availability and pricing: + +Contact us: +255778242424 or email [info@mbweniruinsandgardens.com](mailto:info@mbweniruinsandgardens.com). + +Embrace an active lifestyle and make the most of your stay at Mbweni Ruins and Gardens with our sport equipment rental services. diff --git a/collections/mbweni/facilities/swimmingpool.md b/collections/mbweni/facilities/swimmingpool.md index e69de29..20f850b 100644 --- a/collections/mbweni/facilities/swimmingpool.md +++ b/collections/mbweni/facilities/swimmingpool.md @@ -0,0 +1,27 @@ +# Swimming Pool at Mbweni Ruins and Gardens + +Dive into relaxation at our infinity pool, nestled by the beach and surrounded by lush botanical gardens. Exclusively available for residents and beach club members, our swimming pool offers a serene oasis where you can unwind and soak up the beauty of Mbweni Bay. + +## Features + +- **Infinity Pool:** Immerse yourself in the tranquility of our infinity pool, where the sparkling waters seamlessly blend with the horizon, creating a breathtaking vista. + +- **Beachfront Location:** Enjoy direct access to the beach from our swimming pool area, allowing you to seamlessly transition between refreshing dips in the pool and leisurely strolls along the sandy shores. + +- **Exclusive Access:** Access to our swimming pool is reserved for residents of Mbweni Ruins and Gardens and members of our Beach Club, ensuring a private and intimate experience for our valued guests. + +- **Botanical Garden Surroundings:** Surround yourself with the beauty of nature as you lounge by the pool, with our botanical gardens providing a verdant backdrop for your relaxation. + +- **F&B Delivery Service:** Indulge in delectable refreshments and culinary delights with our convenient food and beverage delivery service from the restaurant. Savor a refreshing drink or a light snack as you bask in the sun or enjoy the mesmerizing sunset views. + +## Sunset Point + +Experience unparalleled sunset views from our swimming pool area, where the horizon melts into hues of orange and pink, creating a spectacle that will leave you in awe. + +## Join Us + +Elevate your leisure time to new heights with a visit to our swimming pool at Mbweni Ruins and Gardens. Become a resident or join our Beach Club to gain exclusive access to this luxurious amenity. + +For inquiries or to become a resident or Beach Club member, please contact us: + +Contact us: +255778242424 or email [info@mbweniruinsandgardens.com](mailto:info@mbweniruinsandgardens.com). diff --git a/collections/mbweni/history/gardens.md b/collections/mbweni/history/gardens.md index e69de29..04c0419 100644 --- a/collections/mbweni/history/gardens.md +++ b/collections/mbweni/history/gardens.md @@ -0,0 +1,17 @@ +# History of Mbweni Botanical Gardens + +The Mbweni Botanical Gardens, nestled within the tranquil coastal region of Mbweni, have a rich history that dates back to the colonial era. Originally established as part of the St Mary’s School for Girls, founded by missionaries in the 19th century, the gardens served as a place of education and recreation for the students. + +Culturally and historically, the Mbweni Botanical Gardens hold significance as a symbol of colonial influence and botanical exploration in East Africa. The gardens were meticulously cultivated with a diverse array of plant species, including exotic flora from around the world, showcasing the region's botanical diversity and serving as a living laboratory for scientific study. + +In addition to their educational and scientific importance, the Mbweni Botanical Gardens also provided a peaceful retreat for students and staff alike, offering a sanctuary amidst the hustle and bustle of daily life. The gardens were a place of reflection, relaxation, and inspiration, where visitors could immerse themselves in the beauty of nature and marvel at the wonders of the plant kingdom. + +Today, the Mbweni Botanical Gardens are an integral part of Mbweni Ruins and Gardens, a vibrant community and regeneration hub dedicated to sustainable tourism and cultural preservation. The gardens have been lovingly restored and maintained, with an emphasis on preserving their historical and botanical significance. + +Fun Facts: + +- The Mbweni Botanical Gardens are home to a diverse array of plant species, including rare and endangered specimens. +- Visitors to the gardens can spot a variety of wildlife, including birds, butterflies, and small mammals, making it a haven for nature lovers. +- The gardens feature several scenic walking trails, allowing visitors to explore the lush landscapes and discover hidden gems along the way. + +Mbweni Ruins and Gardens is committed to protecting and promoting the legacy of the Mbweni Botanical Gardens, ensuring that future generations can continue to enjoy their beauty and significance for years to come. \ No newline at end of file diff --git a/collections/mbweni/history/history.md b/collections/mbweni/history/history.md index e69de29..501604f 100644 --- a/collections/mbweni/history/history.md +++ b/collections/mbweni/history/history.md @@ -0,0 +1,8 @@ +# Mbweni Ruins and Gardens History + +Here, you'll discover the fascinating stories behind the ruins and botanical gardens that make Mbweni a unique destination. Navigate easily through the different aspects of Mbweni's history: + +- [Mbweni Ruins](mbweni/history/ruins.md): Learn about the ancient ruins that dot the landscape of Mbweni and their historical significance. +- [Botanical Gardens](mbweni/history/gardens.md): Explore the lush botanical gardens of Mbweni and their role in preserving the natural beauty of the area. + +Embark on a journey through time as we uncover the rich heritage and cultural legacy of Mbweni Ruins and Gardens. diff --git a/collections/mbweni/history/ruins.md b/collections/mbweni/history/ruins.md index e69de29..ae15ae6 100644 --- a/collections/mbweni/history/ruins.md +++ b/collections/mbweni/history/ruins.md @@ -0,0 +1,11 @@ +# History of Mbweni Ruins + +Located in the serene coastal region of Mbweni, the ruins of Mbweni hold a significant historical and cultural legacy that dates back centuries. Originally established as a settlement for freed slaves in the 19th century, Mbweni served as a base for the Universities Mission to Central Africa (UMCA), an organization dedicated to education and Christian missionary work in East Africa. + +The ruins of Mbweni include remnants of St Mary’s School for Girls, which was founded by missionaries to provide education and refuge for girls rescued from slave ships. The school played a crucial role in the emancipation of slaves and the promotion of education in the region during a tumultuous period of East African history. + +Culturally and historically, Mbweni represents a beacon of hope and resilience in the face of adversity. The ruins stand as a testament to the struggles and triumphs of those who sought refuge and redemption in this coastal enclave. The site serves as a poignant reminder of the horrors of the slave trade and the resilience of those who fought against it. + +Today, the ruins of Mbweni are preserved as part of Mbweni Ruins and Gardens, a vibrant community and regeneration hub dedicated to sustainable tourism and cultural preservation. The site has been transformed into a peaceful retreat, where visitors can explore the remnants of the past and immerse themselves in the natural beauty of the surrounding botanical gardens. + +Mbweni Ruins and Gardens serves as a living testament to the enduring legacy of Mbweni and its importance in East African history. Through preservation and interpretation, the site continues to educate and inspire visitors from around the world, ensuring that the lessons of the past are not forgotten. \ No newline at end of file diff --git a/collections/mbweni/initiatives/harvest_gardens.md b/collections/mbweni/initiatives/harvest_gardens.md index e69de29..9509a38 100644 --- a/collections/mbweni/initiatives/harvest_gardens.md +++ b/collections/mbweni/initiatives/harvest_gardens.md @@ -0,0 +1,29 @@ +# Harvest Garden Project: Cultivating Sustainable Agriculture at Mbweni Ruins and Gardens + +At Mbweni Ruins and Gardens, we are passionate about fostering sustainable agriculture practices and promoting a farm-to-table lifestyle. Our Harvest Garden Project is a community-driven initiative dedicated to cultivating aromatic herbs and spices within Mbweni Botanical Garden, providing members with an opportunity to connect with nature and learn about the journey from soil to plate. + +## What We Do + +### 1. Local Cultivation + +Within the serene surroundings of Mbweni Botanical Garden, we cultivate a variety of aromatic herbs and spices using sustainable farming methods. From basil and mint to lemongrass and turmeric, our garden is brimming with fresh and flavorful ingredients that are locally sourced and organically grown. + +### 2. Education and Awareness + +Through the Harvest Garden Project, we aim to educate members of the community about the importance of sustainable agriculture and the benefits of consuming locally grown produce. Workshops, demonstrations, and hands-on gardening activities are organized to foster a deeper understanding of the connection between food and the environment. + +### 3. Farm-to-Table Experience + +Members of the Harvest Garden Project have the opportunity to experience the joy of growing their own food and harvesting fresh produce directly from the garden. By participating in the cultivation process, members gain a greater appreciation for the quality and flavor of locally sourced ingredients, enhancing their farm-to-table dining experience. + +### 4. Community Engagement + +The Harvest Garden Project serves as a platform for community engagement and collaboration, bringing together individuals who share a passion for sustainable living and environmental stewardship. Members have the opportunity to connect with like-minded individuals, exchange knowledge and experiences, and work together towards a common goal of promoting sustainable agriculture. + +## Join Us + +Immerse yourself in the joy of growing your own food and connecting with the earth by becoming a member of the Harvest Garden Project at Mbweni Ruins and Gardens. Whether you're a seasoned gardener or a novice enthusiast, there's something for everyone to enjoy in our thriving garden community. + +For more information or to join the Harvest Garden Project, please contact us: + +Contact us: +255778242424 or email [info@mbweniruinsandgardens.com] diff --git a/collections/mbweni/initiatives/initiatives.md b/collections/mbweni/initiatives/initiatives.md index e69de29..48fbc60 100644 --- a/collections/mbweni/initiatives/initiatives.md +++ b/collections/mbweni/initiatives/initiatives.md @@ -0,0 +1,20 @@ +# Initiatives at Mbweni Ruins and Gardens + +Welcome to our Initiatives page, where we highlight the various projects and programs that embody our commitment to sustainability, community engagement, and environmental stewardship. Explore the initiatives below to learn more about how we're making a positive impact at Mbweni Ruins and Gardens: + +## Navigation + +- [Mbweni Clean Project](mbweni/initiatives/mbweni_clean.md) + - Dive into environmental stewardship with our weekly beach clean up initiative dedicated to revitalize the pristine beauty of Mbweni Bay and neighboring surroundings. Our dedicated team, along with residents and guests, comes together every Saturday for a fun beach clean-up. This collaborative effort not only fosters a sense of community but also contributes to the conservation of our coastal ecosystem. + +- [Harvest Garden Project](mbweni/initiatives/harvest_gardens.md) + - Harvest Garden is our farm-to-table community project where aromatic herbs and spices are locally cultivated within Mbweni Botanical Garden, educating members on sustainable agriculture practices. Immerse yourself in the joy of growing your own food and connecting with the earth, as we foster a deeper understanding of the journey from soil to plate. + +- [Ecology Seminars](mbweni/initiatives/seminars.md) + - Join us every month for our Ecology Seminars, where we delve into the fascinating world of ecology through thoughtfully crafted workshops led by passionate individuals. Set amidst the captivating ambiance of the historical Mbweni Ruins, our seminars provide an enriching experience that fosters both learning and connection. + +Join us as we strive to create a more sustainable and vibrant community at Mbweni Ruins and Gardens. + +For more information or to get involved, please contact us: + +Contact us: +255778242424 or email [info@mbweniruinsandgardens.com](mailto:info@mbweniruinsandgardens.com). diff --git a/collections/mbweni/initiatives/mbweni_clean.md b/collections/mbweni/initiatives/mbweni_clean.md index e69de29..7251507 100644 --- a/collections/mbweni/initiatives/mbweni_clean.md +++ b/collections/mbweni/initiatives/mbweni_clean.md @@ -0,0 +1,29 @@ +# Mbweni Clean Project: Preserving the Pristine Beauty of Mbweni Bay + +At Mbweni Ruins and Gardens, we are deeply committed to environmental stewardship and the preservation of our natural surroundings. With our Mbweni Clean Project, we strive to revitalize the pristine beauty of Mbweni Bay and its neighboring surroundings through regular beach clean-up initiatives. + +## Why We Do This + +### 1. Environmental Conservation + +The health of our oceans and coastal ecosystems is vital to the well-being of both wildlife and humans alike. By organizing weekly beach clean-ups, we aim to remove harmful pollutants and debris from the shoreline, safeguarding the marine life and habitats that call Mbweni Bay home. + +### 2. Community Engagement + +The Mbweni Clean Project serves as a platform for fostering community engagement and collaboration. Residents, guests, and members of the local community come together every Saturday to participate in these clean-up activities, strengthening bonds and creating a sense of shared responsibility for our environment. + +### 3. Education and Awareness + +Through our clean-up efforts, we seek to raise awareness about the importance of environmental conservation and the impact of pollution on marine ecosystems. By actively engaging participants in hands-on activities, we hope to inspire a deeper appreciation for nature and encourage sustainable practices in everyday life. + +### 4. Promoting Sustainable Tourism + +As a responsible tourism destination, we recognize the importance of maintaining clean and pristine environments for visitors to enjoy. By showcasing our commitment to environmental sustainability through initiatives like the Mbweni Clean Project, we strive to attract conscientious travelers who prioritize eco-friendly destinations. + +## Join Us + +Become a part of our environmental conservation efforts and make a positive impact on Mbweni Bay and its surrounding areas. Join us every Saturday for our weekly beach clean-up sessions and contribute to the preservation of our coastal ecosystem. + +For more information or to get involved, please contact us: + +Contact us: +255778242424 or email [info@mbweniruinsandgardens.com](mailto:info@mbweniruinsandgardens.com). diff --git a/collections/mbweni/initiatives/seminars.md b/collections/mbweni/initiatives/seminars.md index e69de29..475989b 100644 --- a/collections/mbweni/initiatives/seminars.md +++ b/collections/mbweni/initiatives/seminars.md @@ -0,0 +1,19 @@ +# Ecology Seminars: Enriching Workshops in the Heart of Mbweni Ruins + +Join us every month for our Ecology Seminars, where we delve into the fascinating world of ecology through thoughtfully crafted workshops led by passionate individuals. Set amidst the captivating ambiance of the historical Mbweni Ruins, our seminars provide an enriching experience that fosters both learning and connection. + +## What to Expect + +- **Engaging Workshops:** Our ecology seminars cover a wide range of topics, from biodiversity and conservation to sustainable living and environmental activism. Led by knowledgeable and experienced facilitators, each workshop offers valuable insights and practical solutions for addressing pressing ecological issues. + +- **Historical Setting:** Explore the rich history and cultural significance of Mbweni Ruins as you participate in our seminars. Located amidst the ruins of St. Mary's School for Girls, our workshops provide a unique opportunity to connect with the past while contemplating the future of our planet. + +- **Community Connection:** At Mbweni Ruins and Gardens, we believe in the power of community. Following each seminar, participants are invited to enjoy a delightful lunch at Mbweni Bay, where they can connect with fellow attendees and share ideas in a relaxed and informal setting. + +## Join Us + +Whether you're a seasoned environmentalist or simply curious about the natural world, our Ecology Seminars offer something for everyone. Join us as we explore the wonders of ecology and work together to create a more sustainable future for generations to come. + +For more information or to reserve your spot at our next seminar, please contact us: + +Contact us: +255778242424 or email [info@mbweniruinsandgardens.com](mailto:info@mbweniruinsandgardens.com). diff --git a/collections/mbweni/tours/island_tours.md b/collections/mbweni/tours/island_tours.md index e69de29..d0236e9 100644 --- a/collections/mbweni/tours/island_tours.md +++ b/collections/mbweni/tours/island_tours.md @@ -0,0 +1,21 @@ +# Island Tours at Mbweni Ruins and Gardens + +Embark on unforgettable adventures and explore the stunning beauty of Zanzibar with our curated Island Tours. We partner with trusted third-party tour operators to offer you an array of exciting excursions that showcase the best of what the island has to offer. Whether you're interested in cultural landmarks, pristine beaches, or marine life, there's something for everyone to enjoy. + +## Available Tours + +- **Prison Island Tour:** Discover the fascinating history of Prison Island and its famous resident giant tortoises. + +- **Chumbe Island Coral Park:** Immerse yourself in the breathtaking underwater world of Chumbe Island Coral Park, a protected marine sanctuary. + +- **Sand Bank Excursion:** Relax on the pristine white sands of a secluded sandbank and soak up the tropical sun. + +- **Nakupenda Island:** Experience the natural beauty of Nakupenda Island and enjoy swimming, snorkeling, and beachcombing. + +- **Many More:** Explore a variety of other island destinations, each offering its own unique charm and attractions. + +## RSVP for Pricing + +For pricing information and to book your island tour, please contact us: + +Contact us: +255778242424 or email [info@mbweniruinsandgardens.com](mailto:info@mbweniruinsandgardens.com). diff --git a/collections/mbweni/tours/kilimanjaro.md b/collections/mbweni/tours/kilimanjaro.md index e69de29..5b66460 100644 --- a/collections/mbweni/tours/kilimanjaro.md +++ b/collections/mbweni/tours/kilimanjaro.md @@ -0,0 +1,29 @@ +# Kilimanjaro Trekking + +Embark on the adventure of a lifetime with our Kilimanjaro Trekking tours. Explore the majestic beauty of Africa's highest peak and experience the thrill of summiting one of the world's most iconic mountains. + +## About Kilimanjaro + +Mount Kilimanjaro is a dormant volcanic mountain located in Tanzania, East Africa. It is the tallest freestanding mountain in the world, rising approximately 5,895 meters (19,341 feet) above sea level. Kilimanjaro is comprised of three volcanic cones: Kibo, Mawenzi, and Shira. The summit of Kilimanjaro, known as Uhuru Peak, is situated on Kibo, the tallest of the three cones. + +## The Magnificence of Kilimanjaro + +Kilimanjaro is not just a mountain; it is a symbol of adventure, perseverance, and natural wonder. Its towering presence dominates the skyline, visible from miles away across the plains of Tanzania. The mountain's unique ecosystem supports a diverse range of flora and fauna, from lush rainforests teeming with life to barren alpine deserts sculpted by glaciers. Each year, thousands of trekkers from around the globe flock to Kilimanjaro to test their mettle and conquer its lofty summit. + +## The Challenge of Summiting Kilimanjaro + +Summiting Kilimanjaro is no easy feat. The trek to Uhuru Peak involves navigating challenging terrain, extreme weather conditions, and altitude sickness. However, with proper preparation, determination, and the guidance of experienced guides, it is an achievable goal for adventurers of all ages and fitness levels. The sense of accomplishment that comes with reaching the summit and gazing out at the breathtaking vistas stretching to the horizon is truly unparalleled. + +## Our Kilimanjaro Trekking Tours + +Our Kilimanjaro Trekking tours offer an exhilarating and unforgettable experience for adventurers seeking to conquer Africa's highest peak. Led by knowledgeable guides and supported by skilled porters, our tours take you on a journey through Kilimanjaro's diverse landscapes, from dense rainforests teeming with wildlife to rugged alpine slopes and pristine glaciers. Along the way, you'll have the opportunity to immerse yourself in the natural beauty of Kilimanjaro, witness stunning sunrises and sunsets, and forge lasting memories with fellow trekkers. + +## Trusted Partners and Safety + +We collaborate with trusted third-party tour operators who specialize in Kilimanjaro trekking expeditions. Our partners prioritize safety, professionalism, and environmental stewardship, ensuring that your trekking experience is both safe and environmentally responsible. With their expertise and support, you can embark on your Kilimanjaro adventure with confidence and peace of mind. + +## RSVP for Pricing + +For pricing information and to book your Kilimanjaro trekking adventure, please contact us: + +Contact us: +255778242424 or email [info@mbweniruinsandgardens.com](mailto:info@mbweniruinsandgardens.com). diff --git a/collections/mbweni/tours/maasai.md b/collections/mbweni/tours/maasai.md index e69de29..d6e360a 100644 --- a/collections/mbweni/tours/maasai.md +++ b/collections/mbweni/tours/maasai.md @@ -0,0 +1,25 @@ +# Maasai Village Tours + +Experience the vibrant culture and rich traditions of the Maasai people with our Maasai Village Tours. Immerse yourself in the unique way of life of one of Africa's most iconic indigenous communities as you explore their traditional villages and engage with local residents. + +## Discover Maasai Culture + +The Maasai are a semi-nomadic ethnic group indigenous to Tanzania and Kenya, known for their distinctive customs, colorful attire, and deep connection to the land. During our Maasai Village Tours, you'll have the opportunity to learn about Maasai traditions, rituals, and beliefs directly from community members. From traditional dances and ceremonies to handicraft demonstrations and storytelling sessions, you'll gain insight into the rich cultural heritage of the Maasai people. + +## Explore Traditional Villages + +Our tours take you off the beaten path to visit authentic Maasai villages nestled amidst the stunning landscapes of Tanzania. Walk through the narrow pathways of the village, surrounded by traditional bomas (thatched huts), livestock enclosures, and communal gathering spaces. Engage with local elders, warriors, and women as they share their way of life, values, and customs passed down through generations. + +## Third-Party Tours + +In addition to our own Maasai Village Tours, we also collaborate with trusted third-party tour operators based in Arusha and mainland Tanzania. These tours offer a comprehensive exploration of Maasai culture and heritage, including visits to remote villages and interaction with local communities. Whether you're in Arusha or exploring the mainland, you can embark on an unforgettable journey to discover the essence of Maasai life. + +## Support Sustainable Tourism + +At Mbweni Ruins & Gardens, we are committed to responsible and sustainable tourism practices that benefit local communities. By participating in our Maasai Village Tours, or those offered by our third-party partners, you not only gain a deeper understanding of Maasai culture but also contribute to the economic empowerment and cultural preservation of the Maasai people. A portion of the proceeds from our tours goes directly to support community development projects and initiatives within the Maasai villages. + +## RSVP for Pricing + +For pricing information and to book your Maasai Village Tour, please contact us: + +Contact us: +255778242424 or email [info@mbweniruinsandgardens.com](mailto:info@mbweniruinsandgardens.com). diff --git a/collections/mbweni/tours/mangroves.md b/collections/mbweni/tours/mangroves.md index e69de29..9c4dc9e 100644 --- a/collections/mbweni/tours/mangroves.md +++ b/collections/mbweni/tours/mangroves.md @@ -0,0 +1,25 @@ +# Mangroves Conservation Tours + +Embark on a journey of discovery through the intricate ecosystems of Zanzibar's mangroves with our Mangroves Conservation Tours. Delve into the unique and vital habitats of mangrove forests, learning about their significance and the efforts to preserve them for future generations. + +## Explore Zanzibar's Mangroves + +Zanzibar is home to extensive mangrove forests that fringe its coastlines, providing critical ecosystems that support a diverse array of marine life and protect coastal communities from erosion and storm surges. During our Mangroves Conservation Tours, you'll have the opportunity to explore these fascinating environments and discover their importance to both people and nature. + +## Facts About Zanzibar Mangroves + +Zanzibar's mangroves are vital breeding grounds and nurseries for numerous marine species, including fish, crustaceans, and mollusks. They also act as natural filters, trapping sediment and pollutants, and helping to maintain water quality along the coastline. Additionally, mangroves play a crucial role in carbon sequestration, helping to mitigate climate change by absorbing and storing large amounts of carbon dioxide from the atmosphere. + +## Mbweni's Mangroves Conservation + +At Mbweni Ruins & Gardens, we are dedicated to the conservation of Zanzibar's mangroves. Our private mangrove forest serves as a sanctuary for these precious ecosystems, providing a haven for biodiversity and serving as a living laboratory for ecological research and education. Join us on our Mangroves Conservation Tours to witness the beauty and importance of these natural wonders firsthand. + +## Tour Details + +Our Mangroves Conservation Tours are led by experienced ecologists and conducted in collaboration with trusted tour operators. You can choose to paddle through the mangroves on kayaks or explore them by boat, immersing yourself in the tranquil beauty of these coastal forests. + +## RSVP for Booking + +To book your Mangroves Conservation Tour and experience the wonders of Zanzibar's mangroves, please contact us: + +Contact us: +255778242424 or email [info@mbweniruinsandgardens.com](mailto:info@mbweniruinsandgardens.com). diff --git a/collections/mbweni/tours/mbweni_tour.md b/collections/mbweni/tours/mbweni_tour.md index e69de29..e604a26 100644 --- a/collections/mbweni/tours/mbweni_tour.md +++ b/collections/mbweni/tours/mbweni_tour.md @@ -0,0 +1,30 @@ +# Mbweni Tour + +Discover the rich history, vibrant culture, and stunning natural beauty of Mbweni Ruins & Gardens with our immersive Mbweni Tour. Led by our knowledgeable tour guides, this experience offers a fascinating journey through our historic ruins, lush botanical gardens, and sustainable initiatives. + +## Explore Mbweni's Unique Features + +### Ruins Exploration + +Embark on a captivating journey through the historic ruins of Mbweni, where echoes of the past intertwine with the present. Learn about the fascinating history of Mbweni as a former slave trade settlement and the establishment of St. Mary's School for Girls by missionaries. Explore the remnants of colonial architecture and uncover the stories hidden within these ancient walls. + +### Botanical Gardens + +Step into a lush oasis of biodiversity within Mbweni's botanical gardens. Marvel at the vibrant array of flora and fauna, from indigenous plants to exotic species, as you wander through winding pathways shaded by towering trees. Learn about our commitment to sustainable landscaping and conservation efforts to preserve these precious ecosystems. + +### Sustainability Learning + +Gain insight into Mbweni's dedication to sustainability and environmental stewardship. Discover our eco-friendly initiatives, from renewable energy projects to waste reduction strategies, and learn how we strive to minimize our ecological footprint while maximizing community benefits. Engage in discussions about sustainable living practices and the importance of preserving natural resources for future generations. + +## Tour Details + +- **Duration:** Half-day or full-day options available +- **Tour Guide:** Led by our experienced and knowledgeable guides +- **Activities:** Ruins exploration, botanical garden tour, sustainability discussions +- **Refreshments:** Refreshments and snacks provided during the tour + +## Book Your Mbweni Tour + +Experience the beauty and heritage of Mbweni Ruins & Gardens with our Mbweni Tour. To book your tour and embark on a journey of discovery, please contact us: + +Contact us: +255778242424 or email [info@mbweniruinsandgardens.com](mailto:info@mbweniruinsandgardens.com). diff --git a/collections/mbweni/tours/safari.md b/collections/mbweni/tours/safari.md index e69de29..b5a7d29 100644 --- a/collections/mbweni/tours/safari.md +++ b/collections/mbweni/tours/safari.md @@ -0,0 +1,37 @@ +# Safari Tours in Mainland Tanzania + +Embark on the adventure of a lifetime with our Safari Tours in mainland Tanzania. Experience the awe-inspiring beauty of Tanzania's wilderness as you journey through iconic national parks and wildlife reserves. Our tours are designed to offer unforgettable wildlife encounters while promoting responsible and sustainable tourism practices. + +## Explore Tanzania's Wild Side + +### Safari Destinations + +Discover the diverse landscapes and abundant wildlife of Tanzania's most renowned safari destinations, including: + +- **Arusha National Park:** Explore the lush forests, scenic landscapes, and diverse wildlife of this picturesque park nestled at the foot of Mount Meru. +- **Serengeti National Park:** Witness the epic spectacle of the Great Migration and encounter the Big Five amidst the vast plains and acacia-dotted savannas of the Serengeti. +- **Ngorongoro Conservation Area:** Descend into the Ngorongoro Crater, a UNESCO World Heritage Site teeming with wildlife, and marvel at the breathtaking scenery of this natural wonder. + +### Other Safari Options + +In addition to these iconic destinations, our Safari Tours offer the opportunity to explore other lesser-known gems of Tanzania's wilderness, such as: + +- **Tarangire National Park:** Encounter herds of elephants, baobab trees, and diverse birdlife in this scenic park known for its large elephant population. +- **Lake Manyara National Park:** Cruise along the shores of Lake Manyara and spot tree-climbing lions, flamingos, and other wildlife in this compact yet diverse park. + +## Responsible Tourism + +At Mbweni Ruins & Gardens, we are committed to responsible and ethical tourism practices. Our Safari Tours prioritize wildlife conservation and environmental sustainability, and we do not offer activities that involve killing or game hunting. Instead, our tours focus on wildlife observation, photography, and education, allowing guests to connect with nature in a respectful and non-intrusive manner. + +## Tour Details + +- **Duration:** Customizable itineraries available, ranging from one-day excursions to multi-day safari adventures. +- **Tour Operators:** We partner with trusted tour operators specializing in safari experiences across mainland Tanzania. +- **Activities:** Wildlife viewing, birdwatching, guided nature walks, cultural interactions, and more. +- **Accommodation:** Options include luxury lodges, tented camps, and eco-friendly accommodations, tailored to suit your preferences and budget. + +## Book Your Safari Tour + +Ready to embark on a thrilling safari adventure in mainland Tanzania? Contact us to book your Safari Tour and create unforgettable memories amidst Africa's magnificent wilderness: + +Contact us: +255778242424 or email [info@mbweniruinsandgardens.com](mailto:info@mbweniruinsandgardens.com). diff --git a/collections/mbweni/tours/spice_farm.md b/collections/mbweni/tours/spice_farm.md index e69de29..c26a07d 100644 --- a/collections/mbweni/tours/spice_farm.md +++ b/collections/mbweni/tours/spice_farm.md @@ -0,0 +1,46 @@ +# Spice Farm Tour with Farm-to-Table Lunch in Collaboration with Msonge Organic Farm + +Embark on a sensory journey through the fragrant spice plantations of Zanzibar with our Spice Farm Tour, in collaboration with Msonge Organic Farm. Immerse yourself in the rich tapestry of flavors, aromas, and cultural heritage as you explore the lush greenery and vibrant colors of Zanzibar's renowned spice farms. + +## Discover the Secrets of Spice Cultivation + +### Spice Plantations + +Experience the magic of Zanzibar's spice plantations as you stroll through acres of verdant fields bursting with aromatic spices such as cloves, cinnamon, nutmeg, and vanilla. Learn about the traditional cultivation methods passed down through generations and gain insight into the importance of spices in Zanzibar's history and culture. + +### Organic Agriculture + +At Msonge Organic Farm, delve into the world of organic agriculture and sustainable farming practices. Discover how locally grown spices and herbs are cultivated using environmentally friendly methods, free from synthetic chemicals and pesticides. Learn about the farm's commitment to promoting biodiversity and preserving the natural ecosystem. + +## Botany and Plant Medicine + +### Educational Experience + +Enhance your botanical knowledge as you learn about the diverse array of plants and herbs thriving in Zanzibar's fertile soil. Our knowledgeable guides will introduce you to a variety of indigenous and exotic plants, sharing their insights into their medicinal properties, culinary uses, and cultural significance. + +### Dawa (Plant Medicine) + +Delve into the traditional practice of dawa, or plant medicine, as you discover the healing properties of Zanzibar's medicinal plants. Learn about the ancient wisdom of herbal remedies passed down by local healers and explore the holistic approach to health and wellness rooted in nature. + +## Farm-to-Table Lunch Experience + +### Fresh and Flavorful Cuisine + +After your enlightening tour of the spice farm, indulge in a delicious farm-to-table lunch featuring organic ingredients sourced directly from Msonge Organic Farm. Savor the vibrant flavors of Zanzibar's culinary heritage as you enjoy a freshly prepared meal made with locally grown produce and aromatic spices. + +### Scenic Dining Setting + +Relish your meal in a scenic dining setting surrounded by the natural beauty of Zanzibar's countryside. Whether you choose to dine al fresco amidst the spice fields or in a charming rustic setting, you'll be treated to breathtaking views and a tranquil ambiance that enhances the dining experience. + +## Tour Details + +- **Duration:** Half-day or full-day tours available, customizable to suit your preferences. +- **Collaboration:** In partnership with Msonge Organic Farm, a leading advocate of organic agriculture in Zanzibar. +- **Activities:** Guided tour of spice plantations, organic farming demonstrations, botanical education, dawa workshop, farm-to-table lunch experience. +- **Refreshments:** Enjoy a refreshing herbal tea made from locally grown spices during your tour. + +## Book Your Spice Farm Tour with Farm-to-Table Lunch + +Ready to immerse yourself in the enchanting world of Zanzibar's spice farms and organic agriculture? Contact us to book your Spice Farm Tour with Farm-to-Table Lunch and embark on a journey of discovery: + +Contact us: +255778242424 or email [info@mbweniruinsandgardens.com](mailto:info@mbweniruinsandgardens.com). diff --git a/collections/mbweni/tours/stone_town.md b/collections/mbweni/tours/stone_town.md index e69de29..6b4dc9c 100644 --- a/collections/mbweni/tours/stone_town.md +++ b/collections/mbweni/tours/stone_town.md @@ -0,0 +1,37 @@ +# Stone Town Tour: Unraveling the Charms of Zanzibar's Historic Gem + +## Explore the Rich History of Stone Town + +### Introduction to Stone Town + +Embark on a captivating journey through the centuries-old labyrinthine streets of Stone Town, Zanzibar's historic heart and a UNESCO World Heritage Site. Named for its distinctive coral stone buildings, Stone Town is a melting pot of cultures and a testament to the island's storied past. + +### The Origins of Stone Town + +Discover the origins of Stone Town and unravel the mysteries behind its name. Learn about the rich tapestry of influences that have shaped its architecture, from the Arab and Persian traders who first settled here to the Portuguese, Omani, and British colonial powers who left their indelible mark on the city. + +## Highlights of the Stone Town Tour + +### Architectural Marvels + +Admire the exquisite architecture of Stone Town as you wander through its narrow alleyways and bustling squares. Marvel at the intricately carved wooden doors, elegant balconies, and ornate facades that reflect a blend of Swahili, Arab, Indian, and European styles. + +### Historical Landmarks + +Visit iconic landmarks such as the Sultan's Palace, the Old Fort, and the House of Wonders, each offering insights into Zanzibar's rich heritage. Explore the winding streets lined with bustling markets, mosques, and vibrant bazaars, where the sights, sounds, and scents evoke a sense of timeless charm. + +## Stone Town Tour Details + +### Third-Party Tour Operator + +Our Stone Town Tour is conducted in collaboration with trusted third-party tour operators who specialize in cultural and historical excursions. Led by knowledgeable guides, our tours offer a deep dive into the history, architecture, and cultural heritage of Stone Town. + +### Learning Experience + +Immerse yourself in a learning experience that goes beyond sightseeing, with opportunities to delve into the fascinating history and architecture of Stone Town. Gain insights into the city's colonial past, its role as a center of trade and commerce, and its enduring cultural significance. + +## Book Your Stone Town Tour + +To embark on a journey through the enchanting streets of Stone Town and uncover its hidden treasures, contact us to book your tour: + +Contact us: +255778242424 or email [info@mbweniruinsandgardens.com](mailto:info@mbweniruinsandgardens.com). diff --git a/collections/mbweni/tours/tours.md b/collections/mbweni/tours/tours.md index e69de29..2383511 100644 --- a/collections/mbweni/tours/tours.md +++ b/collections/mbweni/tours/tours.md @@ -0,0 +1,31 @@ +# Tours at Mbweni Ruins and Gardens: Explore Zanzibar's Treasures + +## Embark on Unforgettable Adventures + +Discover the diverse landscapes, rich cultural heritage, and natural wonders of Zanzibar with our curated selection of tours. Each tour offers a unique opportunity to immerse yourself in the beauty and history of the island, guided by experienced professionals who are passionate about sharing their knowledge and insights. + +### Explore our Range of Tours + +- [Mbweni Tour](mbweni/tours/mbweni_tour.md): Delve into the history and culture of Mbweni Ruins and Gardens, uncovering the secrets of this historic site and its lush botanical gardens. + +- [Stone Town](mbweni/tours/stone_town.md): Traverse the labyrinthine streets of Stone Town, a UNESCO World Heritage Site renowned for its architectural marvels, vibrant markets, and rich history. + +- [Island Tours](mbweni/tours/island_tours.md): Embark on island-hopping adventures to explore Zanzibar's pristine beaches, turquoise waters, and secluded islands, each offering its own unique charm and allure. + +- [Spice Farm](mbweni/tours/spice_farm.md): Immerse yourself in the sights, scents, and flavors of Zanzibar's spice farms, where you'll learn about the cultivation of exotic spices and herbs that have shaped the island's culinary heritage. + +- [Mangroves Tours](mbweni/tours/mangroves.md): Paddle through the tranquil waters of Zanzibar's mangrove forests, discovering the unique ecosystem and biodiversity of these vital coastal habitats. + +- [Wildlife Conservations](mbweni/tours/wildlife.md): Embark on wildlife conservation tours to encounter Zanzibar's rich biodiversity, from rare endemic species to majestic marine life, and learn about efforts to protect and preserve these natural treasures. + +- [Kilimanjaro Tours](mbweni/tours/kilimanjaro.md): Embark on an epic journey to the roof of Africa with Kilimanjaro tours, where you'll trek through diverse ecosystems, witness breathtaking vistas, and conquer Africa's highest peak. + +- [Safari Tours](mbweni/tours/safari.md): Experience the thrill of a safari adventure on the mainland of Tanzania, where you'll encounter iconic wildlife, explore vast savannahs, and immerse yourself in the wonders of Africa's untamed wilderness. + +- [Maasai Village](mbweni/tours/maasai.md): Journey to the heart of Maasai culture with tours to traditional Maasai villages, where you'll learn about their rich heritage, customs, and way of life. + +## Book Your Adventure + +To book any of our tours or learn more about our offerings, please contact us: + +Contact us: +255778242424 or email [info@mbweniruinsandgardens.com](mailto:info@mbweniruinsandgardens.com). diff --git a/collections/mbweni/tours/wildlife.md b/collections/mbweni/tours/wildlife.md index e69de29..daf60ee 100644 --- a/collections/mbweni/tours/wildlife.md +++ b/collections/mbweni/tours/wildlife.md @@ -0,0 +1,25 @@ +# Wildlife Conservations + +Embark on a journey to discover and protect the rich biodiversity of Zanzibar with our wildlife conservation tours. Explore pristine habitats, encounter rare and endemic species, and learn about efforts to preserve and safeguard these natural treasures. + +## Turtle Conservation at Prison Island + +Join us on a visit to Prison Island, where you'll have the opportunity to observe and learn about the conservation efforts dedicated to protecting endangered sea turtles. Explore the island's turtle sanctuary, home to a thriving population of turtles, and discover the important role these majestic creatures play in maintaining marine ecosystems. + +## Bird Park Exploration + +Venture into the lush landscapes of Zanzibar's bird parks and sanctuaries, where you'll encounter a dazzling array of avian species, from vibrant tropical birds to majestic raptors. Learn about the importance of bird conservation and habitat preservation as you immerse yourself in the sights and sounds of these natural havens. + +## Marine Life Conservation + +Dive beneath the waves to explore Zanzibar's vibrant coral reefs and marine ecosystems, where you'll encounter an abundance of marine life, including colorful fish, majestic rays, and graceful sea turtles. Discover ongoing conservation efforts aimed at protecting these fragile habitats and preserving the marine biodiversity of the region. + +## Join the Conservation Effort + +Participate in hands-on conservation activities, such as beach clean-ups, reef monitoring, and wildlife surveys, and make a meaningful contribution to the protection of Zanzibar's natural heritage. Whether you're a wildlife enthusiast, conservationist, or simply a nature lover, our wildlife conservation tours offer an unforgettable opportunity to connect with the natural world and make a positive impact on the environment. + +## Book Your Conservation Adventure + +To book a wildlife conservation tour or learn more about our conservation initiatives, please contact us: + +Contact us: +255778242424 or email [info@mbweniruinsandgardens.com](mailto:info@mbweniruinsandgardens.com). diff --git a/collections/new_mdbook/.collection b/collections/new_mdbook/.collection new file mode 100644 index 0000000..e69de29 diff --git a/collections/new_mdbook/new_mdbook_example1.md b/collections/new_mdbook/new_mdbook_example1.md new file mode 100644 index 0000000..49cfeba --- /dev/null +++ b/collections/new_mdbook/new_mdbook_example1.md @@ -0,0 +1,3 @@ +# Example 1 + +This is some text \ No newline at end of file diff --git a/collections/new_mdbook/new_mdbook_example2.md b/collections/new_mdbook/new_mdbook_example2.md new file mode 100644 index 0000000..9abf329 --- /dev/null +++ b/collections/new_mdbook/new_mdbook_example2.md @@ -0,0 +1,3 @@ +# Example 2 + +This is some text \ No newline at end of file diff --git a/collections/tech/innovations/zos_innovation_short.md b/collections/tech/innovations/zos_innovation_short.md index dec72df..684db8d 100644 --- a/collections/tech/innovations/zos_innovation_short.md +++ b/collections/tech/innovations/zos_innovation_short.md @@ -1,26 +1,25 @@ -### Why? +### The Problem -Current Linux-based operating systems are challenging to use safely and efficiently on the edges of the Internet. They require central management, involve excessive complexity, and prove difficult to update and maintain, resulting in numerous security vulnerabilities. To revolutionize the internet, we must rethink how we host our applications, essentially reinventing the concept of a cloud-based operating system. +It is challenging to use current Linux-based operating systems safely and efficiently on the edges of the Internet. They require central management, involve excessive complexity, and prove difficult to update and maintain, resulting in numerous security vulnerabilities. To revolutionize the internet, we must rethink how we host our applications, essentially reinventing the concept of a cloud-based operating system. -### What? +### Introducing Zero-OS An innovative operating system, retaining the Linux kernel but fundamentally redesigned for heightened security, efficiency, and support for true peer-to-peer and decentralized workloads. This unique operating system doesn't require installation on hard disks or SSDs; it remains stateless, consistently up to date, and autonomously managed without human intervention. Its design enables self-healing application delivery, opening new possibilities in system resilience and reliability. -### Benefits? +### The Benefits -- **Compatibility with Existing Workloads:** Our primary goal is to ensure Zero-OS compatibility with over 99% of the workloads commonly hosted in centralized cloud environments today. This includes support for Docker containers, virtual machines, Kubernetes, and more. -- **Reduced Attack Surface:** Zero-OS boasts a smaller hacking surface, enhancing security by minimizing potential vulnerabilities. -- **Stateless Design:** Its statelessness simplifies deployment and updates, making it easier to maintain while ensuring it's always up to date. -- **Autonomous Operation:** Whether you have one instance or a billion, Zero-OS operates autonomously, streamlining management and maintaining consistency across all instances. -- **Rapid Deployment:** With Zero-OS, you can deploy 1000 virtual machines in just 2 minutes, ensuring agility and efficiency in scaling up resources. -- **Unique Security Features:** Zero-OS offers support for distinctive security features to enhance protection and fortify your infrastructure. -- **Lower Cost, Easier to Maintain:** Zero-OS significantly reduces the operational expenses associated with cloud infrastructure by automating most processes. This results in minimal operational costs and eliminates the need for extensive engineering efforts. -- **Ready for a Decentralized World:** Zero-OS empowers individuals to become hosts for required Internet capacity (storage, network, compute, gpu), allowing them to be rewarded for providing computing resources and internet connectivity. This aligns with the vision of a truly decentralized and distributed computing ecosystem. +- **Compatible with existing workloads:** our primary goal is to ensure that Zero-OS is compatibile with over 99% of the workloads commonly hosted in centralized cloud environments today. This includes support for Docker containers, virtual machines, Kubernetes, and more. +- **Reduced attack surface:** Zero-OS boasts a smaller hacking surface, enhancing security by minimizing potential vulnerabilities. +- **Stateless design:** its statelessness simplifies deployment and updates, making it easier to maintain while ensuring that it's always up to date. +- **Autonomous operation:** whether you have one instance or a billion, Zero-OS operates autonomously, streamlining management and maintaining consistency across all instances. +- **Rapid deployment:** with Zero-OS, you can deploy 1000 virtual machines in just 2 minutes, ensuring agility and efficiency in scaling up resources. +- **Unique security features:** Zero-OS offers support for distinctive security features to enhance protection and fortify your infrastructure. +- **Lower cost and easier maintenance:** Zero-OS significantly reduces the operational expenses associated with cloud infrastructure by automating most processes. This results in minimal operational costs and eliminates the need for extensive engineering efforts. +- **Ready for a decentralized world:** Zero-OS empowers individuals to become hosts for required Internet capacity (storage, network, compute, gpu), allowing them to be rewarded for providing computing resources and internet connectivity. This aligns with the vision of a truly decentralized and distributed computing ecosystem. -### Status? +### Status -- 3e generation, active for +4 years, tested by thousands -- Play with it yourself see www.threefold.io +3e generation, active for +4 years and tested by thousands. Play with it yourself [here](https://www.threefold.io/). diff --git a/collections/tech/innovations/zstor_innovation.md b/collections/tech/innovations/zstor_innovation.md index 348b89f..89b01a8 100644 --- a/collections/tech/innovations/zstor_innovation.md +++ b/collections/tech/innovations/zstor_innovation.md @@ -1,5 +1,5 @@ -## Zero-Stor : a quantum safe backend storage system. +## Zero-Stor : A Quantum Safe Backend Storage System ![](qsss.png) diff --git a/collections/tech/qsss/s3_interface.md b/collections/tech/qsss/s3_interface.md index 1d34eea..948f415 100644 --- a/collections/tech/qsss/s3_interface.md +++ b/collections/tech/qsss/s3_interface.md @@ -1,14 +1,14 @@ -# S3 Service - -If you like an S3 interface you can deploy this on top of our eVDC, it works very well together with our [quantumsafe_filesystem](qss_filesystem.md). - -A good opensource solution delivering an S3 solution is [min.io](https://min.io/). - -Thanks to our quantum safe storage layer, you could build fast, robust and reliable storage and archiving solutions. - -A typical setup would look like: - -![](img/storage_architecture_1.jpg) - -> TODO: link to manual on cloud how to deploy minio, using helm (3.0 release) - +# S3 Service + +If you like an S3 interface you can deploy this on top of our eVDC, it works very well together with our [quantumsafe_filesystem](qss_filesystem.md). + +A good opensource solution delivering an S3 solution is [min.io](https://min.io/). + +Thanks to our quantum safe storage layer, you could build fast, robust and reliable storage and archiving solutions. + +A typical setup would look like: + +![](img/storage_architecture_1.jpg) + +To deploy MinIO using Helm 3, you can consult [this guide](https://forum.threefold.io/t/minio-operator-with-helm-3/4294). + diff --git a/collections/tfgrid3/governance/gep2.md b/collections/tfgrid3/governance/gep2.md deleted file mode 100644 index cc2ad09..0000000 --- a/collections/tfgrid3/governance/gep2.md +++ /dev/null @@ -1 +0,0 @@ -!!wiki.include page:gep.md \ No newline at end of file diff --git a/collections/tfgrid3/governance/governance.md b/collections/tfgrid3/governance/governance.md index dd0bba4..a5c57d7 100644 --- a/collections/tfgrid3/governance/governance.md +++ b/collections/tfgrid3/governance/governance.md @@ -6,9 +6,11 @@ Governance is important to us, there is a wish from TF DMCC to outsource the ope ## Planned for 3.14 (our next release) -- GEP process = voting process on TFChain (the ThreeFold Blockchain) +- GEP process is the voting process on TFChain (the ThreeFold Blockchain) - 9 guardians: run the validators and necessary tooling for the TFGrid - 9 cooperative directors (at start are cooperative founders): create a cooperative for all members ## Treasury +This section needs to be filled in by the team. + diff --git a/collections/tfgrid3/promotion/messaging.md b/collections/tfgrid3/promotion/messaging.md index a498518..084ee05 100644 --- a/collections/tfgrid3/promotion/messaging.md +++ b/collections/tfgrid3/promotion/messaging.md @@ -1,20 +1,19 @@ # ThreeFold Messaging -## principles +## Principles -- we don't sell anything, just show what you can do with it and where we are going -- we are just clear about status -- we are ofcourse clear about size & features +- We don't sell anything, we just show people what you can do with the project and where we are headed +- We are clear about the status of the project including its size and features -## narative +## Narrative > Decentralized Autonomous Cloud -- Cloud means, any service -- Decentralized means, everyone is a participant. Everyone can deliver and/or use cloud services, everyone can use. -- Autonomous means, cloud service providers don't need to be experts, the software is capable to run 100% autonomous. +- Cloud means any service +- Decentralized means everyone is a participant. Everyone can deliver and/or use cloud services +- Autonomous means cloud service providers don't need to be experts, the software is capable to run 100% autonomously diff --git a/collections/tfgrid3/specs/farming_update_3_14.md b/collections/tfgrid3/specs/farming_update_3_14.md index 7595e30..5abccda 100644 --- a/collections/tfgrid3/specs/farming_update_3_14.md +++ b/collections/tfgrid3/specs/farming_update_3_14.md @@ -1,54 +1,104 @@ - -# Farming Logic Update 3.14 - -> this is for TFGrid version 3.14, and will still change because of feedback on our [forum](https://forum.threefold.io/t/feedback-on-farming-logic-as-suggested-for-tfgrid-3-14/4275) - -## FARMING REWARDS - -- [x] farming reward stays the same, price on 0.08 -- [ ] max 1billion TFT on Stellar -- [ ] uptime checks include network, min BW, quality of HW (needs to be further specified) -- [ ] all farmers have done KYC/AML -- [ ] for new nodes: we do no register nodes which are not DDR4... -- [ ] bigger farmers can sign with DMCC for SLA, which will be visible, with penalty in locked tokens by TF DMCC/COOP, there is contract involved, which gets linked to TFChain -- [ ] if price > 0.08 for more than 30 days, then the farming price changes ... - -The cooperative will resell capacity (using TFT at back) and redistribute margin as follows: - -- [ ] give 50% on utilization to farmers -- [ ] give 10% on utilization to the stakers on the validators -- [ ] give 40% on utilization to treasury of TF Cooperative - -[more info about coop see here](tfcoop_intro.md). - -## UI & EXPLORER - -- [ ] track more info about nodes in explorer, easier for people to select which node is good one -- [ ] info about mem, cpu, ... -- [ ] unified way how to query nodes in UI -- [ ] show that farmers are having SLA & link to their contract with TF DMCC or TF COOP - -## GOVERNANCE - -- [ ] 1 tft = 1 vote - - -## GEP 1 NEEDED - -- [ ] stop burning -- [ ] agree on 1 billion TFT cap (farming will stop) -- [ ] farming rules as above -- [ ] utilization revenue distribution through cooperative see above - -## GEP 2 NEEDED - -Will be done once voting system has been changed and GEP 1 done - -- [ ] agree on 9 directors for cooperative - -## GEP 3 NEEDED - -Will be done once voting system has been changed and GEP 1 done - -- [ ] agree on 9 guardians who run the validators - + +

TFGrid 3.14 Farming Updates

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [3.14 Parameters](#314-parameters) + - [Farming Rewards](#farming-rewards) + - [UI \& Explorer](#ui--explorer) + - [Governance](#governance) +- [GEP to Enable 3.14 Parameters](#gep-to-enable-314-parameters) + - [GEP 1: Ongoing](#gep-1-ongoing) + - [GEP 2: TBD](#gep-2-tbd) + - [GEP 3: TBD](#gep-3-tbd) + - [GEP 4: TBD](#gep-4-tbd) +- [Questions and Feedback](#questions-and-feedback) + +*** + +## Introduction + +We present the farming updates for TFGrid 3.14. + +For this version of the grid to take place, we must first decide its parameters and features, and second we must pass grid enhancement proposals (GEP) to set the agreed upon parameters and features. + +Note that this documentation is for TFGrid version 3.14. It is subject to change based on the feedback from our community. Read more and join the discussion on the [ThreeFold Forum](https://forum.threefold.io/t/feedback-on-farming-logic-as-suggested-for-tfgrid-3-14/4275). + +## 3.14 Parameters + +We discuss the parameters needed for the TFGrid 3.14. + +### Farming Rewards + +We bring many important changes to the farming rewards. This should benefit users and farmers alike. + +- [x] Farming reward stays the same, price on 0.08 + - [ ] If price > 0.08 for more than 30 days, then the farming price changes ... +- [ ] Max 1 billion TFT on Stellar chain +- [ ] Uptime checks include network, min BW, quality of HW (needs to be further specified) +- [ ] All farmers have done KYC/AML +- [ ] Bigger farmers can sign with DMCC for SLA, which will be visible, with penalty in locked tokens by TF DMCC/COOP, there is contract involved, which gets linked to TFChain + + +The cooperative will resell capacity (using TFT at back) and redistribute margin as follows: + +- [ ] Give 50% on utilization to farmers +- [ ] Give 10% on utilization to the stakers on the validators +- [ ] Give 40% on utilization to treasury of TF Cooperative + +For more information, [see here](tfcoop_intro.md). + +### UI & Explorer + +We want to make sure the user interface (UI) and the user experience (UX) are as good as possible. Providing users with as much information as possible on their deployment will allow them to take sound decisions that benefit them. + +- [ ] track more info about nodes in explorer, easier for people to select which node is good one +- [ ] info about mem, cpu, ... +- [ ] unified way how to query nodes in UI +- [ ] show that farmers are having SLA & link to their contract with TF DMCC or TF COOP + +### Governance + +The governance of ThreeFold will be updated to a 1 TFT, 1 vote system. This will add value to TFT and allow anyone to participate in decisions around TFT by holding the coin and voting with the power it provides. + +- [ ] 1 TFT = 1 vote + +## GEP to Enable 3.14 Parameters + +As discussed, we need to prepare the TFGrid for 3.14. To achieve this, we will pass GEPs in the coming weeks and months to ensure we are ready for 3.14. + +### GEP 1: Ongoing + +- [ ] 95% and 98% uptime requirement for DIY and certified nodes respectively +- [ ] 50% of proof-of-utilization revenues will go to the farmer running the 3Node +- [ ] Minting will be slashed for 1 month if the node cannot wake up within 30-minutes twice within the same minting period +- [ ] When we reach 1 Billion TFT on Stellar, minting stops on Stellar +- [ ] TFT burning will stop + +References: Read the GEP on the Forum [here](https://forum.threefold.io/t/gep-minting-and-farming-rewards-updates-march-2024/4285). + +### GEP 2: TBD + +This GEP is used to define further the role of the coop as well as define clear farming rules that will ensure high-quality hardware on the grid and reliable support from farmers. + +- [ ] incorporate more farming rules ([see above](#farming-rewards)) +- [ ] utilization revenue distribution through cooperative ([see above](#farming-rewards)) + +### GEP 3: TBD + +This GEP can be done once voting system has been changed and GEP 1 and 2 are done. + +- [ ] Agree on 9 directors for cooperative + +### GEP 4: TBD + +This GEP can be done once voting system has been changed and GEP 1, 2 and 3 are done. + +- [ ] Agree on 9 guardians who run the validators + +## Questions and Feedback + +We highly encourage everyone to discuss on the forum about this exciting phase of the ThreeFold adventure. + +Please share your thoughts and feedback on the ongoing forum post [here](https://forum.threefold.io/t/feedback-on-farming-logic-as-suggested-for-tfgrid-3-14/4275). \ No newline at end of file diff --git a/collections/tfmanual/.collection b/collections/tfmanual/.collection new file mode 100644 index 0000000..e69de29 diff --git a/collections/tfmanual/404.md b/collections/tfmanual/404.md new file mode 100644 index 0000000..b997540 --- /dev/null +++ b/collections/tfmanual/404.md @@ -0,0 +1,7 @@ +

HTTP ERROR 404

+ +

This page can’t be found.

+ +The page you're looking for might have moved somewhere else. + +To find the content you're looking for, you can use the search function by clicking on the magnifier button at the top left of the page, or by hitting **'s'** on your keyboard. \ No newline at end of file diff --git a/collections/tfmanual/documentation/dashboard/dashboard.md b/collections/tfmanual/documentation/dashboard/dashboard.md new file mode 100644 index 0000000..991b189 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/dashboard.md @@ -0,0 +1,43 @@ +

ThreeFold Dashboard

+ +Explore, control, and manage your ThreeFold Grid resources effortlessly through our integrated Dashboard. Deploy solutions seamlessly while gaining full control, all within a unified interface. + +The ThreeFold Dashboard is a revolutionary platform that simplifies the deployment process, allowing users to effortlessly interact with the TFGrid using intuitive web components known as weblets. + +## What is the ThreeFold Dashboard? + +The ThreeFold Dashboard is a dynamic environment designed for both seasoned developers and newcomers alike. It offers a seamless and accessible browser experience, making it easy to deploy solutions on the TFGrid through the use of weblets. + +In the context of the Dashboard, a weblet is a compiled JavaScript web component that can be effortlessly embedded within the HTML page of a web application. This modular approach allows for flexible and intuitive interactions, facilitating a user-friendly deployment process. + +The backend for the weblets is introduced with the [Javascript Client](../developers/javascript/grid3_javascript_readme.md) which communicates to TFChain over RMB. + +

Table of Contents

+ +- [Wallet Connector](./wallet_connector.md) +- [TFGrid](./tfgrid/tfgrid.md) +- [Deploy](./deploy/deploy.md) +- [Farms](./farms/farms.md) +- [TFChain](./tfchain/tfchain.md) + +## Advantages + +- It is a non-code easy way to deploy a whole solution on the TFGrid. +- It is 100% decentralized, there is no server involved. +- It is powerful tool designed to empower individuals and organizations with seamless control and management over their ThreeFold Grid resources. +- It provides an intuitive web-based interface that allows users to effortlessly deploy, monitor, and scale their workloads on the decentralized and sustainable ThreeFold Grid infrastructure. + +## Dashboard + +You can access the ThreeFold Dashboard on different TF Chain networks. + +- [https://dashboard.dev.grid.tf](https://dashboard.dev.grid.tf) for Dev net +- [https://dashboard.qa.grid.tf](https://dashboard.qa.grid.tf) for QA net +- [https://dashboard.test.grid.tf](https://dashboard.test.grid.tf) for Test net +- [https://dashboard.grid.tf](https://dashboard.grid.tf) for Main net + +## Limitations + +- Regarding browser support, we're only supporting Google Chrome browser (and thus Brave browser) at the moment with more browsers to be supported soon. +- Deploys one thing at a time. +- Might take sometime to deploy a solution like Peertube, so you should wait a little bit until it's fully running. diff --git a/collections/tfmanual/documentation/dashboard/deploy/applications.md b/collections/tfmanual/documentation/dashboard/deploy/applications.md new file mode 100644 index 0000000..ca16e19 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/deploy/applications.md @@ -0,0 +1,24 @@ +

Ready Community Applications

+ +Easily deploy your favourite applications on the ThreeFold grid with a click of a button. + +![](../img/applications_landing.png) + +*** + +

Table of Contents

+ +- [Algorand](../solutions/algorand.md) +- [CasperLabs](../solutions/casper.md) +- [Discourse](../solutions/discourse.md) +- [Funkwhale](../solutions/funkwhale.md) +- [Mattermost](../solutions/mattermost.md) +- [Nextcloud](../solutions/nextcloud.md) +- [Node Pilot](../solutions/nodepilot.md) +- [ownCloud](../solutions/owncloud.md) +- [Peertube](../solutions/peertube.md) +- [Presearch](../solutions/presearch.md) +- [Subsquid](../solutions/subsquid.md) +- [Taiga](../solutions/taiga.md) +- [Umbrel](../solutions/umbrel.md) +- [WordPress](../solutions/wordpress.md) \ No newline at end of file diff --git a/collections/tfmanual/documentation/dashboard/deploy/dedicated_machines.md b/collections/tfmanual/documentation/dashboard/deploy/dedicated_machines.md new file mode 100644 index 0000000..24f4dbb --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/deploy/dedicated_machines.md @@ -0,0 +1,93 @@ +

Dedicated Machines

+ +

Table of Contents

+ +- [What is a Dedicated Machine?](#what-is-a-dedicated-machine) +- [Description](#description) +- [Billing \& Pricing](#billing--pricing) +- [Discounts](#discounts) +- [Usage](#usage) +- [GPU Support](#gpu-support) +- [Filter and Reserve a GPU Node](#filter-and-reserve-a-gpu-node) + - [Filter Nodes](#filter-nodes) + - [Reserve a Node](#reserve-a-node) +- [GPU Support Links](#gpu-support-links) + +*** + +## What is a Dedicated Machine? + +Dedicated machines are 3Nodes that can be reserved and rented entirely by one user. The user can thus reserve an entire node and use it exclusively to deploy solutions. This feature is ideal for users who want to host heavy deployments with the benefits of high reliability and cost effectiveness. + +## Description + +- Node reserved with deploying a `RentContract` on this node. node can has only one rentContract. +- When a user create a RentContract against a node, the grid validate that there are no other active contracts on that node on the creation. +- Once a RentContract is created, the grid can only accept contracts on this node from the tenant. +- Only workloads from the tenant are accepted + +## Billing & Pricing + +- Once a node is rented, there is a fixed charge billed to the tenant regardless of deployed workloads. +- Any subsequent NodeContract deployed on a node where a rentContract is active (and the same user is creating the nodeContracts) can be excluded from billing (apart from public ip and network usage). +- Billing rates are calculated hourly on the TFGrid. + - While some of the documentation mentions a monthly price, the chain expresses pricing per hour. The monthly price shown within the manual is offered as a convenience to users, as it provides a simple way to estimate costs. + +## Discounts + +- Received Discounts for renting a node on TFGrid internet capacity + - 50% for dedicated node (TF Pricing policies) + - A second level discount up to 60% for balance level see [Discount Levels](../../../knowledge_base/cloud/pricing/staking_discount_levels.md) +- Discounts are calculated every time the grid bills by checking the available TFT balance on the user wallet and seeing if it is sufficient to receive a discount. As a result, if the user balance drops below the treshold of a given discount, the deployment price increases. + +## Usage + +- See list of all dedicated node on `Dedicated Machines` tab on the portal. + + ![ ](../img/dedicated_machines.png) + + - Hover over the price to see the applied discounts + + ![](../img/dashboard_dedicated_nodes_discounts.png) + + - Expand row to see more info on the node: + + ![ ](../img/dashboard_dedicated_nodes_details.png) + - Resources + - Location + - Possible Public Ips *this depends on the farm it belongs to* + + - You can see the nodes in 2 states: + - Free + - Reserved *Owned by current twin* +- Reserve a node: + - If node is not rented by another twin you can simply click reserve. + + +- Unreserve a node: + - Simply as reserving but another check will be done to check you don't have any active workloads on the node before unreserving. + +## GPU Support + +To use a GPU on the TFGrid, users need to rent a dedicated node. Once they have rented a dedicated node equipped with a GPU, users can deploy workloads on their dedicated GPU node. + +## Filter and Reserve a GPU Node + +You can filter and reserve a GPU node using the [Dedicated Machines section](https://dashboard.grid.tf/#/deploy/dedicated-nodes/) of the **Dashboard**. + +### Filter Nodes + +- Filter nodes using the vendor name + - In **Filters**, select **GPU's vendor name** + - Write the name of the vendor desired (e.g. **nvidia**, **amd**) +- Filter nodes using the device name + - In **Filters**, select **GPU's device name** + - Write the name of the device desired (e.g. **GT218**) + +### Reserve a Node + +When you have decided which node to reserve, click on **Reserve** under the column named **Actions**. Once you've rented a dedicated node that has a GPU, you can deploy GPU workloads. + +## GPU Support Links + +The ThreeFold Manual covers many ways to use a GPU node on the TFGrid. Read [this section](../../system_administrators/gpu/gpu_toc.md) to learn more. \ No newline at end of file diff --git a/collections/tfmanual/documentation/dashboard/deploy/deploy.md b/collections/tfmanual/documentation/dashboard/deploy/deploy.md new file mode 100644 index 0000000..a96decc --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/deploy/deploy.md @@ -0,0 +1,27 @@ +# Deploy + +Here you will find everything related to deployments on the ThreeFold grid. This includes: + +- Checking the cost of a deployment using [Pricing Calculator](./pricing_calculator.md) +- Finding a node to deploy on using the [Node Finder](./node_finder.md) +- Deploying your desired workload from [Virtual Machines](../solutions/vm_intro.md), [Orchestrators](./orchestrators.md), or [Applictions](./applications.md) +- Renting your own node on the ThreeFold grid from [Dedicated Machines](./dedicated_machines.md) +- Consulting [Your Contracts](./your_contracts.md) on the TFGrid +- Finding or publishing Flists from [Images](./images.md) +- Updating or generating your SSH key from [SSH Keys](./ssh_keys.md) + + ![](../img/sidebar_2.png) + +*** + +## Table of Content + +- [Pricing Calculator](./pricing_calculator.md) +- [Node Finder](./node_finder.md) +- [Virtual Machines](../solutions/vm_intro.md) +- [Orchestrators](./orchestrators.md) +- [Dedicated Machines](./dedicated_machines.md) +- [Applications](./applications.md) +- [Your Contracts](./your_contracts.md) +- [Images](./images.md) +- [SSH Keys](./ssh_keys.md) \ No newline at end of file diff --git a/collections/tfmanual/documentation/dashboard/deploy/images.md b/collections/tfmanual/documentation/dashboard/deploy/images.md new file mode 100644 index 0000000..2c27966 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/deploy/images.md @@ -0,0 +1,5 @@ +# Images + +Find or Publish your Flist from [Zero-OS Hub](https://hub.grid.tf/) + +![](../img/0_hub.png) \ No newline at end of file diff --git a/collections/tfmanual/documentation/dashboard/deploy/node_finder.md b/collections/tfmanual/documentation/dashboard/deploy/node_finder.md new file mode 100644 index 0000000..dd93347 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/deploy/node_finder.md @@ -0,0 +1,40 @@ +

Node Finder

+ +

Table of Contents

+ +- [Nodes](#nodes) +- [GPU Support](#gpu-support) + +*** + +## Nodes + +The Node Finder page provides a more detailed view for the nodes available on the ThreeFold grid With detailed information and statistics about any of the available nodes. + +![](../img/nodes.png) + +You can get a node with the desired specifications using the filters available in the nodes page. + +![](../img/nodes_filters.png) + +You can see all of the node details by clicking on a node record. + +![](../img/nodes_details.png) + +## GPU Support + +![GPU support](../img/gpu_filter.png) + +- A new filter for GPU supported node is now available on the Nodes page. +- GPU count +- Filtering capabilities based on the model / device + +On the details pages is shown the card information and its status (`reserved` or `available`) also the ID that’s needed to be used during deployments is easily accessible and has a copy to clipboard button. + +![GPU details](../img/gpu_details.png) + +Here’s an example of how it looks in case of reserved + +![GPU details](../img/gpu_details_reserved.png) + +The TF Dashboard is where to reserve the nodes the farmer should be able to set the extra fees on the form and the user also should be able to reserve and get the details of the node (cost including the extrafees, GPU informations). diff --git a/collections/tfmanual/documentation/dashboard/deploy/node_finder_gpu_support.md b/collections/tfmanual/documentation/dashboard/deploy/node_finder_gpu_support.md new file mode 100644 index 0000000..7002630 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/deploy/node_finder_gpu_support.md @@ -0,0 +1,19 @@ +

GPU Support

+ +*** + +![GPU support](../img/gpu_filter.png) + +- A new filter for GPU supported node is now available on the Nodes page. +- GPU count +- Filtering capabilities based on the model / device + +On the details pages is shown the card information and its status (`reserved` or `available`) also the ID that’s needed to be used during deployments is easily accessible and has a copy to clipboard button. + +![GPU details](../img/gpu_details.png) + +Here’s an example of how it looks in case of reserved + +![GPU details](../img/gpu_details_reserved.png) + +The TF Dashboard is where to reserve the nodes the farmer should be able to set the extra fees on the form and the user also should be able to reserve and get the details of the node (cost including the extrafees, GPU informations). diff --git a/collections/tfmanual/documentation/dashboard/deploy/orchestrators.md b/collections/tfmanual/documentation/dashboard/deploy/orchestrators.md new file mode 100644 index 0000000..47282a6 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/deploy/orchestrators.md @@ -0,0 +1,14 @@ +# Orchestrators + +Deploy your favorite orchestrating services and enjoy the seamless coordination and automation of various software applications and services. + +![](../img/orchestrator_landing.png) + +*** + +## Table of Contnet + +- [Kubernetes](../solutions/k8s.md) +- [Caprover](../solutions/caprover.md) + - [Caprover Admin](../solutions/caprover_admin.md) + - [Caprover Worker](../solutions/caprover_worker.md) \ No newline at end of file diff --git a/collections/tfmanual/documentation/dashboard/deploy/pricing_calculator.md b/collections/tfmanual/documentation/dashboard/deploy/pricing_calculator.md new file mode 100644 index 0000000..a050215 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/deploy/pricing_calculator.md @@ -0,0 +1,6 @@ +# TF Resource Calculator + +A tool provided by ThreeFold that allows users to estimate and calculate potential cost of a deployment on the ThreeFold grid. The resource calculator takes into account various factors, including deployment resources, node certification, currnet balance, and in return it displays an accurate estimate for the deployment in terms of ThreeFold Tokens (TFT) and in USD per month. + + +![](../img/pricing_calculator.png) \ No newline at end of file diff --git a/collections/tfmanual/documentation/dashboard/deploy/ssh_keys.md b/collections/tfmanual/documentation/dashboard/deploy/ssh_keys.md new file mode 100644 index 0000000..4e2cecb --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/deploy/ssh_keys.md @@ -0,0 +1,5 @@ +# SSH Keys + +Add, update or generate your SSH key with a click of a button. + +![](../img/SSH_Key.png) \ No newline at end of file diff --git a/collections/tfmanual/documentation/dashboard/deploy/vm.md b/collections/tfmanual/documentation/dashboard/deploy/vm.md new file mode 100644 index 0000000..5a22576 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/deploy/vm.md @@ -0,0 +1,13 @@ +

Virtual Machines

+ +On the TFGrid, you can deploy both micro and full virtual machines. + +![](../img/vm_landing.png) + +*** + +

Table of Contents

+ +- [Micro and Full VM Differences ](../solutions/vm_differences.md) +- [Full Virtual Machine](../solutions/fullVm.md) +- [Micro Virtual Machine](../solutions/vm.md) diff --git a/collections/tfmanual/documentation/dashboard/deploy/your_contracts.md b/collections/tfmanual/documentation/dashboard/deploy/your_contracts.md new file mode 100644 index 0000000..c7cb4a6 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/deploy/your_contracts.md @@ -0,0 +1,49 @@ +# Contracts + +From the Contracts section you can check your contracts by navigating to the `Deploy` then `Your Contracts` tab from the sidebar. + +From there you will see the `Contracts List`, the list is split into three different sections. these sections are: + +### Node contracts + +![image](../img/node_contracts.png) + +### Name contracts + +![image](../img/name_contracts.png) + +### Rent contracts + +![image](../img/rent_contracts.png) + + + +This list includes the following information about each contract. + +- Contract ID. +- Contract Type. +- Contract State (Created, Deleted, GracePeriod). +- Solution Typw +- Billing Rate (in TFT/Hour). +- Solution Name. +- Created At. +- Expiration (Only appears if the contract is in GracePeriod). +- Node ID +- Node Status (Up, Down, Standby). +- Show Details (This button will display the detailed information of the desired contract). + + ![image](../img/contract_details.png) + + +## Cancel Contract + +You can also cancel the target contract/s by select the contract you want to cancel + +- Click on the checkbox on the left side of the contract row +- Click on the delete button in the bottom right of the table +- Review the contract/s ID then click on *Delete* button + +Note: + +>- You can Cancel all you contracts by clicking on the checkbox on the left side of the table header then click on *Delete* button. +>- It is advisable to remove the contract from its solution page, especially when multiple contracts may be linked to the same instance. diff --git a/collections/tfmanual/documentation/dashboard/farms/farms.md b/collections/tfmanual/documentation/dashboard/farms/farms.md new file mode 100644 index 0000000..7faedd3 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/farms/farms.md @@ -0,0 +1,19 @@ +# Farms + +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. + + ![](../img/sidebar_3.png) + +*** + +## 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 diff --git a/collections/tfmanual/documentation/dashboard/farms/farms_finder.md b/collections/tfmanual/documentation/dashboard/farms/farms_finder.md new file mode 100644 index 0000000..252aa73 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/farms/farms_finder.md @@ -0,0 +1,13 @@ +# Farms + +The farms page provides a more detailed view for the farms available on the ThreeFold grid With detailed information about any of the available farms. + +![](../img/farms.png) + +You can search for a specific farm using the farms filters. + +![](../img/farms_filters.png) + +You can see all of the farm details by clicking on a farm record. + +![](../img/farms_details.png) diff --git a/collections/tfmanual/documentation/dashboard/farms/node_installer.md b/collections/tfmanual/documentation/dashboard/farms/node_installer.md new file mode 100644 index 0000000..903e10e --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/farms/node_installer.md @@ -0,0 +1,5 @@ +# Node Installer + +Generate your own boot device for your system and download Zero-OS Images from [Zero-OS Bootstrap](https://bootstrap.grid.tf/) + +![](../img/0_Bootstrap.png) \ No newline at end of file diff --git a/collections/tfmanual/documentation/dashboard/farms/simulator.md b/collections/tfmanual/documentation/dashboard/farms/simulator.md new file mode 100644 index 0000000..3d5b594 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/farms/simulator.md @@ -0,0 +1,5 @@ +# Simulator + +A tool provided by ThreeFold that allows users to estimate and calculate potential earnings from farming on the ThreeFold Grid. Farming refers to the process of providing computing resources, such as storage and processing power, to the ThreeFold Grid and earning tokens in return. The tf-farming-calculator takes into account various factors, including the amount of resources contributed, the duration of farming, and the current market conditions, to provide users with an estimate of their potential earnings in terms of ThreeFold Tokens (TFT). + +![](../img/simulator.png) \ No newline at end of file diff --git a/collections/tfmanual/documentation/dashboard/farms/your_farms.md b/collections/tfmanual/documentation/dashboard/farms/your_farms.md new file mode 100644 index 0000000..8afc756 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/farms/your_farms.md @@ -0,0 +1,134 @@ +# Farms + +This comprehensive guide aims to provide users with detailed instructions and insights into efficiently managing their _Farms_. Farms encompass servers and storage devices contributing computational and storage capabilities to the grid, empowering users to oversee, maintain, and optimize their resources effectively. + +- [Getting started](#getting-started) +- [Create a new Farm](#create-a-new-farm) +- [Manage Your Farms](#manage-your-farms) + - [Add a public IP to your Farm](#add-a-public-ip-to-your-farm) + - [Add a Stellar address for payout](#add-a-stellar-address-for-payout) + - [Generate your node bootstrap image](#generate-your-node-bootstrap-image) + - [Additional information](#additional-information) +- [Manage Your Nodes](#manage-your-nodes) + - [Node information](#node-information) + - [Extra Fees](#extra-fees) + - [Public Configuration](#public-configuration) + - [The Difference Between IPs Assigned to Nodes Versus a Farm](#the-difference-between-ips-assigned-to-nodes-versus-a-farm) + +## Getting started + +After logging in to the TF Dashboard, on the sidebar click on **Dashboard** then _Your Farms_ . + +## Create a new Farm + +If you want to start farming, you need a farmID, the ID of the farm that is owning the hardware node(s) you connect to the TFGrid. + +**Currently on**: + +- [Devnet](https://dashboard.dev.grid.tf/) +- [Qanet](https://dashboard.qa.grid.tf/) +- [Testnet](https://dashboard.test.grid.tf/) +- [Mainnet](https://dashboard.grid.tf/) + +Click `Create Farm` and choose a name. + +![ ](../img/dashboard_farms.png) + +![ ](../img/dashboard_farms_create.png) + +Click on `Create`. + +The farm is by default set up as 'DIY'. A farm can become certified through certification program. +Also a pricing policy is defined. Pricing policy is currently the same for all farms, the field is created for future use. + +## Manage Your Farms + +You can browse your Farms in _Farms_ table; Farms table contains all your own farms and its your entry point to manage your farm as in the following sections. + +![](../img/dashboard_farms_farms_table.png) + +### Add a public IP to your Farm + +If you have public IPv4 addresses available that can be used for usage on the TFGrid, you can add them in your farm. +Click `ADD IP`, specify the addresses, the gateway and click `CREATE`. +You can add them one by one or using range of IPs. + +**Some notes about adding a new IPs**: + +- Be careful not to create a new IP range that contains an IP address that already exists; doing so will result in an error. +- Verify that both the gateway address and the IP address are correct. +- Be careful not to include the same gateway address in a new IP range. + +![ ](../img/dashboard_farms_farm_details.png) + +![ ](../img/dashboard_farms_add_ip_single.png) + +![ ](../img/dashboard_farms_add_ip_range.png) + +Deleting IPv4 addresses is also possible here. The `Deployed Contract ID` gives an indication of whether an IP is currently used. If it is 0, it is safe to remove it. + +![ ](../img/dashboard_farms_ip_details.png) + +### Add a Stellar address for payout + +In a first phase, farming of tokens still results in payout on the Stellar network. So to get the farming reward, a Stellar address needs to be provided. + +![ ](../img/dashboard_farms_farm_details.png) + +![ ](../img/dashboard_farms_stellar_address.png) + +You can read about different ways to store TFT [here](../../threefold_token/storing_tft/storing_tft.md). Make sure to use a Stellar wallet for your farming rewards. + +### Generate your node bootstrap image + +Once you know your farmID, you can set up your node on TFGrid3. Click on `Bootstrap Node Image`. + +![dashboard_bootstrap_farm](../img/dashboard_bootstrap_farm.png) + +Read more Zero-OS bootstrap image [here](../../farmers/3node_building/2_bootstrap_image.md). + +### Additional information + +After booting a node, the info will become available in `Your Nodes` table, including the status info along with the minting and fixup receipts. + +![ ](../img/dashboard_farms_node_details.png) + +Clicking on the node statistics will open up a calendar where you can view the periods the node was minting or undergoing a fixup. Clicking on the periods will show a popup with the start and end datetimes, receipt hash and the amount of TFTs minted (if it is a minting receipt). + +![ ](../img/dashboard_portal_ui_nodes_minting.png) + +You can also download a single node's receipts using the `Download Receipts` button within the node statistics. Moreover, you can download all of the nodes' receipts using the `Download Receipts` button on the top left corner of the farm nodes table. + +## Manage Your Nodes + +as in farms table _Nodes_ table contains all your own nodes and its your entry point to manage your farm as in the following sections. + +### Node information + +Expand your node information by clicking on the expand button in the target node row. + +### Extra Fees + +You can set a price for the special hardware you’re providing e.g. GPUs while renting. + +![](../img/dashboard_farms_extra_fee.png) + +- Under the **Your Nodes** table, locate the target node and click **Set Additional Fees** under **Actions** +- Set a monthly fee (in USD) and click **Save** + +### Public Configuration + +To configure public IP addresses to a specific Node + +![](../img/dashboard_farms_public_config.png) + +- Under the **Your Nodes** table, locate the target node and click **Add a public config** under **Actions** +- Fill in the necessary information and click save. Only the IPv4 address and gateway are necessary. + +> The IPv6 address and the Domain are optional but if you provide The IPv6 you have to provide its Domain. + +#### The Difference Between IPs Assigned to Nodes Versus a Farm + +--- + +IPs assigned to a farm are available to be rented by workloads. They can be assigned to virtual machines for example. IPs assigned to nodes enable each node to become a gateway. diff --git a/collections/tfmanual/documentation/dashboard/home.md b/collections/tfmanual/documentation/dashboard/home.md new file mode 100644 index 0000000..d14fd9a --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/home.md @@ -0,0 +1,43 @@ +

ThreeFold Dashboard

+ +Explore, control, and manage your ThreeFold Grid resources effortlessly through our integrated Dashboard. Deploy solutions seamlessly while gaining full control, all within a unified interface. + +The ThreeFold Dashboard is a revolutionary platform that simplifies the deployment process, allowing users to effortlessly interact with the TFGrid using intuitive web components known as weblets. + +## What is the ThreeFold Dashboard? + +The ThreeFold Dashboard is a dynamic environment designed for both seasoned developers and newcomers alike. It offers a seamless and accessible browser experience, making it easy to deploy solutions on the TFGrid through the use of weblets. + +In the context of the Dashboard, a weblet is a compiled JavaScript web component that can be effortlessly embedded within the HTML page of a web application. This modular approach allows for flexible and intuitive interactions, facilitating a user-friendly deployment process. + +The backend for the weblets is introduced with the [Javascript Client](../javascript/grid3_javascript_readme.md) which communicates to TFChain over RMB. + +

Table of Contents

+ +- [Wallet Connector](./wallet_connector.md) +- [TFGrid](./tfgrid/tfgrid.md) +- [Deploy](./deploy/deploy.md) +- [Farms](./farms/farms.md) +- [TFChain](./tfchain/tfchain.md) + +## Advantages + +- It is a non-code easy way to deploy a whole solution on the TFGrid. +- It is 100% decentralized, there is no server involved. +- It is powerful tool designed to empower individuals and organizations with seamless control and management over their ThreeFold Grid resources. +- It provides an intuitive web-based interface that allows users to effortlessly deploy, monitor, and scale their workloads on the decentralized and sustainable ThreeFold Grid infrastructure. + +## Dashboard + +You can access the ThreeFold Dashboard on different TF Chain networks. + +- [https://dashboard.dev.grid.tf](https://dashboard.dev.grid.tf) for Dev net. +- [https://dashboard.qa.grid.tf](https://dashboard.qa.grid.tf) for QA net. +- [https://dashboard.test.grid.tf](https://dashboard.test.grid.tf) for Test net. +- [https://dashboard.grid.tf](https://dashboard.grid.tf) for Main net. + +## Limitations + +- Regarding browser support, we're only supporting Google Chrome browser (and thus Brave browser) at the moment with more browsers to be supported soon. +- Deploys one thing at a time. +- Might take sometime to deploy a solution like Peertube, so you should wait a little bit until it's fully running. diff --git a/collections/tfmanual/documentation/dashboard/img/0_Bootstrap.png b/collections/tfmanual/documentation/dashboard/img/0_Bootstrap.png new file mode 100644 index 0000000..dedec1b Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/0_Bootstrap.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/0_hub.png b/collections/tfmanual/documentation/dashboard/img/0_hub.png new file mode 100644 index 0000000..da7faf5 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/0_hub.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/Minting.png b/collections/tfmanual/documentation/dashboard/img/Minting.png new file mode 100644 index 0000000..b7de134 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/Minting.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/Monitoring.png b/collections/tfmanual/documentation/dashboard/img/Monitoring.png new file mode 100644 index 0000000..1cda446 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/Monitoring.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/SSH_Key.png b/collections/tfmanual/documentation/dashboard/img/SSH_Key.png new file mode 100644 index 0000000..7d22832 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/SSH_Key.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/add_domain_10.png b/collections/tfmanual/documentation/dashboard/img/add_domain_10.png new file mode 100644 index 0000000..aabe5de Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/add_domain_10.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/add_domain_11.png b/collections/tfmanual/documentation/dashboard/img/add_domain_11.png new file mode 100644 index 0000000..8540ce8 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/add_domain_11.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/add_domain_6.png b/collections/tfmanual/documentation/dashboard/img/add_domain_6.png new file mode 100644 index 0000000..05611ef Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/add_domain_6.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/add_domain_8.png b/collections/tfmanual/documentation/dashboard/img/add_domain_8.png new file mode 100644 index 0000000..3a35803 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/add_domain_8.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/add_domain_9.png b/collections/tfmanual/documentation/dashboard/img/add_domain_9.png new file mode 100644 index 0000000..346009b Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/add_domain_9.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/add_new_domain_success.png b/collections/tfmanual/documentation/dashboard/img/add_new_domain_success.png new file mode 100644 index 0000000..3b23776 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/add_new_domain_success.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/applications_landing.png b/collections/tfmanual/documentation/dashboard/img/applications_landing.png new file mode 100644 index 0000000..e4117a5 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/applications_landing.png differ diff --git a/collections/documentation/system_administrators/advanced/img/bridge.png b/collections/tfmanual/documentation/dashboard/img/bridge.png similarity index 100% rename from collections/documentation/system_administrators/advanced/img/bridge.png rename to collections/tfmanual/documentation/dashboard/img/bridge.png diff --git a/collections/documentation/system_administrators/advanced/img/bridge_deposit.png b/collections/tfmanual/documentation/dashboard/img/bridge_deposit.png similarity index 100% rename from collections/documentation/system_administrators/advanced/img/bridge_deposit.png rename to collections/tfmanual/documentation/dashboard/img/bridge_deposit.png diff --git a/collections/documentation/system_administrators/advanced/img/bridge_withdraw.png b/collections/tfmanual/documentation/dashboard/img/bridge_withdraw.png similarity index 100% rename from collections/documentation/system_administrators/advanced/img/bridge_withdraw.png rename to collections/tfmanual/documentation/dashboard/img/bridge_withdraw.png diff --git a/collections/tfmanual/documentation/dashboard/img/contract_details.png b/collections/tfmanual/documentation/dashboard/img/contract_details.png new file mode 100644 index 0000000..286c87a Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/contract_details.png differ diff --git a/collections/documentation/dashboard/img/dashboard_T&C.png b/collections/tfmanual/documentation/dashboard/img/dashboard_T&C.png similarity index 100% rename from collections/documentation/dashboard/img/dashboard_T&C.png rename to collections/tfmanual/documentation/dashboard/img/dashboard_T&C.png diff --git a/collections/documentation/farmers/3node_building/img/dashboard_bootstrap_farm.png b/collections/tfmanual/documentation/dashboard/img/dashboard_bootstrap_farm.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/dashboard_bootstrap_farm.png rename to collections/tfmanual/documentation/dashboard/img/dashboard_bootstrap_farm.png diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_bridge.png b/collections/tfmanual/documentation/dashboard/img/dashboard_bridge.png new file mode 100644 index 0000000..111ef91 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_bridge.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_connect.png b/collections/tfmanual/documentation/dashboard/img/dashboard_connect.png new file mode 100644 index 0000000..289b2e8 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_connect.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_dao.png b/collections/tfmanual/documentation/dashboard/img/dashboard_dao.png new file mode 100644 index 0000000..37fb232 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_dao.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_dedicated_nodes_details.png b/collections/tfmanual/documentation/dashboard/img/dashboard_dedicated_nodes_details.png new file mode 100644 index 0000000..649f7c9 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_dedicated_nodes_details.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_dedicated_nodes_discounts.png b/collections/tfmanual/documentation/dashboard/img/dashboard_dedicated_nodes_discounts.png new file mode 100644 index 0000000..fe66434 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_dedicated_nodes_discounts.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_explorer_farms.png b/collections/tfmanual/documentation/dashboard/img/dashboard_explorer_farms.png new file mode 100644 index 0000000..58d3305 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_explorer_farms.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_explorer_nodes.png b/collections/tfmanual/documentation/dashboard/img/dashboard_explorer_nodes.png new file mode 100644 index 0000000..963730e Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_explorer_nodes.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_explorer_statistics.png b/collections/tfmanual/documentation/dashboard/img/dashboard_explorer_statistics.png new file mode 100644 index 0000000..0d81f19 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_explorer_statistics.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_farms.png b/collections/tfmanual/documentation/dashboard/img/dashboard_farms.png new file mode 100644 index 0000000..bebffe2 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_farms.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_farms_add_ip_range.png b/collections/tfmanual/documentation/dashboard/img/dashboard_farms_add_ip_range.png new file mode 100644 index 0000000..30d6dcc Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_farms_add_ip_range.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_farms_add_ip_single.png b/collections/tfmanual/documentation/dashboard/img/dashboard_farms_add_ip_single.png new file mode 100644 index 0000000..26f80e4 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_farms_add_ip_single.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_farms_create.png b/collections/tfmanual/documentation/dashboard/img/dashboard_farms_create.png new file mode 100644 index 0000000..684dfbb Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_farms_create.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_farms_extra_fee.png b/collections/tfmanual/documentation/dashboard/img/dashboard_farms_extra_fee.png new file mode 100644 index 0000000..2800f03 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_farms_extra_fee.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_farms_farm_details.png b/collections/tfmanual/documentation/dashboard/img/dashboard_farms_farm_details.png new file mode 100644 index 0000000..5de107e Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_farms_farm_details.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_farms_farms_table.png b/collections/tfmanual/documentation/dashboard/img/dashboard_farms_farms_table.png new file mode 100644 index 0000000..dd92e0b Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_farms_farms_table.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_farms_ip_details.png b/collections/tfmanual/documentation/dashboard/img/dashboard_farms_ip_details.png new file mode 100644 index 0000000..025d9b5 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_farms_ip_details.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_farms_node_details.png b/collections/tfmanual/documentation/dashboard/img/dashboard_farms_node_details.png new file mode 100644 index 0000000..c95e3fc Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_farms_node_details.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_farms_public_config.png b/collections/tfmanual/documentation/dashboard/img/dashboard_farms_public_config.png new file mode 100644 index 0000000..cf1e8f5 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_farms_public_config.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_farms_stellar_address.png b/collections/tfmanual/documentation/dashboard/img/dashboard_farms_stellar_address.png new file mode 100644 index 0000000..0ba6efd Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_farms_stellar_address.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_generate_account.png b/collections/tfmanual/documentation/dashboard/img/dashboard_generate_account.png new file mode 100644 index 0000000..c0433dc Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_generate_account.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_login.png b/collections/tfmanual/documentation/dashboard/img/dashboard_login.png new file mode 100644 index 0000000..c119ac3 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_login.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_portal_account.png b/collections/tfmanual/documentation/dashboard/img/dashboard_portal_account.png new file mode 100644 index 0000000..be66b4e Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_portal_account.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_portal_create_account_1.png b/collections/tfmanual/documentation/dashboard/img/dashboard_portal_create_account_1.png new file mode 100644 index 0000000..4024e7d Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_portal_create_account_1.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_portal_create_account_2.png b/collections/tfmanual/documentation/dashboard/img/dashboard_portal_create_account_2.png new file mode 100644 index 0000000..5f1b4e5 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_portal_create_account_2.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_portal_create_twin.png b/collections/tfmanual/documentation/dashboard/img/dashboard_portal_create_twin.png new file mode 100644 index 0000000..776a27e Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_portal_create_twin.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_portal_deposit_tft.png b/collections/tfmanual/documentation/dashboard/img/dashboard_portal_deposit_tft.png new file mode 100644 index 0000000..97782e3 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_portal_deposit_tft.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_portal_farms.png b/collections/tfmanual/documentation/dashboard/img/dashboard_portal_farms.png new file mode 100644 index 0000000..3272e64 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_portal_farms.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_portal_fill_ipv6.png b/collections/tfmanual/documentation/dashboard/img/dashboard_portal_fill_ipv6.png new file mode 100644 index 0000000..c2ddd0c Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_portal_fill_ipv6.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_portal_terms_conditions.png b/collections/tfmanual/documentation/dashboard/img/dashboard_portal_terms_conditions.png new file mode 100644 index 0000000..82f6c3e Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_portal_terms_conditions.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_portal_transaction_sign.png b/collections/tfmanual/documentation/dashboard/img/dashboard_portal_transaction_sign.png new file mode 100644 index 0000000..62b4219 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_portal_transaction_sign.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_portal_transfer_detail.png b/collections/tfmanual/documentation/dashboard/img/dashboard_portal_transfer_detail.png new file mode 100644 index 0000000..919303c Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_portal_transfer_detail.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_portal_twin_created.png b/collections/tfmanual/documentation/dashboard/img/dashboard_portal_twin_created.png new file mode 100644 index 0000000..0d9b470 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_portal_twin_created.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_portal_ui_nodes_minting.png b/collections/tfmanual/documentation/dashboard/img/dashboard_portal_ui_nodes_minting.png new file mode 100644 index 0000000..fc925e2 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_portal_ui_nodes_minting.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_portal_withdraw_tft.png b/collections/tfmanual/documentation/dashboard/img/dashboard_portal_withdraw_tft.png new file mode 100644 index 0000000..5493694 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_portal_withdraw_tft.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_sidebar_portal.png b/collections/tfmanual/documentation/dashboard/img/dashboard_sidebar_portal.png new file mode 100644 index 0000000..9639032 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_sidebar_portal.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_statistics.png b/collections/tfmanual/documentation/dashboard/img/dashboard_statistics.png new file mode 100644 index 0000000..8badd4c Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_statistics.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_swap.png b/collections/tfmanual/documentation/dashboard/img/dashboard_swap.png new file mode 100644 index 0000000..dbda2ba Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_swap.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_transfer_address.png b/collections/tfmanual/documentation/dashboard/img/dashboard_transfer_address.png new file mode 100644 index 0000000..2a389e9 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_transfer_address.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_transfer_twin.png b/collections/tfmanual/documentation/dashboard/img/dashboard_transfer_twin.png new file mode 100644 index 0000000..7bff8ca Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_transfer_twin.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dashboard_uptime.png b/collections/tfmanual/documentation/dashboard/img/dashboard_uptime.png new file mode 100644 index 0000000..21920e7 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dashboard_uptime.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/dedicated_machines.png b/collections/tfmanual/documentation/dashboard/img/dedicated_machines.png new file mode 100644 index 0000000..e832be5 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/dedicated_machines.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/explorer_basics_.png b/collections/tfmanual/documentation/dashboard/img/explorer_basics_.png new file mode 100644 index 0000000..d8635ea Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/explorer_basics_.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/explorer_basics_2.png b/collections/tfmanual/documentation/dashboard/img/explorer_basics_2.png new file mode 100644 index 0000000..8af783c Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/explorer_basics_2.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/explorer_darkmode.png b/collections/tfmanual/documentation/dashboard/img/explorer_darkmode.png new file mode 100644 index 0000000..54cce34 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/explorer_darkmode.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/explorer_farm_details.png b/collections/tfmanual/documentation/dashboard/img/explorer_farm_details.png new file mode 100644 index 0000000..17f5f88 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/explorer_farm_details.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/explorer_farms.png b/collections/tfmanual/documentation/dashboard/img/explorer_farms.png new file mode 100644 index 0000000..73ddb75 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/explorer_farms.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/explorer_find_country_pubip.png b/collections/tfmanual/documentation/dashboard/img/explorer_find_country_pubip.png new file mode 100644 index 0000000..54b7ab6 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/explorer_find_country_pubip.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/explorer_gpu.png b/collections/tfmanual/documentation/dashboard/img/explorer_gpu.png new file mode 100644 index 0000000..6df7394 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/explorer_gpu.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/explorer_grafana.png b/collections/tfmanual/documentation/dashboard/img/explorer_grafana.png new file mode 100644 index 0000000..9a702fb Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/explorer_grafana.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/explorer_node_details.png b/collections/tfmanual/documentation/dashboard/img/explorer_node_details.png new file mode 100644 index 0000000..e6fd8c1 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/explorer_node_details.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/explorer_node_example_1.png b/collections/tfmanual/documentation/dashboard/img/explorer_node_example_1.png new file mode 100644 index 0000000..712a8da Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/explorer_node_example_1.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/explorer_node_example_2.png b/collections/tfmanual/documentation/dashboard/img/explorer_node_example_2.png new file mode 100644 index 0000000..7a0e46b Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/explorer_node_example_2.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/explorer_node_resources_1.png b/collections/tfmanual/documentation/dashboard/img/explorer_node_resources_1.png new file mode 100644 index 0000000..51e44a0 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/explorer_node_resources_1.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/explorer_node_resources_2.png b/collections/tfmanual/documentation/dashboard/img/explorer_node_resources_2.png new file mode 100644 index 0000000..0c406f3 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/explorer_node_resources_2.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/explorer_node_resources_3.png b/collections/tfmanual/documentation/dashboard/img/explorer_node_resources_3.png new file mode 100644 index 0000000..47af607 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/explorer_node_resources_3.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/explorer_nodes.png b/collections/tfmanual/documentation/dashboard/img/explorer_nodes.png new file mode 100644 index 0000000..d99a011 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/explorer_nodes.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/explorer_nodes_distribution.png b/collections/tfmanual/documentation/dashboard/img/explorer_nodes_distribution.png new file mode 100644 index 0000000..90cd664 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/explorer_nodes_distribution.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/explorer_statistics.png b/collections/tfmanual/documentation/dashboard/img/explorer_statistics.png new file mode 100644 index 0000000..9821a1d Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/explorer_statistics.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/explorer_status.png b/collections/tfmanual/documentation/dashboard/img/explorer_status.png new file mode 100644 index 0000000..821d4ca Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/explorer_status.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/explorer_toggle_gateways.png b/collections/tfmanual/documentation/dashboard/img/explorer_toggle_gateways.png new file mode 100644 index 0000000..6ce6c9f Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/explorer_toggle_gateways.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/explorer_toggle_gpu.png b/collections/tfmanual/documentation/dashboard/img/explorer_toggle_gpu.png new file mode 100644 index 0000000..7ee4d6f Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/explorer_toggle_gpu.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/farms.png b/collections/tfmanual/documentation/dashboard/img/farms.png new file mode 100644 index 0000000..5280633 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/farms.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/farms_details.png b/collections/tfmanual/documentation/dashboard/img/farms_details.png new file mode 100644 index 0000000..744fde4 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/farms_details.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/farms_filters.png b/collections/tfmanual/documentation/dashboard/img/farms_filters.png new file mode 100644 index 0000000..8eca69f Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/farms_filters.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/gpu_details.png b/collections/tfmanual/documentation/dashboard/img/gpu_details.png new file mode 100644 index 0000000..83314cb Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/gpu_details.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/gpu_details_reserved.png b/collections/tfmanual/documentation/dashboard/img/gpu_details_reserved.png new file mode 100644 index 0000000..84ab221 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/gpu_details_reserved.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/gpu_filter.png b/collections/tfmanual/documentation/dashboard/img/gpu_filter.png new file mode 100644 index 0000000..3a3657d Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/gpu_filter.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/grid_health.png b/collections/tfmanual/documentation/dashboard/img/grid_health.png new file mode 100644 index 0000000..2c5d9ee Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/grid_health.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/list_domains.png b/collections/tfmanual/documentation/dashboard/img/list_domains.png new file mode 100644 index 0000000..9144a76 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/list_domains.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/manage_domains_button.png b/collections/tfmanual/documentation/dashboard/img/manage_domains_button.png new file mode 100644 index 0000000..891110b Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/manage_domains_button.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/name_contracts.png b/collections/tfmanual/documentation/dashboard/img/name_contracts.png new file mode 100644 index 0000000..35f1217 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/name_contracts.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/node_contracts.png b/collections/tfmanual/documentation/dashboard/img/node_contracts.png new file mode 100644 index 0000000..b785b21 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/node_contracts.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/node_detail_.png b/collections/tfmanual/documentation/dashboard/img/node_detail_.png new file mode 100644 index 0000000..1e06f9a Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/node_detail_.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/node_detail_1.png b/collections/tfmanual/documentation/dashboard/img/node_detail_1.png new file mode 100644 index 0000000..6747192 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/node_detail_1.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/nodes.png b/collections/tfmanual/documentation/dashboard/img/nodes.png new file mode 100644 index 0000000..be29183 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/nodes.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/nodes_details.png b/collections/tfmanual/documentation/dashboard/img/nodes_details.png new file mode 100644 index 0000000..f5c4e8b Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/nodes_details.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/nodes_filters.png b/collections/tfmanual/documentation/dashboard/img/nodes_filters.png new file mode 100644 index 0000000..68257c2 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/nodes_filters.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/orchestrator_landing.png b/collections/tfmanual/documentation/dashboard/img/orchestrator_landing.png new file mode 100644 index 0000000..4770f40 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/orchestrator_landing.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/owncloud_create_user.png b/collections/tfmanual/documentation/dashboard/img/owncloud_create_user.png new file mode 100644 index 0000000..ba0badc Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/owncloud_create_user.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/owncloud_credentials.png b/collections/tfmanual/documentation/dashboard/img/owncloud_credentials.png new file mode 100644 index 0000000..8f1ad29 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/owncloud_credentials.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/owncloud_details.png b/collections/tfmanual/documentation/dashboard/img/owncloud_details.png new file mode 100644 index 0000000..efe6136 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/owncloud_details.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/owncloud_enabled.png b/collections/tfmanual/documentation/dashboard/img/owncloud_enabled.png new file mode 100644 index 0000000..8877f6b Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/owncloud_enabled.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/owncloud_logo.svg b/collections/tfmanual/documentation/dashboard/img/owncloud_logo.svg new file mode 100644 index 0000000..4959a9f --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/img/owncloud_logo.svg @@ -0,0 +1,159 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/collections/tfmanual/documentation/dashboard/img/owncloud_logout.png b/collections/tfmanual/documentation/dashboard/img/owncloud_logout.png new file mode 100644 index 0000000..ba21a9f Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/owncloud_logout.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/owncloud_show.png b/collections/tfmanual/documentation/dashboard/img/owncloud_show.png new file mode 100644 index 0000000..6b16ee3 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/owncloud_show.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/owncloud_tfconnect.png b/collections/tfmanual/documentation/dashboard/img/owncloud_tfconnect.png new file mode 100644 index 0000000..d386991 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/owncloud_tfconnect.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/owncloud_users.png b/collections/tfmanual/documentation/dashboard/img/owncloud_users.png new file mode 100644 index 0000000..aec7c03 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/owncloud_users.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/owncloud_visit.png b/collections/tfmanual/documentation/dashboard/img/owncloud_visit.png new file mode 100644 index 0000000..5624e89 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/owncloud_visit.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/polkadot_extension_.png b/collections/tfmanual/documentation/dashboard/img/polkadot_extension_.png new file mode 100644 index 0000000..bf3f6fd Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/polkadot_extension_.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/pricing_calculator.png b/collections/tfmanual/documentation/dashboard/img/pricing_calculator.png new file mode 100644 index 0000000..31f21eb Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/pricing_calculator.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/pro_manager5.png b/collections/tfmanual/documentation/dashboard/img/pro_manager5.png new file mode 100644 index 0000000..791dae0 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/pro_manager5.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/pro_manager6.png b/collections/tfmanual/documentation/dashboard/img/pro_manager6.png new file mode 100644 index 0000000..2b77950 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/pro_manager6.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/profile_manager1.png b/collections/tfmanual/documentation/dashboard/img/profile_manager1.png new file mode 100644 index 0000000..73d59d5 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/profile_manager1.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/profile_manager2.png b/collections/tfmanual/documentation/dashboard/img/profile_manager2.png new file mode 100644 index 0000000..98f2154 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/profile_manager2.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/profile_manager3.png b/collections/tfmanual/documentation/dashboard/img/profile_manager3.png new file mode 100644 index 0000000..407780c Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/profile_manager3.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/rent_contracts.png b/collections/tfmanual/documentation/dashboard/img/rent_contracts.png new file mode 100644 index 0000000..170ca57 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/rent_contracts.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/select_to_delete_domain.png b/collections/tfmanual/documentation/dashboard/img/select_to_delete_domain.png new file mode 100644 index 0000000..1ae8ce8 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/select_to_delete_domain.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/sidebar_1 (copy)_full.png b/collections/tfmanual/documentation/dashboard/img/sidebar_1 (copy)_full.png new file mode 100644 index 0000000..9e01af9 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/sidebar_1 (copy)_full.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/sidebar_1.png b/collections/tfmanual/documentation/dashboard/img/sidebar_1.png new file mode 100644 index 0000000..4779b4c Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/sidebar_1.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/sidebar_2 (copy)_full.png b/collections/tfmanual/documentation/dashboard/img/sidebar_2 (copy)_full.png new file mode 100644 index 0000000..f7d8600 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/sidebar_2 (copy)_full.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/sidebar_2.png b/collections/tfmanual/documentation/dashboard/img/sidebar_2.png new file mode 100644 index 0000000..58e913b Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/sidebar_2.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/sidebar_3 (copy)_full.png b/collections/tfmanual/documentation/dashboard/img/sidebar_3 (copy)_full.png new file mode 100644 index 0000000..8924f42 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/sidebar_3 (copy)_full.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/sidebar_3.png b/collections/tfmanual/documentation/dashboard/img/sidebar_3.png new file mode 100644 index 0000000..565715d Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/sidebar_3.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/sidebar_4 (copy)_full.png b/collections/tfmanual/documentation/dashboard/img/sidebar_4 (copy)_full.png new file mode 100644 index 0000000..7a7e165 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/sidebar_4 (copy)_full.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/sidebar_4.png b/collections/tfmanual/documentation/dashboard/img/sidebar_4.png new file mode 100644 index 0000000..8f94e9e Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/sidebar_4.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/simulator.png b/collections/tfmanual/documentation/dashboard/img/simulator.png new file mode 100644 index 0000000..b85a528 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/simulator.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/statistics.png b/collections/tfmanual/documentation/dashboard/img/statistics.png new file mode 100644 index 0000000..a216231 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/statistics.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/twin.png b/collections/tfmanual/documentation/dashboard/img/twin.png new file mode 100644 index 0000000..1e62185 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/twin.png differ diff --git a/collections/tfmanual/documentation/dashboard/img/vm_landing.png b/collections/tfmanual/documentation/dashboard/img/vm_landing.png new file mode 100644 index 0000000..21211a3 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/img/vm_landing.png differ diff --git a/collections/tfmanual/documentation/dashboard/play_go.md b/collections/tfmanual/documentation/dashboard/play_go.md new file mode 100644 index 0000000..5bb8332 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/play_go.md @@ -0,0 +1,5 @@ +- Choose one of the networks: + - https://dashboard.dev.grid.tf for Devnet. + - https://dashboard.qa.grid.tf for QAnet. + - https://dashboard.test.grid.tf for Testnet. + - https://dashboard.grid.tf for Mainnet. \ No newline at end of file diff --git a/collections/tfmanual/documentation/dashboard/solutions/add_domain.md b/collections/tfmanual/documentation/dashboard/solutions/add_domain.md new file mode 100644 index 0000000..6883c97 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/solutions/add_domain.md @@ -0,0 +1,107 @@ +

Add a Domain to a VM

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Preparation](#preparation) +- [Add New Domain](#add-new-domain) +- [Domains List](#domains-list) +- [Delete a Domain](#delete-a-domain) +- [Questions and Feedback](#questions-and-feedback) + +*** + +## Introduction + +We cover the overall process to add a domain to a virtual machine running on the ThreeFold Grid. + +## Preparation + +- Deploy a virtual machine +- Click on the button **Manage Domains** under **Actions** + +![](../img/add_domain_6.png) + +- Open the **Add New Domain** tab + +![](../img/add_domain_10.png) + +## Add New Domain + +We cover the different domain parameters presented in the **Add New Domain** tab. + +- **Subdomain** + - The subdomain is used to reference to the complete domain name. It is randomly generated, but the user can write a specific subdomain name. + - The subdomain prefix (e.g. **fvm3748domainguide**) is decided as follows: + - Solution name (e.g. **fvm**) + - Twin ID (e.g. **3748**) + - Deployment name (e.g. **domainguide**) + - The complete subdomain is thus composed of the subdomain prefix mentioned above and the subdomain entered in the **Subdomain** field. +- **Custom domain name** + - You can also use a custom domain. + - In this case, instead of having a gateway subdomain and a gateway name as your domain, the domain will be the custom domain entered in this field. + - If you select **Custom domain**, make sure to set a DNS A record pointing to the gateway IP address on your domain name registrar. + +![Custom Domain Name](../img/add_domain_8.png) + +- **Select domain** + - Choose a gateway for your domain. + +- **Port** + - Choose the port that exposes your application instance on the virtual machine which the domain will point to. + - By default, it is set to **80**. + +- **TLS Passthrough** + - Disabling TLS passthrough will let the gateway terminate the traffic. + - Enabling TLS passthrough will let the backend service terminate the traffic. + +- **Network Name** + - This is the name of the WireGuard interface network (read-only field). + +- **IP Address** + - This is the WireGuard IP address (read-only field). + +Once you've filled the domain parameters, click on the **Add** button. The message **Successfully deployed gateway** will be presented once the domain is properly added. + +![Success Domain](../img/add_new_domain_success.png) + +## Domains List + +Once your domain is set, you can access the **Domains List** tab to consult its parameters. To visit the domain, simply click on the **Visit** button under **Actions**. + +![List Domain For VM](../img/add_domain_9.png) + +* **Name** + * The name is the subdomain (without the prefix) +* **Contract ID** + * Contract ID of the domain +* **Domain** + * Without a custom domain (default) + * The complete domain name (e.g. `fvm3748domainguidextebgpt.gent01.dev.grid.tf`) is composed of the subdomain prefix, the subdomain and the gateway domain. + - The subdomain prefix (e.g. `fvm3748domainguide`), as mentioned above. + - The subdomain (e.g. `xtebgpt`), chosen during the domain creation. + - The gateway domain (e.g. `gent01.dev.grid.tf`), based on the chosen gateway. + - With a custom domain + - The domain will be your custom domain (`e.g. threefold.pro`). +* **TLS Passthrough** + * The TLS passthrough status can be either **Yes** or **No**. +* **Backend** + * The WireGuard IP and the chosen port of the domain (e.g. `http://10.20.4.2:80`). +* **Status** + * **OK** is displayed when the domain is properly set. +* **Actions** + * Use the **Visit** button to open the domain URL. + +At all time, you can click on **Reload** to reload the Domains List parameters. + +## Delete a Domain + +To delete a domain, open the **Manage Domains** window, in the tab **Domains lists** select the domain you wish to delete and click **Delete**. + +![Select To Delete Domain](../img/add_domain_11.png) + +By clicking the **Delete** button, the deletion will start and the domain will be deleted from this virtual machine. + +## Questions and Feedback + +If you have any questions, you can ask the ThreeFold community for help on the [ThreeFold Forum](http://forum.threefold.io/) or on the [ThreeFold Grid Tester Community](https://t.me/threefoldtesting) on Telegram. \ No newline at end of file diff --git a/collections/tfmanual/documentation/dashboard/solutions/algorand.md b/collections/tfmanual/documentation/dashboard/solutions/algorand.md new file mode 100644 index 0000000..21c25c7 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/solutions/algorand.md @@ -0,0 +1,97 @@ +

Algorand

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) + - [Algorand Structure](#algorand-structure) +- [Run Default Node](#run-default-node) +- [Run Relay Node](#run-relay-node) +- [Run Participant Node](#run-participant-node) +- [Run Indexer Node](#run-indexer-node) +- [Select Capacity](#select-capacity) + +*** + +## Introduction + +[Algorand](https://www.algorand.com/) builds technology that accelerates the convergence between decentralized and traditional finance by enabling the simple creation of next-generation financial products, protocols, and exchange of value. + +## Prerequisites + +- Make sure you have a [wallet](../wallet_connector.md) +- From the sidebar click on **Applications** +- Click on **Algorand** + +### Algorand Structure + +- Algorand has two main [types](https://developer.algorand.org/docs/run-a-node/setup/types/#:~:text=The%20Algorand%20network%20is%20comprised,%2C%20and%20non%2Drelay%20nodes.) of nodes (Relay or Participant) you can run also a 4 networks you can run your node against. Combining the types you can get: + - Defualt: + This is a Non-relay and Non-participant + It can run on (Devnet, Testnet, Betanet, Mainnet) + - Relay: + Relay node Can't be participant. + It can run only on (Testnet, Mainnet) + - Participant: + Can run on any of the four nets. + - Indexer: + It is a default node but with Archival Mode enbled which will make you able to query the data of the blockchain. + +## Run Default Node + +The basic type. you select any network you want. and for the node type select Default. +![defaultdep](./img/solutions_algorand.png) + +after the deployment is done. `ssh` to the node and run `goal node status` +![defaulttest](./img/algorand_defaulttest.png) +here you see your node run against mainnet. + +## Run Relay Node + +Relay nodes are where other nodes connect. Therefore, a relay node must be able to support a large number of connections and handle the processing load associated with all the data flowing to and from these connections. Thus, relay nodes require significantly more power than non-relay nodes. Relay nodes are always configured in archival mode. + +The relay node must be publicaly accessable. so it must have public ip. +![relaydep](./img/algorand_relaydep.png) + +after the deployment is done. `ssh` to the node and run `goal node status` to see the status of the node. and also you can check if the right port is listening (:4161 for testnet, and :4160 for mainnet) +![relaytest](./img/algorand_relaytest.png) + +The next step accourding to the [docs](https://developer.algorand.org/docs/run-a-node/setup/types/#relay-node) is to register your `ip:port` on Algorand Public SRV. + +## Run Participant Node + +Participation means participation in the Algorand consensus protocol. An account that participates in the Algorand consensus protocol is eligible and available to be selected to propose and vote on new blocks in the Algorand blockchain. +Participation node is responsible for hosting participation keys for one or more online accounts. + +What you need? +- Account mnemonics on the network you deploy on (offline) you can check the status for you account on the AlgoExplorer. search by your account id. + + The account needs to have some microAlgo to sign the participation transaction. + - [Main net explorer](https://algoexplorer.io/) + - [Test net explorer](https://testnet.algoexplorer.io/) + +- First Round: is the first block you need your participaiton node to validate from. you can choose the last block form the explorer. + ![partexp](./img/algorand_partexp.png) +- Last Round: is the final block your node can validate. let's make it 30M + +![partdep](./img/algorand_partdep.png) + +after the deployment is done. `ssh` to the node and run `goal node status` to see the status of the node. you see it do catchup. and the fast catchup is to make the node sync with the latest block faster by only fetch the last 1k blocks. after it done it will start create the participation keys. +![partstatus](./img/algorand_partstatus.png) + +now if you check the explorer you can see the status of the account turned to Online +![partonl](./img/algorand_partonl.png) + +## Run Indexer Node + +The primary purpose of this Indexer is to provide a REST API interface of API calls to support searching the Algorand Blockchain. The Indexer REST APIs retrieve the blockchain data from a PostgreSQL compatible database that must be populated. This database is populated using the same indexer instance or a separate instance of the indexer which must connect to the algod process of a running Algorand node to read block data. This node must also be an Archival node to make searching the entire blockchain possible. + +![indexernode](./img/algorand_indexernode.png) + +After it finish you can access the indexer API at port `8980` and here are the [endpoint](https://developer.algorand.org/docs/rest-apis/indexer/) you can access. + +## Select Capacity + +The default scinario the capacity is computed based on the node (network/type) accourding to this [reference](https://howbigisalgorand.com/). +But you still can change this only to higher values by selecting the option `Set Custom Capacity` + \ No newline at end of file diff --git a/collections/tfmanual/documentation/dashboard/solutions/basic_environments_readme.md b/collections/tfmanual/documentation/dashboard/solutions/basic_environments_readme.md new file mode 100644 index 0000000..d1bd532 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/solutions/basic_environments_readme.md @@ -0,0 +1,11 @@ +

Basic Environments

+ +

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 diff --git a/collections/tfmanual/documentation/dashboard/solutions/caprover.md b/collections/tfmanual/documentation/dashboard/solutions/caprover.md new file mode 100644 index 0000000..32034d7 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/solutions/caprover.md @@ -0,0 +1,165 @@ +

CapRover

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Requirements](#requirements) +- [Configs Tab](#configs-tab) +- [Admin and Workers Tabs](#admin-and-workers-tabs) +- [The Domain Name](#the-domain-name) + - [Domain Name Example](#domain-name-example) +- [How to Know the IP Address](#how-to-know-the-ip-address) +- [How to Access the Admin Interface](#how-to-access-the-admin-interface) +- [How to Work with CapRover](#how-to-work-with-caprover) + +*** + +## Introduction + +CapRover is an extremely easy to use app/database deployment & web server manager for your NodeJS, Python, PHP, ASP.NET, Ruby, MySQL, MongoDB, Postgres, WordPress (and etc...) applications! + +It's blazingly fast and very robust as it uses Docker, nginx, LetsEncrypt and NetData under the hood behind its simple-to-use interface. + +- CLI for automation and scripting +- Web GUI for ease of access and convenience +- No lock-in! Remove CapRover and your apps keep working! +- Docker Swarm under the hood for containerization and clustering +- Nginx (fully customizable template) under the hood for load-balancing +- Let's Encrypt under the hood for free SSL (HTTPS) + +Caprover is a very cool management app for containers based on Docker Swarm. + +It has following benefits : + +- easy to deploy apps (in seconds) +- easy to create new apps +- super good monitoring +- can be extended over the TFGrid + +## Requirements + +- Make sure you have a [wallet](../wallet_connector.md) +- From the sidebar click on **Orchestrators** +- Click on **CapRover** + +## Configs Tab + +![ ](./img/solutions_caprover.png) + +- Enter domain for you Caprover instance, Be very careful about the domain name: it needs to be a wildcard domain name you can configure in your chosen domain name system. +- Enter password for you Caprover instance. + +## Admin and Workers Tabs + +![ ](./img/solutions_caprover_leader.png) + +![ ](./img/solutions_caprover_workers.png) +Note: Worker nodes only accept SSH keys of RSA format. + +Deployment will take couple of minutes. + +## The Domain Name + +As per the [CapRover documentation](https://caprover.com/docs/get-started.html), you need to point a wildcard DNS entry to the VM IP address of your CapRover instance. You have to do this after having deployed the CapRover instance, otherwise you won't have access to the VM IP address. + +Let’s say your domain is **example.com** and your subdomain is **subdomain**. You can set **\*.subdomain.example.com** as an A record in your DNS settings to point to the VM IP address of the server hosting the CapRover instance, where **\*** acts as the wildcard. To do this, go to the DNS settings of your domain name registrar, and set a wild card A record entry. + +On your domain name registrar, you can manage your DNS settings as such, with **subdomain** as an example: + +| Record | Host | Value | TTL | +| ------ | ------------- | ------------- | --------- | +| A | @ | VM IP address | Automatic | +| A | subdomain | VM IP address | Automatic | +| A | \*.subdomain | VM IP address | Automatic | + +We note here that **@** is the root domain (@ takes the value of your domain name, e.g. **example** in **example.com**), **subdomain** is the name of your subdomain (it can be anything you want), and **\*.subdomain** is the wildcard for **subdomain**. If you don't want to use a subdomain, but only the domain, you could use a wildcard linked to the domain instead of the subdomain (e.g. put **\*** instead of **\*.subdomain** in the column **Host**). + +Once you've point a wildcard DNS entry to your CapRover IP address and that the DNS is properly propagated, you can click the **Admin Panel** button to access CapRover. This will lead you to the following URL (with **subdomain.example.com** as an example): + +> captain.subdomain.example.com + +Note that, to confirm the DNS propagation, you can use a [DNS lookup tool](https://mxtoolbox.com/DNSLookup.aspx). As an example, you can use the URL **captain.subdomain.example.com** to check if the IP address resolves to the VM IP address. + +### Domain Name Example + +In the following example, we pick ```apps.openly.life``` which is a domain name that will point to the IP address of the CapRover instance (which we only know after deployment). + +![ ](./img/domain_name_caprover_config.png) + +> Note how the *.apps.openly.life points to the public IPv4 address that has been returned from the deployment. + +## How to Know the IP Address + +Go back to your CapRover weblet and go to the deployment list. Click on `Show Details`. + +![ ](./img/solution_caprover_list.png) + +- The public IPv4 address is visible in here +- Now you can configure the domain name (see above, don't forget to point the wildcard domain to the public IP address) + +Click on details if you want to see more details + +```json + +{ + "version": 0, + "name": "caprover_leader_cr_156e44f0", + "created": 1637843368, + "status": "ok", + "message": "", + "flist": "https://hub.grid.tf/samehabouelsaad.3bot/tf-caprover-main-a4f186da8d.flist", + "publicIP": { + "ip": "185.206.122.136/24", + "gateway": "185.206.122.1" + }, + "planetary": false, + "yggIP": "", + "interfaces": [ + { + "network": "caprover_network_cr_156e44f0", + "ip": "10.200.4.2" + } + ], + "capacity": { + "cpu": 4, + "memory": 8192 + }, + "mounts": [ + { + "name": "data0", + "mountPoint": "/var/lib/docker", + "size": 107374182400, + "state": "ok", + "message": "" + } + ], + "env": { + "SWM_NODE_MODE": "leader", + "CAPROVER_ROOT_DOMAIN": "apps.openly.life", + "PUBLIC_KEY": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC/9RNGKRjHvViunSOXhBF7EumrWvmqAAVJSrfGdLaVasgaYK6tkTRDzpZNplh3Tk1aowneXnZffygzIIZ82FWQYBo04IBWwFDOsCawjVbuAfcd9ZslYEYB3QnxV6ogQ4rvXnJ7IHgm3E3SZvt2l45WIyFn6ZKuFifK1aXhZkxHIPf31q68R2idJ764EsfqXfaf3q8H3u4G0NjfWmdPm9nwf/RJDZO+KYFLQ9wXeqRn6u/mRx+u7UD+Uo0xgjRQk1m8V+KuLAmqAosFdlAq0pBO8lEBpSebYdvRWxpM0QSdNrYQcMLVRX7IehizyTt+5sYYbp6f11WWcxLx0QDsUZ/J" + }, + "entrypoint": "/sbin/zinit init", + "metadata": "", + "description": "caprover leader machine/node" +} +``` + +## How to Access the Admin Interface + +Make sure that you've point a wildcard DNS entry to your CapRover IP address (e.g. **185.206.122.136** in our example), as explained [here](#the-domain-name). + +* To access the CapRover admin interface, you can click the **Admin Panel** button or you can use the following admin URL template: **https://captain.subdomain.example.com**. + * Note the prefix **captain** and the usage of our wildcard domain. + +* The admin password is generated and visible behind the `Show Details` button of your CapRover deployment. + +![ ](./img/caprover_login.png) + +* You should now see the following screen: + +![ ](./img/captain_login+weblet_caprover_.png) + +## How to Work with CapRover + +* [CapRover Admin Tutorial](./caprover_admin.md) +* [CapRover Worker Tutorial](./caprover_worker.md) diff --git a/collections/tfmanual/documentation/dashboard/solutions/caprover_admin.md b/collections/tfmanual/documentation/dashboard/solutions/caprover_admin.md new file mode 100644 index 0000000..47dd8fd --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/solutions/caprover_admin.md @@ -0,0 +1,59 @@ +

CapRover Admin

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Step 1: Enable HTTPS](#step-1-enable-https) +- [Step 2: Add a Default Docker Registry](#step-2-add-a-default-docker-registry) +- [Step 3: Deploy an App](#step-3-deploy-an-app) +- [Step 4: Enable Monitoring](#step-4-enable-monitoring) +- [Step 5: Change Your Password](#step-5-change-your-password) + +*** + +## Introduction + +We present the steps to manage a CapRover Admin node. + +## Step 1: Enable HTTPS + +![ ](./img/enable_https_caprover.png) + +You need to specify your email address. + +You will have to login again. + +![ ](./img/caprover_https_activated.png) + +> Now force https. + +You will have to login again, and you should notice https is now used. + +## Step 2: Add a Default Docker Registry + +You'll have to add a default docker registry so other CapRover nodes in the cluster can download images from, and it can be self-hosted (managed by CapRover itself), to add it, go to `Cluster` -> `Docker Registry Configuration`. + +![ ](./img/caprover_docker_registry.png) + +You can check [official documentation](https://caprover.com/docs/app-scaling-and-cluster.html#setup-docker-registry) to know more about Docker registry options. + +## Step 3: Deploy an App + +![ ](./img/deploy_app_caprover1.png) + +just go to apps & follow the instructions, there is much more info on caprover website. + +## Step 4: Enable Monitoring + +![ ](./img/caprover_monitoring_start_.png) + +You should now see + +![ ](./img/caprover_monitoring_2_.png) + +## Step 5: Change Your Password + +- Go to `Settings` and change your password. This is important for your own security. + + +> Further information regarding the process of attaching a new node to the cluster can be found through the following documentation link: [Attach a New Node to the Cluster](./caprover_worker.md/#step-2-attach-a-new-node-to-the-cluster) \ No newline at end of file diff --git a/collections/tfmanual/documentation/dashboard/solutions/caprover_worker.md b/collections/tfmanual/documentation/dashboard/solutions/caprover_worker.md new file mode 100644 index 0000000..5269e23 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/solutions/caprover_worker.md @@ -0,0 +1,42 @@ +

CapRover Worker

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Step 1: Add a Default Docker Registry](#step-1-add-a-default-docker-registry) +- [Step 2: Attach a New Node to the Cluster](#step-2-attach-a-new-node-to-the-cluster) + +*** + +## Introduction + +We present the steps to manage a CapRover Worker node. + +## Step 1: Add a Default Docker Registry + +You'll have to add a default docker registry so other CapRover nodes in the cluster can download images from, and it can be self-hosted (managed by CapRover itself), to add it, go to `Cluster` -> `Docker Registry Configuration`. + +![ ](./img/caprover_docker_registry.png) + +- Click `Add Self-Hosted Registry` button, then click `Enable Self-Hosted Registry` + +![ ](./img/caprover_docker_default_registry.png) + +You can check [official documentation](https://caprover.com/docs/app-scaling-and-cluster.html#setup-docker-registry) to know more about Docker registry options. + + + +## Step 2: Attach a New Node to the Cluster + +![ ](./img/caprover_add_worker.png) + +- Add the public IPv4 address that has been returned from the worker deployment in the `New node IP Address` field. +- Add your `SSH private key` (you can use this command `cat ~/.ssh/id_rsa` to get your private key). +- Click `Join cluster` button. + +You should see the new added node under **Current Cluster Nodes** +![ ](./img/caprover_node_added.png) + +If you faced any problem you can use the `Alternative method`. + +Also you can check for Troubleshooting instruction on [Caprover Troubleshooting](https://caprover.com/docs/troubleshooting.html#second) \ No newline at end of file diff --git a/collections/tfmanual/documentation/dashboard/solutions/casper.md b/collections/tfmanual/documentation/dashboard/solutions/casper.md new file mode 100644 index 0000000..5071c09 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/solutions/casper.md @@ -0,0 +1,51 @@ +

CasperLabs

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Deployment](#deployment) + +*** + +## Introduction + +[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) +- From the sidebar click on **Applications** +- Click on **Casperlabs** + +## Deployment + +__Process__ : + +![ ](./img/solutions_casperlabs.png) + +- Enter an Application Name. It's used in generating a unique subdomain on one of the gateways on the network alongside your twin ID. Ex. ***cl98casp*.gent02.dev.grid.tf** + +- Select a capacity package: + - **Small**: {cpu: 2, memory: 4, diskSize: 100 } + - **Medium**: {cpu: 4, memory: 16, diskSize: 500 } + - **Large**: {cpu: 8, memory: 32, diskSize: 100 } + - Or choose a **Custom** plan +- Choose the network + - `Public IPv4` flag gives the virtual machine a Public IPv4 + +- `Dedicated` flag to retrieve only dedeicated nodes +- `Certified` flag to retrieve only certified nodes +- Choose the location of the node + - `Region` + - `Country` + - `Farm Name` +- Choose the node to deploy on +> Or you can select a specific node with manual selection. +- `Custom Domain` flag lets the user to use a custom domain +- Choose a gateway node to deploy your Casperlab instance on. + +After that is done you can see a list of all of your deployed instances + +![ ](./img/casper4.png) + +Click on ***Visit*** to go to the homepage of your Casperlabs instance! The node takes a long time in order for the RPC service to be ready so be patient! + +![ ](./img/casper5.png) \ No newline at end of file diff --git a/collections/tfmanual/documentation/dashboard/solutions/discourse.md b/collections/tfmanual/documentation/dashboard/solutions/discourse.md new file mode 100644 index 0000000..9bdff3c --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/solutions/discourse.md @@ -0,0 +1,53 @@ +

Discourse

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Deployment](#deployment) + +*** + +## Introduction + +[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) +- From the sidebar click on **Applications** +- Click on **Discourse** + +## Deployment + +![ ](./img/solutions_discourse.png) + +- Enter an Application Name. It's used in generating a unique subdomain on one of the gateways on the network alongside your twin ID. Ex. ***dc98newdisc*.gent02.dev.grid.tf** + +- Enter administrator information including **Email**. This admin will have full permission on the deployed instance. +- Select a capacity package: + - **Small**: {cpu: 1, memory: 2, diskSize: 15 } + - **Medium**: {cpu: 2, memory: 4, diskSize: 50 } + - **Large**: {cpu: 4, memory: 16, diskSize: 100 } + - Or choose a **Custom** plan + +- `Dedicated` flag to retrieve only dedeicated nodes +- `Certified` flag to retrieve only certified nodes +- Choose the location of the node + - `Region` + - `Country` + - `Farm Name` + +- Choose the node to deploy on +> Or you can select a specific node with manual selection. +- `Custom Domain` flag lets the user to use a custom domain +- Choose a gateway node to deploy your Discourse instance on. + +Unlike other solutions, Discourse requires that you have an SMTP server. So make sure you fill the fields in the **Mail Server** tab in order to deploy your instance successfully. + +![ ](./img/discourse4.png) + +After that is done you can see a list of all of your deployed instances + +![ ](./img/discourse5.png) + +Click on ***Visit*** to go to the homepage of your Discourse instance! + +![ ](./img/discourse6.png) diff --git a/collections/tfmanual/documentation/dashboard/solutions/fullVm.md b/collections/tfmanual/documentation/dashboard/solutions/fullVm.md new file mode 100644 index 0000000..59b01e6 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/solutions/fullVm.md @@ -0,0 +1,108 @@ +

Full Virtual Machine

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Deployment](#deployment) +- [Difference Between Full VM and Micro VM](#difference-between-full-vm-and-micro-vm) +- [Manually Mounting Additional Disk](#manually-mounting-additional-disk) + - [Check All Disks Attached to the VM](#check-all-disks-attached-to-the-vm) + - [Create a Mount Directory](#create-a-mount-directory) + - [New file system](#new-file-system) + - [Mount drive](#mount-drive) + +*** + +## Introduction + +We present the steps to deploy a full VM on the TFGrid. + +## Deployment + +Deploy a new full virtual machine on the Threefold Grid + +- Make sure you have a [wallet](../wallet_connector.md) +- From the sidebar click on **Applications** +- Click on **Full Virtual Machine** + +**Process:** + +![ ](./img/solutions_fullvm.png) + +- Fill in the instance name: it's used to reference the Full VM in the future. +- Choose the image from the drop down (e.g Alpine, Ubuntu) or you can click on `Other` and manually specify the flist URL and the entrypoint. +- Select a capacity package: + - **Small**: {cpu: 1, memory: 2, diskSize: 25 } + - **Medium**: {cpu: 2, memory: 4, diskSize: 50 } + - **Large**: {cpu: 4, memory: 16, diskSize: 100} + - Or choose a **Custom** plan +- Choose the network + - `Public IPv4` flag gives the virtual machine a Public IPv4 + - `Public IPv6` flag gives the virtual machine a Public IPv6 + - `Planetary Network` to connect the Virtual Machine to Planetary network + - `Myceluim` to enable mycelium on the virtual machine + - `Wireguard Access` to add a wireguard access to the Virtual Machine +- `GPU` flag to add GPU to the Virtual machine + - To deploy a Full VM with GPU, you first need to [rent a dedicated node](../../dashboard/deploy/dedicated_machines.md) +- `Dedicated` flag to retrieve only dedicated nodes +- `Certified` flag to retrieve only certified nodes +- Choose the location of the node + - `Country` + - `Farm Name` +- Choose the node to deploy the Full Virtual Machine on + ![](./img/node_selection.png) + +You can attach one or more disks to the Virtual Machine by clicking on the Disks tab and the plus `+` sign and specify the following parameters +![ ](./img/new_vm3.png) + +- Disk name +- Disk size + +in the bottom of the page you can see a list of all of the virtual machines you deployed. you can click on `Show details` for more details + +![ ](./img/new_vm5.png) +You can also go to JSON tab for full details +![ ](./img/new_vm6.png) + +## Difference Between Full VM and Micro VM + +- Full VM contains a default disk attached to it which is not the case in the Micro VM where you needed to make sure to attach a disk to it or the VM will fail +- The default disk is mounted on / so if you want to attach any additional disks, you have to choose a different mounting point +- Only cloud init flists can be deployed on Full VM. You can check official Threefold flists [here](https://hub.grid.tf/tf-official-vms) +- In Full VM, you need to mount the additional disks manually after the VM is deployed + +## Manually Mounting Additional Disk + +- You can follow the following commands to add your disk manually: + +### Check All Disks Attached to the VM + +```bash +fdisk -l +``` + +The additional disk won't be mounted and you won't find it listed + +```bash +df -h +``` + +### Create a Mount Directory + +```bash +sudo mkdir /hdd6T +``` + +### New file system + +```bash +sudo mkfs.ext4 /dev/vdb +``` + +### Mount drive + +```bash +sudo mount /dev/vdb /hdd6T/ +``` + +![mounting additional disk](./img/fullvm6.png) diff --git a/collections/tfmanual/documentation/dashboard/solutions/funkwhale.md b/collections/tfmanual/documentation/dashboard/solutions/funkwhale.md new file mode 100644 index 0000000..8940728 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/solutions/funkwhale.md @@ -0,0 +1,59 @@ +

Funkwhale

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Deployment](#deployment) + +*** + +## Introduction + +[Funkwhale](https://funkwhale.audio/) is social platform to enjoy and share music. +Funkwhale is a community-driven project that lets you listen and share music and audio within a decentralized, open network. + +## Prerequisites + +- Make sure you have a [wallet](../wallet_connector.md) +- From the sidebar click on **Applications** +- Click on **Funkwhale** + +## Deployment + +__Process__ : + +![ ](./img/solutions_funkwhale.png) + +- Enter an Application Name. It's used in generating a unique subdomain on one of the gateways on the network alongside your twin ID. Ex. ***fw100myfunk*.gent02.dev.grid.tf** + +- Enter administrator information including **Username**, **Email** and **Password**. This admin user will have full permission on the deployed instance. + +- Select a capacity package: + - **Small**: {cpu: 1, memory: 2, diskSize: 50 } + - **Medium**: {cpu: 2, memory: 4, diskSize: 100 } + - **Large**: {cpu: 4, memory: 16, diskSize: 250 } + - Or choose a **Custom** plan +- Choose the network + - `Public IPv4` flag gives the virtual machine a Public IPv4 + +- `Dedicated` flag to retrieve only dedeicated nodes +- `Certified` flag to retrieve only certified nodes +- Choose the location of the node + - `Region` + - `Country` + - `Farm Name` + +- Choose the node to deploy on +> Or you can select a specific node with manual selection. +- `Custom Domain` flag lets the user to use a custom domain +- Choose a gateway node to deploy your Funkwhale instance on. + + +After that is done you can see a list of all of your deployed instances + +![ ](./img/funkwhale2.png) + +Click on ***Visit*** to go to the homepage of your Funkwhale instance! + +![ ](./img/funkwhale3.png) \ No newline at end of file diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/algorand_defaulttest.png b/collections/tfmanual/documentation/dashboard/solutions/img/algorand_defaulttest.png new file mode 100644 index 0000000..8fbad1c Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/algorand_defaulttest.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/algorand_indexernode.png b/collections/tfmanual/documentation/dashboard/solutions/img/algorand_indexernode.png new file mode 100644 index 0000000..54540ab Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/algorand_indexernode.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/algorand_partdep.png b/collections/tfmanual/documentation/dashboard/solutions/img/algorand_partdep.png new file mode 100644 index 0000000..bde2f8c Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/algorand_partdep.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/algorand_partexp.png b/collections/tfmanual/documentation/dashboard/solutions/img/algorand_partexp.png new file mode 100644 index 0000000..1c452fb Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/algorand_partexp.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/algorand_partonl.png b/collections/tfmanual/documentation/dashboard/solutions/img/algorand_partonl.png new file mode 100644 index 0000000..984ebd5 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/algorand_partonl.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/algorand_partstatus.png b/collections/tfmanual/documentation/dashboard/solutions/img/algorand_partstatus.png new file mode 100644 index 0000000..f8a9635 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/algorand_partstatus.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/algorand_relaydep.png b/collections/tfmanual/documentation/dashboard/solutions/img/algorand_relaydep.png new file mode 100644 index 0000000..eb04aca Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/algorand_relaydep.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/algorand_relaytest.png b/collections/tfmanual/documentation/dashboard/solutions/img/algorand_relaytest.png new file mode 100644 index 0000000..870b06e Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/algorand_relaytest.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/caprover_1.png b/collections/tfmanual/documentation/dashboard/solutions/img/caprover_1.png new file mode 100644 index 0000000..b6b3f39 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/caprover_1.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/caprover_add_node2.png b/collections/tfmanual/documentation/dashboard/solutions/img/caprover_add_node2.png new file mode 100644 index 0000000..e3ae2a0 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/caprover_add_node2.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/caprover_add_worker.png b/collections/tfmanual/documentation/dashboard/solutions/img/caprover_add_worker.png new file mode 100644 index 0000000..ee0e83a Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/caprover_add_worker.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/caprover_cluster.png b/collections/tfmanual/documentation/dashboard/solutions/img/caprover_cluster.png new file mode 100644 index 0000000..0ede9c8 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/caprover_cluster.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/caprover_deploy_leader.png b/collections/tfmanual/documentation/dashboard/solutions/img/caprover_deploy_leader.png new file mode 100644 index 0000000..0d757e4 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/caprover_deploy_leader.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/caprover_deploy_worker.png b/collections/tfmanual/documentation/dashboard/solutions/img/caprover_deploy_worker.png new file mode 100644 index 0000000..e4f80ce Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/caprover_deploy_worker.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/caprover_deploying.png b/collections/tfmanual/documentation/dashboard/solutions/img/caprover_deploying.png new file mode 100644 index 0000000..307569c Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/caprover_deploying.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/caprover_detail_weblet.png b/collections/tfmanual/documentation/dashboard/solutions/img/caprover_detail_weblet.png new file mode 100644 index 0000000..4f619ff Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/caprover_detail_weblet.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/caprover_docker_default_registry.png b/collections/tfmanual/documentation/dashboard/solutions/img/caprover_docker_default_registry.png new file mode 100644 index 0000000..0998b1c Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/caprover_docker_default_registry.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/caprover_docker_registry.png b/collections/tfmanual/documentation/dashboard/solutions/img/caprover_docker_registry.png new file mode 100644 index 0000000..06abbeb Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/caprover_docker_registry.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/caprover_https_activated.png b/collections/tfmanual/documentation/dashboard/solutions/img/caprover_https_activated.png new file mode 100644 index 0000000..2cbadd6 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/caprover_https_activated.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/caprover_login.png b/collections/tfmanual/documentation/dashboard/solutions/img/caprover_login.png new file mode 100644 index 0000000..3d27d7e Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/caprover_login.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/caprover_monitoring_2_.png b/collections/tfmanual/documentation/dashboard/solutions/img/caprover_monitoring_2_.png new file mode 100644 index 0000000..c92bf01 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/caprover_monitoring_2_.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/caprover_monitoring_start_.png b/collections/tfmanual/documentation/dashboard/solutions/img/caprover_monitoring_start_.png new file mode 100644 index 0000000..2a5fa78 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/caprover_monitoring_start_.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/caprover_node_added.png b/collections/tfmanual/documentation/dashboard/solutions/img/caprover_node_added.png new file mode 100644 index 0000000..93e9a35 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/caprover_node_added.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/caprover_select_node.png b/collections/tfmanual/documentation/dashboard/solutions/img/caprover_select_node.png new file mode 100644 index 0000000..ce155b1 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/caprover_select_node.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/captain_login+weblet_caprover_.png b/collections/tfmanual/documentation/dashboard/solutions/img/captain_login+weblet_caprover_.png new file mode 100644 index 0000000..c4f14d9 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/captain_login+weblet_caprover_.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/casper2.png b/collections/tfmanual/documentation/dashboard/solutions/img/casper2.png new file mode 100644 index 0000000..4948b79 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/casper2.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/casper3.png b/collections/tfmanual/documentation/dashboard/solutions/img/casper3.png new file mode 100644 index 0000000..a9123f0 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/casper3.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/casper4.png b/collections/tfmanual/documentation/dashboard/solutions/img/casper4.png new file mode 100644 index 0000000..17bd144 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/casper4.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/casper5.png b/collections/tfmanual/documentation/dashboard/solutions/img/casper5.png new file mode 100644 index 0000000..5d3f1e7 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/casper5.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/cluster_add_nodes.png b/collections/tfmanual/documentation/dashboard/solutions/img/cluster_add_nodes.png new file mode 100644 index 0000000..c338f54 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/cluster_add_nodes.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/contracts_list.png b/collections/tfmanual/documentation/dashboard/solutions/img/contracts_list.png new file mode 100644 index 0000000..2990bde Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/contracts_list.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/deleted_contract_info copy.png b/collections/tfmanual/documentation/dashboard/solutions/img/deleted_contract_info copy.png new file mode 100644 index 0000000..a3c0357 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/deleted_contract_info copy.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/deleted_contract_info.png b/collections/tfmanual/documentation/dashboard/solutions/img/deleted_contract_info.png new file mode 100644 index 0000000..a3c0357 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/deleted_contract_info.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/deplist1.png b/collections/tfmanual/documentation/dashboard/solutions/img/deplist1.png new file mode 100644 index 0000000..e73d1fd Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/deplist1.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/deploy_app_caprover1.png b/collections/tfmanual/documentation/dashboard/solutions/img/deploy_app_caprover1.png new file mode 100644 index 0000000..7a8fe1e Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/deploy_app_caprover1.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/discourse4.png b/collections/tfmanual/documentation/dashboard/solutions/img/discourse4.png new file mode 100644 index 0000000..eaeb779 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/discourse4.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/discourse5.png b/collections/tfmanual/documentation/dashboard/solutions/img/discourse5.png new file mode 100644 index 0000000..01dca67 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/discourse5.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/discourse6.png b/collections/tfmanual/documentation/dashboard/solutions/img/discourse6.png new file mode 100644 index 0000000..f1566c8 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/discourse6.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/domain_name_caprover_config.png b/collections/tfmanual/documentation/dashboard/solutions/img/domain_name_caprover_config.png new file mode 100644 index 0000000..dca23c3 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/domain_name_caprover_config.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/enable_https_caprover.png b/collections/tfmanual/documentation/dashboard/solutions/img/enable_https_caprover.png new file mode 100644 index 0000000..4149288 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/enable_https_caprover.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/fullvm1.png b/collections/tfmanual/documentation/dashboard/solutions/img/fullvm1.png new file mode 100644 index 0000000..ce820d2 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/fullvm1.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/fullvm2.png b/collections/tfmanual/documentation/dashboard/solutions/img/fullvm2.png new file mode 100644 index 0000000..811bdfc Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/fullvm2.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/fullvm4.png b/collections/tfmanual/documentation/dashboard/solutions/img/fullvm4.png new file mode 100644 index 0000000..5186f74 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/fullvm4.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/fullvm5.png b/collections/tfmanual/documentation/dashboard/solutions/img/fullvm5.png new file mode 100644 index 0000000..376d3d9 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/fullvm5.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/fullvm6.png b/collections/tfmanual/documentation/dashboard/solutions/img/fullvm6.png new file mode 100644 index 0000000..30348fc Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/fullvm6.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/fullvm7.jpg b/collections/tfmanual/documentation/dashboard/solutions/img/fullvm7.jpg new file mode 100644 index 0000000..f5fd320 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/fullvm7.jpg differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/funkwhale2.png b/collections/tfmanual/documentation/dashboard/solutions/img/funkwhale2.png new file mode 100644 index 0000000..de4fab4 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/funkwhale2.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/funkwhale3.png b/collections/tfmanual/documentation/dashboard/solutions/img/funkwhale3.png new file mode 100644 index 0000000..7a5f00c Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/funkwhale3.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/k8s_dl_1.png b/collections/tfmanual/documentation/dashboard/solutions/img/k8s_dl_1.png new file mode 100644 index 0000000..c8b5670 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/k8s_dl_1.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/k8s_dl_2.png b/collections/tfmanual/documentation/dashboard/solutions/img/k8s_dl_2.png new file mode 100644 index 0000000..a5874f7 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/k8s_dl_2.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/k8s_dl_4.png b/collections/tfmanual/documentation/dashboard/solutions/img/k8s_dl_4.png new file mode 100644 index 0000000..be4361c Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/k8s_dl_4.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/mastodon1.jpg b/collections/tfmanual/documentation/dashboard/solutions/img/mastodon1.jpg new file mode 100644 index 0000000..e4bc3d6 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/mastodon1.jpg differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/mastodon2.jpg b/collections/tfmanual/documentation/dashboard/solutions/img/mastodon2.jpg new file mode 100644 index 0000000..ae0748b Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/mastodon2.jpg differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/mastodon3.jpg b/collections/tfmanual/documentation/dashboard/solutions/img/mastodon3.jpg new file mode 100644 index 0000000..591570b Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/mastodon3.jpg differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/mastodon4.jpg b/collections/tfmanual/documentation/dashboard/solutions/img/mastodon4.jpg new file mode 100644 index 0000000..f9afe85 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/mastodon4.jpg differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/mastodon5.jpg b/collections/tfmanual/documentation/dashboard/solutions/img/mastodon5.jpg new file mode 100644 index 0000000..eb01556 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/mastodon5.jpg differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/mattermost3.png b/collections/tfmanual/documentation/dashboard/solutions/img/mattermost3.png new file mode 100644 index 0000000..2ada6dc Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/mattermost3.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/mattermost4.png b/collections/tfmanual/documentation/dashboard/solutions/img/mattermost4.png new file mode 100644 index 0000000..fd6ee19 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/mattermost4.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/mattermost5.png b/collections/tfmanual/documentation/dashboard/solutions/img/mattermost5.png new file mode 100644 index 0000000..a45f632 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/mattermost5.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/new_cap2.png b/collections/tfmanual/documentation/dashboard/solutions/img/new_cap2.png new file mode 100644 index 0000000..689da23 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/new_cap2.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/new_cap3.png b/collections/tfmanual/documentation/dashboard/solutions/img/new_cap3.png new file mode 100644 index 0000000..31c5110 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/new_cap3.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/new_funk2.png b/collections/tfmanual/documentation/dashboard/solutions/img/new_funk2.png new file mode 100644 index 0000000..eb87d9f Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/new_funk2.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/new_funk3.png b/collections/tfmanual/documentation/dashboard/solutions/img/new_funk3.png new file mode 100644 index 0000000..4e97d6d Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/new_funk3.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/new_k8s4.png b/collections/tfmanual/documentation/dashboard/solutions/img/new_k8s4.png new file mode 100644 index 0000000..9dded9c Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/new_k8s4.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/new_k8s5.png b/collections/tfmanual/documentation/dashboard/solutions/img/new_k8s5.png new file mode 100644 index 0000000..e6aa91a Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/new_k8s5.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/new_peer2.png b/collections/tfmanual/documentation/dashboard/solutions/img/new_peer2.png new file mode 100644 index 0000000..604fe10 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/new_peer2.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/new_peer3.png b/collections/tfmanual/documentation/dashboard/solutions/img/new_peer3.png new file mode 100644 index 0000000..43987a4 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/new_peer3.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/new_vm2.png b/collections/tfmanual/documentation/dashboard/solutions/img/new_vm2.png new file mode 100644 index 0000000..c5ebf1d Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/new_vm2.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/new_vm3.png b/collections/tfmanual/documentation/dashboard/solutions/img/new_vm3.png new file mode 100644 index 0000000..1981cb6 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/new_vm3.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/new_vm5.png b/collections/tfmanual/documentation/dashboard/solutions/img/new_vm5.png new file mode 100644 index 0000000..723a44e Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/new_vm5.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/new_vm6.png b/collections/tfmanual/documentation/dashboard/solutions/img/new_vm6.png new file mode 100644 index 0000000..d2af47d Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/new_vm6.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/new_vm7.png b/collections/tfmanual/documentation/dashboard/solutions/img/new_vm7.png new file mode 100644 index 0000000..da8c92b Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/new_vm7.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/new_vm8.png b/collections/tfmanual/documentation/dashboard/solutions/img/new_vm8.png new file mode 100644 index 0000000..ee291c8 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/new_vm8.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/nixos-micro1.png b/collections/tfmanual/documentation/dashboard/solutions/img/nixos-micro1.png new file mode 100644 index 0000000..0114907 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/nixos-micro1.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/nixos-micro2.png b/collections/tfmanual/documentation/dashboard/solutions/img/nixos-micro2.png new file mode 100644 index 0000000..d094ef3 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/nixos-micro2.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/nixos-micro3.png b/collections/tfmanual/documentation/dashboard/solutions/img/nixos-micro3.png new file mode 100644 index 0000000..85247c3 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/nixos-micro3.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/nodeP_2.png b/collections/tfmanual/documentation/dashboard/solutions/img/nodeP_2.png new file mode 100644 index 0000000..f1f7ac2 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/nodeP_2.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/nodePilot_2.png b/collections/tfmanual/documentation/dashboard/solutions/img/nodePilot_2.png new file mode 100644 index 0000000..083551b Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/nodePilot_2.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/nodePilot_3.png b/collections/tfmanual/documentation/dashboard/solutions/img/nodePilot_3.png new file mode 100644 index 0000000..8b4549b Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/nodePilot_3.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/node_selection.png b/collections/tfmanual/documentation/dashboard/solutions/img/node_selection.png new file mode 100644 index 0000000..50a30dc Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/node_selection.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/nxios-micro1.png b/collections/tfmanual/documentation/dashboard/solutions/img/nxios-micro1.png new file mode 100644 index 0000000..c2fc9d7 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/nxios-micro1.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/owncloud1.png b/collections/tfmanual/documentation/dashboard/solutions/img/owncloud1.png new file mode 100644 index 0000000..2a5567e Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/owncloud1.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/owncloud2.png b/collections/tfmanual/documentation/dashboard/solutions/img/owncloud2.png new file mode 100644 index 0000000..c34fab7 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/owncloud2.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/owncloud3.png b/collections/tfmanual/documentation/dashboard/solutions/img/owncloud3.png new file mode 100644 index 0000000..62995d3 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/owncloud3.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/owncloud4.png b/collections/tfmanual/documentation/dashboard/solutions/img/owncloud4.png new file mode 100644 index 0000000..98d16ae Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/owncloud4.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/owncloud5.png b/collections/tfmanual/documentation/dashboard/solutions/img/owncloud5.png new file mode 100644 index 0000000..d441b86 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/owncloud5.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/owncloud6.png b/collections/tfmanual/documentation/dashboard/solutions/img/owncloud6.png new file mode 100644 index 0000000..a994782 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/owncloud6.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/presearch0.png b/collections/tfmanual/documentation/dashboard/solutions/img/presearch0.png new file mode 100644 index 0000000..29dedbe Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/presearch0.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/presearch4.png b/collections/tfmanual/documentation/dashboard/solutions/img/presearch4.png new file mode 100644 index 0000000..2c3c8e9 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/presearch4.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/presearch5.png b/collections/tfmanual/documentation/dashboard/solutions/img/presearch5.png new file mode 100644 index 0000000..9c7ec67 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/presearch5.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/presearch6.png b/collections/tfmanual/documentation/dashboard/solutions/img/presearch6.png new file mode 100644 index 0000000..9279f30 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/presearch6.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/qvm1.png b/collections/tfmanual/documentation/dashboard/solutions/img/qvm1.png new file mode 100644 index 0000000..93277ab Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/qvm1.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/qvm2.png b/collections/tfmanual/documentation/dashboard/solutions/img/qvm2.png new file mode 100644 index 0000000..0777158 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/qvm2.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/qvm_nodes.png b/collections/tfmanual/documentation/dashboard/solutions/img/qvm_nodes.png new file mode 100644 index 0000000..3670785 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/qvm_nodes.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/qvm_qsfs_config.png b/collections/tfmanual/documentation/dashboard/solutions/img/qvm_qsfs_config.png new file mode 100644 index 0000000..6e337e4 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/qvm_qsfs_config.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/solution_caprover_list.png b/collections/tfmanual/documentation/dashboard/solutions/img/solution_caprover_list.png new file mode 100644 index 0000000..3f672e2 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/solution_caprover_list.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/solutions_algorand.png b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_algorand.png new file mode 100644 index 0000000..ca7e860 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_algorand.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/solutions_caprover.png b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_caprover.png new file mode 100644 index 0000000..bf2f072 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_caprover.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/solutions_caprover_leader.png b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_caprover_leader.png new file mode 100644 index 0000000..218931d Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_caprover_leader.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/solutions_caprover_workers.png b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_caprover_workers.png new file mode 100644 index 0000000..0b12a69 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_caprover_workers.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/solutions_casperlabs.png b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_casperlabs.png new file mode 100644 index 0000000..f9f3271 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_casperlabs.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/solutions_discourse.png b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_discourse.png new file mode 100644 index 0000000..d7e0c66 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_discourse.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/solutions_fullvm.png b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_fullvm.png new file mode 100644 index 0000000..32d786d Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_fullvm.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/solutions_funkwhale.png b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_funkwhale.png new file mode 100644 index 0000000..6802db6 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_funkwhale.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/solutions_k8s.png b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_k8s.png new file mode 100644 index 0000000..935de58 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_k8s.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/solutions_k8s_master.png b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_k8s_master.png new file mode 100644 index 0000000..948a43b Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_k8s_master.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/solutions_k8s_workers.png b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_k8s_workers.png new file mode 100644 index 0000000..5e6df13 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_k8s_workers.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/solutions_mattermost.png b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_mattermost.png new file mode 100644 index 0000000..e47bb61 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_mattermost.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/solutions_microvm.png b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_microvm.png new file mode 100644 index 0000000..abad7ff Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_microvm.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/solutions_nextcloud.png b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_nextcloud.png new file mode 100644 index 0000000..a588f97 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_nextcloud.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/solutions_nodepilot.png b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_nodepilot.png new file mode 100644 index 0000000..65de04c Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_nodepilot.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/solutions_owncloud.png b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_owncloud.png new file mode 100644 index 0000000..98f7302 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_owncloud.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/solutions_owncloud_visit.png b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_owncloud_visit.png new file mode 100644 index 0000000..45c8857 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_owncloud_visit.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/solutions_peertube.png b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_peertube.png new file mode 100644 index 0000000..341653d Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_peertube.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/solutions_presearch.png b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_presearch.png new file mode 100644 index 0000000..258fca0 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_presearch.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/solutions_subsquid.png b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_subsquid.png new file mode 100644 index 0000000..2b2f132 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_subsquid.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/solutions_taiga.png b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_taiga.png new file mode 100644 index 0000000..b4f89e1 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_taiga.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/solutions_umbrel.png b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_umbrel.png new file mode 100644 index 0000000..311d83c Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_umbrel.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/solutions_wordpress.png b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_wordpress.png new file mode 100644 index 0000000..58e66b2 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/solutions_wordpress.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/subsquid_graphql.png b/collections/tfmanual/documentation/dashboard/solutions/img/subsquid_graphql.png new file mode 100644 index 0000000..82cf6d0 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/subsquid_graphql.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/subsquid_list.jpeg b/collections/tfmanual/documentation/dashboard/solutions/img/subsquid_list.jpeg new file mode 100644 index 0000000..596497f Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/subsquid_list.jpeg differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/subsquid_list.png b/collections/tfmanual/documentation/dashboard/solutions/img/subsquid_list.png new file mode 100644 index 0000000..c0a78aa Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/subsquid_list.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/taiga2.png b/collections/tfmanual/documentation/dashboard/solutions/img/taiga2.png new file mode 100644 index 0000000..cdcfcd4 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/taiga2.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/taiga3.png b/collections/tfmanual/documentation/dashboard/solutions/img/taiga3.png new file mode 100644 index 0000000..35ddd01 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/taiga3.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/taiga4.png b/collections/tfmanual/documentation/dashboard/solutions/img/taiga4.png new file mode 100644 index 0000000..8b9c844 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/taiga4.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/taiga5.png b/collections/tfmanual/documentation/dashboard/solutions/img/taiga5.png new file mode 100644 index 0000000..f0bcc2b Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/taiga5.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/taiga6.png b/collections/tfmanual/documentation/dashboard/solutions/img/taiga6.png new file mode 100644 index 0000000..606939b Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/taiga6.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/umbrel2.png b/collections/tfmanual/documentation/dashboard/solutions/img/umbrel2.png new file mode 100644 index 0000000..859e141 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/umbrel2.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/umbrel3.png b/collections/tfmanual/documentation/dashboard/solutions/img/umbrel3.png new file mode 100644 index 0000000..c8dacd5 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/umbrel3.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/umbrel4.png b/collections/tfmanual/documentation/dashboard/solutions/img/umbrel4.png new file mode 100644 index 0000000..1d9bdf1 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/umbrel4.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/umbrel5.png b/collections/tfmanual/documentation/dashboard/solutions/img/umbrel5.png new file mode 100644 index 0000000..4d7379d Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/umbrel5.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/vm_json.png b/collections/tfmanual/documentation/dashboard/solutions/img/vm_json.png new file mode 100644 index 0000000..1ab3737 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/vm_json.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/vm_list.png b/collections/tfmanual/documentation/dashboard/solutions/img/vm_list.png new file mode 100644 index 0000000..2a504b1 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/vm_list.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/weblet_peertube_instance.png b/collections/tfmanual/documentation/dashboard/solutions/img/weblet_peertube_instance.png new file mode 100644 index 0000000..4474a75 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/weblet_peertube_instance.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/weblet_peertube_listing.png b/collections/tfmanual/documentation/dashboard/solutions/img/weblet_peertube_listing.png new file mode 100644 index 0000000..93de06f Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/weblet_peertube_listing.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/weblet_vm4.png b/collections/tfmanual/documentation/dashboard/solutions/img/weblet_vm4.png new file mode 100644 index 0000000..f088303 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/weblet_vm4.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/weblet_vm5.png b/collections/tfmanual/documentation/dashboard/solutions/img/weblet_vm5.png new file mode 100644 index 0000000..0f778f5 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/weblet_vm5.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/weblet_vm_overview.png b/collections/tfmanual/documentation/dashboard/solutions/img/weblet_vm_overview.png new file mode 100644 index 0000000..3262552 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/weblet_vm_overview.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/weblet_vm_presearch_result.jpg b/collections/tfmanual/documentation/dashboard/solutions/img/weblet_vm_presearch_result.jpg new file mode 100644 index 0000000..ae77142 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/weblet_vm_presearch_result.jpg differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/wp10.png b/collections/tfmanual/documentation/dashboard/solutions/img/wp10.png new file mode 100644 index 0000000..c4f9998 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/wp10.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/wp11.png b/collections/tfmanual/documentation/dashboard/solutions/img/wp11.png new file mode 100644 index 0000000..35e9f58 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/wp11.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/wp2.png b/collections/tfmanual/documentation/dashboard/solutions/img/wp2.png new file mode 100644 index 0000000..8e3aed3 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/wp2.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/wp3.png b/collections/tfmanual/documentation/dashboard/solutions/img/wp3.png new file mode 100644 index 0000000..e485277 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/wp3.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/wp4.png b/collections/tfmanual/documentation/dashboard/solutions/img/wp4.png new file mode 100644 index 0000000..8d534f1 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/wp4.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/wp5.png b/collections/tfmanual/documentation/dashboard/solutions/img/wp5.png new file mode 100644 index 0000000..141497d Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/wp5.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/wp6.png b/collections/tfmanual/documentation/dashboard/solutions/img/wp6.png new file mode 100644 index 0000000..0f72d48 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/wp6.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/wp7.png b/collections/tfmanual/documentation/dashboard/solutions/img/wp7.png new file mode 100644 index 0000000..01af952 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/wp7.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/wp8.png b/collections/tfmanual/documentation/dashboard/solutions/img/wp8.png new file mode 100644 index 0000000..f243cd2 Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/wp8.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/img/wp9.png b/collections/tfmanual/documentation/dashboard/solutions/img/wp9.png new file mode 100644 index 0000000..34173dd Binary files /dev/null and b/collections/tfmanual/documentation/dashboard/solutions/img/wp9.png differ diff --git a/collections/tfmanual/documentation/dashboard/solutions/k8s.md b/collections/tfmanual/documentation/dashboard/solutions/k8s.md new file mode 100644 index 0000000..11197ec --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/solutions/k8s.md @@ -0,0 +1,98 @@ +

Kubernetes

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Configs tab](#configs-tab) +- [Master and Workers tabs](#master-and-workers-tabs) +- [Kubeconfig](#kubeconfig) +- [Manage Workers](#manage-workers) + +*** + +## Introduction + +Kubernetes is the standard container orchestration tool. + +On the TF grid, Kubernetes clusters can be deployed out of the box. We have implemented [K3S](https://k3s.io/), a full-blown Kubernetes offering that uses only half of the memory footprint. It is packaged as a single binary and made more lightweight to run workloads in resource-constrained locations (fits e.g. IoT, edge, ARM workloads). + +## Prerequisites + +- Make sure you have a [wallet](../wallet_connector.md) +- From the sidebar click on **Applications** +- Click on **Kubernetes** + +## Configs tab + +![ ](./img/solutions_k8s.png) + +- `Name`: Your Kubernetes Cluster name. +- `Cluster Token`: It's used for authentication between your worker nodes and master node. You could use the auto-generated one or type your own. + + +## Master and Workers tabs + +![ ](./img/solutions_k8s_master.png) +![ ](./img/solutions_k8s_workers.png) + +> Currently, we only support "single-master-multi-worker" k8s clusters. So you could always add more than one worker node by clicking on the **+** in the ***Worker*** tab. + + +## Kubeconfig +Once the cluster is ready, you can SSH into the cluster using `ssh root@IP` +> IP can be the public IP or the planetary network IP + +Onced connected via SSH, you can execute commands on the cluster like `kubectl get nodes`, and to get the kubeconfig, you can find it in `/root/.kube/config` + +> if it doesn't exist in `/root/.kube/config` it can be in `/etc/rancher/k3s/k3s.yaml` + +example: + +``` +root@WR768dbf76:~# cat /root/.kube/config +apiVersion: v1 +clusters: +- cluster: + certificate-authority-data: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUJkakNDQVIyZ0F3SUJBZ0lCQURBS0JnZ3Foa2pPUFFRREFqQWpNU0V3SHdZRFZRUUREQmhyTTNNdGMyVnkKZG1WeUxXTmhRREUyTkRBeU5qWTBNVE13SGhjTk1qRXhNakl6TVRNek16TXpXaGNOTXpFeE1qSXhNVE16TXpNegpXakFqTVNFd0h3WURWUVFEREJock0zTXRjMlZ5ZG1WeUxXTmhRREUyTkRBeU5qWTBNVE13V1RBVEJnY3Foa2pPClBRSUJCZ2dxaGtqT1BRTUJCd05DQUFUcGNtZE1KaWg1eGFTa1JlelNKVU5mUkQ5NWV6cE12amhVeUc2bWU4bTkKY0lQWENoNUZ2ZU81Znk1d1VTSTlYOFlGV2JkOGtRcG9vaVdVbStwYjFvU3hvMEl3UURBT0JnTlZIUThCQWY4RQpCQU1DQXFRd0R3WURWUjBUQVFIL0JBVXdBd0VCL3pBZEJnTlZIUTRFRmdRVUtkL3VUU3FtWk12bHhtcWNYU3lxCmVhWERIbXd3Q2dZSUtvWkl6ajBFQXdJRFJ3QXdSQUlnSUQ0cGNQWDl2R0F6SC9lTkhCNndVdmNZRi9HbXFuQVIKR2dqT1RSdWVia1lDSUdRUmUwTGJzQXdwMWNicHlYRWljV3V0aG1RQ1dwRXY1NThWZ3BoMFpETFAKLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQo= + server: https://127.0.0.1:6443 + name: default +contexts: +- context: + cluster: default + user: default + name: default +current-context: default +kind: Config +preferences: {} +users: +- name: default + user: + client-certificate-data: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUJrVENDQVRlZ0F3SUJBZ0lJWnptV1A4ellKaGd3Q2dZSUtvWkl6ajBFQXdJd0l6RWhNQjhHQTFVRUF3d1kKYXpOekxXTnNhV1Z1ZEMxallVQXhOalF3TWpZMk5ERXpNQjRYRFRJeE1USXlNekV6TXpNek0xb1hEVEl5TVRJeQpNekV6TXpNek0xb3dNREVYTUJVR0ExVUVDaE1PYzNsemRHVnRPbTFoYzNSbGNuTXhGVEFUQmdOVkJBTVRESE41CmMzUmxiVHBoWkcxcGJqQlpNQk1HQnlxR1NNNDlBZ0VHQ0NxR1NNNDlBd0VIQTBJQUJINTZaZGM5aTJ0azAyNGQKcXBDQ2NRMndMMjc1QWtPZUFxalIzQjFTTGFQeG1oOG9IcXd4SzY2RTc1ZWQya2VySFIySnBZbWwwNE5sa0grLwpSd2kvMDNDalNEQkdNQTRHQTFVZER3RUIvd1FFQXdJRm9EQVRCZ05WSFNVRUREQUtCZ2dyQmdFRkJRY0RBakFmCkJnTlZIU01FR0RBV2dCVGhPakJSaExjeE53UDkzd0xtUzBYRUFUNjlSekFLQmdncWhrak9QUVFEQWdOSUFEQkYKQWlBcjdDcDR2dks4Y2s0Q0lROEM5em5zVkFUZVhDaHZsUmdvanZuVXU4REZld0loQUlwRVYyMWJZVXBpUEkzVQowa3QvQmJqRUtjV1poVXNHQ0g0YzVNWTFFS0JhCi0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0KLS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUJkekNDQVIyZ0F3SUJBZ0lCQURBS0JnZ3Foa2pPUFFRREFqQWpNU0V3SHdZRFZRUUREQmhyTTNNdFkyeHAKWlc1MExXTmhRREUyTkRBeU5qWTBNVE13SGhjTk1qRXhNakl6TVRNek16TXpXaGNOTXpFeE1qSXhNVE16TXpNegpXakFqTVNFd0h3WURWUVFEREJock0zTXRZMnhwWlc1MExXTmhRREUyTkRBeU5qWTBNVE13V1RBVEJnY3Foa2pPClBRSUJCZ2dxaGtqT1BRTUJCd05DQUFUY3NlakN3TDQ5VkZvQnJhWVRyR3ByR2lMajNKeEw4ZVcwYnpTVDBWRGUKeFlrb3hDbDlnR0N6R2p1Q2Q0ZmZmRXV0QWdFMjU5MDFBWGJCU2VnOHdlSkJvMEl3UURBT0JnTlZIUThCQWY4RQpCQU1DQXFRd0R3WURWUjBUQVFIL0JBVXdBd0VCL3pBZEJnTlZIUTRFRmdRVTRUb3dVWVMzTVRjRC9kOEM1a3RGCnhBRSt2VWN3Q2dZSUtvWkl6ajBFQXdJRFNBQXdSUUloQU5CYWRhcFFZbnlYOEJDUllNODZtYWtMNkFDM0hSenMKL2l3Ukp6TnV6YytaQWlCZm14YytDTVZHQnBrblAzR2dWSWlFMFVQWkUrOFRnRUdkTTgrdCt4V2Ywdz09Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K + client-key-data: LS0tLS1CRUdJTiBFQyBQUklWQVRFIEtFWS0tLS0tCk1IY0NBUUVFSURXQURoZUl0RVdHWlFCc0tCSUpZTTZPeDB5TmRHQ1JjTDBTMUtvYjRTZ25vQW9HQ0NxR1NNNDkKQXdFSG9VUURRZ0FFZm5wbDF6MkxhMlRUYmgycWtJSnhEYkF2YnZrQ1E1NENxTkhjSFZJdG8vR2FIeWdlckRFcgpyb1R2bDUzYVI2c2RIWW1saWFYVGcyV1FmNzlIQ0wvVGNBPT0KLS0tLS1FTkQgRUMgUFJJVkFURSBLRVktLS0tLQo= +root@WR768dbf76:~# + +``` + +If you want to use kubectl through another machine, you need to change the line `server: https://127.0.0.1:6443` to be `server: https://PLANETARYIP_OR_PUBLICIP/6443` +replace PLANETARYIP_OR_PUBLICIP with the IP you want to reach th cluster through. + + +## Manage Workers +Add or Remove workers in any **Kubernetes cluster**. + + +- Kubernetes DeployedList Weblet +![ ](./img/k8s_dl_1.png) + +- Manager kubernetes workers +![ ](./img/k8s_dl_2.png) + +- Add a new worker +![ ](./img/new_k8s4.png) + +- Successfully added new worker +![ ](./img/k8s_dl_4.png) + +- Delete a worker +![ ](./img/new_k8s5.png) \ No newline at end of file diff --git a/collections/tfmanual/documentation/dashboard/solutions/mattermost.md b/collections/tfmanual/documentation/dashboard/solutions/mattermost.md new file mode 100644 index 0000000..0e9528c --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/solutions/mattermost.md @@ -0,0 +1,55 @@ +

Mattermost

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Deployment](#deployment) + +*** + +## Introduction + +[Mattermost](https://mattermost.com/) A single point of collaboration. Designed specifically for digital operations. + +## Prerequisites + +- Make sure you have a [wallet](../wallet_connector.md) +- From the sidebar click on **Applications** +- Click on **Mattermost** + +## Deployment + +![ ](./img/solutions_mattermost.png) + +- Enter an Application Name. It's used in generating a unique subdomain on one of the gateways on the network alongside your twin ID. Ex. ***matter*.gent02.dev.grid.tf** + +- Select a capacity package: + - **Small**: {cpu: 1, memory: 2, diskSize: 15 } + - **Medium**: {cpu: 2, memory: 4, diskSize: 50 } + - **Large**: {cpu: 4, memory: 16, diskSize: 100 } + - Or choose a **Custom** plan +- `Dedicated` flag to retrieve only dedeicated nodes +- `Certified` flag to retrieve only certified nodes +- Choose the location of the node + - `Region` + - `Country` + - `Farm Name` + +- Choose the node to deploy on +> Or you can select a specific node with manual selection. +- `Custom Domain` flag lets the user to use a custom domain +- Choose a gateway node to deploy your Mattermost instance on. + + +- There's also an optional **SMTP Server** tab if you'd like to have your Mattermost instance configured with an SMTP server. + + ![ ](./img/mattermost3.png) + +After that is done you can see a list of all of your deployed instances + +![ ](./img/mattermost4.png) + +Click on ***Visit*** to go to the homepage of your Mattermost instance! You need to login using TFConnect so make sure you download the *TFConnect* app from your App Store. + +![ ](./img/mattermost5.png) diff --git a/collections/tfmanual/documentation/dashboard/solutions/nextcloud.md b/collections/tfmanual/documentation/dashboard/solutions/nextcloud.md new file mode 100644 index 0000000..d25dd79 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/solutions/nextcloud.md @@ -0,0 +1,207 @@ +

Nextcloud

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Domain Names and Public IPs](#domain-names-and-public-ips) +- [Deploy Nextcloud](#deploy-nextcloud) +- [Nextcloud Setup](#nextcloud-setup) +- [DNS Details](#dns-details) + - [DNS Record with Public IPv4](#dns-record-with-public-ipv4) + - [DNS Record with Gateway](#dns-record-with-gateway) + - [DNS Propagation](#dns-propagation) +- [Talk](#talk) + - [Install Talk](#install-talk) + - [TURN](#turn) + - [Use Talk](#use-talk) +- [Backups and Updates](#backups-and-updates) + - [Create a Backup](#create-a-backup) + - [Automatic Backups and Updates](#automatic-backups-and-updates) +- [Troubleshooting](#troubleshooting) + - [Retrieve the Nextcloud AIO Password](#retrieve-the-nextcloud-aio-password) + - [Access the Nextcloud Interface Page](#access-the-nextcloud-interface-page) + - [Check the DNS Propagation](#check-the-dns-propagation) +- [Questions and Feedback](#questions-and-feedback) + +*** + +# Introduction + +[Nextcloud](https://nextcloud.com/) is a suite of client-server software for creating and using file hosting services. + +Nextcloud provides functionality similar to Dropbox, Office 365 or Google Drive when used with integrated office suites like Collabora Online or OnlyOffice. + + + +# Prerequisites + +- Make sure you have a [wallet](../wallet_connector.md) +- From the sidebar click on **Applications** +- Click on **Nextcloud** + + + +# Domain Names and Public IPs + +A domain name is required to use Nextcloud. You can either use your own, which we'll call a *custom domain*, or you can get a free subdomain from a gateway node. This won't impact the function of your deployment, it's just a matter of preference. If you want to use your own domain, follow the steps for custom domain wherever you see them below. + +Another choice to make before launching your Nextcloud instance is whether you want to reserve a public IPv4 for the deployment. Renting a public IP is an extra cost and is only required for the dedicated Nextcloud Talk video conferencing backend, recommended for calls with more than four participants. If you don't reserve a public IP, you can still use Talk in a more limited fashion (see the [Talk](#talk) section below for details). + +If you're not sure and just want the easiest, most affordable option, skip the public IP and use a gateway domain. + + + +# Deploy Nextcloud + +* On the [ThreeFold Dashboard](https://dashboard.grid.tf/), click on solutions from the sidebar, then click on **Nextcloud** +* Choose a name for your deployment + * Note: You can use the auto-generated name if you want +* Select a capacity package: + * **Minimum**: {cpu: 2, memory: 4gb, diskSize: 50gb } + * **Standard**: {cpu: 2, memory: 8gb, diskSize: 500gb } + * **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 +* Choose the location of the node + * `Country` + * `Farm Name` +* Select a node +* If you want to use a custom domain, click on **Custom domain** under **Domain Name** and write your domain name + * Example: `nextcloudwebsite.com` +* The **Select gateway** box will be visible whenever a gateway is required. If so, click it and choose a gateway + * If you are also using a custom domain, you must set your DNS record now before proceeding. The IP of the gateway will appear on screen. Check [below](#set-the-dns-record) for more information +* Click **Deploy** + + + +# Nextcloud Setup + +Once the weblet is deployed, the details page will appear. If you are using a custom domain with a public IPv4, you'll need to set your DNS record now using the IP address shown under **Public IPv4**. Again, see [below](#dns-details) for details. + +Before you can access Nextcloud itself, you'll need to decide which addons you want to install and complete a setup step. This is done through the AIO interface that's included with your deployment. To access it, you can visit the **Nextcloud Setup** link shown in the details page, or click on the **Nextcloud Setup** button under **Actions** in the deployments list to set up Nextcloud. + +* Once you have access to the **Nextcloud AIO setup page**, you will be given a password composed of 8 words. + * Use this password to access the **Nextcloud AIO interface page**. + * Store this password somewhere safe. It's only possible to recover it by using SSH. +* On the next page, you can add **Optionals addons** if you want. +* Click on **Download and start containers** to start the Nextcloud instance. +* Once the containers are properly started, you can access the Nextcloud admin login page by clicking **Open your Nextcloud**. + * You will be given an **Initial Nextcloud user name** and an **Initial Nextcloud password**. Use these credentials to log into the admin page. + * Store these credentials somewhere safe. +* Later, if you want to access the Nextcloud admin login page, you can simply click on the button **Open Nextcloud** under **Actions** in the deployment list. + +The installation is now complete and you have access to your Nextcloud instance. + + + +# DNS Details + +## DNS Record with Public IPv4 + +After deployment, you will have access to the IPv4 address of the VM you deployed on. You will need to add a **DNS A record** (Host: "@", Value: ) to your domain to access Nextcloud. This record type indicates the IP address of a given domain. + +## DNS Record with Gateway + +Before starting the deployment, you will need to add a **DNS A record** (Host: "@", Value: ) to your domain. The gateway IP will be shown to you when you select this option. + +## DNS Propagation + +When setting your own custom domain, it might take time for DNS to propagate. It is possible that you see the following message when opening the Nextcloud page: + +>"This site can't be reached. DNS address could not be found. Diagnosing the problem." + +This is normal. You might simply need to wait for the DNS to propagate completely. + + + +# Talk + +If you don't rent a public IP with your deployement, it's still possible to use Nextcloud Talk in a more limited fashion. It's generally understood that this method can work well for up to four participants in a call, and text chat also works without restriction. For larger calls, the dedicated backend, which requires a public IP, is recommended. + +While some calls can go entirely peer-to-peer and don't require any setup beyond installing the Talk app, a TURN server can be helpful to relay data when a peer-to-peer connection can't be established. There's more information on TURN servers after the install instructions. + +## Install Talk + +To install Talk, do the following: + +* Open the dropdown menu at the top right of the Nextcloud page +* Click on **Apps** +* In the left-side menu, select **Social & communication** +* Scroll down and locate the Talk app +* Click on **Download and enable** + +Once the Talk app is downloaded and enabled, you can find its icon at the top bar menu. + +## TURN + +As mentioned before, TURN servers relay data to help call participants connect to each other. All data sent to TURN server is encrypted in this case, so it's perfectly safe to use a free public server. + +That said, such free servers are not common, because relaying video chat uses a lot of bandwidth. As of the time of writing, Open Relay Project is one example that includes [instructions for use with Nextcloud Talk](https://www.metered.ca/tools/openrelay/#turn-server-for-nextcloud-talk). + +TURN server configuration can be found by opening the Talk settings, like this: + +* Open the dropdown menu at the top right of the Nextcloud page +* Click on **Personal settings** +* In the left-side menu, select **Talk** + +## Use Talk + +Once you've installed Talk and optionally added a TURN server, you can use Talk to create video conferences. + +Note that the host of the video meeting might need to turn the VPN off before creating a new conversation. + + + +# Backups and Updates + +## Create a Backup + +In the section **Backup and restore**, you can set a [BorgBackup](https://www.borgbackup.org/) of your Nextcloud instance. + +* Add a mount point and a directory name for your backup (e.g. **/mnt/backup**) and click **Submit backup location**. +* After the creation of the backup location, write down the **encryption password for backups** somewhere safe and offline. +* Click **Create backup** to create a BorgBackup of your Nextcloud instance. + * This will stop all containers, run the backup container and create the backup. +* Once the backup is complete, you can click on **Start containers** to restart the Nextcloud instance. + +## Automatic Backups and Updates + +After the first manual backup of your Nextcloud instance is complete, you can set automatic backups and updates. + +* In the section **Backup and restore**, open the dropdown menu **Click here to reveal all backup options**. +* In the section **Daily backup and automatic updates**, choose a time for your daily backup and click **Submit backup time**. + * To set automatic updates, make sure that the option **Automatically update all containers, the mastercontainer and on** is selected. + + + +# Troubleshooting + +## Retrieve the Nextcloud AIO Password + +You can retrieve the Nextcloud AIO password (8 words) by writing the following command line on the VM hosting your Nextcloud instance: + +``` +cat /mnt/data/docker/volumes/nextcloud_aio_mastercontainer/_data/data/configuration.json | grep password +``` + +## Access the Nextcloud Interface Page + +To access the Nextcloud interface page, follow those stepse + +* Open your Nextcloud instance +* In the top right Profile menu, select **Administration Settings** +* Under **Nextcloud All-in-One**, click **Open Nextcloud AIO Interface** + + + +## Check the DNS Propagation + +You can check if the DNS records are propagated globally with DNS propagation check services such as [DNS Checker](https://dnschecker.org/). You can use this tool to verify that your domain is properly pointing to the IPv4 address of the VM you deployed on. + + + +# Questions and Feedback + +If you have any questions, you can ask the ThreeFold community for help on the [ThreeFold Forum](http://forum.threefold.io/) or on the [ThreeFold Grid Tester Community](https://t.me/threefoldtesting) on Telegram. \ No newline at end of file diff --git a/collections/tfmanual/documentation/dashboard/solutions/nixos_micro.md b/collections/tfmanual/documentation/dashboard/solutions/nixos_micro.md new file mode 100644 index 0000000..41f8932 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/solutions/nixos_micro.md @@ -0,0 +1,66 @@ +

NixOS MicroVM

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Access the ThreeFold Dashboard](#access-the-threefold-dashboard) +- [Deploy a NixOS MicroVM](#deploy-a-nixos-microvm) +- [Questions and Feedback](#questions-and-feedback) + +*** + +## Introduction + +__NixOS MicroVM__ refers to a minimalistic virtual machine environment based on the NixOS Linux distribution. +The NixOS MicroVM leverages these principles to create a highly customizable and reproducible virtual machine environment. It allows users to define the entire system configuration, including packages, services, and dependencies, in a declarative manner using the Nix language. This ensures that the MicroVM is consistent, easily reproducible, and can be version-controlled. + +In this guide, will learn how to make reproducible, declarative and reliable systems by deploying a NixOS MicroVM weblet in ThreeFold Dashboard. + +For more information on Nix, you can read the [Nix Reference Manual](https://nixos.org/manual/nix/stable/). + +## Access the ThreeFold Dashboard + +* Go to the ThreeFold Dashboard website, based on the deployment network you prefer: + * [Mainnet](https://dashboard.grid.tf) + * [Testnet](https://dashboard.test.grid.tf) + * [Devnet](https://dashboard.dev.grid.tf) + * [QAnet](https://dashboard.qa.grid.tf) + +* 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 + + + +## Deploy a NixOS MicroVM + +We now present the main steps to properly configure your NixOS MicroVM running on the TFGrid. + +* In the section `Config`, make sure to select `Nixos` as the `VM Image`. You can choose different parameters (CPU, Memory, etc.) for your deployment depending on your workload needs. + +![](./img/nxios-micro1.png) + +* In the section `Environment Variables`, you can add the default configurations for Nix. Here's an example: + * ``` + { pkgs ? import { } }: + let pythonEnv = pkgs.python3.withPackages(ps: [ ]); in pkgs.mkShell { packages = [ pythonEnv ]; } + ``` + * This will be written to `/root/default.nix`. You can change the Nix shell configuration there. + +![](./img/nixos-micro2.png) + +* In the section `Disks`, you should mount a disk large enough for Nix to store its files used for `nix-store`. + +![](./img/nixos-micro3.png) + +* Once your configured the parameters, you can deploy the MicroVM. + +If you need more information on how to SSH into your deployment, read [this section](../../system_administrators/getstarted/tfgrid3_getstarted.md) of the TF Manual. + + + +## Questions and Feedback + +You should now be able to easily deploy a NixOS MicroVM on the ThreeFold Grid. + +If you have any question or feedback, you can write a post on the [ThreeFold Forum](http://forum.threefold.io/). \ No newline at end of file diff --git a/collections/tfmanual/documentation/dashboard/solutions/nodepilot.md b/collections/tfmanual/documentation/dashboard/solutions/nodepilot.md new file mode 100644 index 0000000..1fc212a --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/solutions/nodepilot.md @@ -0,0 +1,52 @@ +

NodePilot

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Deployment](#deployment) + +*** + +## Introduction + +This is a simple instance of upstream [Node Pilot](https://nodepilot.tech). + +## Prerequisites + +- Make sure you have a [wallet](../wallet_connector.md) +- From the sidebar click on **Applications** +- Click on **Node Pilot** + +## Deployment + +![ ](./img/solutions_nodepilot.png) + +- Fill in the instance name: it's used to reference the node-pilot in the future. + +- Minimum CPU allowed is 8 cores and minimum memory allowed is 8192. + +- `Dedicated` flag to retrieve only dedeicated nodes +- `Certified` flag to retrieve only certified nodes + +- Choose the location of the node + - `Region` + - `Country` + - `Farm Name` +- Select a node to deploy your node-pilot instance on. + +> Or you can select a specific node with manual selection. + +- When using the [flist](https://hub.grid.tf/tf-official-vms/node-pilot-zdbfs.flist) you get a node pilot instance ready out-of-box. You need to get a public ipv4 to get it to works. + +After that is done you can see a list of all of your deployed instances + +![ ](./img/nodeP_2.png) + +Click on ***Visit*** to go to the registration page of your Node Pilot instance! + +![ ](./img/nodePilot_3.png) + +You can go to `https://publicip` and configure your node-pilot. You can upload a backup to the VM via ssh as well if you have a backup of a previous instance. + +What change compared to upstream node-pilot, we have out-of-box a transparent pre-filled blockchain database for some blochain (currently Fuse and Pokt as proof-of-concept). You can start one of theses blockchain in no-time and it will be automatically nearly sync already without the requirement of the full space locally nor downloading everything and killing bandwidth. diff --git a/collections/tfmanual/documentation/dashboard/solutions/owncloud.md b/collections/tfmanual/documentation/dashboard/solutions/owncloud.md new file mode 100644 index 0000000..16726a0 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/solutions/owncloud.md @@ -0,0 +1,86 @@ +

ownCloud

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Deploy ownCloud](#deploy-owncloud) + - [Base](#base) + - [SMTP](#smtp) + - [List of Instances](#list-of-instances) +- [Admin Connection](#admin-connection) +- [TFConnect App Connection](#tfconnect-app-connection) + +*** + +## Introduction + +[ownCloud](https://owncloud.com/) develops and provides open-source software for content collaboration, allowing teams to easily share and work on files seamlessly regardless of device or location. + +## Prerequisites + +- Make sure you have a [wallet](../wallet_connector.md) +- From the sidebar click on **Solutions** +- Click on **ownCloud** + +## Deploy ownCloud + +![ ](./img/owncloud1.png) + +### Base + +- Enter an ownCloud deployment name. + - The name is used in generating a unique subdomain on one of the gateways on the network alongside your twin ID. + - Ex. ***oc98newcloud*.gent02.dev.grid.tf** + +- Enter administrator information including **Username** and **Password**. + - This admin user will have full permission on the deployed instance. +- Select a capacity package: + - **Small**: {cpu: 2, memory: 8, diskSize: 250 } + - **Medium**: {cpu: 2, memory: 16, diskSize: 500 } + - **Large**: {cpu: 4, memory: 32, diskSize: 1000 } + - Or choose a **Custom** plan +- Choose the network + - `Public IPv4` flag gives the virtual machine a Public IPv4 +- Enable the `Dedicated` flag to retrieve only dedicated nodes +- Enable the `Certified` flag to retrieve only certified nodes +- Choose the location of the node + - `Region` + - `Country` + - `Farm Name` +- Choose the node to deploy on +> Or you can select a specific node with manual selection. +- Enable the `Custom Domain` flag to use a custom domain +- Choose a gateway node to deploy your ownCloud instance on. + +Once you've set the deployment parameters, you can click on **Deploy**. + +### SMTP + +On the SMTP window, you can enable the optional `SMTP Server` flag if you want to have your ownCloud instance configured with an SMTP server. + +![ ](./img/owncloud4.png) + +### List of Instances + +When the deployment is ready, you will see a list of all of your deployed instances. + +![ ](./img/owncloud5.png) + +## Admin Connection + +Click on the button **Visit** under **Actions** to open the ownCloud login window. If you see **bad gateway**, you might simply need to wait a couple of minutes until the deployment completes. + +![ ](./img/solutions_owncloud_visit.png) + +To consult the deployment details, click on the button **Details** under **Actions**. On this page, you can access the **ownCloud Admin Username** and the **ownCloud Admin Password**. Use those credentials to log in as an administrator on your ownCloud deployment. + +![ ](./img/owncloud6.png) + +## TFConnect App Connection + +To connect to your ownCloud instance with the ThreeFold Connect app, you need to add permissions to your ThreeFold 3Bot ID by first [connecting as an administrator](#admin-connection). + +- Once you're connected as an admin, open the top-right menu and click on **Users**. +- To create a new user, set your 3Bot ID as the username with its corresponding email address, and set **Groups** as **admin**. Then click **Create**. +- You can now log out and connect to your ownCloud instance with the TF Connect app. \ No newline at end of file diff --git a/collections/tfmanual/documentation/dashboard/solutions/peertube.md b/collections/tfmanual/documentation/dashboard/solutions/peertube.md new file mode 100644 index 0000000..79a74ee --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/solutions/peertube.md @@ -0,0 +1,59 @@ +

Peertube

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Deployment](#deployment) + +*** + +## Introduction + +[Peertube](https://joinpeertube.org/) aspires to be a decentralized and free/libre alternative to video broadcasting services. + +## Prerequisites + +- Make sure you have a [wallet](../wallet_connector.md) +- From the sidebar click on **Applications** +- Click on **Peertube** + +## Deployment + +![ ](./img/solutions_peertube.png) + +- Enter an Application Name. It's used in generating a unique subdomain on one of the gateways on the network alongside your twin ID. + the applied format `.` Ex. ***pt100peerprod*.gent02.dev.grid.tf** +- Enter an email and password which will be used for the admin login. +- Select a capacity package: + - **Small**: { cpu: 1, memory: 2, diskSize: 15 } + - **Medium**: { cpu: 2, memory: 4, diskSize: 100 } + - **Large**: { cpu: 4, memory: 16, diskSize: 250 } + - Or choose a **Custom** plan + + - `Public IPv4` flag gives the virtual machine a Public IPv4 + - `Public IPv6` flag gives the virtual machine a Public IPv6 + - `Planetary Network` to connect the Virtual Machine to Planetary network + - `Wiregaurd Access` to add a wiregaurd acces to the Virtual Machine +- `Dedicated` flag to retrieve only dedeicated nodes +- `Certified` flag to retrieve only certified nodes +- Choose the location of the node + - `Region` + - `Country` + - `Farm Name` + +- Choose the node to deploy on +> Or you can select a specific node with manual selection. +- `Custom Domain` flag lets the user to use a custom domain +- Choose a gateway node to deploy your Peertube instance on. + +After that is done you can see a list of all of your deployed instances + + +![ ](./img/weblet_peertube_listing.png) + +Click on ***Visit*** to go to the homepage of your Peertube instance! + +![ ](./img/weblet_peertube_instance.png) + +> Please note it may take sometime to be ready \ No newline at end of file diff --git a/collections/tfmanual/documentation/dashboard/solutions/presearch.md b/collections/tfmanual/documentation/dashboard/solutions/presearch.md new file mode 100644 index 0000000..c0c3f55 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/solutions/presearch.md @@ -0,0 +1,98 @@ +

Presearch

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Deploy a Presearch Node](#deploy-a-presearch-node) +- [Migrate an Existing Presearch Node to the TFGrid](#migrate-an-existing-presearch-node-to-the-tfgrid) +- [Verify if a 3Node Already Runs a Presearch Workload](#verify-if-a-3node-already-runs-a-presearch-workload) +- [Learn More About Presearch](#learn-more-about-presearch) +- [Questions and Feedback](#questions-and-feedback) + +*** + +## Introduction + +[Presearch](https://www.presearch.io/) is a community-powered, decentralized search engine that provides better results while protecting your privacy and rewarding you when you search. This weblet deploys a Presearch node. Presearch Nodes are used to process user search requests, and node operators earn Presearch PRE tokens for joining and supporting the network. + +## Prerequisites + +- Make sure you have a [wallet](../wallet_connector.md) +- From the sidebar click on **Applications** +- Click on **Presearch** + +## Deploy a Presearch Node + +![ ](./img/solutions_presearch.png) + +- Enter an instance name. + +- You need to sign up on Presearch in order to get your *Presearch Registration Code*. To sign up, go to the [Presearch](https://presearch.com) website, create your account and then head to your [dashboard](https://nodes.presearch.com/dashboard) to find your registration code. + +- Choose the network + - `Public IPv4` flag gives the virtual machine a Public IPv4 + - `Planetary Network` to connect the Virtual Machine to Planetary network + +- `Dedicated` flag to retrieve only dedeicated nodes +- `Certified` flag to retrieve only certified nodes +- Choose the location of the node + - `Region` + - `Country` + - `Farm Name` + +- Choose the node to deploy the Virtual Machine on +> Or you can select a specific node with manual selection. + +## Migrate an Existing Presearch Node to the TFGrid + +Now what if you already have a Presearch node deployed somewhere and would like to migrate to Threefold? + +We got you! All you need to do is: + +1. Login to your old server that has your node via SSH. +2. Run `docker cp presearch-node:/app/node/.keys presearch-node-keys` in order to generate your key-pair. +3. Head to the *Restore* tab in the Presearch weblet and paste your key-pair in the fields below and you'll be good to deploy! + +![ ](./img/presearch6.png) + +After that is done you can see a list of all of your deployed instances + +![ ](./img/presearch4.png ) + +Now head to your [dashboard](https://nodes.presearch.com/dashboard) again and scroll down to **Current Nodes**, you'll see your newly created node up and connected! + +![ ](./img/presearch5.png) + + +## Verify if a 3Node Already Runs a Presearch Workload + +You can do the following to verify if a Presearch workload deployed without a public IP address already has a Presearch workload running. Note that you will first need to deploy a Presearch workload on the 3Node. After deployment, you can SSH into the VM and do the verification. + +* SSH into the VM running the Presearch workload + * ``` + ssh root@ + ``` +* List running containers and identity the Presearch container + * ``` + docker ps + ``` +* Print the logs of the Presearch container + * ``` + docker logs + ``` +* If there is no other Presearch workload running on the 3Node, you will see a similar output: + * > 2023-10-16T12:18:33.780Z info: Node is listening for searches... +* If there is another Presearch workload running on the 3Node, you will see a similar output: + * > 2023-10-16T12:24:00.346Z error: Duplicate IP: This IP Address is already running another Node. Only one Node is permitted per IP Address. + * If there is another Presearch workload running, you will need to either deploy on another 3Node with a public IP or deploy on another node without a public IP that isn't running a Presearch deployment. + + + +## Learn More About Presearch + +To learn more about Presearch, you can read the [Presearch documentation](https://docs.presearch.io/). + +## Questions and Feedback + +If you have any questions, you can ask the ThreeFold community for help on the [ThreeFold Forum](http://forum.threefold.io/) or on the [ThreeFold Grid Tester Community](https://t.me/threefoldtesting) on Telegram. \ No newline at end of file diff --git a/collections/tfmanual/documentation/dashboard/solutions/solutions.md b/collections/tfmanual/documentation/dashboard/solutions/solutions.md new file mode 100644 index 0000000..60732e3 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/solutions/solutions.md @@ -0,0 +1,29 @@ +

Solutions

+ +This section provides a non-code easy way to deploy a whole solution on the TFGrid. + +

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) diff --git a/collections/tfmanual/documentation/dashboard/solutions/subsquid.md b/collections/tfmanual/documentation/dashboard/solutions/subsquid.md new file mode 100644 index 0000000..063ff35 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/solutions/subsquid.md @@ -0,0 +1,54 @@ +

Subsquid

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Deployment](#deployment) + +*** + +## Introduction + +[Subsquid](https://www.subsquid.io/) indexer is a piece of software that reads all the blocks from a Substrate based blockchain, decodes and stores them for processing in a later stage. + +## Prerequisites + +- Make sure you have a [wallet](../wallet_connector.md) +- From the sidebar click on **Applications** +- Click on **Subsquid** + +## Deployment + +![ ](./img/solutions_subsquid.png) + +- Enter an instance name. + +- Enter an endpoint for a supported substrate chain. You can find the list of endpoints of supported cahins [here](https://github.com/polkadot-js/apps/blob/master/packages/apps-config/src/endpoints/production.ts). + + +- Select a capacity package: + - **Small**: {cpu: 1, memory: 2 , diskSize: 50 } + - **Medium**: {cpu: 2, memory: 4, diskSize: 100 } + - **Large**: {cpu: 4, memory: 16, diskSize: 250 } + - Or choose a **Custom** plan + +- `Dedicated` flag to retrieve only dedeicated nodes +- `Certified` flag to retrieve only certified nodes +- Choose the location of the node + - `Region` + - `Country` + - `Farm Name` +- Choose the node to deploy on +> Or you can select a specific node with manual selection. +- `Custom Domain` flag lets the user to use a custom domain +- Choose a gateway node to deploy your Subsquid instance on. + + +After that is done you can see a list of all of your deployed instances + +![ ](./img/subsquid_list.png) + +Click on ***Visit*** to go to the homepage of your Subsquid indexer instance! + +![ ](./img/subsquid_graphql.png) diff --git a/collections/tfmanual/documentation/dashboard/solutions/taiga.md b/collections/tfmanual/documentation/dashboard/solutions/taiga.md new file mode 100644 index 0000000..4291e12 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/solutions/taiga.md @@ -0,0 +1,57 @@ +

Taiga

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Deployment](#deployment) + +*** + +## Introduction + +[Taiga](https://www.taiga.io/) is the project management tool for multi-functional agile teams. It has a rich feature set and at the same time it is very simple to start with through its intuitive user interface. + +## Prerequisites + +- Make sure you have a [wallet](../wallet_connector.md) +- From the sidebar click on **Applications** +- Click on **Taiga** + +## Deployment + +![ ](./img/solutions_taiga.png) + +- Enter an Application Name. It's used in generating a unique subdomain on one of the gateways on the network alongside your twin ID. Ex. ***tg98taigar*.gent02.dev.grid.tf** + +- Enter administrator information including **Username**, **Email** and **Password**. This admin user will have full permission on the deployed instance. +- Select a capacity package: + - **Small**: {cpu: 2, memory: 4, diskSize: 100 } + - **Medium**: {cpu: 4, memory: 8, diskSize: 150 } + - **Large**: {cpu: 4, memory: 16, diskSize: 250 } + - Or choose a **Custom** plan + +- `Dedicated` flag to retrieve only dedeicated nodes +- `Certified` flag to retrieve only certified nodes +- Choose the location of the node + - `Region` + - `Country` + - `Farm Name` +- Choose the node to deploy the Tiaga instance on +> Or you can select a specific node with manual selection. +- `Custom Domain` flag lets the user to use a custom domain +- Choose a gateway node to deploy your Funkwhale instance on. + + + +There's also an optional **Mail Server** tab if you'd like to have your Taiga instance configured with an SMTP server. + +![ ](./img/taiga4.png) + +After that is done you can see a list of all of your deployed instances + +![ ](./img/taiga5.png) + +Click on ***Visit*** to go to the homepage of your Taiga instance! + +![ ](./img/taiga6.png) diff --git a/collections/tfmanual/documentation/dashboard/solutions/umbrel.md b/collections/tfmanual/documentation/dashboard/solutions/umbrel.md new file mode 100644 index 0000000..21075ca --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/solutions/umbrel.md @@ -0,0 +1,60 @@ +

Umbrel

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) + +*** + +## Introduction + +[Umbrel](https://umbrel.com/) is an OS for running a personal server in your home. Self-host open source apps like Nextcloud, Bitcoin node, and more. + +## Prerequisites + +- Make sure you have a [wallet](../wallet_connector.md) +- From the sidebar click on **Applications** +- Click on **Umbrel** + +**Process** : +![Config](./img/solutions_umbrel.png) + +- Enter an instance name. +- Enter a Username + - will be used to create Umbrel dashboard account. +- Enter a Password + - Will be used to login to the Umbrel dashboard. + - Must be 12 to 30 characters . +- Select a capacity package: + - **Small**: { cpu: 1, memory: 2, diskSize: 10 } + - **Medium**: { cpu: 2, memory: 4 , diskSize: 50 } + - **Large**: { cpu: 4, memory: 16 , diskSize: 100 } + - Or choose a **Custom** plan + +- `Dedicated` flag to retrieve only dedeicated nodes +- `Certified` flag to retrieve only certified nodes +- Choose the location of the node + - `Region` + - `Country` + - `Farm Name` +- Choose the node to deploy the Umbrel instance on +> Or you can select a specific node with manual selection. + +**After Deploying**: + +You can see a list of all of your deployed instances + +![ ](./img/umbrel2.png) + +- you can click on `Show details` for more details about the Umbrel deployment. + ![ ](./img/umbrel3.png) + and for more detailed information switch to `JSON` tap. + ![ ](./img/umbrel4.png) +- Click on ***Admin Panel*** to go to the dashboard of your Umbrel instance! + - Enter the ***Password*** that you provided in `config` section to login into Umbrel dashboard. + > Forget the credentials? You can find them with `Show details` button. + +![ ](./img/umbrel5.png) + +> **Warning**: Due to the nature of the grid, shutdown, or restart your umbrel from the dashboard **MAY** make some unwanted behaviors. diff --git a/collections/tfmanual/documentation/dashboard/solutions/vm.md b/collections/tfmanual/documentation/dashboard/solutions/vm.md new file mode 100644 index 0000000..5e8db2f --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/solutions/vm.md @@ -0,0 +1,62 @@ +

Micro Virtual Machine

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Deployment](#deployment) + +*** + +## Introduction + +We present the steps to deploy a micro VM on the TFGrid. + + +## Deployment + +Deploy a new virtual machine on the Threefold Grid + +- Make sure you have a [wallet](../wallet_connector.md) +- From the sidebar click on **Solutions** +- Click on **Micro Virtual Machine** + +__Process__ : + +![ ](./img/solutions_microvm.png) + +- Fill in the instance name: it's used to reference the VM in the future. +- Choose the image from the drop down (e.g Alpine, Ubuntu) or you can click on `Other` and manually specify the flist URL and the entrypoint. +- Select a capacity package: + - **Small**: {cpu: 1, memory: 2, diskSize: 25 } + - **Medium**: {cpu: 2, memory: 4, diskSize: 50 } + - **Large**: {cpu: 4, memory: 16, diskSize: 100} + - Or choose a **Custom** plan +- Choose the network + - `Public IPv4` flag gives the virtual machine a Public IPv4 + - `Public IPv6` flag gives the virtual machine a Public IPv6 + - `Planetary Network` to connect the Virtual Machine to Planetary network + - `Wireguard Access` to add a wireguard acces to the Virtual Machine +- `GPU` flag to add GPU to the Virtual machine +- `Dedicated` flag to retrieve only dedicated nodes +- `Certified` flag to retrieve only certified nodes +- Choose the location of the node + - `Region` + - `Country` + - `Farm Name` +- Choose the node to deploy the Virtual Machine on +> Or you can select a specific node with manual selection. + +![](./img/nixos-micro2.png) +* In the section `Environment Variables`, you can add any environment variables that the machine might need + +![](./img/nixos-micro3.png) + +* In the section `Disks`, You can attach one or more disks to the Virtual Machine by clicking on the Disks tab and the plus `+` sign and specify the following parameters + - Disk name + - Disk size + +in the bottom of the page you can see a list of all of the virual machines you deployed. you can click on `Show details` for more details + +![](./img/vm_list.png) +You can also go to JSON tab for full details +![ ](./img/vm_json.png) \ No newline at end of file diff --git a/collections/tfmanual/documentation/dashboard/solutions/vm_differences.md b/collections/tfmanual/documentation/dashboard/solutions/vm_differences.md new file mode 100644 index 0000000..a6dff11 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/solutions/vm_differences.md @@ -0,0 +1,29 @@ +

Micro and Full VM Differences

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Micro Virtual Machine](#micro-virtual-machine) +- [Full Virtual Machine](#full-virtual-machine) + +*** + +## Introduction + +We present the main differences between a micro VM and a full VM. This is useful information when it comes to choosing the proper deployment on the TFGrid. + +## Micro Virtual Machine + +- It's meant to host microservice. and the user should enter the entrypoint. +- The user has no control over ther kernel used to run the machine. +- The network setup will be created for the user. And the vm's init process can assume that it will be fully set up (according to the config the user provided) by the time it is started. +- Mountpoints will also be setup for the user. The environment variables passed will be available inside the the vm. + +## Full Virtual Machine + +- The users run their own operating system, but the image must be + - EFI bootable + - Cloud-init enabled +- It contains a default disk attached, as the boot image will be copied to this disk. +- The default disk is mounted on / so if you want to attach any additional disks, you have to choose a different mounting point. +- A /image.raw file is used as "boot disk". This /image.raw is copied to the first attached volume of the vm. Cloud-init will take care of resizing the filesystem on the image to take the full disk size allocated in the deployment. \ No newline at end of file diff --git a/collections/tfmanual/documentation/dashboard/solutions/vm_intro.md b/collections/tfmanual/documentation/dashboard/solutions/vm_intro.md new file mode 100644 index 0000000..d9cc0a7 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/solutions/vm_intro.md @@ -0,0 +1,11 @@ +

Virtual Machines

+ +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 diff --git a/collections/tfmanual/documentation/dashboard/solutions/wordpress.md b/collections/tfmanual/documentation/dashboard/solutions/wordpress.md new file mode 100644 index 0000000..57f2938 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/solutions/wordpress.md @@ -0,0 +1,147 @@ +

WordPress

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Domain Name and IP Address](#domain-name-and-ip-address) +- [DNS Details with Custom Domain](#dns-details-with-custom-domain) + - [DNS Record with Public IPv4](#dns-record-with-public-ipv4) + - [DNS Record with Gateway](#dns-record-with-gateway) + - [DNS Propagation](#dns-propagation) +- [Deployment Process](#deployment-process) +- [Access WordPress](#access-wordpress) + - [WordPress Instance Website](#wordpress-instance-website) + - [WordPress Instance Admin Page](#wordpress-instance-admin-page) +- [WordPress Instance Credentials](#wordpress-instance-credentials) +- [Questions and Feedback](#questions-and-feedback) + +*** + +# Introduction + +[WordPress](https://wordpress.org/) is the most popular CMS on the market, powering 65.2% of websites whose CMS we know. That translates to 42.4% of all websites – nearly half of the internet. It is a popular option for those who want to build a website or a blog. + +# Prerequisites + +- Make sure you have a [wallet](../wallet_connector.md) +- From the sidebar click on **Solutions** +- Click on **Wordpress** + +# Domain Name and IP Address + +A domain name is required to use WordPress. You can either use your own, which we'll call a **custom domain**, or you can get a free subdomain from a gateway node. Note that this won't impact the function of your deployment, it's just a matter of preference. If you want to use your own domain, follow the steps for custom domain wherever you see them below. + +Another choice to make before launching your WordPress instance is whether you want to reserve a public IPv4 for the deployment. Note that renting a public IPv4 address is an extra cost. If you do not enable IPv4, the deployment will be provided a gateway IPv4 address. + +If you're not sure and just want the easiest, most affordable option, do not enable public IPv4 nor custom domain. + +# DNS Details with Custom Domain + +In this section, we cover the essential DNS information when deploying a WordPress instance with a custom domain. + +You can skip this section if you did not enable **Custom Domain** in **Domain Name**. + +As a general reference, here is what setting a DNS A record can look like: + +![ ](img/wp11.png) + +This record type indicates the IP address of a given domain. + +## DNS Record with Public IPv4 + +Consider the following if you've enabled **Custom Domain** in **Domain Name** and **Public IPv4** in **Network**. + +After deployment, you will have access to the IPv4 address of the VM you deployed on. You will need to add a **DNS A record** (Host: "@", Value: ) to your domain to access WordPress. + +## DNS Record with Gateway + +Consider the following if you've enabled **Custom domain** in **Domain Name** but did not enable **Public IPv4** in **Network**. + +Before deploying the WordPress instance, you will have access to the gateway IPv4 address. You will need to add a **DNS A record** (Host: "@", Value: ) to your domain to access WordPress. + +## DNS Propagation + +When setting a DNS A record, it might take time for the DNS to propagate. It is possible that you see the following message when opening the WordPress page: + +>"This site can't be reached. DNS address could not be found. Diagnosing the problem." + +This is normal. You might simply need to wait for the DNS to propagate completely. + +You can check if the DNS records are propagated globally with DNS propagation check services such as [DNS Checker](https://dnschecker.org/). You can use this tool to verify that your domain is properly pointing to either the VM or the gateway IPv4 address. + +# Deployment Process + +In this section, we cover the steps to deploy a WordPress instance on the Playground. + +![Config](./img/solutions_wordpress.png) + +- Enter an instance name or leave the auto-generated instance name +- Enter the admin information or leave the auto-generated information + - **Username**: This will be used as the MySQL DB username and for Wp-admin + - **Password**: This will be used as the MySQL DB password and for Wp-admin + - **Email**: This will be used for Wp-admin +- Select a capacity package: + - **Small**: { cpu: 1, memory: 2 , diskSize: 15 } + - **Medium**: { cpu: 2, memory: 4 , diskSize: 50 } + - **Large**: { cpu: 4, memory: 16 , diskSize: 100 } + - Or choose a **Custom** plan + +- Choose the network + - **Public IPv4** flag gives the virtual machine a Public IPv4 + +- **Dedicated** flag to retrieve only dedicated nodes +- **Certified** flag to retrieve only certified nodes +- Choose the location of the node + - **Country** + - **Farm Name** +- Choose the node to deploy the WordPress instance on +- **Custom Domain** flag lets the user to use a custom domain +- Choose a gateway node to deploy your WordPress instance on + - If you've enabled IPv4, you do not need to choose a gateway node + +# Access WordPress + +In the section **WordPress Instances**, you can see a list of all of your deployed instances: + +![ ](./img/wp2.png) + +You can click on **Show details** under **Actions** for more details about the WordPress deployment. + +![ ](img/wp8.png) + +![ ](img/wp3.png) + +For more detailed information, you can switch to the **Json** tab. + +![ ](img/wp4.png) + +## WordPress Instance Website + +Click on **Visit** under **Actions** to go to the homepage of your WordPress instance. + +![ ](img/wp10.png) + +![ ](img/wp5.png) + +## WordPress Instance Admin Page + +Click on **Admin Panel** to go to the WordPress admin page (**wp-admin**) of your WordPress instance. + +![ ](img/wp9.png) + +Enter the **Username** and the **Password** that you provided in the **config** section to log into the admin panel. + +![ ](img/wp6.png) + +![ ](img/wp7.png) + +# WordPress Instance Credentials + +At any time, you can find the credentials of your WordPress instance by clicking on the **Show details** button under **Actions**. + +![ ](img/wp8.png) + +# Questions and Feedback + +If you have any questions, you can ask the ThreeFold community for help on the [ThreeFold Forum](http://forum.threefold.io/) or on the [ThreeFold Grid Tester Community](https://t.me/threefoldtesting) on Telegram. diff --git a/collections/tfmanual/documentation/dashboard/tfchain/tf_dao.md b/collections/tfmanual/documentation/dashboard/tfchain/tf_dao.md new file mode 100644 index 0000000..648280b --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/tfchain/tf_dao.md @@ -0,0 +1,41 @@ +

DAO Voting

+ +The TFChain DAO (i.e. Decentralized Autonomous Organization) feature integrates decentralized governance capabilities into the ThreeFold Dashboard. It enables community members to participate in decision-making processes and to contribute to the evolution of the ThreeFold ecosystem. Through the TFChain DAO, users can propose, vote on, and implement changes to the network protocols, policies, and operations, fostering a collaborative and inclusive environment. + +

Table of Contents

+ +- [An Introduction to the DAO concept](#an-introduction-to-the-dao-concept) +- [Prerequisites to Vote](#prerequisites-to-vote) +- [How to Vote for a Proposal](#how-to-vote-for-a-proposal) +- [The Goal of the Threefold DAO](#the-goal-of-the-threefold-dao) + +*** + +## An Introduction to the DAO concept + +[A decentralized autonomous organization (DAO)](../../../knowledge_base/about/dao/dao.md) is an entity with no central leadership. Decisions get made from the bottom-up, governed by a community organized around a specific set of rules enforced on a blockchain. + +DAOs are internet-native organizations collectively owned and managed by their members. They have built-in treasuries that are only accessible with the approval of their members. Decisions are made via proposals the group votes on during a specified period. + + + +## Prerequisites to Vote + +Voting for a DAO proposal is very simple. You first need to meet certain requirements to be able to vote. + +- Have a [Threefold farm](../farms/farms.md) +- Have at least one active [3node server](../../farmers/3node_building/3node_building.md) on the farm +- If you created your farm with the Threefold Connect app + - [Import your farm on the Threefold Dashboard](../../threefold_token/storing_tft/tf_connect_app.md#move-farm-from-the-tf-connect-app-to-the-tf-portal-polkadotjs) + + + +## How to Vote for a Proposal + +To vote, you need to log into your Threefold Dashboard account, go to **TF DAO** section of **TFChain** and vote for an active proposal. Make sure to read the proposition and ask questions on the Threefold Forum proposition post if you have any. + +## The Goal of the Threefold DAO + +The goal of DAO voting system is to gather the thoughts and will of the Threefold community and build projects that are aligned with the ethos of the project. + +We encourage anyone to share their ideas. Who knows? Your sudden spark of genius might lead to an accepted proposal on the Threefold DAO! diff --git a/collections/tfmanual/documentation/dashboard/tfchain/tf_minting_reports.md b/collections/tfmanual/documentation/dashboard/tfchain/tf_minting_reports.md new file mode 100644 index 0000000..158ba04 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/tfchain/tf_minting_reports.md @@ -0,0 +1,5 @@ +# TF Minting Reports + +TFGrid Minting Explorer, works by simply entering a receipt hash and you will get full minting report in return. + +![](../img/Minting.png) \ No newline at end of file diff --git a/collections/tfmanual/documentation/dashboard/tfchain/tf_token_bridge.md b/collections/tfmanual/documentation/dashboard/tfchain/tf_token_bridge.md new file mode 100644 index 0000000..f7391c2 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/tfchain/tf_token_bridge.md @@ -0,0 +1,44 @@ +# TF Token Bridge + +Transferring TFT between Stellar and Tfchain + +## Usage + +This document will explain how you can transfer TFT from Tfchain to Stellar and back. + +![bridge page](../img/bridge.png) + +## Prerequisites + +- Stellar wallet + +- Account on TFchain (use TF Dashboard to create one). + +## Stellar to Tfchain + +You can deposit to Tfchain using the bridge page on the TF Dashboard + +A deposit of tokens from the Stellar network onto TF-Chain needs to happen from a Stellar wallet, like in the ThreeFold Connect App. + +You have 2 options: + +- TFT needs to be sent to the bridge account +- specifying in the memo field the twinID that was generated with the Twin creation e.g. twin_110 (dont forget twin_) +- Note there is a transaction cost of 1 TFT. + +Or + +- You can scan the QR code + +![bridge](../img/bridge_deposit.png) + +## Tfchain to Stellar + +You can bridge back to stellar using the bridge page on the dashboard, click *withdraw*: + +After indicating the destination address and the amount to be transferred, click *Send*. + +![withdraw](../img/bridge_withdraw.png) + +A withdraw fee of 1 TFT will be taken, so make sure you send a larger amount as 1 TFT. +The amount withdrawn from TFChain will be sent to your Stellar wallet. diff --git a/collections/tfmanual/documentation/dashboard/tfchain/tf_token_transfer.md b/collections/tfmanual/documentation/dashboard/tfchain/tf_token_transfer.md new file mode 100644 index 0000000..733eff6 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/tfchain/tf_token_transfer.md @@ -0,0 +1,26 @@ +# TF Token Transfer + +Manage your TFT on TFChain. + +## Transfer TFT between TFChain accounts + +You can transfer TFTs between two accounts that exist on the same chain. + +> Remark: testnet and mainnet both have the same TFTs but as the 2 chains are different, there is no way to do a direct transfer between accounts on testnet and on mainnet. + +You can transfer TFTs by recipient address or recipient twin id; by selecting the needed tab. + + +### Transfer by twin id + +Fill in the recipient twin id, the amount of tokens to transfer, and click on `Send`. + +![](../img/dashboard_transfer_twin.png) + +### Transfer by address + +Fill in the recipient address, the amount of tokens to transfer, and click on `Send`. + +![](../img/dashboard_transfer_address.png) + +There is no transfer fee, just a signing fee of `0.001` TFT. diff --git a/collections/tfmanual/documentation/dashboard/tfchain/tfchain.md b/collections/tfmanual/documentation/dashboard/tfchain/tfchain.md new file mode 100644 index 0000000..bda6640 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/tfchain/tfchain.md @@ -0,0 +1,20 @@ +# TFChain + +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. + + ![](../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 diff --git a/collections/tfmanual/documentation/dashboard/tfchain/your_profile.md b/collections/tfmanual/documentation/dashboard/tfchain/your_profile.md new file mode 100644 index 0000000..091cffe --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/tfchain/your_profile.md @@ -0,0 +1,13 @@ +

Twin Management

+ +The TF Twin management feature of the ThreeFold Dashboard enables users to create, manage, and monitor their individual digital entities known as **Twins**. A Twin can represent a virtual machine (VM) or a container running on the ThreeFold Grid. With the Twin management, users can easily deploy and scale their workloads, allocate resources, and configure networking and storage settings for their Twins. + +![](../img/twin.png) + +The twin details consists of three main items. + +- `ID` Your unique identifier for your twin on the ThreeFold chain. +- `Address` Your public address on the ThreeFold chain. +- `Relay` A relay is a component that facilitates the reliable and secure transfer of messages between different entities within the ThreeFold ecosystem. + +To create a twin check the [Wallet Connector](../wallet_connector.md) Section. \ No newline at end of file diff --git a/collections/tfmanual/documentation/dashboard/tfgrid/grid_status.md b/collections/tfmanual/documentation/dashboard/tfgrid/grid_status.md new file mode 100644 index 0000000..5969a99 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/tfgrid/grid_status.md @@ -0,0 +1,5 @@ +# Grid Status + +Check the status and health of ThreeFold services From [Grid Status](https://status.grid.tf/status/threefold) + +![](../img/grid_health.png) \ No newline at end of file diff --git a/collections/tfmanual/documentation/dashboard/tfgrid/node_monitoring.md b/collections/tfmanual/documentation/dashboard/tfgrid/node_monitoring.md new file mode 100644 index 0000000..a7c8d51 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/tfgrid/node_monitoring.md @@ -0,0 +1,5 @@ +# Node Monitoring + +Monitor and check the metrics and status of Zero-OS nodes from [Node Monitoring](https://metrics.grid.tf/d/rYdddlPWkfqwf/zos-host-metrics?orgId=2&refresh=30s) + +![](../img/Monitoring.png) \ No newline at end of file diff --git a/collections/tfmanual/documentation/dashboard/tfgrid/node_statistics.md b/collections/tfmanual/documentation/dashboard/tfgrid/node_statistics.md new file mode 100644 index 0000000..0980105 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/tfgrid/node_statistics.md @@ -0,0 +1,18 @@ +# Statistics + +Statistics allows you to see the distribution of 3Nodes all over the world with information on how many nodes are available and in which country. + +![](../img/statistics.png) + +Here you can see generic overview about: + +- Number of Nodes +- Number of Dedicated Nodes +- Number of Farms +- Number of Countries +- The capacity CRU, SRU, HRU, MRU +- Number of GPUs +- Number of Gateways +- Number of Twins +- The number of public IPs available +- Number of Contracts \ No newline at end of file diff --git a/collections/tfmanual/documentation/dashboard/tfgrid/tfgrid.md b/collections/tfmanual/documentation/dashboard/tfgrid/tfgrid.md new file mode 100644 index 0000000..2b06d9b --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/tfgrid/tfgrid.md @@ -0,0 +1,17 @@ +# TFGrid + +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). + + ![](../img/sidebar_1.png) + +*** + +## Table of Content + +- [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/tfmanual/documentation/dashboard/toc.md b/collections/tfmanual/documentation/dashboard/toc.md new file mode 100644 index 0000000..5507842 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/toc.md @@ -0,0 +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) diff --git a/collections/tfmanual/documentation/dashboard/vm_presearch.md b/collections/tfmanual/documentation/dashboard/vm_presearch.md new file mode 100644 index 0000000..f438507 --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/vm_presearch.md @@ -0,0 +1,51 @@ +# Mount a Presearch node on TFGrid3 using VM + +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. +- 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. + +![](./img/vm_list.png) + +For the VM having an IP address you can enter the terminal command +``` +ssh root@185.206.122.162 +``` + +If you didn't reserve a public IPv4 address, you can ssh into your machine using the IPv6 address. Peopl doing this, should however first set up their identity in the Planetary Network with Yggdrasil. See [here](yggdrasil_client) to know how to do this. + +``` +ssh root@300:aa1b:e91b:720f:ae5f:8991:6df8:1ec9 +``` + +Now you have an empty VM, also Docker still needs to be installed. + +Execute the following commands inside your VM : + +``` +apt update ; +apt install sudo ; +sudo apt install apt-transport-https ca-certificates curl software-properties-common ; +curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add - ; +sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu focal stable" ; +``` +Finally, install Docker. The Ubuntu machine does not come with `systemd`. The following does the trick : + +``` +apt-get install docker-ce docker-ce-cli containerd.io +apt-cache madison docker-ce + +dockerd & +``` + +Once Docker is set up, you can launch the PRE node instructions on your VM: + +``` +docker stop presearch-node ; docker rm presearch-node ; docker stop presearch-auto-updater ; docker rm presearch-auto-updater ; docker run -d --name presearch-auto-updater --restart=unless-stopped -v /var/run/docker.sock:/var/run/docker.sock presearch/auto-updater --cleanup --interval 900 presearch-auto-updater presearch-node ; docker pull presearch/node ; docker run -dt --name presearch-node --restart=unless-stopped -v presearch-node-storage:/app/node -e REGISTRATION_CODE=$YOUR_REGISTRATION_CODE_HERE presearch/node ; docker logs -f presearch-node +``` + +And you're done ! + +![ ](./img/weblet_vm_presearch_result.jpg) \ No newline at end of file diff --git a/collections/tfmanual/documentation/dashboard/wallet_connector.md b/collections/tfmanual/documentation/dashboard/wallet_connector.md new file mode 100644 index 0000000..842339a --- /dev/null +++ b/collections/tfmanual/documentation/dashboard/wallet_connector.md @@ -0,0 +1,42 @@ +

Wallet Connector

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Supported Networks](#supported-networks) +- [Process](#process) + +*** + +## Introduction + +To interact with TFChain, users need to set a wallet connector. + +## Supported Networks + +Currently, we're supporting four different networks: + +- Dev net, for development purposes + - [https://dashboard.dev.grid.tf](https://dashboard.dev.grid.tf) +- QA net, for internal testing and verifications + - [https://dashboard.qa.grid.tf](https://dashboard.qa.grid.tf) +- Test net, for testing purposes + - [https://dashboard.test.grid.tf](https://dashboard.test.grid.tf) +- Main net, for production-ready purposes + - [https://dashboard.grid.tf](https://dashboard.grid.tf) + +![ ](./img/profile_manager1.png) + +## Process + +Start entering the following information required to create your new profile. + +![ ](./img/profile_manager2.png) + +- `Mnemonics` are the secret words of your Polkadot account. Click on the **Create Account** button to generate yours. +- `Password` is used to access your account +- `Confirm Password` + +After you finish typing your credentials, click on **Connect**. Once your profile gets activated, you should find your **Twin ID** and **Address** generated under your **_Mnemonics_** for verification. Also, your **Account Balance** will be available at the top right corner under your profile name. + +![ ](./img/profile_manager3.png) diff --git a/collections/tfmanual/documentation/developers/developers.md b/collections/tfmanual/documentation/developers/developers.md new file mode 100644 index 0000000..3877320 --- /dev/null +++ b/collections/tfmanual/documentation/developers/developers.md @@ -0,0 +1,90 @@ +# ThreeFold Developers + +This section covers all practical tutorials on how to develop and build on the ThreeFold Grid. + +For complementary information on the technology developed by ThreeFold, refer to the [Technology](../../knowledge_base/technology/technology_toc.md) section. + +

Table of Contents

+ +- [Javascript Client](./javascript/grid3_javascript_readme.md) + - [Installation](./javascript/grid3_javascript_installation.md) + - [Loading Client](./javascript/grid3_javascript_loadclient.md) + - [Deploy a VM](./javascript/grid3_javascript_vm.md) + - [Capacity Planning](./javascript/grid3_javascript_capacity_planning.md) + - [Deploy Multiple VMs](./javascript/grid3_javascript_vms.md) + - [Deploy CapRover](./javascript/grid3_javascript_caprover.md) + - [Gateways](./javascript/grid3_javascript_vm_gateways.md) + - [Deploy a Kubernetes Cluster](./javascript/grid3_javascript_kubernetes.md) + - [Deploy a ZDB](./javascript/grid3_javascript_zdb.md) + - [Deploy ZDBs for QSFS](./javascript/grid3_javascript_qsfs_zdbs.md) + - [QSFS](./javascript/grid3_javascript_qsfs.md) + - [Key Value Store](./javascript/grid3_javascript_kvstore.md) + - [VM with Wireguard and Gateway](./javascript/grid3_wireguard_gateway.md) + - [GPU Support](./javascript/grid3_javascript_gpu_support.md) +- [Go Client](./go/grid3_go_readme.md) + - [Installation](./go/grid3_go_installation.md) + - [Loading Client](./go/grid3_go_load_client.md) + - [Deploy a VM](./go/grid3_go_vm.md) + - [Deploy Multiple VMs](./go/grid3_go_vms.md) + - [Deploy Gateways](./go/grid3_go_gateways.md) + - [Deploy Kubernetes](./go/grid3_go_kubernetes.md) + - [Deploy a QSFS](./go/grid3_go_qsfs.md) + - [GPU Support](./go/grid3_go_gpu.md) +- [TFCMD](./tfcmd/tfcmd.md) + - [Getting Started](./tfcmd/tfcmd_basics.md) + - [Deploy a VM](./tfcmd/tfcmd_vm.md) + - [Deploy Kubernetes](./tfcmd/tfcmd_kubernetes.md) + - [Deploy ZDB](./tfcmd/tfcmd_zdbs.md) + - [Gateway FQDN](./tfcmd/tfcmd_gateway_fqdn.md) + - [Gateway Name](./tfcmd/tfcmd_gateway_name.md) + - [Contracts](./tfcmd/tfcmd_contracts.md) +- [TFROBOT](./tfrobot/tfrobot.md) + - [Installation](./tfrobot/tfrobot_installation.md) + - [Configuration File](./tfrobot/tfrobot_config.md) + - [Deployment](./tfrobot/tfrobot_deploy.md) + - [Commands and Flags](./tfrobot/tfrobot_commands_flags.md) + - [Supported Configurations](./tfrobot/tfrobot_configurations.md) +- [ThreeFold Chain](./tfchain/tfchain.md) + - [Introduction](./tfchain/introduction.md) + - [Farming Policies](./tfchain/farming_policies.md) + - [External Service Contract](./tfchain/tfchain_external_service_contract.md) + - [Solution Provider](./tfchain/tfchain_solution_provider.md) +- [Grid Proxy](./proxy/proxy_readme.md) + - [Introducing Grid Proxy](./proxy/proxy.md) + - [Setup](./proxy/setup.md) + - [DB Testing](./proxy/db_testing.md) + - [Commands](./proxy/commands.md) + - [Contributions](./proxy/contributions.md) + - [Explorer](./proxy/explorer.md) + - [Database](./proxy/database.md) + - [Production](./proxy/production.md) + - [Release](./proxy/release.md) +- [Flist](./flist/flist.md) + - [ThreeFold Hub Intro](./flist/flist_hub/zos_hub.md) + - [Generate an API Token](./flist/flist_hub/api_token.md) + - [Convert Docker Image Into Flist](./flist/flist_hub/convert_docker_image.md) + - [Supported Flists](./flist/grid3_supported_flists.md) + - [Flist Case Studies](./flist/flist_case_studies/flist_case_studies.md) + - [Case Study: Debian 12](./flist/flist_case_studies/flist_debian_case_study.md) + - [Case Study: Nextcloud AIO](./flist/flist_case_studies/flist_nextcloud_case_study.md) +- [Internals](./internals/internals.md) + - [Reliable Message Bus (RMB)](./internals/rmb/rmb_toc.md) + - [Introduction to RMB](./internals/rmb/rmb_intro.md) + - [RMB Specs](./internals/rmb/rmb_specs.md) + - [RMB Peer](./internals/rmb/uml/peer.md) + - [RMB Relay](./internals/rmb/uml/relay.md) + - [ZOS](./internals/zos/index.md) + - [Manual](./internals/zos/manual/manual.md) + - [Workload Types](./internals/zos/manual/workload_types.md) + - [Internal Modules](./internals/zos/internals/internals.md) + - [Capacity](./internals/zos/internals/capacity.md) + - [Performance Monitor Package](./internals/zos/performance/performance.md) + - [Public IPs Validation Task](./internals/zos/performance/publicips.md) + - [CPUBenchmark](./internals/zos/performance/cpubench.md) + - [IPerf](./internals/zos/performance/iperf.md) + - [Health Check](./internals/zos/performance/healthcheck.md) + - [API](./internals/zos/manual/api.md) +- [Grid Deployment](./grid_deployment/grid_deployment.md) + - [TFGrid Stacks](./grid_deployment/tfgrid_stacks.md) + - [Full VM Grid Deployment](./grid_deployment/grid_deployment_full_vm.md) + - [Grid Snapshots](./grid_deployment/snapshots.md) \ No newline at end of file diff --git a/collections/documentation/developers/flist/flist.md b/collections/tfmanual/documentation/developers/flist/flist.md similarity index 100% rename from collections/documentation/developers/flist/flist.md rename to collections/tfmanual/documentation/developers/flist/flist.md diff --git a/collections/documentation/developers/flist/flist_case_studies/flist_case_studies.md b/collections/tfmanual/documentation/developers/flist/flist_case_studies/flist_case_studies.md similarity index 100% rename from collections/documentation/developers/flist/flist_case_studies/flist_case_studies.md rename to collections/tfmanual/documentation/developers/flist/flist_case_studies/flist_case_studies.md diff --git a/collections/documentation/developers/flist/flist_case_studies/flist_debian_case_study.md b/collections/tfmanual/documentation/developers/flist/flist_case_studies/flist_debian_case_study.md similarity index 100% rename from collections/documentation/developers/flist/flist_case_studies/flist_debian_case_study.md rename to collections/tfmanual/documentation/developers/flist/flist_case_studies/flist_debian_case_study.md diff --git a/collections/documentation/developers/flist/flist_case_studies/flist_nextcloud_case_study.md b/collections/tfmanual/documentation/developers/flist/flist_case_studies/flist_nextcloud_case_study.md similarity index 100% rename from collections/documentation/developers/flist/flist_case_studies/flist_nextcloud_case_study.md rename to collections/tfmanual/documentation/developers/flist/flist_case_studies/flist_nextcloud_case_study.md diff --git a/collections/documentation/developers/flist/flist_case_studies/img/nextcloud_logo.jpeg b/collections/tfmanual/documentation/developers/flist/flist_case_studies/img/nextcloud_logo.jpeg similarity index 100% rename from collections/documentation/developers/flist/flist_case_studies/img/nextcloud_logo.jpeg rename to collections/tfmanual/documentation/developers/flist/flist_case_studies/img/nextcloud_logo.jpeg diff --git a/collections/documentation/developers/flist/flist_hub/api_token.md b/collections/tfmanual/documentation/developers/flist/flist_hub/api_token.md similarity index 100% rename from collections/documentation/developers/flist/flist_hub/api_token.md rename to collections/tfmanual/documentation/developers/flist/flist_hub/api_token.md diff --git a/collections/documentation/developers/flist/flist_hub/convert_docker_image.md b/collections/tfmanual/documentation/developers/flist/flist_hub/convert_docker_image.md similarity index 100% rename from collections/documentation/developers/flist/flist_hub/convert_docker_image.md rename to collections/tfmanual/documentation/developers/flist/flist_hub/convert_docker_image.md diff --git a/collections/documentation/developers/flist/flist_hub/img/docker_convert.png b/collections/tfmanual/documentation/developers/flist/flist_hub/img/docker_convert.png similarity index 100% rename from collections/documentation/developers/flist/flist_hub/img/docker_convert.png rename to collections/tfmanual/documentation/developers/flist/flist_hub/img/docker_convert.png diff --git a/collections/documentation/developers/flist/flist_hub/img/flist_ready.png b/collections/tfmanual/documentation/developers/flist/flist_hub/img/flist_ready.png similarity index 100% rename from collections/documentation/developers/flist/flist_hub/img/flist_ready.png rename to collections/tfmanual/documentation/developers/flist/flist_hub/img/flist_ready.png diff --git a/collections/documentation/developers/flist/flist_hub/img/hub_flist.png b/collections/tfmanual/documentation/developers/flist/flist_hub/img/hub_flist.png similarity index 100% rename from collections/documentation/developers/flist/flist_hub/img/hub_flist.png rename to collections/tfmanual/documentation/developers/flist/flist_hub/img/hub_flist.png diff --git a/collections/documentation/developers/flist/flist_hub/img/preview.png b/collections/tfmanual/documentation/developers/flist/flist_hub/img/preview.png similarity index 100% rename from collections/documentation/developers/flist/flist_hub/img/preview.png rename to collections/tfmanual/documentation/developers/flist/flist_hub/img/preview.png diff --git a/collections/documentation/developers/flist/flist_hub/img/search.png b/collections/tfmanual/documentation/developers/flist/flist_hub/img/search.png similarity index 100% rename from collections/documentation/developers/flist/flist_hub/img/search.png rename to collections/tfmanual/documentation/developers/flist/flist_hub/img/search.png diff --git a/collections/documentation/developers/flist/flist_hub/zos_hub.md b/collections/tfmanual/documentation/developers/flist/flist_hub/zos_hub.md similarity index 100% rename from collections/documentation/developers/flist/flist_hub/zos_hub.md rename to collections/tfmanual/documentation/developers/flist/flist_hub/zos_hub.md diff --git a/collections/documentation/developers/flist/grid3_supported_flists.md b/collections/tfmanual/documentation/developers/flist/grid3_supported_flists.md similarity index 100% rename from collections/documentation/developers/flist/grid3_supported_flists.md rename to collections/tfmanual/documentation/developers/flist/grid3_supported_flists.md diff --git a/collections/documentation/developers/go/grid3_go_gateways.md b/collections/tfmanual/documentation/developers/go/grid3_go_gateways.md similarity index 100% rename from collections/documentation/developers/go/grid3_go_gateways.md rename to collections/tfmanual/documentation/developers/go/grid3_go_gateways.md diff --git a/collections/documentation/developers/go/grid3_go_gpu.md b/collections/tfmanual/documentation/developers/go/grid3_go_gpu.md similarity index 100% rename from collections/documentation/developers/go/grid3_go_gpu.md rename to collections/tfmanual/documentation/developers/go/grid3_go_gpu.md diff --git a/collections/documentation/developers/go/grid3_go_gpu_support.md b/collections/tfmanual/documentation/developers/go/grid3_go_gpu_support.md similarity index 100% rename from collections/documentation/developers/go/grid3_go_gpu_support.md rename to collections/tfmanual/documentation/developers/go/grid3_go_gpu_support.md diff --git a/collections/documentation/developers/go/grid3_go_installation.md b/collections/tfmanual/documentation/developers/go/grid3_go_installation.md similarity index 100% rename from collections/documentation/developers/go/grid3_go_installation.md rename to collections/tfmanual/documentation/developers/go/grid3_go_installation.md diff --git a/collections/documentation/developers/go/grid3_go_kubernetes.md b/collections/tfmanual/documentation/developers/go/grid3_go_kubernetes.md similarity index 100% rename from collections/documentation/developers/go/grid3_go_kubernetes.md rename to collections/tfmanual/documentation/developers/go/grid3_go_kubernetes.md diff --git a/collections/documentation/developers/go/grid3_go_load_client.md b/collections/tfmanual/documentation/developers/go/grid3_go_load_client.md similarity index 100% rename from collections/documentation/developers/go/grid3_go_load_client.md rename to collections/tfmanual/documentation/developers/go/grid3_go_load_client.md diff --git a/collections/documentation/developers/go/grid3_go_qsfs.md b/collections/tfmanual/documentation/developers/go/grid3_go_qsfs.md similarity index 100% rename from collections/documentation/developers/go/grid3_go_qsfs.md rename to collections/tfmanual/documentation/developers/go/grid3_go_qsfs.md diff --git a/collections/documentation/developers/go/grid3_go_readme.md b/collections/tfmanual/documentation/developers/go/grid3_go_readme.md similarity index 100% rename from collections/documentation/developers/go/grid3_go_readme.md rename to collections/tfmanual/documentation/developers/go/grid3_go_readme.md diff --git a/collections/documentation/developers/go/grid3_go_vm.md b/collections/tfmanual/documentation/developers/go/grid3_go_vm.md similarity index 100% rename from collections/documentation/developers/go/grid3_go_vm.md rename to collections/tfmanual/documentation/developers/go/grid3_go_vm.md diff --git a/collections/documentation/developers/go/grid3_go_vm_with_gpu.md b/collections/tfmanual/documentation/developers/go/grid3_go_vm_with_gpu.md similarity index 100% rename from collections/documentation/developers/go/grid3_go_vm_with_gpu.md rename to collections/tfmanual/documentation/developers/go/grid3_go_vm_with_gpu.md diff --git a/collections/documentation/developers/go/grid3_go_vms.md b/collections/tfmanual/documentation/developers/go/grid3_go_vms.md similarity index 100% rename from collections/documentation/developers/go/grid3_go_vms.md rename to collections/tfmanual/documentation/developers/go/grid3_go_vms.md diff --git a/collections/documentation/developers/grid_deployment/grid_deployment.md b/collections/tfmanual/documentation/developers/grid_deployment/grid_deployment.md similarity index 100% rename from collections/documentation/developers/grid_deployment/grid_deployment.md rename to collections/tfmanual/documentation/developers/grid_deployment/grid_deployment.md diff --git a/collections/documentation/developers/grid_deployment/grid_deployment_full_vm.md b/collections/tfmanual/documentation/developers/grid_deployment/grid_deployment_full_vm.md similarity index 100% rename from collections/documentation/developers/grid_deployment/grid_deployment_full_vm.md rename to collections/tfmanual/documentation/developers/grid_deployment/grid_deployment_full_vm.md diff --git a/collections/documentation/developers/grid_deployment/snapshots.md b/collections/tfmanual/documentation/developers/grid_deployment/snapshots.md similarity index 100% rename from collections/documentation/developers/grid_deployment/snapshots.md rename to collections/tfmanual/documentation/developers/grid_deployment/snapshots.md diff --git a/collections/documentation/developers/grid_deployment/snapshots_archive.md b/collections/tfmanual/documentation/developers/grid_deployment/snapshots_archive.md similarity index 100% rename from collections/documentation/developers/grid_deployment/snapshots_archive.md rename to collections/tfmanual/documentation/developers/grid_deployment/snapshots_archive.md diff --git a/collections/documentation/developers/grid_deployment/tfgrid_stacks.md b/collections/tfmanual/documentation/developers/grid_deployment/tfgrid_stacks.md similarity index 100% rename from collections/documentation/developers/grid_deployment/tfgrid_stacks.md rename to collections/tfmanual/documentation/developers/grid_deployment/tfgrid_stacks.md diff --git a/collections/documentation/developers/internals/internals.md b/collections/tfmanual/documentation/developers/internals/internals.md similarity index 100% rename from collections/documentation/developers/internals/internals.md rename to collections/tfmanual/documentation/developers/internals/internals.md diff --git a/collections/documentation/developers/internals/rmb/img/layout.png b/collections/tfmanual/documentation/developers/internals/rmb/img/layout.png similarity index 100% rename from collections/documentation/developers/internals/rmb/img/layout.png rename to collections/tfmanual/documentation/developers/internals/rmb/img/layout.png diff --git a/collections/documentation/developers/internals/rmb/img/peer.png b/collections/tfmanual/documentation/developers/internals/rmb/img/peer.png similarity index 100% rename from collections/documentation/developers/internals/rmb/img/peer.png rename to collections/tfmanual/documentation/developers/internals/rmb/img/peer.png diff --git a/collections/documentation/developers/internals/rmb/img/relay.png b/collections/tfmanual/documentation/developers/internals/rmb/img/relay.png similarity index 100% rename from collections/documentation/developers/internals/rmb/img/relay.png rename to collections/tfmanual/documentation/developers/internals/rmb/img/relay.png diff --git a/collections/documentation/developers/internals/rmb/rmb_intro.md b/collections/tfmanual/documentation/developers/internals/rmb/rmb_intro.md similarity index 100% rename from collections/documentation/developers/internals/rmb/rmb_intro.md rename to collections/tfmanual/documentation/developers/internals/rmb/rmb_intro.md diff --git a/collections/documentation/developers/internals/rmb/rmb_specs.md b/collections/tfmanual/documentation/developers/internals/rmb/rmb_specs.md similarity index 100% rename from collections/documentation/developers/internals/rmb/rmb_specs.md rename to collections/tfmanual/documentation/developers/internals/rmb/rmb_specs.md diff --git a/collections/documentation/developers/internals/rmb/rmb_toc.md b/collections/tfmanual/documentation/developers/internals/rmb/rmb_toc.md similarity index 100% rename from collections/documentation/developers/internals/rmb/rmb_toc.md rename to collections/tfmanual/documentation/developers/internals/rmb/rmb_toc.md diff --git a/collections/documentation/developers/internals/rmb/uml/peer.md b/collections/tfmanual/documentation/developers/internals/rmb/uml/peer.md similarity index 100% rename from collections/documentation/developers/internals/rmb/uml/peer.md rename to collections/tfmanual/documentation/developers/internals/rmb/uml/peer.md diff --git a/collections/documentation/developers/internals/rmb/uml/relay.md b/collections/tfmanual/documentation/developers/internals/rmb/uml/relay.md similarity index 100% rename from collections/documentation/developers/internals/rmb/uml/relay.md rename to collections/tfmanual/documentation/developers/internals/rmb/uml/relay.md diff --git a/collections/tfmanual/documentation/developers/internals/zos/assets/.keep b/collections/tfmanual/documentation/developers/internals/zos/assets/.keep new file mode 100644 index 0000000..e69de29 diff --git a/collections/documentation/developers/internals/zos/assets/0-OS v2 architecture.xml b/collections/tfmanual/documentation/developers/internals/zos/assets/0-OS v2 architecture.xml similarity index 100% rename from collections/documentation/developers/internals/zos/assets/0-OS v2 architecture.xml rename to collections/tfmanual/documentation/developers/internals/zos/assets/0-OS v2 architecture.xml diff --git a/collections/documentation/developers/internals/zos/assets/0-OS-upgrade.png b/collections/tfmanual/documentation/developers/internals/zos/assets/0-OS-upgrade.png similarity index 100% rename from collections/documentation/developers/internals/zos/assets/0-OS-upgrade.png rename to collections/tfmanual/documentation/developers/internals/zos/assets/0-OS-upgrade.png diff --git a/collections/documentation/developers/internals/zos/assets/0-OS-upgrade.wsd b/collections/tfmanual/documentation/developers/internals/zos/assets/0-OS-upgrade.wsd similarity index 100% rename from collections/documentation/developers/internals/zos/assets/0-OS-upgrade.wsd rename to collections/tfmanual/documentation/developers/internals/zos/assets/0-OS-upgrade.wsd diff --git a/collections/documentation/developers/internals/zos/assets/0-OS_v2_architecture.png b/collections/tfmanual/documentation/developers/internals/zos/assets/0-OS_v2_architecture.png similarity index 100% rename from collections/documentation/developers/internals/zos/assets/0-OS_v2_architecture.png rename to collections/tfmanual/documentation/developers/internals/zos/assets/0-OS_v2_architecture.png diff --git a/collections/documentation/developers/internals/zos/assets/Container_module_flow.png b/collections/tfmanual/documentation/developers/internals/zos/assets/Container_module_flow.png similarity index 100% rename from collections/documentation/developers/internals/zos/assets/Container_module_flow.png rename to collections/tfmanual/documentation/developers/internals/zos/assets/Container_module_flow.png diff --git a/collections/documentation/developers/internals/zos/assets/boot_sequence.plantuml b/collections/tfmanual/documentation/developers/internals/zos/assets/boot_sequence.plantuml similarity index 100% rename from collections/documentation/developers/internals/zos/assets/boot_sequence.plantuml rename to collections/tfmanual/documentation/developers/internals/zos/assets/boot_sequence.plantuml diff --git a/collections/documentation/developers/internals/zos/assets/boot_sequence.png b/collections/tfmanual/documentation/developers/internals/zos/assets/boot_sequence.png similarity index 100% rename from collections/documentation/developers/internals/zos/assets/boot_sequence.png rename to collections/tfmanual/documentation/developers/internals/zos/assets/boot_sequence.png diff --git a/collections/documentation/developers/internals/zos/assets/grid_provisioning.png b/collections/tfmanual/documentation/developers/internals/zos/assets/grid_provisioning.png similarity index 100% rename from collections/documentation/developers/internals/zos/assets/grid_provisioning.png rename to collections/tfmanual/documentation/developers/internals/zos/assets/grid_provisioning.png diff --git a/collections/documentation/developers/internals/zos/assets/grid_provisioning.wsd b/collections/tfmanual/documentation/developers/internals/zos/assets/grid_provisioning.wsd similarity index 100% rename from collections/documentation/developers/internals/zos/assets/grid_provisioning.wsd rename to collections/tfmanual/documentation/developers/internals/zos/assets/grid_provisioning.wsd diff --git a/collections/documentation/developers/internals/zos/assets/grid_provisioning2.png b/collections/tfmanual/documentation/developers/internals/zos/assets/grid_provisioning2.png similarity index 100% rename from collections/documentation/developers/internals/zos/assets/grid_provisioning2.png rename to collections/tfmanual/documentation/developers/internals/zos/assets/grid_provisioning2.png diff --git a/collections/documentation/developers/internals/zos/assets/grid_provisioning2.wsd b/collections/tfmanual/documentation/developers/internals/zos/assets/grid_provisioning2.wsd similarity index 100% rename from collections/documentation/developers/internals/zos/assets/grid_provisioning2.wsd rename to collections/tfmanual/documentation/developers/internals/zos/assets/grid_provisioning2.wsd diff --git a/collections/documentation/developers/internals/zos/assets/ipc.plantuml b/collections/tfmanual/documentation/developers/internals/zos/assets/ipc.plantuml similarity index 100% rename from collections/documentation/developers/internals/zos/assets/ipc.plantuml rename to collections/tfmanual/documentation/developers/internals/zos/assets/ipc.plantuml diff --git a/collections/documentation/developers/internals/zos/assets/ipc.png b/collections/tfmanual/documentation/developers/internals/zos/assets/ipc.png similarity index 100% rename from collections/documentation/developers/internals/zos/assets/ipc.png rename to collections/tfmanual/documentation/developers/internals/zos/assets/ipc.png diff --git a/collections/documentation/developers/internals/zos/assets/market.png b/collections/tfmanual/documentation/developers/internals/zos/assets/market.png similarity index 100% rename from collections/documentation/developers/internals/zos/assets/market.png rename to collections/tfmanual/documentation/developers/internals/zos/assets/market.png diff --git a/collections/documentation/developers/internals/zos/assets/market.wsd b/collections/tfmanual/documentation/developers/internals/zos/assets/market.wsd similarity index 100% rename from collections/documentation/developers/internals/zos/assets/market.wsd rename to collections/tfmanual/documentation/developers/internals/zos/assets/market.wsd diff --git a/collections/documentation/developers/internals/zos/development/README.md b/collections/tfmanual/documentation/developers/internals/zos/development/README.md similarity index 100% rename from collections/documentation/developers/internals/zos/development/README.md rename to collections/tfmanual/documentation/developers/internals/zos/development/README.md diff --git a/collections/documentation/developers/internals/zos/development/net.sh b/collections/tfmanual/documentation/developers/internals/zos/development/net.sh old mode 100644 new mode 100755 similarity index 100% rename from collections/documentation/developers/internals/zos/development/net.sh rename to collections/tfmanual/documentation/developers/internals/zos/development/net.sh diff --git a/collections/documentation/developers/internals/zos/development/packages.md b/collections/tfmanual/documentation/developers/internals/zos/development/packages.md similarity index 100% rename from collections/documentation/developers/internals/zos/development/packages.md rename to collections/tfmanual/documentation/developers/internals/zos/development/packages.md diff --git a/collections/documentation/developers/internals/zos/development/quickstart.md b/collections/tfmanual/documentation/developers/internals/zos/development/quickstart.md similarity index 100% rename from collections/documentation/developers/internals/zos/development/quickstart.md rename to collections/tfmanual/documentation/developers/internals/zos/development/quickstart.md diff --git a/collections/documentation/developers/internals/zos/development/testing.md b/collections/tfmanual/documentation/developers/internals/zos/development/testing.md similarity index 100% rename from collections/documentation/developers/internals/zos/development/testing.md rename to collections/tfmanual/documentation/developers/internals/zos/development/testing.md diff --git a/collections/documentation/developers/internals/zos/faq/readme.md b/collections/tfmanual/documentation/developers/internals/zos/faq/readme.md similarity index 100% rename from collections/documentation/developers/internals/zos/faq/readme.md rename to collections/tfmanual/documentation/developers/internals/zos/faq/readme.md diff --git a/collections/documentation/developers/internals/zos/internals/boot.md b/collections/tfmanual/documentation/developers/internals/zos/internals/boot.md similarity index 100% rename from collections/documentation/developers/internals/zos/internals/boot.md rename to collections/tfmanual/documentation/developers/internals/zos/internals/boot.md diff --git a/collections/documentation/developers/internals/zos/internals/capacity.md b/collections/tfmanual/documentation/developers/internals/zos/internals/capacity.md similarity index 100% rename from collections/documentation/developers/internals/zos/internals/capacity.md rename to collections/tfmanual/documentation/developers/internals/zos/internals/capacity.md diff --git a/collections/documentation/developers/internals/zos/internals/compatibility/readme.md b/collections/tfmanual/documentation/developers/internals/zos/internals/compatibility/readme.md similarity index 100% rename from collections/documentation/developers/internals/zos/internals/compatibility/readme.md rename to collections/tfmanual/documentation/developers/internals/zos/internals/compatibility/readme.md diff --git a/collections/documentation/developers/internals/zos/internals/container/readme.md b/collections/tfmanual/documentation/developers/internals/zos/internals/container/readme.md similarity index 100% rename from collections/documentation/developers/internals/zos/internals/container/readme.md rename to collections/tfmanual/documentation/developers/internals/zos/internals/container/readme.md diff --git a/collections/documentation/developers/internals/zos/internals/flist/readme.md b/collections/tfmanual/documentation/developers/internals/zos/internals/flist/readme.md similarity index 100% rename from collections/documentation/developers/internals/zos/internals/flist/readme.md rename to collections/tfmanual/documentation/developers/internals/zos/internals/flist/readme.md diff --git a/collections/documentation/developers/internals/zos/internals/gateway/readme.md b/collections/tfmanual/documentation/developers/internals/zos/internals/gateway/readme.md similarity index 100% rename from collections/documentation/developers/internals/zos/internals/gateway/readme.md rename to collections/tfmanual/documentation/developers/internals/zos/internals/gateway/readme.md diff --git a/collections/documentation/developers/internals/zos/internals/history/readme.md b/collections/tfmanual/documentation/developers/internals/zos/internals/history/readme.md similarity index 100% rename from collections/documentation/developers/internals/zos/internals/history/readme.md rename to collections/tfmanual/documentation/developers/internals/zos/internals/history/readme.md diff --git a/collections/documentation/developers/internals/zos/internals/identity/identity.md b/collections/tfmanual/documentation/developers/internals/zos/internals/identity/identity.md similarity index 100% rename from collections/documentation/developers/internals/zos/internals/identity/identity.md rename to collections/tfmanual/documentation/developers/internals/zos/internals/identity/identity.md diff --git a/collections/documentation/developers/internals/zos/internals/identity/readme.md b/collections/tfmanual/documentation/developers/internals/zos/internals/identity/readme.md similarity index 100% rename from collections/documentation/developers/internals/zos/internals/identity/readme.md rename to collections/tfmanual/documentation/developers/internals/zos/internals/identity/readme.md diff --git a/collections/documentation/developers/internals/zos/internals/identity/upgrade.md b/collections/tfmanual/documentation/developers/internals/zos/internals/identity/upgrade.md similarity index 100% rename from collections/documentation/developers/internals/zos/internals/identity/upgrade.md rename to collections/tfmanual/documentation/developers/internals/zos/internals/identity/upgrade.md diff --git a/collections/documentation/developers/internals/zos/internals/internals.md b/collections/tfmanual/documentation/developers/internals/zos/internals/internals.md similarity index 100% rename from collections/documentation/developers/internals/zos/internals/internals.md rename to collections/tfmanual/documentation/developers/internals/zos/internals/internals.md diff --git a/collections/documentation/developers/internals/zos/internals/macdev/readme.md b/collections/tfmanual/documentation/developers/internals/zos/internals/macdev/readme.md similarity index 100% rename from collections/documentation/developers/internals/zos/internals/macdev/readme.md rename to collections/tfmanual/documentation/developers/internals/zos/internals/macdev/readme.md diff --git a/collections/documentation/developers/internals/zos/internals/network/Deploy_Network-V2.md b/collections/tfmanual/documentation/developers/internals/zos/internals/network/Deploy_Network-V2.md similarity index 100% rename from collections/documentation/developers/internals/zos/internals/network/Deploy_Network-V2.md rename to collections/tfmanual/documentation/developers/internals/zos/internals/network/Deploy_Network-V2.md diff --git a/collections/documentation/developers/internals/zos/internals/network/HIDDEN-PUBLIC.dia b/collections/tfmanual/documentation/developers/internals/zos/internals/network/HIDDEN-PUBLIC.dia similarity index 100% rename from collections/documentation/developers/internals/zos/internals/network/HIDDEN-PUBLIC.dia rename to collections/tfmanual/documentation/developers/internals/zos/internals/network/HIDDEN-PUBLIC.dia diff --git a/collections/documentation/developers/internals/zos/internals/network/HIDDEN-PUBLIC.png b/collections/tfmanual/documentation/developers/internals/zos/internals/network/HIDDEN-PUBLIC.png similarity index 100% rename from collections/documentation/developers/internals/zos/internals/network/HIDDEN-PUBLIC.png rename to collections/tfmanual/documentation/developers/internals/zos/internals/network/HIDDEN-PUBLIC.png diff --git a/collections/documentation/developers/internals/zos/internals/network/NR_layout.dia b/collections/tfmanual/documentation/developers/internals/zos/internals/network/NR_layout.dia similarity index 100% rename from collections/documentation/developers/internals/zos/internals/network/NR_layout.dia rename to collections/tfmanual/documentation/developers/internals/zos/internals/network/NR_layout.dia diff --git a/collections/documentation/developers/internals/zos/internals/network/NR_layout.png b/collections/tfmanual/documentation/developers/internals/zos/internals/network/NR_layout.png similarity index 100% rename from collections/documentation/developers/internals/zos/internals/network/NR_layout.png rename to collections/tfmanual/documentation/developers/internals/zos/internals/network/NR_layout.png diff --git a/collections/documentation/developers/internals/zos/internals/network/Network-V2.md b/collections/tfmanual/documentation/developers/internals/zos/internals/network/Network-V2.md similarity index 100% rename from collections/documentation/developers/internals/zos/internals/network/Network-V2.md rename to collections/tfmanual/documentation/developers/internals/zos/internals/network/Network-V2.md diff --git a/collections/documentation/developers/internals/zos/internals/network/attic/exitpoints.md b/collections/tfmanual/documentation/developers/internals/zos/internals/network/attic/exitpoints.md similarity index 100% rename from collections/documentation/developers/internals/zos/internals/network/attic/exitpoints.md rename to collections/tfmanual/documentation/developers/internals/zos/internals/network/attic/exitpoints.md diff --git a/collections/documentation/developers/internals/zos/internals/network/attic/tools.md b/collections/tfmanual/documentation/developers/internals/zos/internals/network/attic/tools.md similarity index 100% rename from collections/documentation/developers/internals/zos/internals/network/attic/tools.md rename to collections/tfmanual/documentation/developers/internals/zos/internals/network/attic/tools.md diff --git a/collections/documentation/developers/internals/zos/internals/network/attic/zostst.dhcp b/collections/tfmanual/documentation/developers/internals/zos/internals/network/attic/zostst.dhcp similarity index 100% rename from collections/documentation/developers/internals/zos/internals/network/attic/zostst.dhcp rename to collections/tfmanual/documentation/developers/internals/zos/internals/network/attic/zostst.dhcp diff --git a/collections/documentation/developers/internals/zos/internals/network/definitions.md b/collections/tfmanual/documentation/developers/internals/zos/internals/network/definitions.md similarity index 100% rename from collections/documentation/developers/internals/zos/internals/network/definitions.md rename to collections/tfmanual/documentation/developers/internals/zos/internals/network/definitions.md diff --git a/collections/documentation/developers/internals/zos/internals/network/introduction.md b/collections/tfmanual/documentation/developers/internals/zos/internals/network/introduction.md similarity index 100% rename from collections/documentation/developers/internals/zos/internals/network/introduction.md rename to collections/tfmanual/documentation/developers/internals/zos/internals/network/introduction.md diff --git a/collections/documentation/developers/internals/zos/internals/network/mesh.md b/collections/tfmanual/documentation/developers/internals/zos/internals/network/mesh.md similarity index 100% rename from collections/documentation/developers/internals/zos/internals/network/mesh.md rename to collections/tfmanual/documentation/developers/internals/zos/internals/network/mesh.md diff --git a/collections/documentation/developers/internals/zos/internals/network/readme.md b/collections/tfmanual/documentation/developers/internals/zos/internals/network/readme.md similarity index 100% rename from collections/documentation/developers/internals/zos/internals/network/readme.md rename to collections/tfmanual/documentation/developers/internals/zos/internals/network/readme.md diff --git a/collections/documentation/developers/internals/zos/internals/network/setup_farm_network.md b/collections/tfmanual/documentation/developers/internals/zos/internals/network/setup_farm_network.md similarity index 100% rename from collections/documentation/developers/internals/zos/internals/network/setup_farm_network.md rename to collections/tfmanual/documentation/developers/internals/zos/internals/network/setup_farm_network.md diff --git a/collections/documentation/developers/internals/zos/internals/network/topology/png/ndmz-dualstack.png b/collections/tfmanual/documentation/developers/internals/zos/internals/network/topology/png/ndmz-dualstack.png similarity index 100% rename from collections/documentation/developers/internals/zos/internals/network/topology/png/ndmz-dualstack.png rename to collections/tfmanual/documentation/developers/internals/zos/internals/network/topology/png/ndmz-dualstack.png diff --git a/collections/documentation/developers/internals/zos/internals/network/topology/png/ndmz-hidden.png b/collections/tfmanual/documentation/developers/internals/zos/internals/network/topology/png/ndmz-hidden.png similarity index 100% rename from collections/documentation/developers/internals/zos/internals/network/topology/png/ndmz-hidden.png rename to collections/tfmanual/documentation/developers/internals/zos/internals/network/topology/png/ndmz-hidden.png diff --git a/collections/documentation/developers/internals/zos/internals/network/topology/png/nr-join.png b/collections/tfmanual/documentation/developers/internals/zos/internals/network/topology/png/nr-join.png similarity index 100% rename from collections/documentation/developers/internals/zos/internals/network/topology/png/nr-join.png rename to collections/tfmanual/documentation/developers/internals/zos/internals/network/topology/png/nr-join.png diff --git a/collections/documentation/developers/internals/zos/internals/network/topology/png/nr-step-1.png b/collections/tfmanual/documentation/developers/internals/zos/internals/network/topology/png/nr-step-1.png similarity index 100% rename from collections/documentation/developers/internals/zos/internals/network/topology/png/nr-step-1.png rename to collections/tfmanual/documentation/developers/internals/zos/internals/network/topology/png/nr-step-1.png diff --git a/collections/documentation/developers/internals/zos/internals/network/topology/png/nr-step-2.png b/collections/tfmanual/documentation/developers/internals/zos/internals/network/topology/png/nr-step-2.png similarity index 100% rename from collections/documentation/developers/internals/zos/internals/network/topology/png/nr-step-2.png rename to collections/tfmanual/documentation/developers/internals/zos/internals/network/topology/png/nr-step-2.png diff --git a/collections/documentation/developers/internals/zos/internals/network/topology/png/public-namespace.png b/collections/tfmanual/documentation/developers/internals/zos/internals/network/topology/png/public-namespace.png similarity index 100% rename from collections/documentation/developers/internals/zos/internals/network/topology/png/public-namespace.png rename to collections/tfmanual/documentation/developers/internals/zos/internals/network/topology/png/public-namespace.png diff --git a/collections/documentation/developers/internals/zos/internals/network/topology/png/zos-bridge.png b/collections/tfmanual/documentation/developers/internals/zos/internals/network/topology/png/zos-bridge.png similarity index 100% rename from collections/documentation/developers/internals/zos/internals/network/topology/png/zos-bridge.png rename to collections/tfmanual/documentation/developers/internals/zos/internals/network/topology/png/zos-bridge.png diff --git a/collections/documentation/developers/internals/zos/internals/network/topology/readme.md b/collections/tfmanual/documentation/developers/internals/zos/internals/network/topology/readme.md similarity index 100% rename from collections/documentation/developers/internals/zos/internals/network/topology/readme.md rename to collections/tfmanual/documentation/developers/internals/zos/internals/network/topology/readme.md diff --git a/collections/documentation/developers/internals/zos/internals/network/topology/uml/ndmz-dualstack.wsd b/collections/tfmanual/documentation/developers/internals/zos/internals/network/topology/uml/ndmz-dualstack.wsd similarity index 100% rename from collections/documentation/developers/internals/zos/internals/network/topology/uml/ndmz-dualstack.wsd rename to collections/tfmanual/documentation/developers/internals/zos/internals/network/topology/uml/ndmz-dualstack.wsd diff --git a/collections/documentation/developers/internals/zos/internals/network/topology/uml/ndmz-hidden.wsd b/collections/tfmanual/documentation/developers/internals/zos/internals/network/topology/uml/ndmz-hidden.wsd similarity index 100% rename from collections/documentation/developers/internals/zos/internals/network/topology/uml/ndmz-hidden.wsd rename to collections/tfmanual/documentation/developers/internals/zos/internals/network/topology/uml/ndmz-hidden.wsd diff --git a/collections/documentation/developers/internals/zos/internals/network/topology/uml/nr-join.wsd b/collections/tfmanual/documentation/developers/internals/zos/internals/network/topology/uml/nr-join.wsd similarity index 100% rename from collections/documentation/developers/internals/zos/internals/network/topology/uml/nr-join.wsd rename to collections/tfmanual/documentation/developers/internals/zos/internals/network/topology/uml/nr-join.wsd diff --git a/collections/documentation/developers/internals/zos/internals/network/topology/uml/nr-step-1.wsd b/collections/tfmanual/documentation/developers/internals/zos/internals/network/topology/uml/nr-step-1.wsd similarity index 100% rename from collections/documentation/developers/internals/zos/internals/network/topology/uml/nr-step-1.wsd rename to collections/tfmanual/documentation/developers/internals/zos/internals/network/topology/uml/nr-step-1.wsd diff --git a/collections/documentation/developers/internals/zos/internals/network/topology/uml/nr-step-2.wsd b/collections/tfmanual/documentation/developers/internals/zos/internals/network/topology/uml/nr-step-2.wsd similarity index 100% rename from collections/documentation/developers/internals/zos/internals/network/topology/uml/nr-step-2.wsd rename to collections/tfmanual/documentation/developers/internals/zos/internals/network/topology/uml/nr-step-2.wsd diff --git a/collections/documentation/developers/internals/zos/internals/network/topology/uml/public-namespace.wsd b/collections/tfmanual/documentation/developers/internals/zos/internals/network/topology/uml/public-namespace.wsd similarity index 100% rename from collections/documentation/developers/internals/zos/internals/network/topology/uml/public-namespace.wsd rename to collections/tfmanual/documentation/developers/internals/zos/internals/network/topology/uml/public-namespace.wsd diff --git a/collections/documentation/developers/internals/zos/internals/network/topology/uml/zos-bridge.wsd b/collections/tfmanual/documentation/developers/internals/zos/internals/network/topology/uml/zos-bridge.wsd similarity index 100% rename from collections/documentation/developers/internals/zos/internals/network/topology/uml/zos-bridge.wsd rename to collections/tfmanual/documentation/developers/internals/zos/internals/network/topology/uml/zos-bridge.wsd diff --git a/collections/documentation/developers/internals/zos/internals/network/yggdrasil.md b/collections/tfmanual/documentation/developers/internals/zos/internals/network/yggdrasil.md similarity index 100% rename from collections/documentation/developers/internals/zos/internals/network/yggdrasil.md rename to collections/tfmanual/documentation/developers/internals/zos/internals/network/yggdrasil.md diff --git a/collections/documentation/developers/internals/zos/internals/network/zbus.md b/collections/tfmanual/documentation/developers/internals/zos/internals/network/zbus.md similarity index 100% rename from collections/documentation/developers/internals/zos/internals/network/zbus.md rename to collections/tfmanual/documentation/developers/internals/zos/internals/network/zbus.md diff --git a/collections/documentation/developers/internals/zos/internals/node/readme.md b/collections/tfmanual/documentation/developers/internals/zos/internals/node/readme.md similarity index 100% rename from collections/documentation/developers/internals/zos/internals/node/readme.md rename to collections/tfmanual/documentation/developers/internals/zos/internals/node/readme.md diff --git a/collections/documentation/developers/internals/zos/internals/provision/readme.md b/collections/tfmanual/documentation/developers/internals/zos/internals/provision/readme.md similarity index 100% rename from collections/documentation/developers/internals/zos/internals/provision/readme.md rename to collections/tfmanual/documentation/developers/internals/zos/internals/provision/readme.md diff --git a/collections/documentation/developers/internals/zos/internals/storage/readme.md b/collections/tfmanual/documentation/developers/internals/zos/internals/storage/readme.md similarity index 100% rename from collections/documentation/developers/internals/zos/internals/storage/readme.md rename to collections/tfmanual/documentation/developers/internals/zos/internals/storage/readme.md diff --git a/collections/documentation/developers/internals/zos/internals/vmd/readme.md b/collections/tfmanual/documentation/developers/internals/zos/internals/vmd/readme.md similarity index 100% rename from collections/documentation/developers/internals/zos/internals/vmd/readme.md rename to collections/tfmanual/documentation/developers/internals/zos/internals/vmd/readme.md diff --git a/collections/documentation/developers/internals/zos/manual/api.md b/collections/tfmanual/documentation/developers/internals/zos/manual/api.md similarity index 100% rename from collections/documentation/developers/internals/zos/manual/api.md rename to collections/tfmanual/documentation/developers/internals/zos/manual/api.md diff --git a/collections/documentation/developers/internals/zos/manual/gateway/fqdn-proxy.md b/collections/tfmanual/documentation/developers/internals/zos/manual/gateway/fqdn-proxy.md similarity index 100% rename from collections/documentation/developers/internals/zos/manual/gateway/fqdn-proxy.md rename to collections/tfmanual/documentation/developers/internals/zos/manual/gateway/fqdn-proxy.md diff --git a/collections/documentation/developers/internals/zos/manual/gateway/name-proxy.md b/collections/tfmanual/documentation/developers/internals/zos/manual/gateway/name-proxy.md similarity index 100% rename from collections/documentation/developers/internals/zos/manual/gateway/name-proxy.md rename to collections/tfmanual/documentation/developers/internals/zos/manual/gateway/name-proxy.md diff --git a/collections/documentation/developers/internals/zos/manual/ip/readme.md b/collections/tfmanual/documentation/developers/internals/zos/manual/ip/readme.md similarity index 100% rename from collections/documentation/developers/internals/zos/manual/ip/readme.md rename to collections/tfmanual/documentation/developers/internals/zos/manual/ip/readme.md diff --git a/collections/documentation/developers/internals/zos/manual/manual.md b/collections/tfmanual/documentation/developers/internals/zos/manual/manual.md similarity index 100% rename from collections/documentation/developers/internals/zos/manual/manual.md rename to collections/tfmanual/documentation/developers/internals/zos/manual/manual.md diff --git a/collections/documentation/developers/internals/zos/manual/network/readme.md b/collections/tfmanual/documentation/developers/internals/zos/manual/network/readme.md similarity index 100% rename from collections/documentation/developers/internals/zos/manual/network/readme.md rename to collections/tfmanual/documentation/developers/internals/zos/manual/network/readme.md diff --git a/collections/documentation/developers/internals/zos/manual/qsfs/readme.md b/collections/tfmanual/documentation/developers/internals/zos/manual/qsfs/readme.md similarity index 100% rename from collections/documentation/developers/internals/zos/manual/qsfs/readme.md rename to collections/tfmanual/documentation/developers/internals/zos/manual/qsfs/readme.md diff --git a/collections/documentation/developers/internals/zos/manual/workload_types.md b/collections/tfmanual/documentation/developers/internals/zos/manual/workload_types.md similarity index 100% rename from collections/documentation/developers/internals/zos/manual/workload_types.md rename to collections/tfmanual/documentation/developers/internals/zos/manual/workload_types.md diff --git a/collections/documentation/developers/internals/zos/manual/zdb/readme.md b/collections/tfmanual/documentation/developers/internals/zos/manual/zdb/readme.md similarity index 100% rename from collections/documentation/developers/internals/zos/manual/zdb/readme.md rename to collections/tfmanual/documentation/developers/internals/zos/manual/zdb/readme.md diff --git a/collections/documentation/developers/internals/zos/manual/zlogs/readme.md b/collections/tfmanual/documentation/developers/internals/zos/manual/zlogs/readme.md similarity index 100% rename from collections/documentation/developers/internals/zos/manual/zlogs/readme.md rename to collections/tfmanual/documentation/developers/internals/zos/manual/zlogs/readme.md diff --git a/collections/documentation/developers/internals/zos/manual/zmachine/cloud-console.md b/collections/tfmanual/documentation/developers/internals/zos/manual/zmachine/cloud-console.md similarity index 100% rename from collections/documentation/developers/internals/zos/manual/zmachine/cloud-console.md rename to collections/tfmanual/documentation/developers/internals/zos/manual/zmachine/cloud-console.md diff --git a/collections/documentation/developers/internals/zos/manual/zmachine/readme.md b/collections/tfmanual/documentation/developers/internals/zos/manual/zmachine/readme.md similarity index 100% rename from collections/documentation/developers/internals/zos/manual/zmachine/readme.md rename to collections/tfmanual/documentation/developers/internals/zos/manual/zmachine/readme.md diff --git a/collections/documentation/developers/internals/zos/manual/zmachine/zmachine.md b/collections/tfmanual/documentation/developers/internals/zos/manual/zmachine/zmachine.md similarity index 100% rename from collections/documentation/developers/internals/zos/manual/zmachine/zmachine.md rename to collections/tfmanual/documentation/developers/internals/zos/manual/zmachine/zmachine.md diff --git a/collections/documentation/developers/internals/zos/manual/zmount/readme.md b/collections/tfmanual/documentation/developers/internals/zos/manual/zmount/readme.md similarity index 100% rename from collections/documentation/developers/internals/zos/manual/zmount/readme.md rename to collections/tfmanual/documentation/developers/internals/zos/manual/zmount/readme.md diff --git a/collections/documentation/developers/internals/zos/performance/cpubench.md b/collections/tfmanual/documentation/developers/internals/zos/performance/cpubench.md similarity index 100% rename from collections/documentation/developers/internals/zos/performance/cpubench.md rename to collections/tfmanual/documentation/developers/internals/zos/performance/cpubench.md diff --git a/collections/documentation/developers/internals/zos/performance/healthcheck.md b/collections/tfmanual/documentation/developers/internals/zos/performance/healthcheck.md similarity index 100% rename from collections/documentation/developers/internals/zos/performance/healthcheck.md rename to collections/tfmanual/documentation/developers/internals/zos/performance/healthcheck.md diff --git a/collections/documentation/developers/internals/zos/performance/iperf.md b/collections/tfmanual/documentation/developers/internals/zos/performance/iperf.md similarity index 100% rename from collections/documentation/developers/internals/zos/performance/iperf.md rename to collections/tfmanual/documentation/developers/internals/zos/performance/iperf.md diff --git a/collections/documentation/developers/internals/zos/performance/performance.md b/collections/tfmanual/documentation/developers/internals/zos/performance/performance.md similarity index 100% rename from collections/documentation/developers/internals/zos/performance/performance.md rename to collections/tfmanual/documentation/developers/internals/zos/performance/performance.md diff --git a/collections/documentation/developers/internals/zos/performance/publicips.md b/collections/tfmanual/documentation/developers/internals/zos/performance/publicips.md similarity index 100% rename from collections/documentation/developers/internals/zos/performance/publicips.md rename to collections/tfmanual/documentation/developers/internals/zos/performance/publicips.md diff --git a/collections/documentation/developers/internals/zos/readme.md b/collections/tfmanual/documentation/developers/internals/zos/readme.md similarity index 100% rename from collections/documentation/developers/internals/zos/readme.md rename to collections/tfmanual/documentation/developers/internals/zos/readme.md diff --git a/collections/documentation/developers/internals/zos/release/readme.md b/collections/tfmanual/documentation/developers/internals/zos/release/readme.md similarity index 100% rename from collections/documentation/developers/internals/zos/release/readme.md rename to collections/tfmanual/documentation/developers/internals/zos/release/readme.md diff --git a/collections/documentation/developers/javascript/grid3_javascript_capacity_planning.md b/collections/tfmanual/documentation/developers/javascript/grid3_javascript_capacity_planning.md similarity index 100% rename from collections/documentation/developers/javascript/grid3_javascript_capacity_planning.md rename to collections/tfmanual/documentation/developers/javascript/grid3_javascript_capacity_planning.md diff --git a/collections/documentation/developers/javascript/grid3_javascript_caprover.md b/collections/tfmanual/documentation/developers/javascript/grid3_javascript_caprover.md similarity index 100% rename from collections/documentation/developers/javascript/grid3_javascript_caprover.md rename to collections/tfmanual/documentation/developers/javascript/grid3_javascript_caprover.md diff --git a/collections/documentation/developers/javascript/grid3_javascript_gpu_support.md b/collections/tfmanual/documentation/developers/javascript/grid3_javascript_gpu_support.md similarity index 100% rename from collections/documentation/developers/javascript/grid3_javascript_gpu_support.md rename to collections/tfmanual/documentation/developers/javascript/grid3_javascript_gpu_support.md diff --git a/collections/documentation/developers/javascript/grid3_javascript_installation.md b/collections/tfmanual/documentation/developers/javascript/grid3_javascript_installation.md similarity index 100% rename from collections/documentation/developers/javascript/grid3_javascript_installation.md rename to collections/tfmanual/documentation/developers/javascript/grid3_javascript_installation.md diff --git a/collections/documentation/developers/javascript/grid3_javascript_kubernetes.md b/collections/tfmanual/documentation/developers/javascript/grid3_javascript_kubernetes.md similarity index 100% rename from collections/documentation/developers/javascript/grid3_javascript_kubernetes.md rename to collections/tfmanual/documentation/developers/javascript/grid3_javascript_kubernetes.md diff --git a/collections/documentation/developers/javascript/grid3_javascript_kvstore.md b/collections/tfmanual/documentation/developers/javascript/grid3_javascript_kvstore.md similarity index 100% rename from collections/documentation/developers/javascript/grid3_javascript_kvstore.md rename to collections/tfmanual/documentation/developers/javascript/grid3_javascript_kvstore.md diff --git a/collections/documentation/developers/javascript/grid3_javascript_loadclient.md b/collections/tfmanual/documentation/developers/javascript/grid3_javascript_loadclient.md similarity index 100% rename from collections/documentation/developers/javascript/grid3_javascript_loadclient.md rename to collections/tfmanual/documentation/developers/javascript/grid3_javascript_loadclient.md diff --git a/collections/documentation/developers/javascript/grid3_javascript_qsfs.md b/collections/tfmanual/documentation/developers/javascript/grid3_javascript_qsfs.md similarity index 100% rename from collections/documentation/developers/javascript/grid3_javascript_qsfs.md rename to collections/tfmanual/documentation/developers/javascript/grid3_javascript_qsfs.md diff --git a/collections/documentation/developers/javascript/grid3_javascript_qsfs_zdbs.md b/collections/tfmanual/documentation/developers/javascript/grid3_javascript_qsfs_zdbs.md similarity index 100% rename from collections/documentation/developers/javascript/grid3_javascript_qsfs_zdbs.md rename to collections/tfmanual/documentation/developers/javascript/grid3_javascript_qsfs_zdbs.md diff --git a/collections/documentation/developers/javascript/grid3_javascript_readme.md b/collections/tfmanual/documentation/developers/javascript/grid3_javascript_readme.md similarity index 100% rename from collections/documentation/developers/javascript/grid3_javascript_readme.md rename to collections/tfmanual/documentation/developers/javascript/grid3_javascript_readme.md diff --git a/collections/documentation/developers/javascript/grid3_javascript_run_scripts.md b/collections/tfmanual/documentation/developers/javascript/grid3_javascript_run_scripts.md similarity index 100% rename from collections/documentation/developers/javascript/grid3_javascript_run_scripts.md rename to collections/tfmanual/documentation/developers/javascript/grid3_javascript_run_scripts.md diff --git a/collections/documentation/developers/javascript/grid3_javascript_vm.md b/collections/tfmanual/documentation/developers/javascript/grid3_javascript_vm.md similarity index 100% rename from collections/documentation/developers/javascript/grid3_javascript_vm.md rename to collections/tfmanual/documentation/developers/javascript/grid3_javascript_vm.md diff --git a/collections/documentation/developers/javascript/grid3_javascript_vm_gateways.md b/collections/tfmanual/documentation/developers/javascript/grid3_javascript_vm_gateways.md similarity index 100% rename from collections/documentation/developers/javascript/grid3_javascript_vm_gateways.md rename to collections/tfmanual/documentation/developers/javascript/grid3_javascript_vm_gateways.md diff --git a/collections/documentation/developers/javascript/grid3_javascript_vms.md b/collections/tfmanual/documentation/developers/javascript/grid3_javascript_vms.md similarity index 100% rename from collections/documentation/developers/javascript/grid3_javascript_vms.md rename to collections/tfmanual/documentation/developers/javascript/grid3_javascript_vms.md diff --git a/collections/documentation/developers/javascript/grid3_javascript_zdb.md b/collections/tfmanual/documentation/developers/javascript/grid3_javascript_zdb.md similarity index 100% rename from collections/documentation/developers/javascript/grid3_javascript_zdb.md rename to collections/tfmanual/documentation/developers/javascript/grid3_javascript_zdb.md diff --git a/collections/documentation/developers/javascript/grid3_wireguard_gateway.md b/collections/tfmanual/documentation/developers/javascript/grid3_wireguard_gateway.md similarity index 100% rename from collections/documentation/developers/javascript/grid3_wireguard_gateway.md rename to collections/tfmanual/documentation/developers/javascript/grid3_wireguard_gateway.md diff --git a/collections/documentation/developers/javascript/sidebar.md b/collections/tfmanual/documentation/developers/javascript/sidebar.md similarity index 100% rename from collections/documentation/developers/javascript/sidebar.md rename to collections/tfmanual/documentation/developers/javascript/sidebar.md diff --git a/collections/documentation/developers/proxy/commands.md b/collections/tfmanual/documentation/developers/proxy/commands.md similarity index 100% rename from collections/documentation/developers/proxy/commands.md rename to collections/tfmanual/documentation/developers/proxy/commands.md diff --git a/collections/documentation/developers/proxy/contributions.md b/collections/tfmanual/documentation/developers/proxy/contributions.md similarity index 100% rename from collections/documentation/developers/proxy/contributions.md rename to collections/tfmanual/documentation/developers/proxy/contributions.md diff --git a/collections/documentation/developers/proxy/database.md b/collections/tfmanual/documentation/developers/proxy/database.md similarity index 100% rename from collections/documentation/developers/proxy/database.md rename to collections/tfmanual/documentation/developers/proxy/database.md diff --git a/collections/documentation/developers/proxy/db_testing.md b/collections/tfmanual/documentation/developers/proxy/db_testing.md similarity index 100% rename from collections/documentation/developers/proxy/db_testing.md rename to collections/tfmanual/documentation/developers/proxy/db_testing.md diff --git a/collections/documentation/developers/proxy/explorer.md b/collections/tfmanual/documentation/developers/proxy/explorer.md similarity index 100% rename from collections/documentation/developers/proxy/explorer.md rename to collections/tfmanual/documentation/developers/proxy/explorer.md diff --git a/collections/documentation/developers/proxy/production.md b/collections/tfmanual/documentation/developers/proxy/production.md similarity index 100% rename from collections/documentation/developers/proxy/production.md rename to collections/tfmanual/documentation/developers/proxy/production.md diff --git a/collections/documentation/developers/proxy/proxy.md b/collections/tfmanual/documentation/developers/proxy/proxy.md similarity index 100% rename from collections/documentation/developers/proxy/proxy.md rename to collections/tfmanual/documentation/developers/proxy/proxy.md diff --git a/collections/documentation/developers/proxy/proxy_readme.md b/collections/tfmanual/documentation/developers/proxy/proxy_readme.md similarity index 100% rename from collections/documentation/developers/proxy/proxy_readme.md rename to collections/tfmanual/documentation/developers/proxy/proxy_readme.md diff --git a/collections/documentation/developers/proxy/release.md b/collections/tfmanual/documentation/developers/proxy/release.md similarity index 100% rename from collections/documentation/developers/proxy/release.md rename to collections/tfmanual/documentation/developers/proxy/release.md diff --git a/collections/documentation/developers/proxy/setup.md b/collections/tfmanual/documentation/developers/proxy/setup.md similarity index 100% rename from collections/documentation/developers/proxy/setup.md rename to collections/tfmanual/documentation/developers/proxy/setup.md diff --git a/collections/documentation/developers/tfchain/farming_policies.md b/collections/tfmanual/documentation/developers/tfchain/farming_policies.md similarity index 100% rename from collections/documentation/developers/tfchain/farming_policies.md rename to collections/tfmanual/documentation/developers/tfchain/farming_policies.md diff --git a/collections/tfmanual/documentation/developers/tfchain/img/TF.png b/collections/tfmanual/documentation/developers/tfchain/img/TF.png new file mode 100644 index 0000000..528b5d9 Binary files /dev/null and b/collections/tfmanual/documentation/developers/tfchain/img/TF.png differ diff --git a/collections/tfmanual/documentation/developers/tfchain/img/attach.png b/collections/tfmanual/documentation/developers/tfchain/img/attach.png new file mode 100644 index 0000000..96e3c5f Binary files /dev/null and b/collections/tfmanual/documentation/developers/tfchain/img/attach.png differ diff --git a/collections/tfmanual/documentation/developers/tfchain/img/close_proposal.png b/collections/tfmanual/documentation/developers/tfchain/img/close_proposal.png new file mode 100644 index 0000000..07e66a2 Binary files /dev/null and b/collections/tfmanual/documentation/developers/tfchain/img/close_proposal.png differ diff --git a/collections/tfmanual/documentation/developers/tfchain/img/create_contract.png b/collections/tfmanual/documentation/developers/tfchain/img/create_contract.png new file mode 100644 index 0000000..f082e80 Binary files /dev/null and b/collections/tfmanual/documentation/developers/tfchain/img/create_contract.png differ diff --git a/collections/tfmanual/documentation/developers/tfchain/img/create_policy.png b/collections/tfmanual/documentation/developers/tfchain/img/create_policy.png new file mode 100644 index 0000000..fa344e7 Binary files /dev/null and b/collections/tfmanual/documentation/developers/tfchain/img/create_policy.png differ diff --git a/collections/tfmanual/documentation/developers/tfchain/img/create_provider.png b/collections/tfmanual/documentation/developers/tfchain/img/create_provider.png new file mode 100644 index 0000000..e8668a2 Binary files /dev/null and b/collections/tfmanual/documentation/developers/tfchain/img/create_provider.png differ diff --git a/collections/tfmanual/documentation/developers/tfchain/img/propose_approve.png b/collections/tfmanual/documentation/developers/tfchain/img/propose_approve.png new file mode 100644 index 0000000..667f66f Binary files /dev/null and b/collections/tfmanual/documentation/developers/tfchain/img/propose_approve.png differ diff --git a/collections/tfmanual/documentation/developers/tfchain/img/proposed_approve.png b/collections/tfmanual/documentation/developers/tfchain/img/proposed_approve.png new file mode 100644 index 0000000..5202c4c Binary files /dev/null and b/collections/tfmanual/documentation/developers/tfchain/img/proposed_approve.png differ diff --git a/collections/tfmanual/documentation/developers/tfchain/img/query_provider.png b/collections/tfmanual/documentation/developers/tfchain/img/query_provider.png new file mode 100644 index 0000000..de66d4c Binary files /dev/null and b/collections/tfmanual/documentation/developers/tfchain/img/query_provider.png differ diff --git a/collections/tfmanual/documentation/developers/tfchain/img/service_contract_approve.png b/collections/tfmanual/documentation/developers/tfchain/img/service_contract_approve.png new file mode 100644 index 0000000..1e0d034 Binary files /dev/null and b/collections/tfmanual/documentation/developers/tfchain/img/service_contract_approve.png differ diff --git a/collections/tfmanual/documentation/developers/tfchain/img/service_contract_bill.png b/collections/tfmanual/documentation/developers/tfchain/img/service_contract_bill.png new file mode 100644 index 0000000..55e84fe Binary files /dev/null and b/collections/tfmanual/documentation/developers/tfchain/img/service_contract_bill.png differ diff --git a/collections/tfmanual/documentation/developers/tfchain/img/service_contract_cancel.png b/collections/tfmanual/documentation/developers/tfchain/img/service_contract_cancel.png new file mode 100644 index 0000000..7669510 Binary files /dev/null and b/collections/tfmanual/documentation/developers/tfchain/img/service_contract_cancel.png differ diff --git a/collections/tfmanual/documentation/developers/tfchain/img/service_contract_create.png b/collections/tfmanual/documentation/developers/tfchain/img/service_contract_create.png new file mode 100644 index 0000000..69ec62a Binary files /dev/null and b/collections/tfmanual/documentation/developers/tfchain/img/service_contract_create.png differ diff --git a/collections/tfmanual/documentation/developers/tfchain/img/service_contract_id.png b/collections/tfmanual/documentation/developers/tfchain/img/service_contract_id.png new file mode 100644 index 0000000..e49c396 Binary files /dev/null and b/collections/tfmanual/documentation/developers/tfchain/img/service_contract_id.png differ diff --git a/collections/tfmanual/documentation/developers/tfchain/img/service_contract_reject.png b/collections/tfmanual/documentation/developers/tfchain/img/service_contract_reject.png new file mode 100644 index 0000000..6235530 Binary files /dev/null and b/collections/tfmanual/documentation/developers/tfchain/img/service_contract_reject.png differ diff --git a/collections/tfmanual/documentation/developers/tfchain/img/service_contract_set_fees.png b/collections/tfmanual/documentation/developers/tfchain/img/service_contract_set_fees.png new file mode 100644 index 0000000..6cfa91a Binary files /dev/null and b/collections/tfmanual/documentation/developers/tfchain/img/service_contract_set_fees.png differ diff --git a/collections/tfmanual/documentation/developers/tfchain/img/service_contract_set_metadata.png b/collections/tfmanual/documentation/developers/tfchain/img/service_contract_set_metadata.png new file mode 100644 index 0000000..e472145 Binary files /dev/null and b/collections/tfmanual/documentation/developers/tfchain/img/service_contract_set_metadata.png differ diff --git a/collections/tfmanual/documentation/developers/tfchain/img/service_contract_state.png b/collections/tfmanual/documentation/developers/tfchain/img/service_contract_state.png new file mode 100644 index 0000000..e824552 Binary files /dev/null and b/collections/tfmanual/documentation/developers/tfchain/img/service_contract_state.png differ diff --git a/collections/tfmanual/documentation/developers/tfchain/img/service_contract_twin_from_account.png b/collections/tfmanual/documentation/developers/tfchain/img/service_contract_twin_from_account.png new file mode 100644 index 0000000..293bad2 Binary files /dev/null and b/collections/tfmanual/documentation/developers/tfchain/img/service_contract_twin_from_account.png differ diff --git a/collections/tfmanual/documentation/developers/tfchain/img/vote_proposal.png b/collections/tfmanual/documentation/developers/tfchain/img/vote_proposal.png new file mode 100644 index 0000000..16111a0 Binary files /dev/null and b/collections/tfmanual/documentation/developers/tfchain/img/vote_proposal.png differ diff --git a/collections/documentation/developers/tfchain/introduction.md b/collections/tfmanual/documentation/developers/tfchain/introduction.md similarity index 100% rename from collections/documentation/developers/tfchain/introduction.md rename to collections/tfmanual/documentation/developers/tfchain/introduction.md diff --git a/collections/tfmanual/documentation/developers/tfchain/tfchain.md b/collections/tfmanual/documentation/developers/tfchain/tfchain.md new file mode 100644 index 0000000..a575535 --- /dev/null +++ b/collections/tfmanual/documentation/developers/tfchain/tfchain.md @@ -0,0 +1,95 @@ +

ThreeFold Chain

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Twins](#twins) +- [Farms](#farms) +- [Nodes](#nodes) +- [Node Contract](#node-contract) +- [Rent Contract](#rent-contract) +- [Name Contract](#name-contract) +- [Contract billing](#contract-billing) +- [Contract locking](#contract-locking) +- [Contract grace period](#contract-grace-period) +- [DAO](#dao) +- [Farming Policies](#farming-policies) +- [Node Connection price](#node-connection-price) +- [Node Certifiers](#node-certifiers) + +*** + +## Introduction + +ThreeFold Chain (TFChain) is the base layer for everything that interacts with the grid. Nodes, farms, users are registered on the chain. It plays the central role in achieving decentralised consensus between a user and Node to deploy a certain workload. A contract can be created on the chain that is essentially an agreement between a node and user. + +## Twins + +A twin is the central Identity object that is used for every entity that lives on the grid. A twin optionally has an IPV6 planetary network address which can be used for communication between twins no matter of the location they are in. A twin is coupled to a private/public keypair on chain. This keypair can hold TFT on TF Chain. + +## Farms + +A farm must be created before a Node can be booted. Every farms needs to have an unique name and is linked to the Twin that creates the farm. Once a farm is created, a unique ID is generated. This ID can be used to provide to the boot image of a Node. + +## Nodes + +When a node is booted for the first time, it registers itself on the chain and a unique identity is generated for this Node. + +## Node Contract + +A node contract is a contract between a user and a Node to deploy a certain workload. The contract is specified as following: + +``` +{ + "contract_id": auto generated, + "node_id": unique id of the node, + "deployment_data": some additional deployment data + "deployment_hash": hash of the deployment definition signed by the user + "public_ips": number of public ips to attach to the deployment contract +} +``` + +We don't save the raw workload definition on the chain but only a hash of the definition. After the contract is created, the user must send the raw deployment to the specified node in the contract. He can find where to send this data by looking up the Node's twin and contacting that twin over the planetary network. + +## Rent Contract + +A rent contract is also a contract between a user and a Node, but instead of being able to reserve a part of the node's capacity, the full capacity is rented. Once a rent contract is created on a Node by a user, only this user can deploy node contracts on this specific node. A discount of 50% is given if a the user wishes to rent the full capacity of a node by creating a rent contract. All node contracts deployed on a node where a user has a rent contract are free of use expect for the public ip's which can be added on a node contract. + +## Name Contract + +A name contract is a contract that specifies a unique name to be used on the grid's webgateways. Once a name contract is created, this name can be used as and entrypoint for an application on the grid. + +## Contract billing + +Every contract is billed every 1 hour on the chain, the amount that is due is deducted from the user's wallet every 24 hours or when the user cancels his contract. The total amount acrued in those 24 hours gets send to following destinations: + +- 10% goes to the threefold foundation +- 5% goes to staking pool wallet (to be implemented in a later phase) +- 50% goes to certified sales channel +- 35% TFT gets burned + +See [pricing](../../../knowledge_base/cloud/pricing/pricing.md) for more information on how the cost for a contract is calculated. + +## Contract locking + +To not overload the chain with transfer events and others we choose to lock the amount due for a contract every hour and after 24 hours unlock the amount and deduct it in one go. This lock is saved on a user's account, if the user has multiple contracts the locked amount will be stacked. + +## Contract grace period + +When the owner of a contract runs out funds on his wallet to pay for his deployment, the contract goes in to a Grace Period state. The deployment, whatever that might be, will be unaccessible during this period to the user. When the wallet is funded with TFT again, the contract goes back to a normal operating state. If the grace period runs out (by default 2 weeks) the user's deployment and data will be deleted from the node. + +## DAO + +See [DAO](../../dashboard/tfchain/tf_dao.md) for more information on the DAO on TF Chain. + +## Farming Policies + +See [farming_policies](farming_policies.md) for more information on the farming policies on TF Chain. + +## Node Connection price + +A connection price is set to every new Node that boots on the Grid. This connection price influences the amount of TFT farmed in a period. The connection price set on a node is permanent. The DAO can propose the increase / decrease of the connection price. At the time of writing the connection price is set to $ 0.08. When the DAO proposes a connection price and the vote is passed, new nodes will attach to the new connection price. + +## Node Certifiers + +Node certifiers are entities who are allowed to set a node's certification level to `Certified`. The DAO can propose to add / remove entities that can certify nodes. This is usefull for allowing approved resellers of Threefold nodes to mark nodes as Certified. A certified node farms 25% more tokens than `Diy` a node. \ No newline at end of file diff --git a/collections/documentation/developers/tfchain/tfchain_external_service_contract.md b/collections/tfmanual/documentation/developers/tfchain/tfchain_external_service_contract.md similarity index 100% rename from collections/documentation/developers/tfchain/tfchain_external_service_contract.md rename to collections/tfmanual/documentation/developers/tfchain/tfchain_external_service_contract.md diff --git a/collections/documentation/developers/tfchain/tfchain_solution_provider.md b/collections/tfmanual/documentation/developers/tfchain/tfchain_solution_provider.md similarity index 100% rename from collections/documentation/developers/tfchain/tfchain_solution_provider.md rename to collections/tfmanual/documentation/developers/tfchain/tfchain_solution_provider.md diff --git a/collections/documentation/developers/tfcmd/tfcmd.md b/collections/tfmanual/documentation/developers/tfcmd/tfcmd.md similarity index 100% rename from collections/documentation/developers/tfcmd/tfcmd.md rename to collections/tfmanual/documentation/developers/tfcmd/tfcmd.md diff --git a/collections/documentation/developers/tfcmd/tfcmd_basics.md b/collections/tfmanual/documentation/developers/tfcmd/tfcmd_basics.md similarity index 100% rename from collections/documentation/developers/tfcmd/tfcmd_basics.md rename to collections/tfmanual/documentation/developers/tfcmd/tfcmd_basics.md diff --git a/collections/documentation/developers/tfcmd/tfcmd_contracts.md b/collections/tfmanual/documentation/developers/tfcmd/tfcmd_contracts.md similarity index 100% rename from collections/documentation/developers/tfcmd/tfcmd_contracts.md rename to collections/tfmanual/documentation/developers/tfcmd/tfcmd_contracts.md diff --git a/collections/documentation/developers/tfcmd/tfcmd_gateway_fqdn.md b/collections/tfmanual/documentation/developers/tfcmd/tfcmd_gateway_fqdn.md similarity index 100% rename from collections/documentation/developers/tfcmd/tfcmd_gateway_fqdn.md rename to collections/tfmanual/documentation/developers/tfcmd/tfcmd_gateway_fqdn.md diff --git a/collections/documentation/developers/tfcmd/tfcmd_gateway_name.md b/collections/tfmanual/documentation/developers/tfcmd/tfcmd_gateway_name.md similarity index 100% rename from collections/documentation/developers/tfcmd/tfcmd_gateway_name.md rename to collections/tfmanual/documentation/developers/tfcmd/tfcmd_gateway_name.md diff --git a/collections/documentation/developers/tfcmd/tfcmd_kubernetes.md b/collections/tfmanual/documentation/developers/tfcmd/tfcmd_kubernetes.md similarity index 100% rename from collections/documentation/developers/tfcmd/tfcmd_kubernetes.md rename to collections/tfmanual/documentation/developers/tfcmd/tfcmd_kubernetes.md diff --git a/collections/documentation/developers/tfcmd/tfcmd_vm.md b/collections/tfmanual/documentation/developers/tfcmd/tfcmd_vm.md similarity index 100% rename from collections/documentation/developers/tfcmd/tfcmd_vm.md rename to collections/tfmanual/documentation/developers/tfcmd/tfcmd_vm.md diff --git a/collections/documentation/developers/tfcmd/tfcmd_zdbs.md b/collections/tfmanual/documentation/developers/tfcmd/tfcmd_zdbs.md similarity index 100% rename from collections/documentation/developers/tfcmd/tfcmd_zdbs.md rename to collections/tfmanual/documentation/developers/tfcmd/tfcmd_zdbs.md diff --git a/collections/documentation/developers/tfrobot/tfrobot.md b/collections/tfmanual/documentation/developers/tfrobot/tfrobot.md similarity index 100% rename from collections/documentation/developers/tfrobot/tfrobot.md rename to collections/tfmanual/documentation/developers/tfrobot/tfrobot.md diff --git a/collections/documentation/developers/tfrobot/tfrobot_commands_flags.md b/collections/tfmanual/documentation/developers/tfrobot/tfrobot_commands_flags.md similarity index 100% rename from collections/documentation/developers/tfrobot/tfrobot_commands_flags.md rename to collections/tfmanual/documentation/developers/tfrobot/tfrobot_commands_flags.md diff --git a/collections/documentation/developers/tfrobot/tfrobot_config.md b/collections/tfmanual/documentation/developers/tfrobot/tfrobot_config.md similarity index 100% rename from collections/documentation/developers/tfrobot/tfrobot_config.md rename to collections/tfmanual/documentation/developers/tfrobot/tfrobot_config.md diff --git a/collections/documentation/developers/tfrobot/tfrobot_configurations.md b/collections/tfmanual/documentation/developers/tfrobot/tfrobot_configurations.md similarity index 100% rename from collections/documentation/developers/tfrobot/tfrobot_configurations.md rename to collections/tfmanual/documentation/developers/tfrobot/tfrobot_configurations.md diff --git a/collections/documentation/developers/tfrobot/tfrobot_deploy.md b/collections/tfmanual/documentation/developers/tfrobot/tfrobot_deploy.md similarity index 100% rename from collections/documentation/developers/tfrobot/tfrobot_deploy.md rename to collections/tfmanual/documentation/developers/tfrobot/tfrobot_deploy.md diff --git a/collections/documentation/developers/tfrobot/tfrobot_installation.md b/collections/tfmanual/documentation/developers/tfrobot/tfrobot_installation.md similarity index 100% rename from collections/documentation/developers/tfrobot/tfrobot_installation.md rename to collections/tfmanual/documentation/developers/tfrobot/tfrobot_installation.md diff --git a/collections/tfmanual/documentation/documentation.md b/collections/tfmanual/documentation/documentation.md new file mode 100644 index 0000000..1724121 --- /dev/null +++ b/collections/tfmanual/documentation/documentation.md @@ -0,0 +1,14 @@ +

ThreeFold Documentation

+ +The section contains all the practical information for farmers, developers and system administrators of the ThreeFold Grid. + +For complementary information on ThreeFold, refer to the [ThreeFold Knowledge Base](../knowledge_base/knowledge_base.md). + +

Table of Contents

+ +- [Dashboard](./dashboard/dashboard.md) +- [Developers](./developers/developers.md) +- [Farmers](./farmers/farmers.md) +- [System Administrators](./system_administrators/system_administrators.md) +- [ThreeFold Token](./threefold_token/threefold_token.md) +- [FAQ](./faq/faq.md) \ No newline at end of file diff --git a/collections/tfmanual/documentation/faq/faq.md b/collections/tfmanual/documentation/faq/faq.md new file mode 100644 index 0000000..511c34d --- /dev/null +++ b/collections/tfmanual/documentation/faq/faq.md @@ -0,0 +1,2480 @@ +

ThreeFold FAQ

+ +

Table of Contents

+ +- [GENERAL FAQ](#general-faq) + - [Basic Facts](#basic-facts) + - [What is the the ThreeFold blockchain?](#what-is-the-the-threefold-blockchain) + - [What is the architecture of the ThreeFold Grid in simple terms?](#what-is-the-architecture-of-the-threefold-grid-in-simple-terms) + - [What is the difference between Internet capacity and connectivity? Does ThreeFold replace my Internet service provider (ISP)?](#what-is-the-difference-between-internet-capacity-and-connectivity-does-threefold-replace-my-internet-service-provider-isp) + - [What are the priorities of ThreeFold (the Three P of ThreeFold)? ThreeFold is a Planet first project, what does it mean?](#what-are-the-priorities-of-threefold-the-three-p-of-threefold-threefold-is-a-planet-first-project-what-does-it-mean) + - [I want to help build the new Internet. How can I become a ThreeFold certified 3node partner?](#i-want-to-help-build-the-new-internet-how-can-i-become-a-threefold-certified-3node-partner) + - [How can I create a twin on the TF Grid?](#how-can-i-create-a-twin-on-the-tf-grid) + - [ThreeFold Communication](#threefold-communication) + - [Is there a ThreeFold app for mobile?](#is-there-a-threefold-app-for-mobile) + - [I want to reach the ThreeFold community. What are ThreeFold social links?](#i-want-to-reach-the-threefold-community-what-are-threefold-social-links) + - [Could we reach out someone for publishing research work on ThreeFold?](#could-we-reach-out-someone-for-publishing-research-work-on-threefold) + - [Who can I write to for a proposal? Where can I send a proposal email for a new partnership opportunity with ThreeFold?](#who-can-i-write-to-for-a-proposal-where-can-i-send-a-proposal-email-for-a-new-partnership-opportunity-with-threefold) + - [How can I track and follow the progress and development of ThreeFold?](#how-can-i-track-and-follow-the-progress-and-development-of-threefold) + - [Why do some forum posts need to be approved?](#why-do-some-forum-posts-need-to-be-approved) + - [The Technology of ThreeFold](#the-technology-of-threefold) + - [What is a 3Node?](#what-is-a-3node) + - [What is the difference between a 3node and a ThreeFold farm?](#what-is-the-difference-between-a-3node-and-a-threefold-farm) + - [What is Zero-OS from ThreeFold?](#what-is-zero-os-from-threefold) + - [ThreeFold uses Quantum Safe Storage technology, what does it mean?](#threefold-uses-quantum-safe-storage-technology-what-does-it-mean) + - [Quantum Safe File System (QSFS) allows for part of the storage to go down and it can self repair, however it’s still attached to a single VM and a single point of failure. Can a QSFS instance be reattached to another VM to recover it?](#quantum-safe-file-system-qsfs-allows-for-part-of-the-storage-to-go-down-and-it-can-self-repair-however-its-still-attached-to-a-single-vm-and-a-single-point-of-failure-can-a-qsfs-instance-be-reattached-to-another-vm-to-recover-it) + - [Where does the ThreeFold Explorer take its data from?](#where-does-the-threefold-explorer-take-its-data-from) + - [How can I use the Gridproxy to query information on the TF Grid?](#how-can-i-use-the-gridproxy-to-query-information-on-the-tf-grid) + - [How can I see the stats of the ThreeFold Grid?](#how-can-i-see-the-stats-of-the-threefold-grid) + - [What is the difference between a seed phrase (mnemonics) and an HEX secret?](#what-is-the-difference-between-a-seed-phrase-mnemonics-and-an-hex-secret) + - [Buying and Transacting TFT](#buying-and-transacting-tft) + - [How long does it take when you use the BSC-Stellar Bridge?](#how-long-does-it-take-when-you-use-the-bsc-stellar-bridge) + - [On my website, users can donate TFT on the Stellar Chain. Is there a way for users on my website to easily track the total sum of TFT donated?](#on-my-website-users-can-donate-tft-on-the-stellar-chain-is-there-a-way-for-users-on-my-website-to-easily-track-the-total-sum-of-tft-donated) + - [TF Connect App, TF Dashboard, GraphQL, Grix Proxy and Polkadot Substrate](#tf-connect-app-tf-dashboard-graphql-grix-proxy-and-polkadot-substrate) + - [Is there a way to create or import another wallet in TF Connect App?](#is-there-a-way-to-create-or-import-another-wallet-in-tf-connect-app) + - [I created a farm on the TF Chain. On the TF Connect App Farmer Migration section, my farm is under Other v3 farms, is this normal?](#i-created-a-farm-on-the-tf-chain-on-the-tf-connect-app-farmer-migration-section-my-farm-is-under-other-v3-farms-is-this-normal) + - [I am trying to access my wallet in the ThreeFold Connect App. It worked fine before, but now I just get a white screen. What does it mean and what can I do?](#i-am-trying-to-access-my-wallet-in-the-threefold-connect-app-it-worked-fine-before-but-now-i-just-get-a-white-screen-what-does-it-mean-and-what-can-i-do) + - [When I open the ThreeFold Connect App, I get the error: Error in initialization in Flagsmith. How can I fix this issue?](#when-i-open-the-threefold-connect-app-i-get-the-error-error-in-initialization-in-flagsmith-how-can-i-fix-this-issue) + - [Apart form the ThreeFold Connect App Wallet, how can I check my TFT balance?](#apart-form-the-threefold-connect-app-wallet-how-can-i-check-my-tft-balance) + - [Is it possible to export the transaction history of a wallet to a CSV file?](#is-it-possible-to-export-the-transaction-history-of-a-wallet-to-a-csv-file) + - [How can I use GraphQl to find information on the ThreeFold Grid?](#how-can-i-use-graphql-to-find-information-on-the-threefold-grid) + - [What are the different links to ThreeFold's Graph QL depending on the network?](#what-are-the-different-links-to-threefolds-graph-ql-depending-on-the-network) + - [How can I find 3Nodes with IPv6 addresses?](#how-can-i-find-3nodes-with-ipv6-addresses) + - [How can I use GraphQL to see contracts on my 3Nodes?](#how-can-i-use-graphql-to-see-contracts-on-my-3nodes) + - [How can I use Grid Proxy to find information on the ThreeFold Grid and 3Nodes?](#how-can-i-use-grid-proxy-to-find-information-on-the-threefold-grid-and-3nodes) + - [Who is hosting GraphQL and Grid Proxy on the ThreeFold Grid?](#who-is-hosting-graphql-and-grid-proxy-on-the-threefold-grid) + - [What is the difference between uptime, status and power state?](#what-is-the-difference-between-uptime-status-and-power-state) + - [I do not remember the name (ThreeFold 3bot ID) associated with my seed phrase on the ThreeFold Connect app. Can I recover my TF Connect app account with only the seed phrase and not the name (3bot ID) associated with it?](#i-do-not-remember-the-name-threefold-3bot-id-associated-with-my-seed-phrase-on-the-threefold-connect-app-can-i-recover-my-tf-connect-app-account-with-only-the-seed-phrase-and-not-the-name-3bot-id-associated-with-it) +- [USERS FAQ](#users-faq) + - [TF Grid Functionalities](#tf-grid-functionalities) + - [What are the type of storage available on TF Grid?](#what-are-the-type-of-storage-available-on-tf-grid) + - [Deployments on the ThreeFold Grid](#deployments-on-the-threefold-grid) + - [Does the ThreeFold Grid charge the total resources rented or it only charges the resources used during deployment?](#does-the-threefold-grid-charge-the-total-resources-rented-or-it-only-charges-the-resources-used-during-deployment) + - [Do I pay for Internet traffic while deploying workloads on IPv4, IPv6 or Planetary Network?](#do-i-pay-for-internet-traffic-while-deploying-workloads-on-ipv4-ipv6-or-planetary-network) + - [What is the monthly cost for an IPv4 or an IPv6 public address on the ThreeFold Grid?](#what-is-the-monthly-cost-for-an-ipv4-or-an-ipv6-public-address-on-the-threefold-grid) + - [What are the differences between a container, a micro virtual machine and a full virtual machine (VM)?](#what-are-the-differences-between-a-container-a-micro-virtual-machine-and-a-full-virtual-machine-vm) + - [What is a 3Node gateway? How can I configure a 3Node as a gateway node?](#what-is-a-3node-gateway-how-can-i-configure-a-3node-as-a-gateway-node) + - [When connecting remotely with SSH, I get the following error: "WARNING: REMOTE HOST IDENTIFICATION HAS CHANGED!...". What can I do to fix this?](#when-connecting-remotely-with-ssh-i-get-the-following-error-warning-remote-host-identification-has-changed-what-can-i-do-to-fix-this) + - [How can I remove one host from known\_hosts?](#how-can-i-remove-one-host-from-known_hosts) + - [How can I add ThreeFold peers in the Yggdrasil configuration file?](#how-can-i-add-threefold-peers-in-the-yggdrasil-configuration-file) + - [How can I see Yggdrasil/Planetary Network's peers?](#how-can-i-see-yggdrasilplanetary-networks-peers) + - [How can I ping an Yggdrasil IP or IPv6 address?](#how-can-i-ping-an-yggdrasil-ip-or-ipv6-address) + - [Is there a way to test if I am properly connected to the Yggdrasil network (Planetary Network)?](#is-there-a-way-to-test-if-i-am-properly-connected-to-the-yggdrasil-network-planetary-network) + - [How can I change the username of my SSH key?](#how-can-i-change-the-username-of-my-ssh-key) + - [What is ThreeFold's stance on sharded workload? Will ThreeFold embrace and move towards distributed data chunks or stay with the one deployment, one node model?](#what-is-threefolds-stance-on-sharded-workload-will-threefold-embrace-and-move-towards-distributed-data-chunks-or-stay-with-the-one-deployment-one-node-model) + - [Tutorials and Guides](#tutorials-and-guides) + - [What is the minimum amount of TFT to deploy a Presearch node? How can I get a TFT discount when I deploy a Presearch node?](#what-is-the-minimum-amount-of-tft-to-deploy-a-presearch-node-how-can-i-get-a-tft-discount-when-i-deploy-a-presearch-node) + - [Can I use the same seed phrase for my mainnet and testnest accounts? How can I transfer my TFT from mainnet to testnet or vice versa?](#can-i-use-the-same-seed-phrase-for-my-mainnet-and-testnest-accounts-how-can-i-transfer-my-tft-from-mainnet-to-testnet-or-vice-versa) + - [Do I need a full or micro virtual machine (VM) when I run QSFS, quantum safe file system, on the ThreeFold Grid?](#do-i-need-a-full-or-micro-virtual-machine-vm-when-i-run-qsfs-quantum-safe-file-system-on-the-threefold-grid) + - [Linux, Github, Containers and More](#linux-github-containers-and-more) + - [Where should I start to learn more about Linux?](#where-should-i-start-to-learn-more-about-linux) + - [How can I clone a single branch of a repository on Github?](#how-can-i-clone-a-single-branch-of-a-repository-on-github) + - [Grace Period (Status Paused)](#grace-period-status-paused) + - [The status of my deployment is paused, in grace period, how can I resume the deployment?](#the-status-of-my-deployment-is-paused-in-grace-period-how-can-i-resume-the-deployment) + - [Once I refund my TF wallet, how long does it take for the deployment to resume from grace period?](#once-i-refund-my-tf-wallet-how-long-does-it-take-for-the-deployment-to-resume-from-grace-period) + - [Can I SSH into my deployments when they are in grace period (i.e. when their status is paused)?](#can-i-ssh-into-my-deployments-when-they-are-in-grace-period-ie-when-their-status-is-paused) + - [How long is the grace period (i.e. when the deployment status is paused)?](#how-long-is-the-grace-period-ie-when-the-deployment-status-is-paused) + - [Terraform](#terraform) + - [Working with Terraform, I get the following error: failed to create contract: ContractIsNotUnique. Is there a fix to this issue?](#working-with-terraform-i-get-the-following-error-failed-to-create-contract-contractisnotunique-is-there-a-fix-to-this-issue) + - [I am working with Terraform. What do I have to write in the file env.tfvars?](#i-am-working-with-terraform-what-do-i-have-to-write-in-the-file-envtfvars) + - [I am working with Terraform and I am using the example in Terraform Provider Grid. How can I use the example main.tf file with environment variables? Why am I getting the message Error: account not found, when deploying with Terraform?](#i-am-working-with-terraform-and-i-am-using-the-example-in-terraform-provider-grid-how-can-i-use-the-example-maintf-file-with-environment-variables-why-am-i-getting-the-message-error-account-not-found-when-deploying-with-terraform) + - [Users Troubleshooting and Error Messages](#users-troubleshooting-and-error-messages) + - [When deploying a virtual machine (VM) on the ThreeFold Grid, I get the following message after trying a full system update and upgrade: GRUB failed to install to the following devices... Is there a fix to this issue?](#when-deploying-a-virtual-machine-vm-on-the-threefold-grid-i-get-the-following-message-after-trying-a-full-system-update-and-upgrade-grub-failed-to-install-to-the-following-devices-is-there-a-fix-to-this-issue) + - [While deploying on the TF Dashboard, I get the following error :"global workload with the same name exists: conflict". What can I do to fix this issue?](#while-deploying-on-the-tf-dashboard-i-get-the-following-error-global-workload-with-the-same-name-exists-conflict-what-can-i-do-to-fix-this-issue) + - [ThreeFold Connect App](#threefold-connect-app) + - [TF Connect App is now asking for a 4-digit password (PIN). I don't remember it as I usually use touch or face ID to unlock the app. What can I do?](#tf-connect-app-is-now-asking-for-a-4-digit-password-pin-i-dont-remember-it-as-i-usually-use-touch-or-face-id-to-unlock-the-app-what-can-i-do) + - [Is there a way to have more than one wallet in TF Connect App?](#is-there-a-way-to-have-more-than-one-wallet-in-tf-connect-app) + - [What is the difference between 10.x.y.z and 192.168.x.y addresses?](#what-is-the-difference-between-10xyz-and-192168xy-addresses) +- [DEVELOPERS FAQ](#developers-faq) + - [General Information for Developer](#general-information-for-developer) + - [Does Zero-OS assign private IPv4 addresses to workloads?](#does-zero-os-assign-private-ipv4-addresses-to-workloads) + - [Why does each 3Node server have two IP addresses associated with it?](#why-does-each-3node-server-have-two-ip-addresses-associated-with-it) + - [Can Zero-OS assign public IPv4 or IPv6 addresses to workloads?](#can-zero-os-assign-public-ipv4-or-ipv6-addresses-to-workloads) + - [What does MAC mean when it comes to networking?](#what-does-mac-mean-when-it-comes-to-networking) + - [I am a developer looking for a way to automatically convert BSC tokens into TFT. Could you please share tips on how to swap regular tokens into TFT, on backend, without and browser extensions, via any platform API?](#i-am-a-developer-looking-for-a-way-to-automatically-convert-bsc-tokens-into-tft-could-you-please-share-tips-on-how-to-swap-regular-tokens-into-tft-on-backend-without-and-browser-extensions-via-any-platform-api) + - [Test Net](#test-net) + - [Can I get some free TFT to test on Test Net](#can-i-get-some-free-tft-to-test-on-test-net) +- [FARMERS FAQ](#farmers-faq) + - [TFT Farming Basics](#tft-farming-basics) + - [My Titan is v2.1 and the ThreeFold Grid is v3., what is the distinction?](#my-titan-is-v21-and-the-threefold-grid-is-v3-what-is-the-distinction) + - [When will I receive the farming rewards for my 3Nodes?](#when-will-i-receive-the-farming-rewards-for-my-3nodes) + - [What is the TFT minting process? Is it fully automated?](#what-is-the-tft-minting-process-is-it-fully-automated) + - [What should I do if I did not receive my farming rewards this month?](#what-should-i-do-if-i-did-not-receive-my-farming-rewards-this-month) + - [What is the TFT entry price of my 3Node farming rewards?](#what-is-the-tft-entry-price-of-my-3node-farming-rewards) + - [What is the necessary uptime for a 3Node per period of one month?](#what-is-the-necessary-uptime-for-a-3node-per-period-of-one-month) + - [How can I check the uptime of my 3Nodes? Is there a tool to check the uptime of 3Node servers on the ThreeFold Grid?](#how-can-i-check-the-uptime-of-my-3nodes-is-there-a-tool-to-check-the-uptime-of-3node-servers-on-the-threefold-grid) + - [I set up a 3Node in the middle of the month, does it affect uptime requirements and rewards?](#i-set-up-a-3node-in-the-middle-of-the-month-does-it-affect-uptime-requirements-and-rewards) + - [What is the difference between a certified and a non-certified 3Node?](#what-is-the-difference-between-a-certified-and-a-non-certified-3node) + - [What are the different certifications available for 3Node servers and farms? What are the Gold and Silver certifications?](#what-are-the-different-certifications-available-for-3node-servers-and-farms-what-are-the-gold-and-silver-certifications) + - [What is the difference between V2 and V3 minting?](#what-is-the-difference-between-v2-and-v3-minting) + - [What is the TFT minting address on Stellar Chain?](#what-is-the-tft-minting-address-on-stellar-chain) + - [Can Titans and DIY 3Nodes share the same farm?](#can-titans-and-diy-3nodes-share-the-same-farm) + - [Do I need one farm for each 3Node?](#do-i-need-one-farm-for-each-3node) + - [Can a single farm be composed of many 3Nodes?](#can-a-single-farm-be-composed-of-many-3nodes) + - [Can a single 3Node be on more than one farm?](#can-a-single-3node-be-on-more-than-one-farm) + - [Do I need one reward address per 3Node?](#do-i-need-one-reward-address-per-3node) + - [How can I access the expert bootstrap mode for Zero-OS?](#how-can-i-access-the-expert-bootstrap-mode-for-zero-os) + - [When it comes to the Zero-OS bootstrap image, can I simply duplicate the first image I burnt when I build another 3Node?](#when-it-comes-to-the-zero-os-bootstrap-image-can-i-simply-duplicate-the-first-image-i-burnt-when-i-build-another-3node) + - [If a node is unused for certain time (e.g. many months offline), will it be erased by the Grid?](#if-a-node-is-unused-for-certain-time-eg-many-months-offline-will-it-be-erased-by-the-grid) + - [Can a farm be erased from TF Grid?](#can-a-farm-be-erased-from-tf-grid) + - [On the ThreeFold Connect App, it says I need to migrate my Titan farm from V2 to V3. What do I have to do? How long does this take?](#on-the-threefold-connect-app-it-says-i-need-to-migrate-my-titan-farm-from-v2-to-v3-what-do-i-have-to-do-how-long-does-this-take) + - [How can I migrate my DIY farm from V2 to V3?](#how-can-i-migrate-my-diy-farm-from-v2-to-v3) + - [What does the pricing policy ID of a farm represent?](#what-does-the-pricing-policy-id-of-a-farm-represent) + - [What is the difference between TiB and TB? Why doesn't the TF Explorer shows the same storage space as my disk?](#what-is-the-difference-between-tib-and-tb-why-doesnt-the-tf-explorer-shows-the-same-storage-space-as-my-disk) + - [Farming Rewards and Related Notions](#farming-rewards-and-related-notions) + - [What are the rewards of farming? Can I get more rewards when my 3Node is being utilized?](#what-are-the-rewards-of-farming-can-i-get-more-rewards-when-my-3node-is-being-utilized) + - [How can I know the potential farming rewards for Grid Utilization?](#how-can-i-know-the-potential-farming-rewards-for-grid-utilization) + - [What is the easiest way to farm ThreeFold tokens (TFT)?](#what-is-the-easiest-way-to-farm-threefold-tokens-tft) + - [When do I receive my rewards?](#when-do-i-receive-my-rewards) + - [Do farming rewards take into account the type of RAM, SSD, HDD and CPU of the 3Node server?](#do-farming-rewards-take-into-account-the-type-of-ram-ssd-hdd-and-cpu-of-the-3node-server) + - [Can I send my farming rewards directly to a crypto exchange?](#can-i-send-my-farming-rewards-directly-to-a-crypto-exchange) + - [Do I need collateral to farm ThreeFold tokens?](#do-i-need-collateral-to-farm-threefold-tokens) + - [Can I add external drives to the 3Nodes to increase rewards and resources available to the ThreeFold Grid?](#can-i-add-external-drives-to-the-3nodes-to-increase-rewards-and-resources-available-to-the-threefold-grid) + - [Do I have access to the TFT rewards I receive each month when farming?](#do-i-have-access-to-the-tft-rewards-i-receive-each-month-when-farming) + - [What is TFTA? Is it still used?](#what-is-tfta-is-it-still-used) + - [Is there a way to certify a DIY 3Node? How can I become a 3Node certified vendor and builder?](#is-there-a-way-to-certify-a-diy-3node-how-can-i-become-a-3node-certified-vendor-and-builder) + - [Does it make sense to make my farm a company?](#does-it-make-sense-to-make-my-farm-a-company) + - [What is the difference between uptime and downtime, and between online and offline, when it comes to 3Nodes?](#what-is-the-difference-between-uptime-and-downtime-and-between-online-and-offline-when-it-comes-to-3nodes) + - [My 3Node server grid utilization is low, is it normal?](#my-3node-server-grid-utilization-is-low-is-it-normal) + - [3Node Farming Requirements](#3node-farming-requirements) + - [Can I host more than one 3Node server at my house?](#can-i-host-more-than-one-3node-server-at-my-house) + - [Is Wifi supported? Can I farm via Wifi instead of an Ethernet cable?](#is-wifi-supported-can-i-farm-via-wifi-instead-of-an-ethernet-cable) + - [I have 2 routers with each a different Internet service provider. I disconnected the ethernet cable from one router and connected it to the other router. Do I need to reboot the 3Node?](#i-have-2-routers-with-each-a-different-internet-service-provider-i-disconnected-the-ethernet-cable-from-one-router-and-connected-it-to-the-other-router-do-i-need-to-reboot-the-3node) + - [Do I need any specific port configuration when booting a 3Node?](#do-i-need-any-specific-port-configuration-when-booting-a-3node) + - [How much electricity does a 3Node use?](#how-much-electricity-does-a-3node-use) + - [Has anyone run stress tests to know the power consumption at heavy load of certain 3Nodes?](#has-anyone-run-stress-tests-to-know-the-power-consumption-at-heavy-load-of-certain-3nodes) + - [Can the Titan 3Node be run on PoE? (Power Over Ethernet)](#can-the-titan-3node-be-run-on-poe-power-over-ethernet) + - [What is the relationship between the 3Node's resources and bandwidth?](#what-is-the-relationship-between-the-3nodes-resources-and-bandwidth) + - [What is the bandwidth needed when it comes to running 3Nodes on the Grid?](#what-is-the-bandwidth-needed-when-it-comes-to-running-3nodes-on-the-grid) + - [Can I run Zero-OS on a virtual machine?](#can-i-run-zero-os-on-a-virtual-machine) + - [Is it possible to build a DIY 3Node with VMWare VM ?](#is-it-possible-to-build-a-diy-3node-with-vmware-vm-) + - [Can I run a 3Node on another operating system, like Windows, MAC or Linux?](#can-i-run-a-3node-on-another-operating-system-like-windows-mac-or-linux) + - [What is the minimum SSD requirement for a 3Node server to farm ThreeFold tokens (TFT)?](#what-is-the-minimum-ssd-requirement-for-a-3node-server-to-farm-threefold-tokens-tft) + - [Is it possible to have a 3Node server running on only HDD disks?](#is-it-possible-to-have-a-3node-server-running-on-only-hdd-disks) + - [Building a 3Node - Steps and Details](#building-a-3node---steps-and-details) + - [How can I be sure that I properly wiped my disks?](#how-can-i-be-sure-that-i-properly-wiped-my-disks) + - [If I wipe my disk to create a new node ID, will I lose my farming rewards during the month?](#if-i-wipe-my-disk-to-create-a-new-node-id-will-i-lose-my-farming-rewards-during-the-month) + - [My disks have issues with Zero-OS and my 3Nodes. How can I do a factory reset of the disks?](#my-disks-have-issues-with-zero-os-and-my-3nodes-how-can-i-do-a-factory-reset-of-the-disks) + - [Before doing a bootstrap image, I need to format my USB key. How can I format my USB key?](#before-doing-a-bootstrap-image-i-need-to-format-my-usb-key-how-can-i-format-my-usb-key) + - [What do you use to burn (or to load) the Zero-OS bootstrap image onto a USB stick?](#what-do-you-use-to-burn-or-to-load-the-zero-os-bootstrap-image-onto-a-usb-stick) + - [Should I do a UEFI image or a BIOS image to bootstrap Zero-OS?](#should-i-do-a-uefi-image-or-a-bios-image-to-bootstrap-zero-os) + - [How do I set the BIOS or UEFI of my 3Node?](#how-do-i-set-the-bios-or-uefi-of-my-3node) + - [For my 3Node server, do I need to enable virtualization in BIOS or UEFI?](#for-my-3node-server-do-i-need-to-enable-virtualization-in-bios-or-uefi) + - [How can I boot a 3Node server with a Zero-OS bootstrap image?](#how-can-i-boot-a-3node-server-with-a-zero-os-bootstrap-image) + - [The first time I booted my 3Node server, it says that the node is not registered yet. What can I do?](#the-first-time-i-booted-my-3node-server-it-says-that-the-node-is-not-registered-yet-what-can-i-do) + - [The first time I boot my 3Node, the node gets registered but it says cache disk : no ssd. What can I do?](#the-first-time-i-boot-my-3node-the-node-gets-registered-but-it-says-cache-disk--no-ssd-what-can-i-do) + - [The first time I boot my 3 node, the node gets registered and it says cache disk : OK, but the table System Used Capacity is empty. What can I do?](#the-first-time-i-boot-my-3-node-the-node-gets-registered-and-it-says-cache-disk--ok-but-the-table-system-used-capacity-is-empty-what-can-i-do) + - [I have a relatively old server (e.g. Dell R710 or R620, Z840). I have trouble booting Zero-OS. What could I do?](#i-have-a-relatively-old-server-eg-dell-r710-or-r620-z840-i-have-trouble-booting-zero-os-what-could-i-do) + - [I connected a SATA SSD to a CD-DVD optical drive adaptor. My system does not recognize the disk. What can I do?](#i-connected-a-sata-ssd-to-a-cd-dvd-optical-drive-adaptor-my-system-does-not-recognize-the-disk-what-can-i-do) + - [Can someone explain what should I put in the Public IP part of my farm? Should I just insert my Public IP and Gateway (given by my ISP)?](#can-someone-explain-what-should-i-put-in-the-public-ip-part-of-my-farm-should-i-just-insert-my-public-ip-and-gateway-given-by-my-isp) + - [Farming Optimization](#farming-optimization) + - [What is the difference between a ThreeFold 3Node and a ThreeFold farm? What is the difference between the farm ID and the node ID?](#what-is-the-difference-between-a-threefold-3node-and-a-threefold-farm-what-is-the-difference-between-the-farm-id-and-the-node-id) + - [How can I know how many GB of SSD and RAM do I need?](#how-can-i-know-how-many-gb-of-ssd-and-ram-do-i-need) + - [What is the optimal ratio of virtual cores (vcores or threads), SSD storage and RAM memory? What is the best optimization scenario for a 3Node, in terms of ThreeFold tokens (TFT) farming rewards?](#what-is-the-optimal-ratio-of-virtual-cores-vcores-or-threads-ssd-storage-and-ram-memory-what-is-the-best-optimization-scenario-for-a-3node-in-terms-of-threefold-tokens-tft-farming-rewards) + - [What does TBW mean? What is a good TBW level for a SSD disk?](#what-does-tbw-mean-what-is-a-good-tbw-level-for-a-ssd-disk) + - [Are SATA and SAS drives interchangeable?](#are-sata-and-sas-drives-interchangeable) + - [What is the speed difference between SAS and SATA disks?](#what-is-the-speed-difference-between-sas-and-sata-disks) + - [Is it possible to do a graceful shutdown to a 3Node server? How can you shutdown or power off a 3Node server?](#is-it-possible-to-do-a-graceful-shutdown-to-a-3node-server-how-can-you-shutdown-or-power-off-a-3node-server) + - [Is it possible to have direct access to Zero-OS's core to force a reboot?](#is-it-possible-to-have-direct-access-to-zero-oss-core-to-force-a-reboot) + - [Do I need some port forwarding in my router for each 3Node server?](#do-i-need-some-port-forwarding-in-my-router-for-each-3node-server) + - [Are there ways to reduce 3Node servers' noises?](#are-there-ways-to-reduce-3node-servers-noises) + - [I built a 3Node out of old hardware. Is it possible that my BIOS or UEFI has improper time and date set as factory default?](#i-built-a-3node-out-of-old-hardware-is-it-possible-that-my-bios-or-uefi-has-improper-time-and-date-set-as-factory-default) + - [I have rack servers in my ThreeFold farm. Can I set rack servers vertically?](#i-have-rack-servers-in-my-threefold-farm-can-i-set-rack-servers-vertically) + - [Farming and Maintenance](#farming-and-maintenance) + - [How can I check if there is utilization on my 3Nodes?](#how-can-i-check-if-there-is-utilization-on-my-3nodes) + - [Do I need the Zero-OS bootstrap image drive (USB or CD-DVD) when I reboot, or can I boot Zero-OS from the 3Node main hard drive?](#do-i-need-the-zero-os-bootstrap-image-drive-usb-or-cd-dvd-when-i-reboot-or-can-i-boot-zero-os-from-the-3node-main-hard-drive) + - [It's written that my node is using 100% of HRU. What does it mean?](#its-written-that-my-node-is-using-100-of-hru-what-does-it-mean) + - [On the ThreeFold Node Finder, I only see half of the virtual cores or threads my 3Node has, what can I do?](#on-the-threefold-node-finder-i-only-see-half-of-the-virtual-cores-or-threads-my-3node-has-what-can-i-do) + - [Why are the 3Nodes' resources different on the ThreeFold Node Finder and the ThreeFold Dashboard?](#why-are-the-3nodes-resources-different-on-the-threefold-node-finder-and-the-threefold-dashboard) + - [How can I test the health of my disks?](#how-can-i-test-the-health-of-my-disks) + - [How can I transfer my 3Node from one farm to another?](#how-can-i-transfer-my-3node-from-one-farm-to-another) + - [What do CRU, MRU, HRU and SRU mean on the ThreeFold Node Finder?](#what-do-cru-mru-hru-and-sru-mean-on-the-threefold-node-finder) + - [I have more than one ThreeFold 3Node farm, but I want all my 3Nodes on only one farm. How can I put all my 3Nodes on one farm? How can I change the farm ID of my 3Node?](#i-have-more-than-one-threefold-3node-farm-but-i-want-all-my-3nodes-on-only-one-farm-how-can-i-put-all-my-3nodes-on-one-farm-how-can-i-change-the-farm-id-of-my-3node) + - [How can I know if my 3Node is online on the Grid?](#how-can-i-know-if-my-3node-is-online-on-the-grid) + - [I booted my 3Node and the monitor says it's online and connected to the Grid. But the ThreeFold Node Finder says it is offline? What can I do?](#i-booted-my-3node-and-the-monitor-says-its-online-and-connected-to-the-grid-but-the-threefold-node-finder-says-it-is-offline-what-can-i-do) + - [My 3Node does show on the ThreeFold Node Finder, but not on the ThreeFold Dashboard, what can I do?](#my-3node-does-show-on-the-threefold-node-finder-but-not-on-the-threefold-dashboard-what-can-i-do) + - [If I upgrade my 3Node, will it increase my rewards?](#if-i-upgrade-my-3node-will-it-increase-my-rewards) + - [I booted my 3Node for the first time at the beginning of the month, then I did some upgrade or downgrade, will the ThreeFold Grid recognize the new hardware? Will it still be the same 3Node ID?](#i-booted-my-3node-for-the-first-time-at-the-beginning-of-the-month-then-i-did-some-upgrade-or-downgrade-will-the-threefold-grid-recognize-the-new-hardware-will-it-still-be-the-same-3node-id) + - [Is it possible to ask the 3Node to refetch the node information on the monitor?](#is-it-possible-to-ask-the-3node-to-refetch-the-node-information-on-the-monitor) + - [When does Zero-OS detect the capacity of a 3Node?](#when-does-zero-os-detect-the-capacity-of-a-3node) + - [Where is the 3Node ID stored?](#where-is-the-3node-id-stored) + - [Is there a way to backup my node ID in order to restore a 3Node if the disk with the node ID gets corrupted or breaks down?](#is-there-a-way-to-backup-my-node-id-in-order-to-restore-a-3node-if-the-disk-with-the-node-id-gets-corrupted-or-breaks-down) + - [If I upgrade my 3Node, does it change the node ID?](#if-i-upgrade-my-3node-does-it-change-the-node-id) + - [Does it make sense to recreate my node when the price drops?](#does-it-make-sense-to-recreate-my-node-when-the-price-drops) + - [My 3Node lost power momentarily and I had to power it back on manually. Is there a better way to proceed?](#my-3node-lost-power-momentarily-and-i-had-to-power-it-back-on-manually-is-there-a-better-way-to-proceed) + - [Do I need to change the battery BIOS?](#do-i-need-to-change-the-battery-bios) + - [Do I need to enable UEFI Network Stack?](#do-i-need-to-enable-uefi-network-stack) + - [I want redundancy of power for my 3 nodes. I have two PSU on my Dell server. What can I do?](#i-want-redundancy-of-power-for-my-3-nodes-i-have-two-psu-on-my-dell-server-what-can-i-do) + - [Why isn't there support for RAID? Does Zero-OS work with RAID?](#why-isnt-there-support-for-raid-does-zero-os-work-with-raid) + - [Is there a way to bypass RAID in order for Zero-OS to have bare metals on the system? (No RAID controller in between storage and the Grid.)](#is-there-a-way-to-bypass-raid-in-order-for-zero-os-to-have-bare-metals-on-the-system-no-raid-controller-in-between-storage-and-the-grid) + - [I have a 3Node rack server. Is it possible to use a M.2 to SATA adapter in order to put the M.2 SATA disk in the HDD bay (onboard storage)?](#i-have-a-3node-rack-server-is-it-possible-to-use-a-m2-to-sata-adapter-in-order-to-put-the-m2-sata-disk-in-the-hdd-bay-onboard-storage) + - [My 3Node uses only PCIe adapters and SSD NVME disks. Do I need the RAID controller on?](#my-3node-uses-only-pcie-adapters-and-ssd-nvme-disks-do-i-need-the-raid-controller-on) + - [Can I change the name of my farm on polkadot.js?](#can-i-change-the-name-of-my-farm-on-polkadotjs) + - [How can I delete a farm on polkadot.js?](#how-can-i-delete-a-farm-on-polkadotjs) + - [I try to delete a node on the TF Dashboard, but it doesn’t work. Is there any other way to proceed that could work?](#i-try-to-delete-a-node-on-the-tf-dashboard-but-it-doesnt-work-is-there-any-other-way-to-proceed-that-could-work) + - [My 3Node has 2 ethernet ports in the back, with one written AMT above, what does it mean? Can I use this port to connect my 3Node to the ThreeFold Grid?](#my-3node-has-2-ethernet-ports-in-the-back-with-one-written-amt-above-what-does-it-mean-can-i-use-this-port-to-connect-my-3node-to-the-threefold-grid) + - [My 3Node is based on a the hardware Z600, Z620 or Z820, can I run it headless or without a GPU?](#my-3node-is-based-on-a-the-hardware-z600-z620-or-z820-can-i-run-it-headless-or-without-a-gpu) + - [Is it possible to add high-level GPU on rack servers to farm more TFT?](#is-it-possible-to-add-high-level-gpu-on-rack-servers-to-farm-more-tft) + - [If I change farm, will my node IDs change on my 3Node servers?](#if-i-change-farm-will-my-node-ids-change-on-my-3node-servers) + - [Troubleshooting and Error Messages](#troubleshooting-and-error-messages) + - [Is it possible to access the Error Screen or Log Screen?](#is-it-possible-to-access-the-error-screen-or-log-screen) + - [What does it mean when I see, during the 3Node boot, the message: error = context deadline exceeded?](#what-does-it-mean-when-i-see-during-the-3node-boot-the-message-error--context-deadline-exceeded) + - [I try to boot a 3Node, but I get the error: "No Route to Host on Linux". What does it mean?](#i-try-to-boot-a-3node-but-i-get-the-error-no-route-to-host-on-linux-what-does-it-mean) + - [How can I fix the error: "Network configuration succeed but Zero-OS kernel could not be downloaded" when booting a 3Node?](#how-can-i-fix-the-error-network-configuration-succeed-but-zero-os-kernel-could-not-be-downloaded-when-booting-a-3node) + - [Using SAS disks, I get the error; "No ssd found, failed to register". What can I do to fix this?](#using-sas-disks-i-get-the-error-no-ssd-found-failed-to-register-what-can-i-do-to-fix-this) + - [When booting a 3Node, how to fix the error: "no disks: registration failed"?](#when-booting-a-3node-how-to-fix-the-error-no-disks-registration-failed) + - [My SSD is sometimes detected as HDD by Zero-OS when there is a reboot. Is there a fix or a way to test the SSD disk?](#my-ssd-is-sometimes-detected-as-hdd-by-zero-os-when-there-is-a-reboot-is-there-a-fix-or-a-way-to-test-the-ssd-disk) + - [When booting a 3Node, I get the message: failed to register node: failed to create node: failed to submit extrinsic: Invalid Transaction: registration failed. What could fix this?](#when-booting-a-3node-i-get-the-message-failed-to-register-node-failed-to-create-node-failed-to-submit-extrinsic-invalid-transaction-registration-failed-what-could-fix-this) + - [I try to boot a 3Node, but I get the message no route with default gateway found. What does it mean?](#i-try-to-boot-a-3node-but-i-get-the-message-no-route-with-default-gateway-found-what-does-it-mean) + - [I have trouble connecting the 3Node to the Grid with a 10GB NIC card. What can I do?](#i-have-trouble-connecting-the-3node-to-the-grid-with-a-10gb-nic-card-what-can-i-do) + - [I switch the ethernet cable to a different port when my 3Node was running. Internet connection is lost. What can I do?](#i-switch-the-ethernet-cable-to-a-different-port-when-my-3node-was-running-internet-connection-is-lost-what-can-i-do) + - [I get the error Certificate is not yet valid when booting my 3Node server, what can I do?](#i--get-the-error-certificate-is-not-yet-valid-when-booting-my-3node-server-what-can-i-do) + - [When running wipefs to wipe my disks on Linux, I get either of the following errors: "syntax error near unexpected token" or "Probing Initialized Failed". Is there a fix?](#when-running-wipefs-to-wipe-my-disks-on-linux-i-get-either-of-the-following-errors-syntax-error-near-unexpected-token-or-probing-initialized-failed-is-there-a-fix) + - [I did a format on my SSD disk, but Zero-OS still does not recognize them. What's wrong?](#i-did-a-format-on-my-ssd-disk-but-zero-os-still-does-not-recognize-them-whats-wrong) + - [I have a Dell Rx10 server (R610, 710, 910). When I boot Zero-OS I get the message Probing EDD and the 3Node doesn't boot from there. What can I do?](#i-have-a-dell-rx10-server-r610-710-910-when-i-boot-zero-os-i-get-the-message-probing-edd-and-the-3node-doesnt-boot-from-there-what-can-i-do) + - [My 3Node doesn't boot properly without a monitor plugged in. What can I do?](#my-3node-doesnt-boot-properly-without-a-monitor-plugged-in-what-can-i-do) + - [My 3Node is running on the Grid, but when I plugged in the monitor, it states: Disabling IR #16. Is there a problem?](#my-3node-is-running-on-the-grid-but-when-i-plugged-in-the-monitor-it-states-disabling-ir-16-is-there-a-problem) + - [My 3Node won't boot without disabling the Secure Boot option, is it safe?](#my-3node-wont-boot-without-disabling-the-secure-boot-option-is-it-safe) + - [When I tried to boot my 3Node, at some point the screen went black, with or without a blinking hyphen or dash. What could cause this and what could I do to resolve the issue?](#when-i-tried-to-boot-my-3node-at-some-point-the-screen-went-black-with-or-without-a-blinking-hyphen-or-dash-what-could-cause-this-and-what-could-i-do-to-resolve-the-issue) + - [My 3Nodes go offline after a modem reboot. Is there a way to prevent this?](#my-3nodes-go-offline-after-a-modem-reboot-is-there-a-way-to-prevent-this) + - [When I boot my 3Node, it reaches the Welcome to Zero-OS window, but it doesn't boot properly and there's an error message: failed to load object : type substrate..., what can I do?](#when-i-boot-my-3node-it-reaches-the-welcome-to-zero-os-window-but-it-doesnt-boot-properly-and-theres-an-error-message-failed-to-load-object--type-substrate-what-can-i-do) + - [When I try to access iDRAC on a web browswer, even with protected mode off, I get the error The webpage cannot be found, what can I do?](#when-i-try-to-access-idrac-on-a-web-browswer-even-with-protected-mode-off-i-get-the-error-the-webpage-cannot-be-found-what-can-i-do) + - [When booting the 3Node, I get the error Network interface detected but autoconfiguration failed. What can I do?](#when-booting-the-3node-i-get-the-error-network-interface-detected-but-autoconfiguration-failed-what-can-i-do) + - [When I boot my Dell server, I get the message: All of the disks from your previous configuration are gone... Press any key to continue or 'C' to load the configuration utility. What can I do?](#when-i-boot-my-dell-server-i-get-the-message-all-of-the-disks-from-your-previous-configuration-are-gone-press-any-key-to-continue-or-c-to-load-the-configuration-utility-what-can-i-do) + - [I have a Dell R620. In Zero-OS, I get the failure message No network card found and then the 3Node reebots after few seconds. The same happens for every LAN input. What can I do?](#i-have-a-dell-r620-in-zero-os-i-get-the-failure-message-no-network-card-found-and-then-the-3node-reebots-after-few-seconds-the-same-happens-for-every-lan-input-what-can-i-do) + - [I am using freeDos to crossflash my raid controller on a Dell server, but I can't see the RAID controller with the Command Info. What can I do?](#i-am-using-freedos-to-crossflash-my-raid-controller-on-a-dell-server-but-i-cant-see-the-raid-controller-with-the-command-info-what-can-i-do) + - [Can I use a VGA to HDMI adaptor to connect a TV screen or monitor to the 3Node? I tried to boot a 3Node with a VGA to HDMI adaptor but the boot fails, what can I do?](#can-i-use-a-vga-to-hdmi-adaptor-to-connect-a-tv-screen-or-monitor-to-the-3node-i-tried-to-boot-a-3node-with-a-vga-to-hdmi-adaptor-but-the-boot-fails-what-can-i-do) + - [When I try to boot my 3Node, the fans start spinning fast with a loud noise and the screen is black. What can I do to resolve this?](#when-i-try-to-boot-my-3node-the-fans-start-spinning-fast-with-a-loud-noise-and-the-screen-is-black-what-can-i-do-to-resolve-this) + - [When booting Zero-OS with IPV6 configurations, I get the errors (1) dial tcp: address IPV6-address too many columns in address and (2) no pools matches key: not routable. What can I do to fix this issue?](#when-booting-zero-os-with-ipv6-configurations-i-get-the-errors-1-dial-tcp-address-ipv6-address-too-many-columns-in-address-and-2-no-pools-matches-key-not-routable-what-can-i-do-to-fix-this-issue) + - [When booting a 3Node, Zero-OS downloads fine, but then I get the message: error no route with default gateway found, and the message: info check if interface has a cable plugged in. What could fix this?](#when-booting-a-3node-zero-os-downloads-fine-but-then-i-get-the-message-error-no-route-with-default-gateway-found-and-the-message-info-check-if-interface-has-a-cable-plugged-in-what-could-fix-this) + - [How can I update Dell and HP servers to Intel E5-2600v2, E5-2400v2 and E5-4600v2, when applicable?](#how-can-i-update-dell-and-hp-servers-to-intel-e5-2600v2-e5-2400v2-and-e5-4600v2-when-applicable) + - [How can I update the firmware and driver of a Dell PowerEdge server?](#how-can-i-update-the-firmware-and-driver-of-a-dell-poweredge-server) + - [When I boot a 3Node in UEFI mode, it gets stuck at: Initializing Network Device, is there a way to fix this?](#when-i-boot-a-3node-in-uefi-mode-it-gets-stuck-at-initializing-network-device-is-there-a-way-to-fix-this) + - [When I boot my 3Node, it gets stuck during the Zero-OS download. It never reaches 100%. What can I do to fix this issue?](#when-i-boot-my-3node-it-gets-stuck-during-the-zero-os-download-it-never-reaches-100-what-can-i-do-to-fix-this-issue) + - [When booting a 3Node, I get the error=“context deadline exceeded” module=network error=failed to initialize rmb api failed to initialized admin mw: failed to get farm: farm not found: object not found. What can I do to fix this issue?](#when-booting-a-3node-i-get-the-errorcontext-deadline-exceeded-modulenetwork-errorfailed-to-initialize-rmb-api-failed-to-initialized-admin-mw-failed-to-get-farm-farm-not-found-object-not-found-what-can-i-do-to-fix-this-issue) + - [ThreeFold Grid and Data](#threefold-grid-and-data) + - [How is the farming minting reward calculated? Is the Grid always monitoring my 3Node?](#how-is-the-farming-minting-reward-calculated-is-the-grid-always-monitoring-my-3node) + - [How does communication happen on the ThreeFold Grid at the 3Node's level?](#how-does-communication-happen-on-the-threefold-grid-at-the-3nodes-level) + - [What is the ThreeFold Node Status bot Telegram link?](#what-is-the-threefold-node-status-bot-telegram-link) + - [How does the ThreeFold Node Status bot work? How can I use the ThreeFold Node Status bot to verify if my 3Node is online?](#how-does-the-threefold-node-status-bot-work-how-can-i-use-the-threefold-node-status-bot-to-verify-if-my-3node-is-online) + - [How does the Telegram Status Bot get information from my 3Node? My 3Node is online on the ThreeFold Node Finder, but offline on the Telegram Status Bot, is this normal?](#how-does-the-telegram-status-bot-get-information-from-my-3node-my-3node-is-online-on-the-threefold-node-finder-but-offline-on-the-telegram-status-bot-is-this-normal) + - [I noticed that when I reboot my 3Node, the uptime counter on the ThreeFold Node Finder goes back to zero. Does it mean I lose uptime and the uptime start over again when I reboot the 3Node?](#i-noticed-that-when-i-reboot-my-3node-the-uptime-counter-on-the-threefold-node-finder-goes-back-to-zero-does-it-mean-i-lose-uptime-and-the-uptime-start-over-again-when-i-reboot-the-3node) + - [One of my nodes is showing the wrong location. Any problem with that?](#one-of-my-nodes-is-showing-the-wrong-location-any-problem-with-that) + - [Memory](#memory) + - [Can I use different type of RAM for the same 3Node?](#can-i-use-different-type-of-ram-for-the-same-3node) + - [How can I know if the memory I am buying is correct for my specific hardware?](#how-can-i-know-if-the-memory-i-am-buying-is-correct-for-my-specific-hardware) + - [What do the terms RDIMM, LDIMM, UDIMM, LRDIMM, FBDIMM mean when it comes to RAM memory sticks?](#what-do-the-terms-rdimm-ldimm-udimm-lrdimm-fbdimm-mean-when-it-comes-to-ram-memory-sticks) + - [What is the difference between ECC and non-ECC memory?](#what-is-the-difference-between-ecc-and-non-ecc-memory) + - [How can I change the RAM memory sticks on my 3Nodes? How can I achieve dual channel configuration with sticks of RAM?](#how-can-i-change-the-ram-memory-sticks-on-my-3nodes-how-can-i-achieve-dual-channel-configuration-with-sticks-of-ram) + - [What does RAM mean?](#what-does-ram-mean) + - [What does DIMM mean when it comes to RAM sticks?](#what-does-dimm-mean-when-it-comes-to-ram-sticks) + - [I have 24 DIMMS ram slots on my server. Can I use them all?](#i-have-24-dimms-ram-slots-on-my-server-can-i-use-them-all) +- [Ask a Question to the ThreeFold Community](#ask-a-question-to-the-threefold-community) + +*** + +# GENERAL FAQ + +## Basic Facts + +### What is the the ThreeFold blockchain? + +ThreeFold blockchain is the layer 0 infrastructure for an open source peer-to-peer (P2P) Internet owned by humanity. + + + +### What is the architecture of the ThreeFold Grid in simple terms? + +Essentially, the ThreeFold Grid is composed of the people using it, the 3Node servers offering compute, storage and network resources, and the TF Chain, which is the blockchain of ThreeFold. + +Middlewares are also used, such as GraphQL and GrixProxy, to get and organize data from the ThreeFold Chain. They help to make data available and to manage load. + +3Nodes store workloads data and can report on their state to the TF Grid and to middlewares. + + +### What is the difference between Internet capacity and connectivity? Does ThreeFold replace my Internet service provider (ISP)? + +In simple terms, the Internet is composed of both capacity and connectivity. Capacity is where the data and resources are being handled, for example in servers. Connectivity is the infrastructure that transfer data and resources between servers. The latter is linked to the typical Internet service provider (ISP). + +ThreeFold’s technology enables distributed capacity generation, but ThreeFold doesn’t deal in connectivity. +3nodes offer Internet capacity, but farmers still rely on connectivity provider like the usual Internet service provider (ISP). + +### What are the priorities of ThreeFold (the Three P of ThreeFold)? ThreeFold is a Planet first project, what does it mean? + +ThreeFold is working for the Planet, the People and Profit, in this very order of importance. Planet comes first as it is our home to us all. A humane enterprise always has people before profit, and serious entrepreneurs know profit cannot be left out of the equation of a thriving project. + + +### I want to help build the new Internet. How can I become a ThreeFold certified 3node partner? + +Apply [here](https://marketplace.3node.global/index.php?dispatch=companies.apply_for_vendor) to become a ThreeFold certified 3node partner. + + + +### How can I create a twin on the TF Grid? + +There are 2 ways to create a twin: + +You can create a twin via the [ThreeFold Dashboard](../dashboard/wallet_connector.md). + +You can also create a twin via the ThreeFold Connect app. Indeed, a twin is automatically generated while creating a farm. Note that, in this case, the twin will be created on mainnet. + + +## ThreeFold Communication + +### Is there a ThreeFold app for mobile? + +Yes! ThreeFold Connect App (TF Connect App) is available for [Android](https://play.google.com/store/apps/details?id=org.jimber.threebotlogin) and [iOS](https://apps.apple.com/us/app/threefold-connect/id1459845885). + +You can use this app to create a ThreeFold ID, a ThreeFold Wallet and also a ThreeFold Farm to link all your 3nodes. +The ThreeFold Connect Wallet, with its Stellar payout address, can be used for transactions as well as to receive farming rewards. +The News section gives you the latest information on the fast ThreeFold development and growth. + + +### I want to reach the ThreeFold community. What are ThreeFold social links? + +You can find links to the ThreeFold community at the bottom of the main page of the [ThreeFold website](https://www.threefold.io/). + + +### Could we reach out someone for publishing research work on ThreeFold? + +You can send an email to info@threefold.io for publishing research on ThreeFold. + + +### Who can I write to for a proposal? Where can I send a proposal email for a new partnership opportunity with ThreeFold? + +You can mail your proposal to info@threefold.io or write about your proposal on the [ThreeFold Forum](http://forum.threefold.io/). + + + +### How can I track and follow the progress and development of ThreeFold? + +There are two main places where you can track the progress of ThreeFold. ThreeFold is open source and its developments can be easily tracked on Github. + +* You can read about the ongoing ThreeFold Tech projects [here](https://github.com/orgs/threefoldtech/projects). +* You can read about the ongoing ThreeFold Foundation projects [here](https://github.com/orgs/threefoldfoundation/projects?query=is%3Aopen). + + + +### Why do some forum posts need to be approved? + +The configurations of the ThreeFold forum make so that some posts need approval, depending on where they are posted. Like posting from meta-sections, and some specific sections. + +Also, note that certain posts can automatically get flagged for moderation based on their content. + + + +## The Technology of ThreeFold + +### What is a 3Node? + +It is essentially a single server that makes up a larger network of servers which together form the ThreeFold Grid. Essentially any modern computer can be turned into a 3node (DIY Farming) and you can [buy plug and play 3nodes](https://marketplace.3node.global/index.php) as state of the art modern computer. + + + +### What is the difference between a 3node and a ThreeFold farm? + +A 3node is a single server connected to the Grid. Each 3node is linked to a farm. A farm can be composed of multiple 3nodes. + + +### What is Zero-OS from ThreeFold? + +Zero-OS is a stateless and lightweight operating system designed to host anything that runs on Linux, in a decentralized way. Once installed, Zero-OS locks the hardware and dedicates its capacity to the People’s Internet via the ThreeFold Blockchain. + + + +### ThreeFold uses Quantum Safe Storage technology, what does it mean? + +Quantum computers are theoretically capable of doing huge calculations in a short period of time. By this fact alone, it is a great potential threat to future online safety. ThreeFold solves this future problem before it even becomes a reality. Indeed, Zero-os can compress, encrypt, and disperse data across the Grid. + + + +### Quantum Safe File System (QSFS) allows for part of the storage to go down and it can self repair, however it’s still attached to a single VM and a single point of failure. Can a QSFS instance be reattached to another VM to recover it? + +QSFS is built from storage devices which are distributed and decentralized. + +The storage engine is a software running on a VM that can run everywhere. +If the storage engine needs to run on a different VM the config needs to pushed to the new VM. +In short, yes Quantum safe file system (QSFS) can be recovered on a different VM. It is not automated yet on Zero-OS. A video tutorial will be shared soon. + + + + +### Where does the ThreeFold Explorer take its data from? + +The ThreeFold Explorer takes its data from this website: [https://gridproxy.grid.tf/](https://gridproxy.grid.tf/). + +To explore Grid Proxy, you can use Swagger: [https://gridproxy.grid.tf/swagger/index.html](https://gridproxy.grid.tf/swagger/index.html). You will then be able to query the TF Grid and extract data. + +See the next Q&A for more information on Swagger. + + + +### How can I use the Gridproxy to query information on the TF Grid? + +You can go to the Gridproxy Swagger index: [https://gridproxy.grid.tf/swagger/index.html](https://gridproxy.grid.tf/swagger/index.html). + +There you can query information such as information on a 3node. + +For example, asking the Gridproxy for the nodeID 466, you get the following URL: `https://gridproxy.grid.tf/nodes/466`. + +To get specific information, you can add parameters, for example: `https://gridproxy.grid.tf/nodes/466/status`. + +When you know the URL representation of the query, you can simply use the URL directly on a web browser. + + + +### How can I see the stats of the ThreeFold Grid? + +You can go to think link: [https://stats.grid.tf/](https://stats.grid.tf/) to see the stats of the ThreeFold Grid. + +You can also check this [thread](https://forum.threefold.io/t/grid-stats-new-nodes-utilization-overview/3291/) on the ThreeFold forum. + + +### What is the difference between a seed phrase (mnemonics) and an HEX secret? + +A seed phrase (also called mnemonics) is a set of words from a carefully selected pool that can be used to derive cryptographic secrets. A HEX secret is a more direct representation of such secret that the computer uses. In the case of an HEX secret, there is no extra information present to form complete words of the seed phrase. + +In typical usage, multiple secrets can be derived from a seed phrase via a one-way operation. The secret and its derived public key are sufficient to do any cryptographic operation like signing transactions or encrypting data, but it can't be used to get back the words of the seed phrase. + + + +## Buying and Transacting TFT + + +### How long does it take when you use the BSC-Stellar Bridge? + +The bridge will process deposits/withdrawals within 48 hours. + + + +### On my website, users can donate TFT on the Stellar Chain. Is there a way for users on my website to easily track the total sum of TFT donated? + +There is a simple way to do this. The [Stellar Explorer](https://stellar.expert/explorer/public) has an embeddable widget that you can insert on any website, including WordPress. + +Simply go to the account you’re interested in showing the balance of, look for “Balance History”, select TFT, and finally click the small icon next to the heading to reveal the embed code. In your WordPress page editor, in HTML mode, paste the embed code. + + +## TF Connect App, TF Dashboard, GraphQL, Grix Proxy and Polkadot Substrate + +### Is there a way to create or import another wallet in TF Connect App? + +The TF Connect App supports Stellar and TF Chain wallets. The app by default can create one wallet. To add any number of additional wallets, you must create a wallet on Stellar or TF Chain and then import it with the import function. + + + +### I created a farm on the TF Chain. On the TF Connect App Farmer Migration section, my farm is under Other v3 farms, is this normal? + +Yes this is normal. Farms created on TF Chain instead of the TF Connect App will appear in *Other v3 farms*. + + + +### I am trying to access my wallet in the ThreeFold Connect App. It worked fine before, but now I just get a white screen. What does it mean and what can I do? + +On the TF Connect App, when you get a white screen, it means that there is a connection issue. It can help to try other networks; maybe try switching between ethernet cable or wifi. Or you can also try it later when the connection might be more stable. + + + +### When I open the ThreeFold Connect App, I get the error: Error in initialization in Flagsmith. How can I fix this issue? + +To fix this Flagsmith error message on the ThreeFold Connect app, you can try the following methods: + +* Check your internet connection +* Update your phone current operating system (OS) version +* Update the date and time on your phone + + +### Apart form the ThreeFold Connect App Wallet, how can I check my TFT balance? + +You can go on [Stellar.Expert](https://stellar.expert). With your wallet address, you will be able to see your transactions and wallet details. + + + +### Is it possible to export the transaction history of a wallet to a CSV file? + +Yes, every blockchain has an explorer function and these explorer functions allow you to see transactions and export them. TFT is on 2 chains at the moment: Stellar and Polkadot. + +For Stellar based TFT’s there is an explorer here: https://stellar.expert/explorer/public. Enter you wallet address in the top left search box, and after pressing enter you should see every transaction related to your account. + +If you are not deploying/doing things on the TF Grid (dev, test or mainnet) you will not have transferred any tokens to the TF Chain, therefore all your tokens/wallets will be on the Stellar Chain. + + +### How can I use GraphQl to find information on the ThreeFold Grid? + +To find information on the ThreeFold Grid with GraphQL, go to this [link](https://graphql.grid.tf/graphql). On the left menu, choose the parameters you want to search and write the necessary information, if needed, then click on the Play button in the middle section, at the top. + +Here's an example of a query, where we want to find all the farms containing "duck" in their name. + +query MyQuery { + farms(where: {name_contains: "duck"}) { + name + farmID + } +} + +This code can be written automatically if you simply select the proper parameters in the left menu. +For the previous example, we had to click on "farms", then "where", and then "name_contains". After clicking on "name_contains", you need to add the words you are looking for, in this example we had "duck". Further down the menu, we simply had to click on "farmID" and "name", and then click the Play button. The results of the query appear on the right screen. + + + +### What are the different links to ThreeFold's Graph QL depending on the network? + +The links for the Development, Test and Main Networks are the following: + +* Main Net Graph QL + * [https://graphql.grid.tf/graphql](https://graphql.grid.tf/graphql) +* Test Net Graph QL + * [https://graphql.test.grid.tf/graphql](https://graphql.test.grid.tf/graphql) +* Dev Net Graph QL + * [https://graphql.dev.grid.tf/graphql](https://graphql.dev.grid.tf/graphql) + + + +### How can I find 3Nodes with IPv6 addresses? + +You can use [GraphQL](https://graphql.grid.tf/graphql) for such queries. + +Use the following code to search for 3Nodes with IPv6 addresses. +Enter the following code on the middle window and click on the "Play" button. + +``` +query MyQuery { + publicConfigs { + ipv6 + node { + nodeID + } + } +} +``` + +The 3nodes with IPv6 addresses will appear on the right window. + +For more information on how to use Graph QL, read [this Q&A](#how-can-i-use-graphql-to-find-information-on-the-threefold-grid). + + + +### How can I use GraphQL to see contracts on my 3Nodes? + +Go to [ThreeFold's GraphQL](https://graphql.grid.tf/graphql) and write the following query: + +``` +query MyQuery { + nodeContracts(where: {state_eq: Created, nodeID_eq: 42}) { + resourcesUsed { + cru + hru + mru + sru + } + contractID + twinID + nodeID + } +} + +``` + +This will show you contracts on the 3Node as well as resources used. You can play with the different parameters. + +How can I see the farm associated with a node? + +``` +query MyQuery { + nodes(where: {nodeID_eq: 57}) { + farmID + nodeID + } +} +``` + + + +### How can I use Grid Proxy to find information on the ThreeFold Grid and 3Nodes? + +To find information on the ThreeFold Grid with GraphQL, you need to write this URL: https://gridproxy.grid.tf/, followed by your specific query. Here's an example if we wanted to see all the available farm on the TF Grid that has "duck" in its name: + +https://gridproxy.grid.tf/farms?name_contains=duck + +The Grid Proxy is appropriate for high volume application. +You can find the parameters to be written in the URL when visiting the [GraphQL explorer](https://graphql.grid.tf/graphql). + + + +### Who is hosting GraphQL and Grid Proxy on the ThreeFold Grid? + +GraphQL and Grid Proxy are hosted by ThreeFold for everyone to use. + +Note that it is also possible to run your own instance of those tools. + + + +### What is the difference between uptime, status and power state? + +There are three distinctly named endpoints or fields that exist in the back end systems: + +* Uptime + * number of seconds the node was up, as of it's last uptime report. This is the same on GraphQL and Grid Proxy. +* Status + * this is a field that only exists on the Grid Proxy, which corresponds to whether the node sent an uptime report within the last 40 minutes. +* Power state + * this is a field that only exists on GraphQL, and it's the self reported power state of the node. This only goes to "down" if the node shut itself down at request of the Farmerbot. + + + +### I do not remember the name (ThreeFold 3bot ID) associated with my seed phrase on the ThreeFold Connect app. Can I recover my TF Connect app account with only the seed phrase and not the name (3bot ID) associated with it? + +If you forgot the name associated with your seed phrase on the TF Connect app, you can always create a new identity (ThreeFold 3bot ID) and import your wallet using the old seed phrase. + +Since the Connect App is also used for identity and authentication, you need both the name (3bot ID) and seed phrase to fully recover your account. The wallet is only linked to the seed phrase and not the name (3bot ID). + + +# USERS FAQ + +## TF Grid Functionalities + + +### What are the type of storage available on TF Grid? + +There’s two type of storage that van de used on the TF Grid. + +1. VM which has a virtual disk. The virtual disk is a straightforward volume on a local hard disk. Everything stored on this virtual disk is stored only on this virtual (and thus physical) disk. Delete the VM and the virtual disk and the content is gone. +2. Quantum safe storage. Quantum safe storage uses a “Storage Engine” that parts, compresses, encrypts and then mathematically describes the data. + + +## Deployments on the ThreeFold Grid + + +### Does the ThreeFold Grid charge the total resources rented or it only charges the resources used during deployment? + +Billing is based on how many resources you reserve, not how much you use them. For this reason, it can be a good idea to deploy the minimim resources needed per project. + + + +### Do I pay for Internet traffic while deploying workloads on IPv4, IPv6 or Planetary Network? + +You do pay for internet traffic while deploying on the ThreeFold Grid. It is calculated during deployment and paid with ThreeFold tokens (TFT). + +Note that the private overlay network traffic is not billed. + + + +### What is the monthly cost for an IPv4 or an IPv6 public address on the ThreeFold Grid? + +The cost for an IPv4 public address is around 3$/month (USD). + +For an IPv6 address, there is no cost. + + + +### What are the differences between a container, a micro virtual machine and a full virtual machine (VM)? + +The following is a list of certain features related to containers as well as full and micro virtual machines. + +* Container + * generally designed to run a single application + * doesn't need to include a full operating system + * relies on the kernel of the host system, no hypervisor needed + * isolated from the rest of the host system for security and can be limited in resources used + * examples: on the [Playground](https://playground.grid.tf/), we have [Kubernetes](https://library.threefold.me/info/manual/#/manual__weblets_k8s?id=kubernetes) and [Caprover](https://library.threefold.me/info/manual/#/manual__weblets_caprover?id=caprover), which are both environments that host containers +* Micro VM + * a container image promoted to run as a VM by pairing with a generic kernel + * more isolated than a container, thus more secure + * generally lighter than a full VM + * can be created from any Docker container image by uploading it to the [TF Hub](https://hub.grid.tf/) + * examples: on the [Playground](https://playground.grid.tf/), we have Ubuntu 20.04, Alpine-3, CentOS-8 and more. +* Full VM + * contains a complete operating system including kernel + * capable of anything that can be done with a Linux server + * compatible with any guides and tutorials written for the same version of the distribution they are running + * normally contains systemd, unlike containers which normally do not + * can load kernel modules or replace the kernel entirely, so has best compatibility + * generally heavier than micro VM + * examples: on the [Playground](https://playground.grid.tf/), we have Ubuntu 18.04, 20.04, 22.04 and more + +Note that you can run Kubernetes on a micro VM and you can run a very minimal operating system in a full VM. There are many possibilities when using those technologies. + + + +### What is a 3Node gateway? How can I configure a 3Node as a gateway node? + +A 3Node becomes a gateway when a ThreeFold farmer adds a public IP address to the node itself on the [ThreeFold Dashboard](https://dashboard.grid.tf/). In doing so, the IP address is then handed over to the base operating system of the node itself. The IP address can then be used in the overall functions of the TF Grid. + +Note that this process differs from when an IP address that has been added to a farm is deployed with a workload in order for that workload to be accessible on the Internet. + +To configure a 3Node as a gateway node, you need a public IP block from your internet service provider (ISP). + +You can configure a 3Node as a gateway node on the [TF mainnet](https://dashboard.grid.tf/), [TF testnet](https://dashboard.test.grid.tf/) and [TF devnet](https://dashboard.dev.grid.tf/). You thus need to choose the correct TF Dashboard link (main, test, dev). + +To configure a 3Node as a gateway node, follow these steps: + +* Configure your DNS records + * Type: A + * Name: + * Value: + * Type: NS + * Name: _acme-challenge. + * Value: . + * Type: CNAME + * Name: *.. + * Value: + * Type: AAAA + * Name: + * Value: +* Configure your 3Node parameters on the TF Dashboard + * Go to the [ThreeFold Dashboard](https://dashboard.grid.tf/) + * Go to the section **Portal** + * Go to the subsection **Farms** + * Choose the 3Node you want to turn into a gateway node and click on **Actions** (Add a public config) on the right + * Enter the necessary information and click **Save** + * IPV4: Enter the IPv4 address of your public IP block + * Gateway: Enter the gateway of your public IP block + * IPV6: Enter the IPv6 address of your public IP block + * Gateway IPV6: Enter the gateway of your public IP block + * Domain: . + +Once this is done, you should see the IPv4 and IPv6 addresses in the section **PUB** of your 3Node screen. + +To learn more about this process, [watch this great video](https://youtu.be/axvKipK7MQM). + + + +### When connecting remotely with SSH, I get the following error: "WARNING: REMOTE HOST IDENTIFICATION HAS CHANGED!...". What can I do to fix this? + +If you've already done an SSH connection on your computer, the issue is most probably that the "host key has just been changed". To fix this, try one of those two solutions: + +* Linux and MAC: + * ``` + sudo rm ~/.ssh/known_hosts + ``` +* Windows: + * ``` + rm ~/.ssh/known_hosts + ``` + +To be more specific, you can remove the probematic host: + +* Windows, Linux and MAC: + * ``` + ssh-keygen -R + ``` + +Once this is done, you should be able to SSH into your 3Node deployment. + + + +### How can I remove one host from known_hosts? + +You can write the following command +``` +ssh-keygen -R hostname +``` + +Where hostname would be the IPv4 or IPv6 address for example. +In the case of the ThreeFold Grid, it can also be the Planetary Network address. + + + +### How can I add ThreeFold peers in the Yggdrasil configuration file? + +In the file /etc/yggdrasil.conf, write the following in the "Peers" section: + +``` + Peers: [ + # Threefold Lochrist + tcp://gent01.grid.tf:9943 + tcp://gent02.grid.tf:9943 + tcp://gent03.grid.tf:9943 + tcp://gent04.grid.tf:9943 + tcp://gent01.test.grid.tf:9943 + tcp://gent02.test.grid.tf:9943 + tcp://gent01.dev.grid.tf:9943 + tcp://gent02.dev.grid.tf:9943 + # GreenEdge + tcp://gw291.vienna1.greenedgecloud.com:9943 + tcp://gw293.vienna1.greenedgecloud.com:9943 + tcp://gw294.vienna1.greenedgecloud.com:9943 + tcp://gw297.vienna1.greenedgecloud.com:9943 + tcp://gw298.vienna1.greenedgecloud.com:9943 + tcp://gw299.vienna2.greenedgecloud.com:9943 + tcp://gw300.vienna2.greenedgecloud.com:9943 + tcp://gw304.vienna2.greenedgecloud.com:9943 + tcp://gw306.vienna2.greenedgecloud.com:9943 + tcp://gw307.vienna2.greenedgecloud.com:9943 + tcp://gw309.vienna2.greenedgecloud.com:9943 + tcp://gw313.vienna2.greenedgecloud.com:9943 + tcp://gw324.salzburg1.greenedgecloud.com:9943 + tcp://gw326.salzburg1.greenedgecloud.com:9943 + tcp://gw327.salzburg1.greenedgecloud.com:9943 + tcp://gw328.salzburg1.greenedgecloud.com:9943 + tcp://gw330.salzburg1.greenedgecloud.com:9943 + tcp://gw331.salzburg1.greenedgecloud.com:9943 + tcp://gw333.salzburg1.greenedgecloud.com:9943 + tcp://gw422.vienna2.greenedgecloud.com:9943 + tcp://gw423.vienna2.greenedgecloud.com:9943 + tcp://gw424.vienna2.greenedgecloud.com:9943 + tcp://gw425.vienna2.greenedgecloud.com:9943 + ] +``` + + + +### How can I see Yggdrasil/Planetary Network's peers? + +On MAC and Linux, write the following line in the terminal: + +``` +/etc/yggdrasil.conf +``` + +On Windows, one of the two following lines should work: + +``` +%ALLUSERSPROFILE%\Yggdrasil\yggdrasil.conf +``` + +``` +C:\ProgramData\Yggdrasil\ +``` + +These are the general location of Yggdrasil. It can change depending on how you installed Yggdrasil. + + + +### How can I ping an Yggdrasil IP or IPv6 address? + +Usually, using the command `ping` works. + +If the typical `ping` doesn't work, try this instead: `ping6` + +For example, the following will send 2 pings: + +``` +ping6 -c 2 yggdrasil_address +``` + + + + +### Is there a way to test if I am properly connected to the Yggdrasil network (Planetary Network)? + +To check if you are properly connected to the Yggdrasil network, try reaching this website: + +``` +http://[319:3cf0:dd1d:47b9:20c:29ff:fe2c:39be]/ +``` + +If you can reach this website, it means that you are properly connected. + +For more information on how to connect to Yggrasil (and the Planetary Network), read [this guide](../system_administrators/getstarted/ssh_guide/ssh_guide.md). + + + + +### How can I change the username of my SSH key? + +In the terminal, write the following line: + +``` +ssh-keygen -C newname +``` + +Make sure to replace "newname" by the name you want. + + +### What is ThreeFold's stance on sharded workload? Will ThreeFold embrace and move towards distributed data chunks or stay with the one deployment, one node model? + +The ThreeFold Grid is basically agnostic when it comes to how you structure your deployment. + +If you want to put all your storage and compute on one node and lose everything if it goes down, you can do so. + +If you want a highly distributed and fault tolerant system with high availability where data is never lost, you can also do so. You could build an architecture with single nodes running single workloads as the building blocks. + +Containerized micro service architectures running on e.g. Kubernetes are basically the way that compute is being "sharded" already in the mainstream of IT, especially at large scales. Such applications fit well on the ThreeFold Grid today, since they account for the possibility that individual nodes may fail. However, many applications aren't built this way and it takes work to adapt them. + +Self driving and self healing IT is one of the core concepts of ThreeFold. What we've built so far is an excellent foundation for making this reality. Some additional features might come into TF Chain and the network itself to enable such features. That being said, a lot is already possible using the existing system. It's just a matter of gluing things together in the right way. + + + +## Tutorials and Guides + + +### What is the minimum amount of TFT to deploy a Presearch node? How can I get a TFT discount when I deploy a Presearch node? + +The minimum amount of TFT that needs to be in your ThreeFold Profile before you can deploy a Presearch node is 2 TFT. But this would not last very long. + +To benefit from the biggest reduction in price (-60%), you need to have a sufficient amount of TFT in your wallet. The TFT is not locked and simply needs to be present in your wallet. + + +For the capacity of a Presearch node, the amount is around 5000 TFT, covering 3 years that the workload could run. + +Note that a Presearch node requires about 3 days to stabilize. + + + + +### Can I use the same seed phrase for my mainnet and testnest accounts? How can I transfer my TFT from mainnet to testnet or vice versa? + +Yes, you can use the same seed phrase for you main and testnet accounts. They will have the same address on each chain but they are really separate accounts. It is much like using the same wallet on Ethereum and BSC for example. + +To transfer your TFT from mainnet to testnet or vice versa, you need to send your TFT to the Stellar chain first. Let's say you want to transfer TFT from the mainnet to the testnet. Here are the steps: + +* Open your mainnet profile on the [mainnet Dashboard](https://dashboard.grid.tf/), on the left menu, choose Portal and then Swap. Click the button Withdraw. Send your TFTs from the mainnet address to your Stellar address. + +* Open your testnet profile on the [testnet Dashboard](https://dashboard.test.grid.tf/), on the left menu, choose Portal and then Swap. Click the button Deposit. Send your TFTs from your Stellar address to the testnet address. You can use the QR code option to make the transfer. + +To go from testnet to mainnet, simply use the URLs in the opposite order. + +> Note that the fees are of 1 TFT per transfer. + + + +### Do I need a full or micro virtual machine (VM) when I run QSFS, quantum safe file system, on the ThreeFold Grid? + +QSFS can be run on both a full virtual machine or a micro virtual machine (VM). The QSFS is a "mountable" object, like a disk. It's defined in its own block, then specified as a mount within a VM. + + +## Linux, Github, Containers and More + +### Where should I start to learn more about Linux? + +While the [ThreeFold Manual](https://www.manual.grid.tf/) would be a good place to learn about ThreeFold and how to deploy on the TF Grid, to learn specifically about Linux, a good place to start is the [Linux website](https://www.linux.org/). There you will find [many tutorials](https://www.linux.org/forums/#linux-tutorials.122). + +A general advice to learn Linux, and computers in general, is to develop the skill of finding answers by following your natural curiosity: most of the questions have been asked before and answers can be found through search engines. + +Before doing any web search, you can use the resources already on hand in the terminal. For any command, you can try adding `-h` or `--help` for a brief description of what it does and to see some commonly used arguments. Typing `man` and then the command name will bring up a more detailed manual, assuming it exists and is installed (e.g. `man sudo`). + +Some ThreeFold users also point out that using different AI and LLM can be very helpful in the process of learning Linux and computers in general. + + +### How can I clone a single branch of a repository on Github? + +You can clone a single branch of a repository with the following line: + +``` +git clone --single-branch --branch branch_name https://github.com/GITHUB_ACCOUNT/REPOSITORY_NAME +``` + + + +## Grace Period (Status Paused) + +### The status of my deployment is paused, in grace period, how can I resume the deployment? + +When your wallet is running out of TFT to pay for deployments, your deployments will be paused. +To resume your deployments, simply fill up your wallet with more TFT. + + + +### Once I refund my TF wallet, how long does it take for the deployment to resume from grace period? + +It can take around one hour to change the status from "paused" to "ok" and thus for the deployment to resume. + + + +### Can I SSH into my deployments when they are in grace period (i.e. when their status is paused)? + +While in grace period, you might not be able to SSH into your deployment. Refund your wallet to resume deployments. + + + +### How long is the grace period (i.e. when the deployment status is paused)? + +The grace period is 2 weeks. During this period, you can refill your wallet to resume your deployment. + + + +## Terraform + +### Working with Terraform, I get the following error: failed to create contract: ContractIsNotUnique. Is there a fix to this issue? + +This error happens when a contract with the same data is already active. For example, two conflicting contracts are not in the same deployment. You can try to change the data on the main.tf file to make sure it's not a self-conflicting terraform deployment. + + + +### I am working with Terraform. What do I have to write in the file env.tfvars? + +This env.tfvars should look like the following, with the proper content within the quotes: + +> MNEMONICS = "write your seed phrase" +> +> NETWORK = "write the main network" +> +> SSH_KEY = "write your ssh-key" + +Note that this could change based on your specific Terraform deployment. + + + +### I am working with Terraform and I am using the example in Terraform Provider Grid. How can I use the example main.tf file with environment variables? Why am I getting the message Error: account not found, when deploying with Terraform? + +This Q&A is linked with the main.tf file in the [QSFS section of the ThreeFold Tech repository](https://github.com/threefoldtech/terraform-provider-grid/blob/development/examples/resources/qsfs/main.tf). + +This error happens when you did not properly set your environment variables. +In the main.tf file, add those lines at the top: + +> variable "MNEMONICS" { +> +> type = string +> +> description = "The mnemonic phrase used to generate the seed for the node." +> +> } + +> variable "NETWORK" { +> +> type = string +> +> default = "main" +> +> description = "The network to connect the node to." +> +> } + +> variable "SSH_KEY" { +> +> type = string +> +> } + +Within the file main.tf, set those lines: + +> provider "grid" { +> +> mnemonics = "${var.MNEMONICS}" +> +> network = "${var.NETWORK}" +> +> } + +> env_vars = { +> +> SSH_KEY = "${var.SSH_KEY}" +> +> } + +Note: Make sure that you properly set your variables in the file env.tfvars. + + +## Users Troubleshooting and Error Messages + +### When deploying a virtual machine (VM) on the ThreeFold Grid, I get the following message after trying a full system update and upgrade: GRUB failed to install to the following devices... Is there a fix to this issue? + +When deploying a virtual machine and doing a full system update and upgrade (apt update, apt upgrade), if you get the error: GRUB failed to install to the following devices /dev/vda15, try this to fix it: + +> apt-mark hold grub-efi-amd64-signed + +This should fix the issue. + + +### While deploying on the TF Dashboard, I get the following error :"global workload with the same name exists: conflict". What can I do to fix this issue? + +This error happens if you deployed a workload on the TF Dashboard with the same deployment name of a previous deployment. In general, you can simply refresh the TF Dashboard browser page and/or change the deployment name for a new one. This should fix the issue. + + + +## ThreeFold Connect App + +### TF Connect App is now asking for a 4-digit password (PIN). I don't remember it as I usually use touch or face ID to unlock the app. What can I do? + +When you set up your the app, you are asked a 4-digit password (PIN). After some time, the app will be asking for this PIN when users may have been exclusively using touch/face ID. You can reset it by recovering the account with your seedphrase. + + +### Is there a way to have more than one wallet in TF Connect App? + +Yes, this is perfectly possible. You can have multiple wallets in the TF Connect app. You can have multiple wallets for the Stellar network and multiple wallets for Polkadot Substrate. + +For example, you can create a wallet on the Stellar Blockchain and import it on TF Connect App with the function *Import Wallet*. Just copy the seedphrase and it will be imported in TF Connect App. + +Note: There will not be an automatic function in the app to create a new wallet. You must do it manually. + + + +### What is the difference between 10.x.y.z and 192.168.x.y addresses? + +The addresses 10.x.y.z and 192.168.x.y are on the private network. + +A 10.x.y.z address is just as valid as a 192.168.x.y address for a private network. If all the devices get a 10.x.y.z network, your private network should work properly. But if some of your devices are getting 10.x.y.z addresses while others are getting 192.168.x.y addresses, then you have two conflicting DHCP servers in your network. + + + +# DEVELOPERS FAQ + +## General Information for Developer + +### Does Zero-OS assign private IPv4 addresses to workloads? + +No. Zero-OS will request two IP address from the DHCP. If you only have one physical NIC connected, Zero-OS will assign the second IP address as a virtual device. + + + +### Why does each 3Node server have two IP addresses associated with it? + +Each node has two IP adresses. + +One is for for Zero-OS and one is for for the DMZ (demilitarized zone, sometimes referred to as a perimeter network or screened subnet). This separates public/private traffic from each other. + +Note: Zero-OS will request two IP address from the DHCP. If you only have one physical NIC connected, Zero-OS will assign the second IP address as a virtual device. + +### Can Zero-OS assign public IPv4 or IPv6 addresses to workloads? +Yes it can provide both standard and Yggdrasil connections. + + +### What does MAC mean when it comes to networking? +MAC means *media access control*. It is a unique hardware ID. It helps the network to recognize your machine. It is then, for example, possible to assign a specific and fixed IP address to your hardware. + + + + +### I am a developer looking for a way to automatically convert BSC tokens into TFT. Could you please share tips on how to swap regular tokens into TFT, on backend, without and browser extensions, via any platform API? + +TFT is implemented as a cross-chain asset (BToken) on BSC. + +Swapping via Pancakeswap directly without a browser and extension can be done by calling the Pancakeswap's BSC contract directly. Note that this requires some EVM knowledge on calling contracts. + +TFT is a standard ERC-20 contract, called BEP20 on BSC. You will thus need to call the approved method in the TFT contract to allow Pancakeswap to transfer TFTs from your account. + +The TFT contract allows you to approve a large amount and when Pancakeswap makes the transfer, the TFT will be deducted from the transaction. This will not reset so you will not have to make a call to approve every swap. This will thus save some gas. + + + +## Test Net + +### Can I get some free TFT to test on Test Net + +The TFT on Test Net is real TFT. There are ways to get free TFT to explore Test Net, such as joining the Beta Tester Group. More information [here](https://forum.threefold.io/t/join-the-grid-3-0-beta-testers-group/1194/21). + + + +# FARMERS FAQ + +## TFT Farming Basics + +### My Titan is v2.1 and the ThreeFold Grid is v3., what is the distinction? + +Titan v2.1 is the hardware. Before v2.1, there was 2.0. The hardware currently being shipped is the Titan v2.1. + +When you read v3, it refers to the ThreeFold Grid. Titans are now being sent ready for TF Grid v3 so they are being referred to as Titan v3. In short, the current Titans are v2.1 hardware ready for ThreeFold Grid v3. + + + +### When will I receive the farming rewards for my 3Nodes? + +Farming rewards are usually sent around the 8th of each month. This can vary slightly because the verification process is not yet fully automated. + +For more information on the minting process, read the next [QnA](#what-is-the-tft-minting-process-is-it-fully-automated). + + + +### What is the TFT minting process? Is it fully automated? + +Minting is based on blockchain data according to strict rules that are carried out by computers with humans involved only to check for errors and to sign the resulting transactions. + +There is a human verification mechanism through multisignatures for calculations done on the data as stored in the blockchain. This explains the timing differences when it comes to the monthly farming rewards distribution, since enough people need to sign off. + +The detailed minting process for V3 is as follow: + +- TFChain, ThreeFold's blockchain, has all the details about capacity provided by the nodes. +- TFChain is used to track uptime. +- Zero-OS reports to TFChain. +- The code in [this repo](https://github.com/threefoldtech/minting_v3) uses the information from the blockchain to calculate the TFT to be minted. +- A proof of what needs to be minted and why is created. This proof is then sent to our guardians. +- The guardians need to double check the execution and the minting report. This is like a human check on the automated process. +- The guardians need to sign. Only when consensus is achieved the minting as suggested will happen. This allows human to check the code. + +It is important to understant that TFChain tracks the capacity and uptime and is the source for the minting. + +Note: Additional auditing code will be added in V4 (i.e. special code generated at runtime for verification) using security primitives on motherboards. + +For more information on the minting periods, read this [QnA](#what-is-the-start-and-end-of-the-current-minting-period-what-are-the-minting-periods-for-threefold-farming-in-2023). + + + +### What should I do if I did not receive my farming rewards this month? + +If you did not receive your farming rewards, please contact us via our live chats. We will then investigate the situation. + +You can find our live chat option on the TF Connect App ([Android](https://play.google.com/store/apps/details?id=org.jimber.threebotlogin&hl=en_CA&gl=US), [iOS](https://apps.apple.com/us/app/threefold-connect/id1459845885)), the [TF Forum](http://forum.threefold.io/), [TF Dashboard](https://dashboard.grid.tf/) and the [TF website](https://threefold.io/). +For the TF Connect app, select the Support option. +For the other websites, it is a blue icon on the right bottom part of the page. + +The easiest way to contact the ThreeFold support is to use [this link](https://threefoldfaq.crisp.help/en/) and click on the chat icon. + +### What is the TFT entry price of my 3Node farming rewards? + +Currently, the TFT entry price of the 3Nodes' farming rewards is 8 cents (0.08 USD). + + + +### What is the necessary uptime for a 3Node per period of one month? + +Note that as of now, rewards are proportional to the uptime, so (e.g.) 40% uptime farms 40% of the total uptime period. + +When implemented : For certified Titans 3Nodes, it is 97% uptime per month (21.6h). For DIY 3Nodes, it is 95% uptime per month (36h). For professional certified 3 nodes, it is 99.5% uptime per month (3.6h). + + +### How can I check the uptime of my 3Nodes? Is there a tool to check the uptime of 3Node servers on the ThreeFold Grid? + +You can go on the [ThreeFold Dashboard](https://dashboard.grid.tf/), and select "Farms" in the Portal menu. When you select a specific 3Node in your farm, you can see a visual graph of the 3Node's uptime of the last month. By clicking on "Node Statistics", you can see past and present uptime periods. + + + +### I set up a 3Node in the middle of the month, does it affect uptime requirements and rewards? + +You will still need to meet the required uptime (95% for DIY, etc.3), but the period starts when you connected the 3Node for the first time, instead of the usual start of the month. This only applies the first month. Afterwards, the uptime is calculated on the whole month. *Read last Q+A + + +### What is the difference between a certified and a non-certified 3Node? + +A certified 3Node will receive 25% more reward compared to a non-certified 3Node. +You can visit the [ThreeFold Marketplace](https://marketplace.3node.global/) for more information on certified 3Nodes. +DIY certified 3Nodes are a future possibility. + + + +### What are the different certifications available for 3Node servers and farms? What are the Gold and Silver certifications? + +3Nodes can be certified. You can buy certified 3Nodes [here](https://marketplace.3node.global/). + +Farms can also be certified. The certifications are: [gold certified farming](https://forum.threefold.io/t/gep-gold-certified-farming-specs-closed/2925) and [silver certified farming](https://forum.threefold.io/t/silver-booster-request-for-comments/3416). + +Note that gold and silver certifications are still being discussed. Join the discussion on the [ThreeFold Forum](http://forum.threefold.io/). + + +### What is the difference between V2 and V3 minting? + +V2 is being sunset. New miners should directly onboard to V3. +On the tokenomics side, V2 rewards decrease as the difficulty level increases. For the V3 rewards, the rewards are constant for 5 years. In short, V3 is more profitable in the long run. For more information, read [this post](https://forum.threefold.io/t/comparison-v2-vs-v3-minting/2122). + + + +### What is the TFT minting address on Stellar Chain? + +The TFT minting address on Stellar Chain is the following: GBOVQKJYHXRR3DX6NOX2RRYFRCUMSADGDESTDNBDS6CDVLGVESRTAC47 + +You can see it on the Stellar Explorer [here](https://stellar.expert/explorer/public/account/GBOVQKJYHXRR3DX6NOX2RRYFRCUMSADGDESTDNBDS6CDVLGVESRTAC47). + + + +### Can Titans and DIY 3Nodes share the same farm? + +Yes. It's one big ThreeFold family! A farm can have several 3Nodes (Titans or DIY) and each 3Node can be linked to only one farm. + + + +### Do I need one farm for each 3Node? + +No. You only need one farm. One farm can have multiple 3Nodes. When setting your farm, you will add an address for the farming rewards. All farming rewards from each 3Node of your farm will be sent to this address. Note that you can choose to have more than one farm. It is up to you. + + + +### Can a single farm be composed of many 3Nodes? + +Yes. You can have many 3Nodes on the same farm. + + + +### Can a single 3Node be on more than one farm? + +No, this is not possible. + + + +### Do I need one reward address per 3Node? + +You do not need more than one address linked to one farm. All of your 3Nodes can be connected to the same farm. Rewards per each 3Nodes will all be sent to the address linked to your farm. + + + +### How can I access the expert bootstrap mode for Zero-OS? + +You can access the expert bootstrap mode for Zero-OS at this link: [https://bootstrap.grid.tf/expert](https://bootstrap.grid.tf/expert). + + + +### When it comes to the Zero-OS bootstrap image, can I simply duplicate the first image I burnt when I build another 3Node? + +Yes. What is needed on this bootstrap image is to have the proper farm ID. The bootstrap image will be the same for all your different 3Nodes. It's a good TF farming practice to leave the bootstrap image plugged in the 3Node at all time. + + + +### If a node is unused for certain time (e.g. many months offline), will it be erased by the Grid? + +No, nodes only get deleted if the farm owner chooses to do so. Old "nodes" are really just entries in TF Chain and TF Chain does not modify or delete this data without external input. + + + +### Can a farm be erased from TF Grid? + +No, this is not possible. In the future, we will implement some features in order to allow the cleaning of unused farms. As of now, this is not possible. Also, an old farm does not take resources on the TF Grid, or very little. + + + +### On the ThreeFold Connect App, it says I need to migrate my Titan farm from V2 to V3. What do I have to do? How long does this take? + +To migrate, read [this documentation](https://forum.threefold.io/t/what-to-do-if-your-farm-is-still-on-grid-v2-closed/3761). + + + + +### How can I migrate my DIY farm from V2 to V3? + +Create a new [bootstrap image](https://bootstrap.grid.tf/) using your new V3 Farm ID. To create a new V3 Farm ID, you can use the ThreeFold Connect App or the ThreeFold Dashboard. + + + +### What does the pricing policy ID of a farm represent? + +The pricing policy is the definition of how the network bills for workloads (pricing for each resource type, discounts, etc.). + + + +### What is the difference between TiB and TB? Why doesn't the TF Explorer shows the same storage space as my disk? + +Terabyte (TB) and Tebibyte (TiB) are units of digital information used to measure storage capacity and data transfer rate. While terabyte is a decimal standard unit, Tebibyte is binary. + +* 1 TB = 1000^4 bytes +* 1 TiB = 1024^4 bytes. + +There are thus more bytes in 1 TiB than in 1 TB. +1 TiB is equal to 1.099511627776 TB. + +You can play around these 2 notions by exploring this [TiB-TB converter](https://www.dataunitconverter.com/tebibyte-to-terabyte/). + +You can also check [this table](https://www.seagate.com/ca/en/support/kb/why-does-my-hard-drive-report-less-capacity-than-indicated-on-the-drives-label-172191en/) to compare different OS system's storage representation. + + + +## Farming Rewards and Related Notions + +### What are the rewards of farming? Can I get more rewards when my 3Node is being utilized? + +By connecting a 3Node to the Grid, you get Farming Rewards. If you set a public IP address for the Grid to use, you will receive additional rewards when your 3Node is being utilized by users on the Grid. All rewards are paid in TFT. To know the potential rewards, use the [simulator](https://simulator.grid.tf/). More information on sales channel will be communicated in the future. + + + +### How can I know the potential farming rewards for Grid Utilization? + +Go on the [ThreeFold simulator](https://simulator.grid.tf/), enter your 3Node resources, check the Public IP address. This will enable farming rewards from the parameter NU Required Per CU. Check the difference in the farming rewards per month. Note that you will need a Public IP address. + + + +### What is the easiest way to farm ThreeFold tokens (TFT)? + +Buy a [certified 3Node](https://marketplace.3node.global/index.php). This is more or less *plug n play*! You can also build a [DIY 3Node](#what-are-the-general-requirements-for-a-diy-3node-server). It's fun and there are many resources to help you along the way. + + + +### When do I receive my rewards? + +They are distributed once a month, around the 8th*. Distributions are not daily, or after a certain threshold. Note that upcoming minting rules may have a 24 month lockup or until 30% utilization for 3 months on your 3Node. + +*This can change slightly depending on the current situation. + + + +### Do farming rewards take into account the type of RAM, SSD, HDD and CPU of the 3Node server? + +No. The farming rewards do not take into account the specific type of RAM, SSD, HDD and CPU. The farming rewards take into account the quantity of storage and compute units (e.g. TB of SSD/HDD, GB of RAM, # of virtual cores). + + +### Can I send my farming rewards directly to a crypto exchange? + +This is not possible. When you send tokens to a crypto exchange, you need to include a memo with your wallet address and the current farming rewards system of ThreeFold is already using that memo space to send the correct farming information. + + +### Do I need collateral to farm ThreeFold tokens? + +Many decentralized data projects require collateral, but not ThreeFold. There is an ongoing discussion on collateral. Join the discussion [here](https://forum.threefold.io/t/should-tft-collateral-be-required-for-3nodes/3724). + + +### Can I add external drives to the 3Nodes to increase rewards and resources available to the ThreeFold Grid? + +As of now, you cannot add external drives to a 3Nodes. It is not yet supported. It might be in the future and we will update the FAQ if/when this happens. + + + +### Do I have access to the TFT rewards I receive each month when farming? + +For now, V3 farming rewards are distributed as TFT on Stellar and they are immediately available. The lock system will be implemented on chain. Tokens will be staked to your address until unlock conditions are met. Conditions are: 2 years of farming or 30% of proof-of-utilization for 3 months per 3Node. + + + +### What is TFTA? Is it still used? + +Note that on V3, TFTA will not be issued anymore. + + + +### Is there a way to certify a DIY 3Node? How can I become a 3Node certified vendor and builder? + +As of now, only certified ThreeFold partners can certify a 3Node. You could become a ThreeFolder vendor and offer certified 3Node. Read more [here](https://marketplace.3node.global/index.php?dispatch=companies.apply_for_vendor). + + + +### Does it make sense to make my farm a company? + +There is no general answer to this. Here's what a ThreeFold member thinks about this if you are living in the USA. Check for your current location if this makes sense for you. DYOR. + +> "Definitely do this project as a business entity. You can write off equipment, utilities and a portion of your home's square footage if your are hosting the equipment at home." TFarmer + + + +### What is the difference between uptime and downtime, and between online and offline, when it comes to 3Nodes? + +Uptime and status are two different things. As long as the 3Node is powered on, its uptime does not reset. Its status changes to offline if it hasn't made an uptime report in the last two hours. Even if after more than two hours, the 3Node isn't yet online, the uptime does not reset. Uptime is a function of the system being powered on. + + +### My 3Node server grid utilization is low, is it normal? + +This is normal. Currently, not all 3Nodes are being utilized by users on the ThreeFold Grid. Each month, more and more utilization happens and the ThreeFold Grid continually expans. To read on the ThreeFold Grid utilization and expansion, check this [TF Forum post](https://forum.threefold.io/t/grid-stats-new-nodes-utilization-overview/3291). + + + + +## 3Node Farming Requirements + + +### Can I host more than one 3Node server at my house? + +Yes, but do not host more than your bandwidth can support. + + + +### Is Wifi supported? Can I farm via Wifi instead of an Ethernet cable? + +No. Wifi is not supported by Zero-OS due to a number of issues, like reliability, performance, configuration requirements and driver support. It's all about Ethernet cables here. + + + +### I have 2 routers with each a different Internet service provider. I disconnected the ethernet cable from one router and connected it to the other router. Do I need to reboot the 3Node? + +You do not need to reboot. The 3Node will be able to reconnect to the ThreeFold Grid. + + + + +### Do I need any specific port configuration when booting a 3Node? + +No, as long as the 3Node is connected to the Internet via an ethernet cable (wifi is not supported), Zero-OS will be able to boot. Usually with the DHCP, it automatically assigns an IP address. + + + +### How much electricity does a 3Node use? + +A small DIY 3Node based on a compact office computer will draw under 20W. A full size server will draw around 100W idling. Note that a 3Node actively used on the Grid (proof-of-utilization) will draw more power, but also generate passive income on top of farming if you have a public IP address. + +For more information, read thes section [Calculate the Total Electricity Cost of Your Farm](../farmers/farming_optimization/farming_costs.md#calculate-the-total-electricity-cost-of-your-farm) of the Farming Guide. + + + +### Has anyone run stress tests to know the power consumption at heavy load of certain 3Nodes? + +The community is starting to gather some data on this. As of now, we know that a R720 with 2x2690v2 cpu, 4TB NVME SSE P4510 and 320GB ram will draw 390W @100% load. With 2x2650L v2, it's around 300W with fans at full speed. More info will be added as we gather more data. + +### Can the Titan 3Node be run on PoE? (Power Over Ethernet) + +Titans don't come equipped for Power Over Ethernet (PoE). If you have a NUC based Titan there are some PoE lids that might be compatible. + + + +### What is the relationship between the 3Node's resources and bandwidth? + +A 3Node connects to the ThreeFold Grid and transfers information, whether it is in the form of compute, storage or network units (CU, SU, NU respectively). The more resources your 3Nodes offer to the Grid, the more bandwidth will be needed to transfer the additional information. + + +### What is the bandwidth needed when it comes to running 3Nodes on the Grid? + +The strict minimum for one Titan is 1 mbps of bandwidth. + +If you want to expand your ThreeFold farm, you should check the following to make sure your bandwidth will be sufficient when there will be Grid utilization. + +> min Bandwidth per 3Node (mbps) = 10 * max((Total SSD TB / 1 TB),(Total Threads / 8 Threads),(Total GB / 64 GB)) + 10 * (Total HDD TB / 2) + +This equation means that for each TB of HDD you need 5 mbps of bandwidth, and for each TB of SSD, 8 Threads and 64GB of RAM (whichever is higher), you need 10 mbps of bandwidth. + +This means a proper bandwidth for a Titan would be 10 mbps. As stated, 1 mbps is the strict minimum for one Titan. + +The bandwidth needed for a given 3Node is not yet set in stone and you are welcome to participate in ongoing the [discussion on this subject](https://forum.threefold.io/t/storage-bandwidth-ratio/1389) on the Forum. + + + +### Can I run Zero-OS on a virtual machine? + +You can. But you won't farm TFT. To farm TFT, Zero-OS needs to be on bare metal. + + +### Is it possible to build a DIY 3Node with VMWare VM ? + +It wouldn't be possible to get farming rewards from such configuration. You need to run a 3Node Zero-OS on bare metal and no virtual machine is permitted. Indeed, to farm TFT you need bare metal. Virtual Machine will not work. Furthermore, all disks of a 3Node need to be wiped completely, thus no other OS can be on the 3Node. + +It would be possible to simply set Zero-OS as a VM on VMWare VM, but it wouldn't farm as stated. + + +### Can I run a 3Node on another operating system, like Windows, MAC or Linux? + +No. ThreeFold runs its own operating system (OS), which is Zero-OS. You thus need to start with completely wiped disks. + +### What is the minimum SSD requirement for a 3Node server to farm ThreeFold tokens (TFT)? + +You need a theoretical minimum of 500 GB SSD on a desktop or server. Less could work. + + + +### Is it possible to have a 3Node server running on only HDD disks? + +This is not possible. A 3Node needs at least one SSD disk of 500 GB. + + + +## Building a 3Node - Steps and Details + + +### How can I be sure that I properly wiped my disks? + +A wiped disk has: +- no label +- no partition +- no filesystem +- only zeroes + +On Linux to see if the disk is only composed of zeroes, use the command line (example with disk sda): + +> cmp /dev/sda /dev/zero + +If there is only zeroes, you should get the output: + +> cmp: EOF on /dev/sda + +You can also use the command line: + +> sudo pv /dev/sda | od | head + +Here are some useful command lines for Linux to make sure there are no partitions, no labels, no filesystems and that the disks are filled with zeroes only: + +> sudo fdisk -l +> +> sudo fdisk -lf +> +> sudo parted -l +> +> sudo parted /dev/sda 'print’ +> +> lsblk --f +> +> lsblk --raw + + + +### If I wipe my disk to create a new node ID, will I lose my farming rewards during the month? + +No, you wouldn't lose any farming rewards. You will get both the rewards for your previous node ID's uptime and also the new node ID's uptime. + +Note that this is the case with the current farming rewards based on total uptime, without any minimum threshold. + + + +### My disks have issues with Zero-OS and my 3Nodes. How can I do a factory reset of the disks? + +> Warning: this is destructive. It erases the disk sda in this example. + +Boot a Linux in Try mode and run the following command: + +> sudo badblocks -svw -b 512 -t 0x00 /dev/sda + +*In this example, the disk selected is sda. Choose the proper disk name in your current situation, e.g. sdb, sdc..). + +This line will read and (over)write zeroes (0x00) everywhere on the disk. + +To understand the line of code, note that 512 is the block size and that without -b BLOCKSIZE, the process would simply go slower. +0x00 represents the zero byte. + + + +This will take some time, but it should reset the disk and hopefully fix any issues. + +Note: it takes the 3Node server around 1 percentage per minute for a 2TB SSD disk to accomplish the badblock operation. + + + +### Before doing a bootstrap image, I need to format my USB key. How can I format my USB key? + +*Note that BalenaEtcher will format and burn your bootstrap image in the same process. See next Q+A for more details. + +Windows: This is done easily with diskpart. Here's all the coding needed (with disk X as an example, make sure you choose the correct disk): run Command Prompt as an administrator (right-click option), write *diskpart*, then in diskpart write *list disk*, choose your disk and write *select disk X*, write *clean*, write *create partition primary*, write *format fs=fat32*, then write *assign*. If for any reason, the process doesn't work, quit diskpart and redo the whole thing. This should fix any bug. Cautious with diskpart, it's destructive. + +MAC: This is done easily with Disk Utility. Go in Disk Utility. Select your USB key, click on *erase* on the top, write a name for your USB key, then choose a format (MS-DOS (FAT) if USB key < 32GB, exFAT if USB key > 32GB), then click *erase*, then click *done*. + +LINUX: In the Terminal, write *df*, find your disk (here we use sdX), write *sudo umount /dev/sdX*, write this line (with the proper FORMAT) *sudo mkfs.FORMAT /dev/sdX* [FORMAT= vfat for FAT32, ntfs for NTFS, exfat for exFAT], then finally verify the formatting by writing *sudo fsck /dev/sdX*. + +### What do you use to burn (or to load) the Zero-OS bootstrap image onto a USB stick? + +For MAC, Linux and Windows, you can use [BalenaEtcher](https://www.balena.io/etcher/) to load/flash the image on a USB stick. This program also formats the USB in the process. Rufus can also be used for Windows. + +Also, got Linux systems, you can transfer the dowloaded image with the dd command: *dd if=created_boot_loader_file.img of=/dev/sd?* where the input file is the downloaded file from http:/bootloader.grid.tf and the output file (device) is the USB stick device. + + +### Should I do a UEFI image or a BIOS image to bootstrap Zero-OS? + +It depends on your 3Node's system. Newer computers and servers will accept UEFI. If it does not work with UEFI, please try with the options ISO (BIOS CD/DVD) or USB (BIOS image) on the [ThreeFold bootstrap website](https://bootstrap.grid.tf). Read the next Q+A for more information on BIOS/UEFI. + + + +### How do I set the BIOS or UEFI of my 3Node? + +You can read this [documentation](../farmers/3node_building/5_set_bios_uefi.md) to learn more about BIOS and UEFI settings for a DIY 3Node. + + + +### For my 3Node server, do I need to enable virtualization in BIOS or UEFI? + +Yes, you should enable virtualization. On Intel, it is denoted as *CPU virtualization* and on ASUS, it is denoted as *SVM*. Make sure virtualization is enabled and look for the precise terms in your specific BIOS/UEFI. + + + +### How can I boot a 3Node server with a Zero-OS bootstrap image? + +Plug the USB key containing the Zero-OS bootstrap image with your farm ID then power on your 3Node. If the BIOS/UEFI is set correctly and the disks are all wiped, it should boot correctly the first time. If you have any problem booting your 3Node, read the section [Troubleshooting and Error Messages](#troubleshooting-and-error-messages) of the FAQ. + + + +### The first time I booted my 3Node server, it says that the node is not registered yet. What can I do? + +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 after some time (couple hours), the 3Node doesn't get registered, there might be something off with the Grid connection. You can then try to reboot the 3Node, or wait and boot it later. If it persists, you can check the rest of the Troubleshooting section of the Farmer FAQ, or ask around the ThreeFold Telegram Farmer chat or the ThreeFold chat for help. + + + +### The first time I boot my 3Node, the node gets registered but it says cache disk : no ssd. What can I do? + +This probably means that you either haven't connected a SSD or that you need to wipe your SSD disk(s). Zero-OS runs on bare metal and needs a minimum of one SSD disk (min 500GB & 50 GB per CU). You will see "cache disk : OK" when it works. + + + +### The first time I boot my 3 node, the node gets registered and it says cache disk : OK, but the table System Used Capacity is empty. What can I do? + +Most of the time, just wait and data will appear. If you want to be sure your 3Node is online on the Grid, you can check the [Node Finder](https://dashboard.grid.tf/), which fetch information every 2 hours. If it persist, first try to simply reboot your 3Node. + + + +### I have a relatively old server (e.g. Dell R710 or R620, Z840). I have trouble booting Zero-OS. What could I do? + +Sometimes, Zero-OS will not boot in UEFI mode on older servers. In that case, try to boot in BIOS mode. Use either a USB key or the CD/DVD optical drive (the 4th and 5th option on https://bootstrap.grid.tf/) and make sure to select BIOS and not UEFI mode in your server settings. + + +### I connected a SATA SSD to a CD-DVD optical drive adaptor. My system does not recognize the disk. What can I do? + +Try to set AHCI mode instead of Legacy mode in SATA settings in the BIOS. + + +### Can someone explain what should I put in the Public IP part of my farm? Should I just insert my Public IP and Gateway (given by my ISP)? + +Assuming you are a DIY farmer and operate from your home, this field can be left blank. You do not have to fill in any details. + +The add IP option is for farmers that have a block of IP addresses routed to their router (in data centers mostly) and want to present “dedicated IP” addresses for deployments. For more information on how to set the public configuration, go to [this link](https://library.threefold.me/info/manual/#/manual__public_config). + + + + + +## Farming Optimization + +### What is the difference between a ThreeFold 3Node and a ThreeFold farm? What is the difference between the farm ID and the node ID? + +A farm is a composition of one or many 3Nodes. A 3Node is a computer connected to the ThreeFold Grid. Each farm has its farm ID and each 3Node has its node ID. + + + +### How can I know how many GB of SSD and RAM do I need? + +You need 50 GB of SSD per compute units (CU) and a minimum of 500 GB SSD and 2 GB of RAM per 3Node. + +A 3Node has, in general, 2 compute units (CU) per thread. Thus, for peak optimisation, you need 100 GB SSD and 8GB RAM per thread. + +### What is the optimal ratio of virtual cores (vcores or threads), SSD storage and RAM memory? What is the best optimization scenario for a 3Node, in terms of ThreeFold tokens (TFT) farming rewards? + +In short, for peak optimization, aim for 100 GB SSD of storage and 8GB RAM of memory per virtual core (vcore or thread). + +For example, a 32 threads (32 vcores) 3Nodes would need 3.2 TB SSD and 256GB RAM to be optimal, reward-wise. +That is: 32 * 100 = 3200 GB SSD = 3.2TB SSD, and 32 * 8 = 256 GB RAM total. + +Adding more GB of RAM would not increase your TFT rewards. You would need more vcores if you want to expand. + +NB: This is purely based on reward considerations. Some users might need different ratios for different specific uses of the Grid. + + + +### What does TBW mean? What is a good TBW level for a SSD disk? + +TBW means Terabytes Written. TBW directly measures how much you can write cumulatively into the drive over its lifetime. For your 3Node, it can be a good idea to prioritize a minimum ratio of 500 TBW per 1TB for SSD. + +*Note that TBW is not a technical specification, but a general claim from the manufacturer. For this reason, it can also be good to check the warranty of the disk. For example, if a manufacturer offers a 5-year warranty to its product, it indicates that the company thinks its product will last a long time. + + +### Are SATA and SAS drives interchangeable? + +This goes only one way. You can put a SATA drive in a SAS slot, but you can’t put a SAS drive in a SATA slot. See the [next question](#what-is-the-speed-difference-between-sas-and-sata-disks) for more information. + + +### What is the speed difference between SAS and SATA disks? + +One of the big differences between SATA and SAS is the transfer speed. Using SATA disks with SAS cables, you will be limited by the SATA transfer speed. + +* Sata I : 150 MB/s +* Sata II : 300 MB/s +* Sata III : 600 MB/s +* SAS : 600-1500 MB/s + +Note: You will most probably need to re-flash the raid card if you use the front panel disks (onboard storage) of your server. + + + + +### Is it possible to do a graceful shutdown to a 3Node server? How can you shutdown or power off a 3Node server? + +There are no "graceful" shutdowns of 3Nodes. You can shutdown a 3Node from the software side. You need to shut it down manually directly on the hardware. 3Nodes are self-healing and if they suddenly power down, no data or information will be lost. + + + + +### Is it possible to have direct access to Zero-OS's core to force a reboot? + +No, this is not possible. The general philosophy with Zero-OS is: no shell, no GUI, and no remote control. In other words, anything that could potentially provide attack surface is off the table. This ensures a high security level to Zero-OS and the ThreeFold Grid in general. To reboot a 3Node, you have to do it manually. + + + +### Do I need some port forwarding in my router for each 3Node server? + +No, this is not needed. + + +### Are there ways to reduce 3Node servers' noises? + +To reduce the noise, you can remove all the unnecessary cards in the servers as well as the HDD disks if you don't use them. Unplugging the SAS cables can also help. You can also set the fans to adjust their speed instead of being constant. + +At the end of the day, servers were manufactured for durability and efficiency, and not for being quiet. Most servers are placed in server rooms where noise doesn't matter much. + + + +### I built a 3Node out of old hardware. Is it possible that my BIOS or UEFI has improper time and date set as factory default? + +Yes. Make sure you have the correct time and date in BIOS to avoid errors when trying to boot Zero-OS. It might not cause any problems, but sometimes it does. + + + +### I have rack servers in my ThreeFold farm. Can I set rack servers vertically? + +In general, it is not recommended to set rack servers vertically as they were designed to be laid flat in racks. That being said, if you want to set your rack vertically, here are some general rules to follow. Do so at your own risk. + +First, make sure the parts in the servers are well installed and that they will not fall if laid vertically. Second, and foremost, you want to make sure that there will not be any overheating. This means to make sure you don't block the front and rear of the unit, so heat can dissipate thought the vents. + +If you want to put the rack vertically with the longest side of the rack laying upward, having the power supply units (PSUs) on the very top will ensure that heat dissipate well. + + + + +## Farming and Maintenance + +### How can I check if there is utilization on my 3Nodes? + +To see if there is utilization on your 3Node, you can consult the [TF Dashboard](https://dashboard.grid.tf/), go to the Farm section and consult the information under your 3Nodes. Note that the quickest way is to check if there are CPUs reserved. + + + +### Do I need the Zero-OS bootstrap image drive (USB or CD-DVD) when I reboot, or can I boot Zero-OS from the 3Node main hard drive? + +It is advised to keep the bootstrap image plugged in your 3Node. Once your node has been booted with Zero-OS via the USB key, you can remove the USB key, but if something happens and the node needs to reconnect with the network, it won’t be able to do so. We advise people to let the USB key always in so the node can reconnect with the network if needed. + +You need the bootstrap image device plugged in every time you reboot a 3Node and it's a good practice to keep it plugged in all the time. The technical explanation is: (1) at first boot, it creates a minimum requirement on SSD which is used as cache (2) each time the system restarts it reuses this SSD piece but Zero-OS bootstrap is also needed to download the last image. Indeed, image is not stored on the machine and also no boot loader is installed. + + +### It's written that my node is using 100% of HRU. What does it mean? + +HRU stands for your HDD space available. It means that you are using 100% of the HDD space available, or equivalently that you have no HDD on your system. + + +### On the ThreeFold Node Finder, I only see half of the virtual cores or threads my 3Node has, what can I do? + +Check in the BIOS settings and make sure you have enabled Virtual Cores (or Hyper Threading/Logical Cores). + + + +### Why are the 3Nodes' resources different on the ThreeFold Node Finder and the ThreeFold Dashboard? + +There is a difference because one shows the resources in GiB and the other in GB. It's just a way to display information, the resources are ultimately the same, but shown differently. 1 GiB = 1.073741824 GB. + + + +### How can I test the health of my disks? + +There are many ways to test the health of your disks. For some information on this, you can have a look at this [TF forum post](https://forum.threefold.io/t/testing-ssd-health/3436). + + + +### How can I transfer my 3Node from one farm to another? + +To transfer your 3Node from one farm to another, simply make a new bootstrap image of the new farm, connect the new bootstrap image to the 3Node and restart the node. + +Note that you can use [balenaEtcher](https://etcher.balena.io/) to format and burn the bootstrap image at the same time. + + + +### What do CRU, MRU, HRU and SRU mean on the ThreeFold Node Finder? + +CRU means the number of virtual cores. MRU means the GB of ram (memory). HRU means the HDD capacity storage and SRU means the SSD capacity storage. + + + +### I have more than one ThreeFold 3Node farm, but I want all my 3Nodes on only one farm. How can I put all my 3Nodes on one farm? How can I change the farm ID of my 3Node? + +If you have more than one 3Node associated with more than one farm, it is possible to put all the 3Nodes under only one farm. +The following shows how to change the farm ID of your 3Node. + +For each 3Node, you need to create a new USB key Zero-OS boostrap image associated with the chosen farm ID. This will ensure your 3Node links to the chosen farm. +To create a new USB key Zero-OS bootstrap image, you can download the bootstrap image [here](https://v3.bootstrap.grid.tf/) or you can clone an existing USB key bootstrap image associated with the chosen farm ID. In both case, you can use a software like [BalenaEtcher](https://www.balena.io/etcher/). +Once you have the new USB key bootstrap image, plug it into the 3Node and reboot the server. +After reboot, the 3Node will have the same node ID as before, but it will now be associated with the chosen farm ID. + +Note: If you want a new node ID for your 3Node, you will need to wipe the main SSD of your 3Node. + + + +### How can I know if my 3Node is online on the Grid? + +There are multiple answers to this. + +(1) You can plug a monitor to your 3Node and check directly its status. + +(2) You can check your 3Node status by using the Node Finder of the [ThreeFold Dashboard](https://dashboard.grid.tf/). + +(3) You can also use the unofficial, but highly useful [ThreeFold Node Status Bot](https://t.me/tfnodestatusbot) on Telegram. + + + +### I booted my 3Node and the monitor says it's online and connected to the Grid. But the ThreeFold Node Finder says it is offline? What can I do? + +The Node Finder refetches information every 2 hours. You can wait 2 hours and see if the problem persists. Then/or, you could reboot the 3Node and see if the Node Finder sees it as online. + + + +### My 3Node does show on the ThreeFold Node Finder, but not on the ThreeFold Dashboard, what can I do? + +If you're 3Node is correctly registered on the ThreeFold Grid but you cannot see it on the ThreeFold Dashboard, there can be many different ways to solve this issue. + +One way to fix this is to go in the TF Dashboard, select *change the address* and then simply re-paste the same address, then the extension will ask you to resign. Usually this fixes the issue. + +If the first method did not work, you can try to remove the account and add it back up on the Polkadot.js extension. Before doing so, make sure you have a back up of your seed phrase as you will need it to re-enter the account. Your 3Node should then appear. + + +### If I upgrade my 3Node, will it increase my rewards? + +Yes. Use the simulator to verify the additional rewards. But note that, currently, upgrades are not recognized until the next minting cycle. + + +### I booted my 3Node for the first time at the beginning of the month, then I did some upgrade or downgrade, will the ThreeFold Grid recognize the new hardware? Will it still be the same 3Node ID? + +Downgrades are counted in the current minting cycle. So you mint for the entire cycle at the downgraded specs. + +Minting only considers a single configuration per node per cycle, and that is the minimum configuration seen at any point during the cycle. With this logic in mind, upgrades will only be recognized at the next minting cycle. Note that your 3Node will have a new ID and new price entry if you changed the SSD containing the 3Node ID. + + + + + + +### Is it possible to ask the 3Node to refetch the node information on the monitor? + +To refetch information, press " q " on the keyboard. + + + +### When does Zero-OS detect the capacity of a 3Node? + +Zero-OS only detects capacity right after it boots. + + + + +### Where is the 3Node ID stored? + +For the current Zero-OS version, the node ID is stored in the first SSD you install on your 3Node*. If you change or erase this disk, this disk will lose its current 3Node ID. + +*Note that if, at the first boot, you put a SSD SATA and a SSD NVME at the same time, the node ID will be registered on the SSD SATA. + + + + +### Is there a way to backup my node ID in order to restore a 3Node if the disk with the node ID gets corrupted or breaks down? + +Yes, you can do a backup, but as of now this process must be done manually. + +One way is to boot a Linux USB image in *Try* mode, open up the *File* folder of your disk that contains the node ID. Click on *+ Other Locations.* Then, open the folder that contains the folder *zos-cache* and open the folder *identityd.* In this folder, select the file *seed.txt* and make a copy of it in a safe place (USB key, notebook, e-mail, etc.). If the disk which contains your node ID is damaged, simply reboot the 3Node with a new disk and the Zero-OS bootstrap image. Your 3Node will connect to the Grid and assign a new node ID. Once this is done, reboot the 3Node, but this time with the Linux USB image, go in the same folder as stated before and replace the new *seed.txt* file with the old file. Reboot your 3Node with the Zero-OS bootstrap and you're done. + + + +### If I upgrade my 3Node, does it change the node ID? + +Upgrades won't change the node ID, unless you replace the SSD where the node ID is stored (see above for more info on this). + + + + +### Does it make sense to recreate my node when the price drops? + +Short answer: no. Long answer: [click here](https://forum.threefold.io/t/does-it-make-sense-to-recreate-my-node-when-the-price-drops/). + + +### My 3Node lost power momentarily and I had to power it back on manually. Is there a better way to proceed? + +In your BIOS, go in *Security Settings* and choose *Last* for *AC Power Recovery*. If you want, set a delay between 60 and 240 seconds. This will ensure your 3Node does not power on and off frantically if your power flickers on and off, thus potentially damaging the unit. On other BIOS, it's *After Power Loss*, and you should choose *Previous State*. + +*Depending on your 3Node, the parameter might have a different name. + + +### Do I need to change the battery BIOS? + +It can be a good thing to change it when you buy an old desktop or server to make sure it lasts long. When the battery goes out of power, the 3Node won't have access to the BIOS settings if it loses power momentarily. + + + +### Do I need to enable UEFI Network Stack? + +You don't need to if you use a removable media (e.g. USB key) as a booting image. It is needed only if you boot from a PXE server on your network. You should keep this feature disabled. Enable it only if you know 100% what you are doing. Otherwise it might bring vulnerabilities in terms of network security. + + +### I want redundancy of power for my 3 nodes. I have two PSU on my Dell server. What can I do? + +Make sure you enable the Hot Spare feature. This feature is accessible in iDRAC Settings - Power Configuration. Other servers might have this function, with a different name and configuration. Check the server's manual for more details. + + + +### Why isn't there support for RAID? Does Zero-OS work with RAID? + +RAID is a technology that has brought resilience and security to the IT industry. But it has some limitations that we at ThreeFold did not want to get stuck in. We developed a different (and more efficient way to store data reliably. Please have a look [here](https://library.threefold.me/info/threefold#/cloud/threefold__cloud_products?id=storage-quantum-safe-filesystem). + +This Quantum Safe Storage overcomes some of the shortfalls of RAID and is able to work over multiple nodes geographically spread on the TF Grid. + + +### Is there a way to bypass RAID in order for Zero-OS to have bare metals on the system? (No RAID controller in between storage and the Grid.) + +Yes it is possible. "You can use the on board storage on a server without RAID. You can [re-flash](https://fohdeesha.com/docs/perc.html) the RAID card, turn on HBA/non-RAID mode, or install a different card. No need for RAID." @FLnelson It's usually easy to set servers such as a HP Proliant with the HBA mode. For Dell servers, you can either cross-flash the RAID controller with an “IT-mode-Firmware” (see this [video](https://www.youtube.com/watch?v=h5nb09VksYw)) or get a DELL H310-controller (which has the non-RAID option). Otherwise, you can install a NVME SSD with a PCIe adaptor, and turn off the RAID controller. + + + +### I have a 3Node rack server. Is it possible to use a M.2 to SATA adapter in order to put the M.2 SATA disk in the HDD bay (onboard storage)? + +Yes, it is possible. You will most probably need to bypass the RAID controller for Zero-OS to access properly the onboard storage. See previous question. + + + +### My 3Node uses only PCIe adapters and SSD NVME disks. Do I need the RAID controller on? + +The onboard RAID controller is not linked to your PCIe SSDs. In this case, you can switch the RAID controller off. + + + +### Can I change the name of my farm on polkadot.js? + +It’s possible to rename farms through the Polkadot UI. For mainnet, use [this link](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Ftfchain.grid.tf#/extrinsics). + +1. Under *using the selected account*, select the account that owns the farm +2. Choose *tfgridModule* from the dropdown menu *submit the following extrinsic*, +3. Select *updateFarm(id, name, pricingPolicyId)* +4. Under *name: Bytes*, write the new farm name +5. Finally, click on the bottom *Submit Transaction* at the bottom right of the screen + + + +### How can I delete a farm on polkadot.js? + +The ability to delete a farm was removed from TF Chain due to concerns that nodes could be left without a farm and thus cause problems with billing. + + + +### I try to delete a node on the TF Dashboard, but it doesn’t work. Is there any other way to proceed that could work? + +It’s possible to delete nodes through the Polkadot UI. For mainnet, use [this link](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Ftfchain.grid.tf#/extrinsics). + +1. Under *using the selected account*, select the account that owns the farm, +2. Choose *tfgridModule* from the dropdown menu *submit the following extrinsic* +3. Select *deleteNodeFarm(nodeId)* +4. Under *id: u32*, write the ID of the 3Node you want to delete +5. Finally, click on the bottom *Submit Transaction* at the bottom right of the screen + + + +### My 3Node has 2 ethernet ports in the back, with one written AMT above, what does it mean? Can I use this port to connect my 3Node to the ThreeFold Grid? + +First, let's define the term AMT. It means: Active Management Technology. Without going into too much details, it is to remotely access servers via the network at the BIOS level. Thus, you should plug the ethernet cable in the port next to AMT, and not into the AMT port. You can explore AMT properties if you want remote access to your server. + + + +### My 3Node is based on a the hardware Z600, Z620 or Z820, can I run it headless or without a GPU? + +For the Z600, there is a great [video on youtube](https://www.youtube.com/watch?app=desktop&v=JgBYbaT-N-w). + +For the Z620 and the Z820, you need to do some variation on the video above. In the BIOS, go in File, then Replicated Setup, and select Save to Removable Storage Device. This will save a text file on your USB key. Then, in the text file, go to Headless Mode and remove the * in front of Disable and put it in front of Enable. Save the file and then go back into BIOS. Now go in File, then Replicated Setup, and select Restore from Removable Storage Device. + +Running your 3Node without the GPU can save some power consumption as well as giving you one more extra slot for other hardware. + + +### Is it possible to add high-level GPU on rack servers to farm more TFT? + +Some farmers had success installing GPUs such as the RTX3080 in servers as small as 2U (such as R730). Connections such as 250W 8-pin plug are needed on each riser. Generally, tower servers have more space to add high-level GPU. + +Note: GPU farming will be implemented in the future. + + + +### If I change farm, will my node IDs change on my 3Node servers? + +You can move 3Nodes between farms without losing the node IDs. You simply need to change the boot media with the new farm ID and then reboot the 3Node. The 3Node will have the same node ID but it will now be associated with the new farm ID. + + +## Troubleshooting and Error Messages + +### Is it possible to access the Error Screen or Log Screen? + +Yes! On the Zero-OS console, hit alt-F2 to open up the Error/Log Screen, and hit alt-F3 to go back to the main screen. + + +### What does it mean when I see, during the 3Node boot, the message: error = context deadline exceeded? + +In general, this message means that the ThreeFold Grid asked something to your 3Node, and your 3Node could not respond fast enough. It is usually necessary to read the following error message to understand the situation more specifically. + + +### I try to boot a 3Node, but I get the error: "No Route to Host on Linux". What does it mean? + +There are many potential answers to this. Perhaps the Host is offline, the service isn't running. This is usually the reason with TF Grid. It means the Grid is not responsive. In this case, try to boot the 3Node later. If it persists ask TF Support. + +There can also be other reasons. You might have connected to the wrong port. Perhaps you have configured iptables to block connections on that port. Your DNS might be improperly configured. You might have an Incorrect Network or Host Configuration. Many troubleshoots are possible. Here's a [good place to start](https://www.maketecheasier.com/fix-no-route-to-host-error-linux/). + + + +### How can I fix the error: "Network configuration succeed but Zero-OS kernel could not be downloaded" when booting a 3Node? + +To fix the error "Network configuration succeed but Zero-OS kernel could not be downloaded", you can try to restart the router and reboot the 3Node. This usually fixes the issue. If this doesn't work, check if the router is still functional. The cause of this issue might be that your router is broken. + + + +### Using SAS disks, I get the error; "No ssd found, failed to register". What can I do to fix this? + +First make sure to wipe the disks and then boot your 3Node. If you've wiped the disks and it doesn't work, it's been reported that using the command "diskpart clean command" on Windows can fix this issue. + + + +### When booting a 3Node, how to fix the error: "no disks: registration failed"? + +There can be many different fixes for this error. Here are some troubleshooting tips to test separately: + +* In BIOS, enable AHCI +* Make sure to [wipe the disks](../farmers/3node_building/4_wipe_all_disks.md) of the 3Nodes +* If the 3Node has a RAID Controller: + * Disabled the RAID controller, OR; + * [Flash the RAID controller](https://fohdeesha.com/docs/perc.html) (i.e. crossflashing), OR; + * Change the controller to a Dell H310 controller (for Dell servers) +* Try the command **badblocks** (replace **sda** with your specific disk). Note that this command will delete all the data on the disk + * ``` + sudo badblocks -svw -b 512 -t 0x00 /dev/sda + ``` + + +### My SSD is sometimes detected as HDD by Zero-OS when there is a reboot. Is there a fix or a way to test the SSD disk? + +If your SSD disk shows as HDD, usually you can reboot the 3Node and Z-OS adjusts correctly. + +Anyone experiencing frequently this issue where Z-OS sometimes detects an SSD as HDD can try the following: + +* Boot up a live Ubuntu Desktop image +* Run the benchmark utility within the Disks app +* Check if the seektime of the disk is sufficient for Z-OS + * If the seektime is above 0.5ms, Z-OS will consider your SSD as HDD + +**Detailed Steps:** + +* Boot a Ubuntu Linux live USB +* Install **gnome-disks** if it isn't already installed: + * ``` + sudo apt install gnome-disks + ``` +* Open the application launcher and search for **Disks** +* Select your disk +* Click on the tree dots menu +* Select **Benchmark Disk...** + * Use the default parameters + * **Transfer rate**: This is not relevant for our current test + * You can set to it to minimum (e.g. 2) + * **Sample size**: 10 MB is sufficient +* Check the average access time on the [ThreeFold repository](https://www.github.com/threefoldtech/seektime) + * Check seek time for HDD and SSD + * A SSD needs to be <=0.5ms +* If the result is above 0.5ms, this is why Z-OS doesn't recognize the disk properly + * You can then run diagnostics (e.g. smartmontools) + * If this is not fixable, you should change disk (e.g. take a more performing disk) + +Note: The green dots on the output represent seektime and that's what Z-OS is looking at. Specifically, it checks that the average seektime is below 0.5ms. If the seektime is above this, Z-OS will consider your SSD as HDD. + + + +### When booting a 3Node, I get the message: failed to register node: failed to create node: failed to submit extrinsic: Invalid Transaction: registration failed. What could fix this? + +The most probable fix to this error is simply to properly wipe your disk(s): + +* [Wipe your disks on Linux](#what-can-you-do-to-zero-out-your-disks-how-can-i-wipe-the-disks-of-my-3node-server-with-linux) + +* [Wipe your disks on Windows](#how-can-i-wipe-a-disk-with-windows) + + +### I try to boot a 3Node, but I get the message no route with default gateway found. What does it mean? + +First, let's see the main terms. Default gateway act as an access point to other networks, in this case the TF Grid, when there is a back and forth exchange of data packets. + +While the last question implied a communication problem from the Grid, this error message usually means that the 3Node has communication problem. In short, it has difficulty reaching the TF Grid. There are many ways to troubleshoot this error. First, let's give the most direct solution. Make sure you have a direct connection with your Internet Service Provider (ISP): your 3Node should be connected to a router or a switch via an ethernet cable. Wifi doesn't work. Make sure your DHCP is set correctly. + +If the problem persists, check the default gateway of your 3Node and then make sure your router can reach it. + +*See next Q+A for more a possible solution. + + + +### I have trouble connecting the 3Node to the Grid with a 10GB NIC card. What can I do? + +As of now, Zero-OS sometimes has trouble with 10GB NIC card. The easiest solution to this is to connect your 3Node with the 1GB NIC card. This should solve the issue. More fine tuning might be needed to get your 3Node to work with a 10GB NIC card. Future Zero-OS version might solve this issue. + + + +### I switch the ethernet cable to a different port when my 3Node was running. Internet connection is lost. What can I do? + +When your 3Node boots, Zero-OS marks the NIC port. This means you cannot change NIC port when your 3Node is running. You can either put back the ethernet cable in the initial NIC port, or reboot the 3Node. At boot, Zero-OS will marks the new NIC port as the main entry. + + + +### I get the error Certificate is not yet valid when booting my 3Node server, what can I do? + +Make sure your firmware is up to date. If necessary, reinstall it. You might have to install then re-install the firmware if your system is very old. + + + +### When running wipefs to wipe my disks on Linux, I get either of the following errors: "syntax error near unexpected token" or "Probing Initialized Failed". Is there a fix? + +Many different reasons can cause this issue. When you get that error, sometimes it is because your are trying to wipe your boot USB by accident. If this is not the case, and you really are trying to wipe the correct disk, here are some fixes to try out, with the disk `sda` as an example: + +* Fix 1: + * Force the wiping of the disk: + * ``` + sudo wipefs -af /dev/sda + ``` +* Fix 2: + * Unmount the disk then wipe it: + * ``` + sudo umount /dev/sda + ``` + * ``` + sudo wipefs -a /dev/sda + ``` + + + +### I did a format on my SSD disk, but Zero-OS still does not recognize them. What's wrong? + +Formatting is one thing, but to boot properly, Zero-OS needs to work on a completely wipe disk. Thus, make sure you [wipe your disks](#what-can-you-do-to-zero-out-your-disks-how-can-i-wipe-the-disks-with-linux). Formatting is not enough. + + + +### I have a Dell Rx10 server (R610, 710, 910). When I boot Zero-OS I get the message Probing EDD and the 3Node doesn't boot from there. What can I do? + +For the R610 and 710, you can simply re-flash the card. See [this link](https://fohdeesha.com/docs/perc.html) for more information. For the 910, you can’t re-flash the card. In this case, get a LSI Dell card and it should work. (They are cheap when you buy them used online.) + + +### My 3Node doesn't boot properly without a monitor plugged in. What can I do? + +First, try to disable the "Halt On" mode in BIOS. If you do not have this option, try simply enabling the Legacy Support (Dell BIOS for example). If this doesn't work, try to plug in a Dummy Plug/Headless Ghost/Display Emulator in your 3Node. This will simulate a plugged monitor. This should fix the problem. + + +### My 3Node is running on the Grid, but when I plugged in the monitor, it states: Disabling IR #16. Is there a problem? + +In general, you can simply ignore this error statement. This error is linked to the Nvidia binary driver. It simply means that your 3Node lost connection with the graphic card (by unplugging and replugging the monitor for example). + + +### My 3Node won't boot without disabling the Secure Boot option, is it safe? + +In the case where you want to boot Zero-OS, disabling Secure Boot option is safe. With Secure Boot disabled, it can be easier or even necessary when it comes to booting Zero-OS. Secure Boot is used when you want to lock the BIOS/UEFI settings. + + + +### When I tried to boot my 3Node, at some point the screen went black, with or without a blinking hyphen or dash. What could cause this and what could I do to resolve the issue? + +There is a possibility that this happens because you are booting your 3Node on a HDD. A 3Node needs a minimum of 500GB of SSD to work properly. + +Also, make sure that you are using the correct boot option (Legacy BIOS or UEFI) in the Settings and that it corresponds to the correct booting image on the ThreeFold Bootstrap page. + +This problem often arises when you plugged your disks in the wrong controller. For example, try unpluging the disks from the SAS controller, and plug them in the SATA controller. Also, disable the SAS controller if needed. + +In a Legacy BIOS boot, make sure Legacy is enabled and disable *Data Execution Prevention* if possible. + +Also, it might have to do with your RAID controller configuration. Make sure this is properly set. For example, configuring all the HDD disks into one logical disk can fix this problem, or re-flashing the RAID card can also help. + + + +### My 3Nodes go offline after a modem reboot. Is there a way to prevent this? + +Yes, there are many ways to prevent this. An easy solution is to set the DHCP server to reserve local IPs for the 3Nodes MAC addresses. + +This problem is also preventable if your router stays online during the modem reboot. + +Indeed, rebooting the 3Nodes is necessary when there are local IP changes, as 3Nodes are addressed a local IP addresses when they are booted. + +The DHCP will addresses any local IP address that is available when you are booting a 3Node. Reserving local IP addresses is a good TF farming practice. + + + +### When I boot my 3Node, it reaches the Welcome to Zero-OS window, but it doesn't boot properly and there's an error message: failed to load object : type substrate..., what can I do? + +Usually simply rebooting the 3Node fixes this problem. + + + +### When I try to access iDRAC on a web browswer, even with protected mode off, I get the error The webpage cannot be found, what can I do? + +Open iDRAC in the Internet Explorer emulator extension (IE Tab) in Chrome, then update iDRAC. It should work elsewhere then. Sometimes, it will be needed to add "ST1=code" at the end of the IE Tab url. + + + +### When booting the 3Node, I get the error Network interface detected but autoconfiguration failed. What can I do? + +First make sure your network cable is plugged in and that your DHCP is working and responding. If you change the NIC port of the ethernet cable, make sure to reboot the 3Node so Zero-OS can change the NIC port attribution. + +Some farmers reported that this got fixed by simply powering off the 3Node(s), the router and modem for 2 minutes then powering it all back on. Resetting the modem and router (switch on the hardware) in the process can also help. + +If this doesn't work, try to upgrade the firmware of the NIC and the motherboard. If this still doesn't work, the NIC card might be broken. Try with another NIC card. + + + +### When I boot my Dell server, I get the message: All of the disks from your previous configuration are gone... Press any key to continue or 'C' to load the configuration utility. What can I do? + +Many changes to your server can lead to this message. + +Usually, the easiest solution is to reset the disk configuration in iDRAC's configuration utility. + +What can causes this message: + +1. During a new installation, the cables connecting to your external storage are not wired to the correct ports. +2. Your RAID adapter has failed. +3. Your SAS cables are not plugged properly or are malfunctioning. + +Note: Resetting the configuration will destroy all data on all virtual disks. Make sure you know what you are doing! In doubt, ask the TF community. + + + +### I have a Dell R620. In Zero-OS, I get the failure message No network card found and then the 3Node reebots after few seconds. The same happens for every LAN input. What can I do? + +The first thing to try here is to boot the server in BIOS mode instead of UEFI mode. If this doesn't fix the problem, try the following. + +Sometimes, this happens when the firmwares of BIOS, iDRAC, Lifecycle Controller and NIC are incompatible to each other. The solution is then to update them all correctly. Some problems can arise in the process. + +First, you should try to do the updates using iDRAC as you can update both iDRAC and BIOS there. If this does not work, try to update separate, with a live-linux distro, the BIOS, iDRAC and Lifecycle Controller. Once this is done, the server should be able to do a liveupdate, https to dell support website, via lifecycle-controller. This would update the other components. For more details on this method, watch [this video](https://www.youtube.com/watch?v=ISA7j2BKgjI). + +Note: Some farmers have reported that the Broadcom NIC card does not work well for Zero-OS and that a standard Intel PCI NIC card replacement resolved the issue. This could be a more straightforward method if updating the firmwares doesn't resolve the issue. + + + +### I am using freeDos to crossflash my raid controller on a Dell server, but I can't see the RAID controller with the Command Info. What can I do? + +Turn on the raid controller in the BIOS, otherwise freeDos does not show you the raid controller with the command Info. + + + +### Can I use a VGA to HDMI adaptor to connect a TV screen or monitor to the 3Node? I tried to boot a 3Node with a VGA to HDMI adaptor but the boot fails, what can I do? + +This might work, but it has been reported by farmers that Zero-OS might have difficulties booting when this is done with a VGA/HDMI adaptor on a TV screen. This is most likely due to the TV screen not supporting the output once the system loaded into Zero-OS. The easy fix to this issue is to use a standard computer monitor with a VGA plug. + + + +### When I try to boot my 3Node, the fans start spinning fast with a loud noise and the screen is black. What can I do to resolve this? + +There may be several causes to this issue. You can try to remove all the RAM sticks, to clean the dust and then to reseat the RAM sticks. If it still doesn't resolve the issue, you can check the RAM sticks one by one to see if one is malfunctioning. This often resolves the issue. Also, some cables might not be properly connected. + + + +### When booting Zero-OS with IPV6 configurations, I get the errors (1) dial tcp: address IPV6-address too many columns in address and (2) no pools matches key: not routable. What can I do to fix this issue? + +This usually means that the IPV6 attributed is not valid. It is also often caused when the DNS configuration does not resolve IPV6 correctly. + +To fix this issue, it is often necessary to adjust the IPV6 settings related to the router and the modem. Confirming with your Internet service provider (ISP) that the IPV6 settings are properly configured could also be necessary to fix the issue. + + + + +### When booting a 3Node, Zero-OS downloads fine, but then I get the message: error no route with default gateway found, and the message: info check if interface has a cable plugged in. What could fix this? + +Make sure you have network stack enabled in BIOS. If so, check you ethernet port and make sure that it's clean. Also make sure the ethernet rj45 connectors are clean on both ends. If that does not work, verify the state of your SATA cables. If all this doesn't work, download and re-install Zero-OS. + + + +### How can I update Dell and HP servers to Intel E5-2600v2, E5-2400v2 and E5-4600v2, when applicable? + +There are many ressources online with steps on how to do this. You can check this [youtube video](https://www.youtube.com/watch?v=duzrULLtonM) on Dell and HP servers, as welll as this [documentation](https://ixnfo.com/en/hp-proliant-gen8-update-to-support-cpu-e5-2600v2-e5-2400v2-e5-4600v2.html) for HP Proliant Gen8. + + + +### How can I update the firmware and driver of a Dell PowerEdge server? + +Dell has excellen documentation for this. Read [this](https://www.dell.com/support/kbdoc/en-us/000128194/updating-firmware-and-drivers-on-dell-emc-poweredge-servers) for the detailed steps. + + + +### When I boot a 3Node in UEFI mode, it gets stuck at: Initializing Network Device, is there a way to fix this? + +In short, booting the 3Node in BIOS mode instead of UEFI mode usually fixes this issue. + +You can make bootable USB with the USB option of the [Zero-OS bootstrap image page](https://bootstrap.grid.tf/). Make sure to boot your server using BIOS and not UEFI. In the boot sequence, make the USB as your first choice to boot. + + + +### When I boot my 3Node, it gets stuck during the Zero-OS download. It never reaches 100%. What can I do to fix this issue? + +Here are some ways to troubleshoot your 3Node when it cannot download Zero-OS completely (to 100%): + +* Sometimes, just rebooting the 3Node and/or trying a little bit later can work. +* It can help to reboot the modem and the router. +* Make sure your BIOS/UEFI is up to date. Updating the BIOS/UEFI can help. +* It can also help to set the correct date and time. + + + +### When booting a 3Node, I get the error=“context deadline exceeded” module=network error=failed to initialize rmb api failed to initialized admin mw: failed to get farm: farm not found: object not found. What can I do to fix this issue? + +Usually, the simple fix to this issue is to make sure that your bootstrap image is on the same network as your farm. For example, if you created your farm on the Main net, you should use a Main net Zero-OS bootstrap image. + + + +## ThreeFold Grid and Data + + +### How is the farming minting reward calculated? Is the Grid always monitoring my 3Node? + +The Grid uses an algorithm that does not continually monitor the 3Node. It does its best to determine uptime through occasional checking in, which we call ping. The 3Node sends a ping to the Grid and the Grid sends a ping to the 3Node to confirm the reception. (Ping-Pong!) + +It’s helpful to understand that the Grid is really just 3Nodes and TF Chain (which itself is a collection of nodes). Nodes report their uptime by writing an entry on TF Chain, about once every two hours. These reports are used for minting. + + + +### How does communication happen on the ThreeFold Grid at the 3Node's level? + +There are two ways to get information about nodes. Once is to query TF Chain, and the other is to communicate with nodes directly. + + + +### What is the ThreeFold Node Status bot Telegram link? + +The link is the following: https://t.me/tfnodestatusbot. + + + +### How does the ThreeFold Node Status bot work? How can I use the ThreeFold Node Status bot to verify if my 3Node is online? + +1. Click on this link: https://t.me/tfnodestatusbot + +2. To subscribe a node, write the command */subscribe nodeID*. With the ID 100 as example, write: */subscribe 100* + +3. To verify the status of all your 3Nodes, write: */status* + +4. To verify the status of all your 3Nodes through Yggdrasil, write: */ping* + +Note: The bot should send you alerts when it considers any registered node to be offline. + + + +### How does the Telegram Status Bot get information from my 3Node? My 3Node is online on the ThreeFold Node Finder, but offline on the Telegram Status Bot, is this normal? + +The status bot communicates directly by sending pings to the nodes over Yggdrasil every five minutes. Therefore, it will report on temporary network interruptions that might not affect your total uptime calculation as used for minting. + + + +### I noticed that when I reboot my 3Node, the uptime counter on the ThreeFold Node Finder goes back to zero. Does it mean I lose uptime and the uptime start over again when I reboot the 3Node? + +No. The only uptime you lose is the time your 3Node was offline from the ThreeFold Grid. This ThreeFold Grid still has the data of your total uptime of the month. The Node Finder only shows this statistics as: "*This node has been up non-stop without being rebooted for now* [insert time]". If you maintain a total uptime above the minimum uptime, you're fine. + +*For now the farming rewards are proportional to the total uptime. + + +### One of my nodes is showing the wrong location. Any problem with that? +The ThreeFold Node Finder is showing your ISP location. This is perfectly normal. + + +## Memory + +### Can I use different type of RAM for the same 3Node? + +No. Always use the same type of RAM per 3Node. If you use RDIMM, go all RDIMM, etc. Check your hardware specifications to make sure you have the right type of memory. + + + +### How can I know if the memory I am buying is correct for my specific hardware? + +To be sure, look into the owner's manual of your specific computer. + +In general, you can go to [Memory.net](https://memory.net/) and look for your specific computer model. As general steps, select your computer's system in *By system*, then select the series and then select the specific model of the series. You will then see available memories to buy from memory.net. You can also simply read the documentation at the bottom. The memory type supported by your computer will be explained. Then you can buy the memory needed from any other computer store. + +For servers, you can check with Cloudninja's documentation [here](https://cloudninjas.com/pages/server-memory). Search for your specific hardware and look for the compatible memory. This reference is good for rack and tower servers. + + + +### What do the terms RDIMM, LDIMM, UDIMM, LRDIMM, FBDIMM mean when it comes to RAM memory sticks? + +Well first, the DIMM means dual inline memory module. + +* U stands for or unregistered (or unbuffered). + +* R stands for registered memory. + +* LR stands for load-reduced. + +* FB stands for fully-buffered. + + + +### What is the difference between ECC and non-ECC memory? + +ECC means error correction code memory. This type of memory can detect and correct data corruption. Non-ECC mostly cannot detect nor correct, but some can detect, but never correct data corruption. Check your hardware specifications to make sure you have the right type of memory (ECC or non-ECC). + + +### How can I change the RAM memory sticks on my 3Nodes? How can I achieve dual channel configuration with sticks of RAM? + +First, always use RAM sticks of the same size and type. It should be noted on your motherboard which slots to populate first. As a general guide, there is usually 2 slots A and B, with each 2 memory stick entries. You must then install the ram sticks on A1 and B1 in order to achieve dual channel, then A2 and B2 if you have more (visual order: A1 A2 B1 B2). + +> Example: You want to start with your largest sticks, evenly distributed between both processors and work your way down to your smallest. Let's take an example with 2 processors as well as 4x 16GB sticks and 4x 8GB sticks. The arrangement would be A1-16GB, B1-16GB, A2-16GB, B2-16GB, A3-8GB, B3-8GB, A4-8GB, B4-8GB. Avoid odd numbers as well. You optimally want pairs. So if you only have 5x 8GB sticks, only install 4 until you have an even 6. + + + +### What does RAM mean? + +RAM means random access memory. Those type of memory can be read and changed in any order. + + + + +### What does DIMM mean when it comes to RAM sticks? + +It means *dual in-line memory module*. This type of computer memory is natively 64 bits, enabling fast data transfer. + + + +### I have 24 DIMMS ram slots on my server. Can I use them all? + +Be careful when installing memory on a server. Always check your server's documentation to make sure your RAM sticks combination are correct. + +For example, on the Dell R720, you can have 24x16gb RAM ECC sticks, but it can only handle 16 Quad ranked DIMMs. In this case, you can fill up all slots with registered DIMMs if you have a maximum of 4 quad DIMMS ranked on each CPU. + +# Ask a Question to the ThreeFold Community + +If you have any question, you can ask the ThreeFold community via the ThreeFold forum or the ThreeFold Telegram channels: + +* [ThreeFold Forum](https://forum.threefold.io/) +* [ThreeFold General TG Channel](https://t.me/threefold) +* [ThreeFold Farmer TG Channel](https://t.me/threefoldfarmers) +* [TF Grid Tester TG Channel](https://t.me/threefoldtesting) + +> Note 1: If we wrote something wrong, tell us! + +> Note 2: This is a collective effort. A big *Thank You* to the great ThreeFold Community. Many Q+A are contributions from the enthusiast farmers, users and developers of the ever-growing ThreeFold community. \ No newline at end of file diff --git a/collections/tfmanual/documentation/faq/img/3nodes.png b/collections/tfmanual/documentation/faq/img/3nodes.png new file mode 100644 index 0000000..c7fe437 Binary files /dev/null and b/collections/tfmanual/documentation/faq/img/3nodes.png differ diff --git a/collections/tfmanual/documentation/faq/img/faq_img_readme.md b/collections/tfmanual/documentation/faq/img/faq_img_readme.md new file mode 100644 index 0000000..5c71297 --- /dev/null +++ b/collections/tfmanual/documentation/faq/img/faq_img_readme.md @@ -0,0 +1 @@ +# Image folder for the FAQ of the Threefold Manual 3.0 diff --git a/collections/tfmanual/documentation/faq/img/minting2022.png b/collections/tfmanual/documentation/faq/img/minting2022.png new file mode 100644 index 0000000..3335f69 Binary files /dev/null and b/collections/tfmanual/documentation/faq/img/minting2022.png differ diff --git a/collections/tfmanual/documentation/faq/img/tf_general.jpg b/collections/tfmanual/documentation/faq/img/tf_general.jpg new file mode 100644 index 0000000..9925a1d Binary files /dev/null and b/collections/tfmanual/documentation/faq/img/tf_general.jpg differ diff --git a/collections/tfmanual/documentation/faq/img/tf_grid.png b/collections/tfmanual/documentation/faq/img/tf_grid.png new file mode 100644 index 0000000..3996369 Binary files /dev/null and b/collections/tfmanual/documentation/faq/img/tf_grid.png differ diff --git a/collections/tfmanual/documentation/faq/img/tf_grid_3nodes.png b/collections/tfmanual/documentation/faq/img/tf_grid_3nodes.png new file mode 100644 index 0000000..49f5a98 Binary files /dev/null and b/collections/tfmanual/documentation/faq/img/tf_grid_3nodes.png differ diff --git a/collections/tfmanual/documentation/faq/img/wethreepedia_developer.png b/collections/tfmanual/documentation/faq/img/wethreepedia_developer.png new file mode 100644 index 0000000..58a1967 Binary files /dev/null and b/collections/tfmanual/documentation/faq/img/wethreepedia_developer.png differ diff --git a/collections/tfmanual/documentation/faq/img/wethreepedia_faq_poster.jpg b/collections/tfmanual/documentation/faq/img/wethreepedia_faq_poster.jpg new file mode 100644 index 0000000..bf43918 Binary files /dev/null and b/collections/tfmanual/documentation/faq/img/wethreepedia_faq_poster.jpg differ diff --git a/collections/tfmanual/documentation/faq/img/wethreepedia_validator.jpg b/collections/tfmanual/documentation/faq/img/wethreepedia_validator.jpg new file mode 100644 index 0000000..f23a7cf Binary files /dev/null and b/collections/tfmanual/documentation/faq/img/wethreepedia_validator.jpg differ diff --git a/collections/documentation/farmers/3node_building/1_create_farm.md b/collections/tfmanual/documentation/farmers/3node_building/1_create_farm.md similarity index 100% rename from collections/documentation/farmers/3node_building/1_create_farm.md rename to collections/tfmanual/documentation/farmers/3node_building/1_create_farm.md diff --git a/collections/documentation/farmers/3node_building/2_bootstrap_image.md b/collections/tfmanual/documentation/farmers/3node_building/2_bootstrap_image.md similarity index 100% rename from collections/documentation/farmers/3node_building/2_bootstrap_image.md rename to collections/tfmanual/documentation/farmers/3node_building/2_bootstrap_image.md diff --git a/collections/documentation/farmers/3node_building/3_set_hardware.md b/collections/tfmanual/documentation/farmers/3node_building/3_set_hardware.md similarity index 100% rename from collections/documentation/farmers/3node_building/3_set_hardware.md rename to collections/tfmanual/documentation/farmers/3node_building/3_set_hardware.md diff --git a/collections/documentation/farmers/3node_building/3node_building.md b/collections/tfmanual/documentation/farmers/3node_building/3node_building.md similarity index 100% rename from collections/documentation/farmers/3node_building/3node_building.md rename to collections/tfmanual/documentation/farmers/3node_building/3node_building.md diff --git a/collections/documentation/farmers/3node_building/4_wipe_all_disks.md b/collections/tfmanual/documentation/farmers/3node_building/4_wipe_all_disks.md similarity index 100% rename from collections/documentation/farmers/3node_building/4_wipe_all_disks.md rename to collections/tfmanual/documentation/farmers/3node_building/4_wipe_all_disks.md diff --git a/collections/documentation/farmers/3node_building/5_set_bios_uefi.md b/collections/tfmanual/documentation/farmers/3node_building/5_set_bios_uefi.md similarity index 100% rename from collections/documentation/farmers/3node_building/5_set_bios_uefi.md rename to collections/tfmanual/documentation/farmers/3node_building/5_set_bios_uefi.md diff --git a/collections/documentation/farmers/3node_building/6_boot_3node.md b/collections/tfmanual/documentation/farmers/3node_building/6_boot_3node.md similarity index 100% rename from collections/documentation/farmers/3node_building/6_boot_3node.md rename to collections/tfmanual/documentation/farmers/3node_building/6_boot_3node.md diff --git a/collections/documentation/farmers/3node_building/gpu_farming.md b/collections/tfmanual/documentation/farmers/3node_building/gpu_farming.md similarity index 100% rename from collections/documentation/farmers/3node_building/gpu_farming.md rename to collections/tfmanual/documentation/farmers/3node_building/gpu_farming.md diff --git a/collections/documentation/farmers/3node_building/img/bootstrap_disable-gpu.png b/collections/tfmanual/documentation/farmers/3node_building/img/bootstrap_disable-gpu.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/bootstrap_disable-gpu.png rename to collections/tfmanual/documentation/farmers/3node_building/img/bootstrap_disable-gpu.png diff --git a/collections/documentation/farmers/3node_building/img/bootstrap_kernel_list.png b/collections/tfmanual/documentation/farmers/3node_building/img/bootstrap_kernel_list.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/bootstrap_kernel_list.png rename to collections/tfmanual/documentation/farmers/3node_building/img/bootstrap_kernel_list.png diff --git a/collections/documentation/farmers/3node_building/img/cli_display_gpu.png b/collections/tfmanual/documentation/farmers/3node_building/img/cli_display_gpu.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/cli_display_gpu.png rename to collections/tfmanual/documentation/farmers/3node_building/img/cli_display_gpu.png diff --git a/collections/documentation/farmers/3node_building/img/dashboard_1.png b/collections/tfmanual/documentation/farmers/3node_building/img/dashboard_1.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/dashboard_1.png rename to collections/tfmanual/documentation/farmers/3node_building/img/dashboard_1.png diff --git a/collections/documentation/farmers/3node_building/img/dashboard_2.png b/collections/tfmanual/documentation/farmers/3node_building/img/dashboard_2.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/dashboard_2.png rename to collections/tfmanual/documentation/farmers/3node_building/img/dashboard_2.png diff --git a/collections/documentation/farmers/3node_building/img/dashboard_4.png b/collections/tfmanual/documentation/farmers/3node_building/img/dashboard_4.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/dashboard_4.png rename to collections/tfmanual/documentation/farmers/3node_building/img/dashboard_4.png diff --git a/collections/documentation/farmers/3node_building/img/dashboard_5.png b/collections/tfmanual/documentation/farmers/3node_building/img/dashboard_5.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/dashboard_5.png rename to collections/tfmanual/documentation/farmers/3node_building/img/dashboard_5.png diff --git a/collections/documentation/farmers/3node_building/img/dashboard_6.png b/collections/tfmanual/documentation/farmers/3node_building/img/dashboard_6.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/dashboard_6.png rename to collections/tfmanual/documentation/farmers/3node_building/img/dashboard_6.png diff --git a/collections/tfmanual/documentation/farmers/3node_building/img/dashboard_bootstrap_farm.png b/collections/tfmanual/documentation/farmers/3node_building/img/dashboard_bootstrap_farm.png new file mode 100644 index 0000000..82f8759 Binary files /dev/null and b/collections/tfmanual/documentation/farmers/3node_building/img/dashboard_bootstrap_farm.png differ diff --git a/collections/documentation/farmers/3node_building/img/dashboard_create_farm.png b/collections/tfmanual/documentation/farmers/3node_building/img/dashboard_create_farm.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/dashboard_create_farm.png rename to collections/tfmanual/documentation/farmers/3node_building/img/dashboard_create_farm.png diff --git a/collections/documentation/farmers/3node_building/img/dashboard_farm_name.png b/collections/tfmanual/documentation/farmers/3node_building/img/dashboard_farm_name.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/dashboard_farm_name.png rename to collections/tfmanual/documentation/farmers/3node_building/img/dashboard_farm_name.png diff --git a/collections/documentation/farmers/3node_building/img/dashboard_tf_mnemonics.png b/collections/tfmanual/documentation/farmers/3node_building/img/dashboard_tf_mnemonics.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/dashboard_tf_mnemonics.png rename to collections/tfmanual/documentation/farmers/3node_building/img/dashboard_tf_mnemonics.png diff --git a/collections/documentation/farmers/3node_building/img/dashboard_tfchain_create_account.png b/collections/tfmanual/documentation/farmers/3node_building/img/dashboard_tfchain_create_account.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/dashboard_tfchain_create_account.png rename to collections/tfmanual/documentation/farmers/3node_building/img/dashboard_tfchain_create_account.png diff --git a/collections/documentation/farmers/3node_building/img/dashboard_tfconnect_wallet_1.png b/collections/tfmanual/documentation/farmers/3node_building/img/dashboard_tfconnect_wallet_1.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/dashboard_tfconnect_wallet_1.png rename to collections/tfmanual/documentation/farmers/3node_building/img/dashboard_tfconnect_wallet_1.png diff --git a/collections/documentation/farmers/3node_building/img/dashboard_tfconnect_wallet_2.png b/collections/tfmanual/documentation/farmers/3node_building/img/dashboard_tfconnect_wallet_2.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/dashboard_tfconnect_wallet_2.png rename to collections/tfmanual/documentation/farmers/3node_building/img/dashboard_tfconnect_wallet_2.png diff --git a/collections/documentation/farmers/3node_building/img/dashboard_walletaddress_1.png b/collections/tfmanual/documentation/farmers/3node_building/img/dashboard_walletaddress_1.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/dashboard_walletaddress_1.png rename to collections/tfmanual/documentation/farmers/3node_building/img/dashboard_walletaddress_1.png diff --git a/collections/documentation/farmers/3node_building/img/dashboard_walletaddress_2.png b/collections/tfmanual/documentation/farmers/3node_building/img/dashboard_walletaddress_2.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/dashboard_walletaddress_2.png rename to collections/tfmanual/documentation/farmers/3node_building/img/dashboard_walletaddress_2.png diff --git a/collections/documentation/farmers/3node_building/img/dashboard_your_farms.png b/collections/tfmanual/documentation/farmers/3node_building/img/dashboard_your_farms.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/dashboard_your_farms.png rename to collections/tfmanual/documentation/farmers/3node_building/img/dashboard_your_farms.png diff --git a/collections/documentation/farmers/3node_building/img/farming_001.png b/collections/tfmanual/documentation/farmers/3node_building/img/farming_001.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/farming_001.png rename to collections/tfmanual/documentation/farmers/3node_building/img/farming_001.png diff --git a/collections/documentation/farmers/3node_building/img/farming_30.png b/collections/tfmanual/documentation/farmers/3node_building/img/farming_30.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/farming_30.png rename to collections/tfmanual/documentation/farmers/3node_building/img/farming_30.png diff --git a/collections/documentation/farmers/3node_building/img/farming_createfarm_1.png b/collections/tfmanual/documentation/farmers/3node_building/img/farming_createfarm_1.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/farming_createfarm_1.png rename to collections/tfmanual/documentation/farmers/3node_building/img/farming_createfarm_1.png diff --git a/collections/documentation/farmers/3node_building/img/farming_createfarm_2.png b/collections/tfmanual/documentation/farmers/3node_building/img/farming_createfarm_2.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/farming_createfarm_2.png rename to collections/tfmanual/documentation/farmers/3node_building/img/farming_createfarm_2.png diff --git a/collections/documentation/farmers/3node_building/img/farming_createfarm_21.png b/collections/tfmanual/documentation/farmers/3node_building/img/farming_createfarm_21.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/farming_createfarm_21.png rename to collections/tfmanual/documentation/farmers/3node_building/img/farming_createfarm_21.png diff --git a/collections/documentation/farmers/3node_building/img/farming_createfarm_22.png b/collections/tfmanual/documentation/farmers/3node_building/img/farming_createfarm_22.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/farming_createfarm_22.png rename to collections/tfmanual/documentation/farmers/3node_building/img/farming_createfarm_22.png diff --git a/collections/documentation/farmers/3node_building/img/farming_createfarm_23.png b/collections/tfmanual/documentation/farmers/3node_building/img/farming_createfarm_23.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/farming_createfarm_23.png rename to collections/tfmanual/documentation/farmers/3node_building/img/farming_createfarm_23.png diff --git a/collections/documentation/farmers/3node_building/img/farming_createfarm_24.png b/collections/tfmanual/documentation/farmers/3node_building/img/farming_createfarm_24.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/farming_createfarm_24.png rename to collections/tfmanual/documentation/farmers/3node_building/img/farming_createfarm_24.png diff --git a/collections/documentation/farmers/3node_building/img/farming_createfarm_3.png b/collections/tfmanual/documentation/farmers/3node_building/img/farming_createfarm_3.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/farming_createfarm_3.png rename to collections/tfmanual/documentation/farmers/3node_building/img/farming_createfarm_3.png diff --git a/collections/documentation/farmers/3node_building/img/farming_createfarm_4.png b/collections/tfmanual/documentation/farmers/3node_building/img/farming_createfarm_4.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/farming_createfarm_4.png rename to collections/tfmanual/documentation/farmers/3node_building/img/farming_createfarm_4.png diff --git a/collections/documentation/farmers/3node_building/img/farming_createfarm_5.png b/collections/tfmanual/documentation/farmers/3node_building/img/farming_createfarm_5.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/farming_createfarm_5.png rename to collections/tfmanual/documentation/farmers/3node_building/img/farming_createfarm_5.png diff --git a/collections/documentation/farmers/3node_building/img/farming_createfarm_6.png b/collections/tfmanual/documentation/farmers/3node_building/img/farming_createfarm_6.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/farming_createfarm_6.png rename to collections/tfmanual/documentation/farmers/3node_building/img/farming_createfarm_6.png diff --git a/collections/documentation/farmers/3node_building/img/farming_createfarm_7.png b/collections/tfmanual/documentation/farmers/3node_building/img/farming_createfarm_7.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/farming_createfarm_7.png rename to collections/tfmanual/documentation/farmers/3node_building/img/farming_createfarm_7.png diff --git a/collections/documentation/farmers/3node_building/img/farming_createfarm_8.png b/collections/tfmanual/documentation/farmers/3node_building/img/farming_createfarm_8.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/farming_createfarm_8.png rename to collections/tfmanual/documentation/farmers/3node_building/img/farming_createfarm_8.png diff --git a/collections/documentation/farmers/3node_building/img/tf_dashboard_2023_1.png b/collections/tfmanual/documentation/farmers/3node_building/img/tf_dashboard_2023_1.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/tf_dashboard_2023_1.png rename to collections/tfmanual/documentation/farmers/3node_building/img/tf_dashboard_2023_1.png diff --git a/collections/documentation/farmers/3node_building/img/tf_dashboard_2023_10.png b/collections/tfmanual/documentation/farmers/3node_building/img/tf_dashboard_2023_10.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/tf_dashboard_2023_10.png rename to collections/tfmanual/documentation/farmers/3node_building/img/tf_dashboard_2023_10.png diff --git a/collections/documentation/farmers/3node_building/img/tf_dashboard_2023_11.png b/collections/tfmanual/documentation/farmers/3node_building/img/tf_dashboard_2023_11.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/tf_dashboard_2023_11.png rename to collections/tfmanual/documentation/farmers/3node_building/img/tf_dashboard_2023_11.png diff --git a/collections/documentation/farmers/3node_building/img/tf_dashboard_2023_12.png b/collections/tfmanual/documentation/farmers/3node_building/img/tf_dashboard_2023_12.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/tf_dashboard_2023_12.png rename to collections/tfmanual/documentation/farmers/3node_building/img/tf_dashboard_2023_12.png diff --git a/collections/documentation/farmers/3node_building/img/tf_dashboard_2023_13.png b/collections/tfmanual/documentation/farmers/3node_building/img/tf_dashboard_2023_13.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/tf_dashboard_2023_13.png rename to collections/tfmanual/documentation/farmers/3node_building/img/tf_dashboard_2023_13.png diff --git a/collections/documentation/farmers/3node_building/img/tf_dashboard_2023_14.png b/collections/tfmanual/documentation/farmers/3node_building/img/tf_dashboard_2023_14.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/tf_dashboard_2023_14.png rename to collections/tfmanual/documentation/farmers/3node_building/img/tf_dashboard_2023_14.png diff --git a/collections/documentation/farmers/3node_building/img/tf_dashboard_2023_15.png b/collections/tfmanual/documentation/farmers/3node_building/img/tf_dashboard_2023_15.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/tf_dashboard_2023_15.png rename to collections/tfmanual/documentation/farmers/3node_building/img/tf_dashboard_2023_15.png diff --git a/collections/documentation/farmers/3node_building/img/tf_dashboard_2023_16.png b/collections/tfmanual/documentation/farmers/3node_building/img/tf_dashboard_2023_16.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/tf_dashboard_2023_16.png rename to collections/tfmanual/documentation/farmers/3node_building/img/tf_dashboard_2023_16.png diff --git a/collections/documentation/farmers/3node_building/img/tf_dashboard_2023_2.png b/collections/tfmanual/documentation/farmers/3node_building/img/tf_dashboard_2023_2.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/tf_dashboard_2023_2.png rename to collections/tfmanual/documentation/farmers/3node_building/img/tf_dashboard_2023_2.png diff --git a/collections/documentation/farmers/3node_building/img/tf_dashboard_2023_4.png b/collections/tfmanual/documentation/farmers/3node_building/img/tf_dashboard_2023_4.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/tf_dashboard_2023_4.png rename to collections/tfmanual/documentation/farmers/3node_building/img/tf_dashboard_2023_4.png diff --git a/collections/documentation/farmers/3node_building/img/tf_dashboard_2023_5.png b/collections/tfmanual/documentation/farmers/3node_building/img/tf_dashboard_2023_5.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/tf_dashboard_2023_5.png rename to collections/tfmanual/documentation/farmers/3node_building/img/tf_dashboard_2023_5.png diff --git a/collections/documentation/farmers/3node_building/img/tf_dashboard_2023_6.png b/collections/tfmanual/documentation/farmers/3node_building/img/tf_dashboard_2023_6.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/tf_dashboard_2023_6.png rename to collections/tfmanual/documentation/farmers/3node_building/img/tf_dashboard_2023_6.png diff --git a/collections/documentation/farmers/3node_building/img/tf_dashboard_2023_7.png b/collections/tfmanual/documentation/farmers/3node_building/img/tf_dashboard_2023_7.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/tf_dashboard_2023_7.png rename to collections/tfmanual/documentation/farmers/3node_building/img/tf_dashboard_2023_7.png diff --git a/collections/documentation/farmers/3node_building/img/tf_dashboard_2023_8.png b/collections/tfmanual/documentation/farmers/3node_building/img/tf_dashboard_2023_8.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/tf_dashboard_2023_8.png rename to collections/tfmanual/documentation/farmers/3node_building/img/tf_dashboard_2023_8.png diff --git a/collections/documentation/farmers/3node_building/img/tf_dashboard_2023_9.png b/collections/tfmanual/documentation/farmers/3node_building/img/tf_dashboard_2023_9.png similarity index 100% rename from collections/documentation/farmers/3node_building/img/tf_dashboard_2023_9.png rename to collections/tfmanual/documentation/farmers/3node_building/img/tf_dashboard_2023_9.png diff --git a/collections/documentation/farmers/3node_building/minting_receipts.md b/collections/tfmanual/documentation/farmers/3node_building/minting_receipts.md similarity index 100% rename from collections/documentation/farmers/3node_building/minting_receipts.md rename to collections/tfmanual/documentation/farmers/3node_building/minting_receipts.md diff --git a/collections/documentation/farmers/advanced_networking/advanced_networking_toc.md b/collections/tfmanual/documentation/farmers/advanced_networking/advanced_networking_toc.md similarity index 100% rename from collections/documentation/farmers/advanced_networking/advanced_networking_toc.md rename to collections/tfmanual/documentation/farmers/advanced_networking/advanced_networking_toc.md diff --git a/collections/documentation/farmers/advanced_networking/network_considerations.md b/collections/tfmanual/documentation/farmers/advanced_networking/network_considerations.md similarity index 100% rename from collections/documentation/farmers/advanced_networking/network_considerations.md rename to collections/tfmanual/documentation/farmers/advanced_networking/network_considerations.md diff --git a/collections/documentation/farmers/advanced_networking/network_setup.md b/collections/tfmanual/documentation/farmers/advanced_networking/network_setup.md similarity index 100% rename from collections/documentation/farmers/advanced_networking/network_setup.md rename to collections/tfmanual/documentation/farmers/advanced_networking/network_setup.md diff --git a/collections/documentation/farmers/advanced_networking/networking_overview.md b/collections/tfmanual/documentation/farmers/advanced_networking/networking_overview.md similarity index 100% rename from collections/documentation/farmers/advanced_networking/networking_overview.md rename to collections/tfmanual/documentation/farmers/advanced_networking/networking_overview.md diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/3node_diy_desktop.md b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/3node_diy_desktop.md similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/3node_diy_desktop.md rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/3node_diy_desktop.md diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_104.jpeg b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_104.jpeg similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_104.jpeg rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_104.jpeg diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_105.jpeg b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_105.jpeg similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_105.jpeg rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_105.jpeg diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_106.jpeg b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_106.jpeg similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_106.jpeg rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_106.jpeg diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_107.jpeg b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_107.jpeg similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_107.jpeg rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_107.jpeg diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_108.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_108.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_108.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_108.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_109.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_109.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_109.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_109.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_110.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_110.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_110.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_110.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_111.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_111.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_111.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_111.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_112.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_112.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_112.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_112.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_114.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_114.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_114.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_114.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_115.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_115.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_115.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_115.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_116.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_116.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_116.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_116.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_117.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_117.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_117.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_117.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_118.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_118.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_118.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_118.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_119.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_119.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_119.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_119.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_120.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_120.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_120.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_120.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_121.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_121.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_121.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_121.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_122.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_122.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_122.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_122.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_123.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_123.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_123.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_123.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_124.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_124.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_124.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_124.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_125.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_125.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_125.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_125.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_126.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_126.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_126.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_126.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_127.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_127.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_127.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_127.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_128.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_128.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_128.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_128.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_129.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_129.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_129.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_129.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_13.jpeg b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_13.jpeg similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_13.jpeg rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_13.jpeg diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_130.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_130.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_130.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_130.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_23.jpeg b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_23.jpeg similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_23.jpeg rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_23.jpeg diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_25.jpeg b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_25.jpeg similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_25.jpeg rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_25.jpeg diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_26.jpeg b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_26.jpeg similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_26.jpeg rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_26.jpeg diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_27.jpeg b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_27.jpeg similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_27.jpeg rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_27.jpeg diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_28.jpeg b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_28.jpeg similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_28.jpeg rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_28.jpeg diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_29.jpeg b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_29.jpeg similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_29.jpeg rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_29.jpeg diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_3.jpeg b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_3.jpeg similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_3.jpeg rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_3.jpeg diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_3.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_3.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_3.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_3.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_30.jpeg b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_30.jpeg similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_30.jpeg rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_30.jpeg diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_31.jpeg b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_31.jpeg similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_31.jpeg rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_31.jpeg diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_38.jpeg b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_38.jpeg similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_38.jpeg rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_38.jpeg diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_40.jpeg b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_40.jpeg similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_40.jpeg rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_40.jpeg diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_42.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_42.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_42.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_42.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_43.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_43.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_43.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_43.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_44.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_44.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_44.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_44.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_45.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_45.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_45.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_45.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_48.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_48.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_48.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_48.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_49.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_49.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_49.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_49.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_50.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_50.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_50.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_50.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_52.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_52.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_52.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_52.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_53.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_53.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_53.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_53.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_54.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_54.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_54.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_54.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_55.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_55.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_55.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_55.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_56.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_56.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_56.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_56.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_6.jpeg b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_6.jpeg similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_6.jpeg rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_6.jpeg diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_6.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_6.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_6.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_6.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_67.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_67.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_67.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_67.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_68.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_68.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_68.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_68.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_69.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_69.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_69.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_69.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_70.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_70.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_70.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_70.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_71.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_71.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_71.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_71.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_72.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_72.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_72.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_72.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_73.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_73.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_73.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_73.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_74.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_74.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_74.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_74.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_75.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_75.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_75.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_75.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_76.jpeg b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_76.jpeg similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_76.jpeg rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_76.jpeg diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_76.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_76.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_76.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_76.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_77.jpeg b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_77.jpeg similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_77.jpeg rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_77.jpeg diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_78.jpeg b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_78.jpeg similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_78.jpeg rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_78.jpeg diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_80.jpeg b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_80.jpeg similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_80.jpeg rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_80.jpeg diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_81.jpeg b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_81.jpeg similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_81.jpeg rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_81.jpeg diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_83.jpeg b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_83.jpeg similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_83.jpeg rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_83.jpeg diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_86.jpeg b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_86.jpeg similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_86.jpeg rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_86.jpeg diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_88.jpeg b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_88.jpeg similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_88.jpeg rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_88.jpeg diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_89.jpeg b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_89.jpeg similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_89.jpeg rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_89.jpeg diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_90.jpeg b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_90.jpeg similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_90.jpeg rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_90.jpeg diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_91.jpeg b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_91.jpeg similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_91.jpeg rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_91.jpeg diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_92.jpeg b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_92.jpeg similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_92.jpeg rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_92.jpeg diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_94.jpeg b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_94.jpeg similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_94.jpeg rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_94.jpeg diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_95.jpeg b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_95.jpeg similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_95.jpeg rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_95.jpeg diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_96.jpeg b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_96.jpeg similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_96.jpeg rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_96.jpeg diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_97.jpeg b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_97.jpeg similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_97.jpeg rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_97.jpeg diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_98.jpeg b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_98.jpeg similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_98.jpeg rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/3node_diy_desktop_98.jpeg diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_001.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_001.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_001.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_001.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_002.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_002.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_002.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_002.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_003.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_003.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_003.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_003.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_004.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_004.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_004.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_004.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_005.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_005.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_005.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_005.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_006.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_006.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_006.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_006.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_25.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_25.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_25.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_25.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_26.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_26.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_26.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_26.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_27.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_27.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_27.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_27.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_28.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_28.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_28.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_28.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_29.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_29.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_29.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_29.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_30.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_30.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_30.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_30.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_1.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_1.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_1.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_1.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_10.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_10.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_10.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_10.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_11.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_11.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_11.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_11.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_12.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_12.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_12.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_12.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_13.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_13.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_13.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_13.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_14.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_14.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_14.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_14.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_15.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_15.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_15.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_15.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_16.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_16.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_16.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_16.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_17.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_17.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_17.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_17.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_18.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_18.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_18.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_18.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_19.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_19.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_19.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_19.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_2.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_2.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_2.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_2.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_20.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_20.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_20.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_20.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_21.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_21.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_21.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_21.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_22.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_22.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_22.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_22.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_23.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_23.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_23.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_23.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_24.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_24.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_24.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_24.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_3.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_3.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_3.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_3.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_4.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_4.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_4.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_4.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_5.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_5.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_5.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_5.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_6.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_6.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_6.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_6.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_7.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_7.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_7.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_7.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_8.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_8.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_8.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_8.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_9.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_9.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_9.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_createfarm_9.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_1.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_1.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_1.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_1.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_10.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_10.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_10.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_10.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_11.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_11.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_11.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_11.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_12.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_12.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_12.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_12.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_13.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_13.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_13.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_13.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_14.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_14.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_14.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_14.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_15.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_15.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_15.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_15.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_16.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_16.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_16.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_16.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_17.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_17.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_17.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_17.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_18.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_18.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_18.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_18.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_19.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_19.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_19.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_19.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_2.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_2.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_2.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_2.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_20.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_20.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_20.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_20.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_21.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_21.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_21.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_21.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_22.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_22.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_22.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_22.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_23.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_23.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_23.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_23.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_24.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_24.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_24.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_24.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_25.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_25.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_25.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_25.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_26.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_26.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_26.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_26.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_27.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_27.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_27.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_27.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_28.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_28.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_28.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_28.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_29.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_29.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_29.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_29.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_3.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_3.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_3.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_3.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_30.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_30.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_30.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_30.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_31.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_31.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_31.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_31.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_32.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_32.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_32.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_32.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_33.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_33.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_33.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_33.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_34.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_34.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_34.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_34.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_35.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_35.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_35.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_35.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_36.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_36.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_36.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_36.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_37.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_37.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_37.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_37.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_38.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_38.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_38.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_38.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_39.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_39.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_39.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_39.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_4.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_4.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_4.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_4.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_40.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_40.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_40.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_40.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_41.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_41.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_41.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_41.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_42.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_42.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_42.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_42.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_43.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_43.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_43.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_43.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_44.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_44.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_44.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_44.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_45.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_45.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_45.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_45.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_46.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_46.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_46.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_46.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_47.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_47.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_47.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_47.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_48.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_48.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_48.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_48.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_49.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_49.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_49.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_49.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_5.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_5.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_5.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_5.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_50.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_50.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_50.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_50.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_51.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_51.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_51.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_51.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_52.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_52.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_52.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_52.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_53.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_53.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_53.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_53.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_54.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_54.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_54.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_54.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_55.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_55.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_55.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_55.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_56.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_56.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_56.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_56.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_57.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_57.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_57.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_57.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_58.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_58.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_58.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_58.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_59.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_59.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_59.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_59.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_6.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_6.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_6.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_6.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_7.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_7.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_7.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_7.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_8.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_8.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_8.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_8.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_9.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_9.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_9.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_tf_wallet_9.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_wallet_10.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_wallet_10.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_wallet_10.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_wallet_10.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_wallet_11.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_wallet_11.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_wallet_11.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_wallet_11.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_wallet_12.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_wallet_12.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_wallet_12.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_wallet_12.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_wallet_13.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_wallet_13.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_wallet_13.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_wallet_13.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_wallet_5.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_wallet_5.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_wallet_5.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_wallet_5.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_wallet_7.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_wallet_7.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_wallet_7.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_wallet_7.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_wallet_8.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_wallet_8.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_wallet_8.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_wallet_8.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_wallet_9.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_wallet_9.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_wallet_9.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/farming_wallet_9.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/old_backup/farming_createfarm_12.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/old_backup/farming_createfarm_12.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/old_backup/farming_createfarm_12.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/old_backup/farming_createfarm_12.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/old_backup/farming_createfarm_13.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/old_backup/farming_createfarm_13.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/old_backup/farming_createfarm_13.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/old_backup/farming_createfarm_13.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/readme.md b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/readme.md similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/readme.md rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/img/readme.md diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/readme.md b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/readme.md similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_desktop/readme.md rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_desktop/readme.md diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/3node_diy_rack_server.md b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/3node_diy_rack_server.md similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/3node_diy_rack_server.md rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/3node_diy_rack_server.md diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_1.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_1.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_1.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_1.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_10.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_10.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_10.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_10.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_11.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_11.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_11.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_11.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_12.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_12.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_12.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_12.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_13.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_13.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_13.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_13.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_14.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_14.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_14.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_14.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_15.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_15.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_15.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_15.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_16.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_16.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_16.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_16.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_17.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_17.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_17.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_17.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_18.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_18.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_18.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_18.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_19.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_19.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_19.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_19.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_2.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_2.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_2.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_2.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_20.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_20.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_20.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_20.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_21.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_21.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_21.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_21.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_22.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_22.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_22.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_22.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_23.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_23.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_23.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_23.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_24.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_24.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_24.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_24.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_25.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_25.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_25.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_25.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_26.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_26.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_26.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_26.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_27.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_27.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_27.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_27.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_28.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_28.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_28.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_28.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_29.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_29.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_29.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_29.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_3.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_3.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_3.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_3.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_30.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_30.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_30.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_30.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_31.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_31.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_31.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_31.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_32.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_32.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_32.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_32.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_33.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_33.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_33.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_33.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_34.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_34.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_34.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_34.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_35.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_35.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_35.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_35.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_36.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_36.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_36.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_36.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_37.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_37.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_37.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_37.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_38.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_38.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_38.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_38.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_39.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_39.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_39.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_39.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_4.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_4.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_4.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_4.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_40.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_40.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_40.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_40.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_41.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_41.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_41.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_41.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_42.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_42.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_42.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_42.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_43.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_43.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_43.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_43.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_44.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_44.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_44.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_44.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_45.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_45.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_45.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_45.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_46.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_46.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_46.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_46.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_47.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_47.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_47.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_47.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_5.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_5.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_5.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_5.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_6.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_6.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_6.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_6.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_7.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_7.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_7.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_7.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_8.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_8.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_8.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_8.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_9.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_9.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_9.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/3node_diy_rack_server_9.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/farming_30.png b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/farming_30.png similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/farming_30.png rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/farming_30.png diff --git a/collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/readme.md b/collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/readme.md similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/readme.md rename to collections/tfmanual/documentation/farmers/complete_diy_guides/3node_diy_rack_server/img/readme.md diff --git a/collections/documentation/farmers/complete_diy_guides/complete_diy_guides_readme.md b/collections/tfmanual/documentation/farmers/complete_diy_guides/complete_diy_guides_readme.md similarity index 100% rename from collections/documentation/farmers/complete_diy_guides/complete_diy_guides_readme.md rename to collections/tfmanual/documentation/farmers/complete_diy_guides/complete_diy_guides_readme.md diff --git a/collections/documentation/farmers/farmerbot/farmerbot_information.md b/collections/tfmanual/documentation/farmers/farmerbot/farmerbot_information.md similarity index 100% rename from collections/documentation/farmers/farmerbot/farmerbot_information.md rename to collections/tfmanual/documentation/farmers/farmerbot/farmerbot_information.md diff --git a/collections/documentation/farmers/farmerbot/farmerbot_intro.md b/collections/tfmanual/documentation/farmers/farmerbot/farmerbot_intro.md similarity index 100% rename from collections/documentation/farmers/farmerbot/farmerbot_intro.md rename to collections/tfmanual/documentation/farmers/farmerbot/farmerbot_intro.md diff --git a/collections/documentation/farmers/farmerbot/farmerbot_minting.md b/collections/tfmanual/documentation/farmers/farmerbot/farmerbot_minting.md similarity index 100% rename from collections/documentation/farmers/farmerbot/farmerbot_minting.md rename to collections/tfmanual/documentation/farmers/farmerbot/farmerbot_minting.md diff --git a/collections/documentation/farmers/farmerbot/farmerbot_quick.md b/collections/tfmanual/documentation/farmers/farmerbot/farmerbot_quick.md similarity index 100% rename from collections/documentation/farmers/farmerbot/farmerbot_quick.md rename to collections/tfmanual/documentation/farmers/farmerbot/farmerbot_quick.md diff --git a/collections/documentation/farmers/farmerbot/img/farmerbot_4.png b/collections/tfmanual/documentation/farmers/farmerbot/img/farmerbot_4.png similarity index 100% rename from collections/documentation/farmers/farmerbot/img/farmerbot_4.png rename to collections/tfmanual/documentation/farmers/farmerbot/img/farmerbot_4.png diff --git a/collections/documentation/farmers/farmerbot/img/farmerbot_5.png b/collections/tfmanual/documentation/farmers/farmerbot/img/farmerbot_5.png similarity index 100% rename from collections/documentation/farmers/farmerbot/img/farmerbot_5.png rename to collections/tfmanual/documentation/farmers/farmerbot/img/farmerbot_5.png diff --git a/collections/documentation/farmers/farmerbot/img/farmerbot_bios_1.jpeg b/collections/tfmanual/documentation/farmers/farmerbot/img/farmerbot_bios_1.jpeg similarity index 100% rename from collections/documentation/farmers/farmerbot/img/farmerbot_bios_1.jpeg rename to collections/tfmanual/documentation/farmers/farmerbot/img/farmerbot_bios_1.jpeg diff --git a/collections/documentation/farmers/farmerbot/img/farmerbot_bios_2.jpeg b/collections/tfmanual/documentation/farmers/farmerbot/img/farmerbot_bios_2.jpeg similarity index 100% rename from collections/documentation/farmers/farmerbot/img/farmerbot_bios_2.jpeg rename to collections/tfmanual/documentation/farmers/farmerbot/img/farmerbot_bios_2.jpeg diff --git a/collections/documentation/farmers/farmerbot/img/farmerbot_bios_3.png b/collections/tfmanual/documentation/farmers/farmerbot/img/farmerbot_bios_3.png similarity index 100% rename from collections/documentation/farmers/farmerbot/img/farmerbot_bios_3.png rename to collections/tfmanual/documentation/farmers/farmerbot/img/farmerbot_bios_3.png diff --git a/collections/documentation/farmers/farmers.md b/collections/tfmanual/documentation/farmers/farmers.md similarity index 100% rename from collections/documentation/farmers/farmers.md rename to collections/tfmanual/documentation/farmers/farmers.md diff --git a/collections/documentation/farmers/farming_optimization/calculate_roi.md b/collections/tfmanual/documentation/farmers/farming_optimization/calculate_roi.md similarity index 100% rename from collections/documentation/farmers/farming_optimization/calculate_roi.md rename to collections/tfmanual/documentation/farmers/farming_optimization/calculate_roi.md diff --git a/collections/documentation/farmers/farming_optimization/farm_room_parameters.md b/collections/tfmanual/documentation/farmers/farming_optimization/farm_room_parameters.md similarity index 100% rename from collections/documentation/farmers/farming_optimization/farm_room_parameters.md rename to collections/tfmanual/documentation/farmers/farming_optimization/farm_room_parameters.md diff --git a/collections/documentation/farmers/farming_optimization/farming_costs.md b/collections/tfmanual/documentation/farmers/farming_optimization/farming_costs.md similarity index 100% rename from collections/documentation/farmers/farming_optimization/farming_costs.md rename to collections/tfmanual/documentation/farmers/farming_optimization/farming_costs.md diff --git a/collections/documentation/farmers/farming_optimization/farming_optimization.md b/collections/tfmanual/documentation/farmers/farming_optimization/farming_optimization.md similarity index 100% rename from collections/documentation/farmers/farming_optimization/farming_optimization.md rename to collections/tfmanual/documentation/farmers/farming_optimization/farming_optimization.md diff --git a/collections/documentation/farmers/farming_optimization/minting_periods.md b/collections/tfmanual/documentation/farmers/farming_optimization/minting_periods.md similarity index 100% rename from collections/documentation/farmers/farming_optimization/minting_periods.md rename to collections/tfmanual/documentation/farmers/farming_optimization/minting_periods.md diff --git a/collections/documentation/farmers/farming_optimization/set_additional_fees.md b/collections/tfmanual/documentation/farmers/farming_optimization/set_additional_fees.md similarity index 100% rename from collections/documentation/farmers/farming_optimization/set_additional_fees.md rename to collections/tfmanual/documentation/farmers/farming_optimization/set_additional_fees.md diff --git a/collections/documentation/farmers/img/farming_30.png b/collections/tfmanual/documentation/farmers/img/farming_30.png similarity index 100% rename from collections/documentation/farmers/img/farming_30.png rename to collections/tfmanual/documentation/farmers/img/farming_30.png diff --git a/collections/documentation/system_administrators/advanced/advanced.md b/collections/tfmanual/documentation/system_administrators/advanced/advanced.md similarity index 100% rename from collections/documentation/system_administrators/advanced/advanced.md rename to collections/tfmanual/documentation/system_administrators/advanced/advanced.md diff --git a/collections/documentation/system_administrators/advanced/cancel_contracts.md b/collections/tfmanual/documentation/system_administrators/advanced/cancel_contracts.md similarity index 100% rename from collections/documentation/system_administrators/advanced/cancel_contracts.md rename to collections/tfmanual/documentation/system_administrators/advanced/cancel_contracts.md diff --git a/collections/documentation/system_administrators/advanced/contract_bill_report.md b/collections/tfmanual/documentation/system_administrators/advanced/contract_bill_report.md similarity index 100% rename from collections/documentation/system_administrators/advanced/contract_bill_report.md rename to collections/tfmanual/documentation/system_administrators/advanced/contract_bill_report.md diff --git a/collections/documentation/system_administrators/advanced/grid3_redis.md b/collections/tfmanual/documentation/system_administrators/advanced/grid3_redis.md similarity index 100% rename from collections/documentation/system_administrators/advanced/grid3_redis.md rename to collections/tfmanual/documentation/system_administrators/advanced/grid3_redis.md diff --git a/collections/documentation/system_administrators/advanced/grid3_stellar_tfchain_bridge.md b/collections/tfmanual/documentation/system_administrators/advanced/grid3_stellar_tfchain_bridge.md similarity index 100% rename from collections/documentation/system_administrators/advanced/grid3_stellar_tfchain_bridge.md rename to collections/tfmanual/documentation/system_administrators/advanced/grid3_stellar_tfchain_bridge.md diff --git a/collections/documentation/system_administrators/advanced/img/advanced_.png b/collections/tfmanual/documentation/system_administrators/advanced/img/advanced_.png similarity index 100% rename from collections/documentation/system_administrators/advanced/img/advanced_.png rename to collections/tfmanual/documentation/system_administrators/advanced/img/advanced_.png diff --git a/collections/documentation/system_administrators/advanced/img/billing_rate.png b/collections/tfmanual/documentation/system_administrators/advanced/img/billing_rate.png similarity index 100% rename from collections/documentation/system_administrators/advanced/img/billing_rate.png rename to collections/tfmanual/documentation/system_administrators/advanced/img/billing_rate.png diff --git a/collections/tfmanual/documentation/system_administrators/advanced/img/bridge.png b/collections/tfmanual/documentation/system_administrators/advanced/img/bridge.png new file mode 100644 index 0000000..269dead Binary files /dev/null and b/collections/tfmanual/documentation/system_administrators/advanced/img/bridge.png differ diff --git a/collections/tfmanual/documentation/system_administrators/advanced/img/bridge_deposit.png b/collections/tfmanual/documentation/system_administrators/advanced/img/bridge_deposit.png new file mode 100644 index 0000000..97619cc Binary files /dev/null and b/collections/tfmanual/documentation/system_administrators/advanced/img/bridge_deposit.png differ diff --git a/collections/tfmanual/documentation/system_administrators/advanced/img/bridge_withdraw.png b/collections/tfmanual/documentation/system_administrators/advanced/img/bridge_withdraw.png new file mode 100644 index 0000000..461a80d Binary files /dev/null and b/collections/tfmanual/documentation/system_administrators/advanced/img/bridge_withdraw.png differ diff --git a/collections/documentation/system_administrators/advanced/img/contracts_list.png b/collections/tfmanual/documentation/system_administrators/advanced/img/contracts_list.png similarity index 100% rename from collections/documentation/system_administrators/advanced/img/contracts_list.png rename to collections/tfmanual/documentation/system_administrators/advanced/img/contracts_list.png diff --git a/collections/documentation/system_administrators/advanced/img/ipfs_logo.png b/collections/tfmanual/documentation/system_administrators/advanced/img/ipfs_logo.png similarity index 100% rename from collections/documentation/system_administrators/advanced/img/ipfs_logo.png rename to collections/tfmanual/documentation/system_administrators/advanced/img/ipfs_logo.png diff --git a/collections/documentation/system_administrators/advanced/img/polka_web_add_development_url.png b/collections/tfmanual/documentation/system_administrators/advanced/img/polka_web_add_development_url.png similarity index 100% rename from collections/documentation/system_administrators/advanced/img/polka_web_add_development_url.png rename to collections/tfmanual/documentation/system_administrators/advanced/img/polka_web_add_development_url.png diff --git a/collections/documentation/system_administrators/advanced/img/polka_web_cancel_contracts.jpg b/collections/tfmanual/documentation/system_administrators/advanced/img/polka_web_cancel_contracts.jpg similarity index 100% rename from collections/documentation/system_administrators/advanced/img/polka_web_cancel_contracts.jpg rename to collections/tfmanual/documentation/system_administrators/advanced/img/polka_web_cancel_contracts.jpg diff --git a/collections/documentation/system_administrators/advanced/img/swap_to_stellar.png b/collections/tfmanual/documentation/system_administrators/advanced/img/swap_to_stellar.png similarity index 100% rename from collections/documentation/system_administrators/advanced/img/swap_to_stellar.png rename to collections/tfmanual/documentation/system_administrators/advanced/img/swap_to_stellar.png diff --git a/collections/documentation/system_administrators/advanced/ipfs/ipfs_fullvm.md b/collections/tfmanual/documentation/system_administrators/advanced/ipfs/ipfs_fullvm.md similarity index 100% rename from collections/documentation/system_administrators/advanced/ipfs/ipfs_fullvm.md rename to collections/tfmanual/documentation/system_administrators/advanced/ipfs/ipfs_fullvm.md diff --git a/collections/documentation/system_administrators/advanced/ipfs/ipfs_microvm.md b/collections/tfmanual/documentation/system_administrators/advanced/ipfs/ipfs_microvm.md similarity index 100% rename from collections/documentation/system_administrators/advanced/ipfs/ipfs_microvm.md rename to collections/tfmanual/documentation/system_administrators/advanced/ipfs/ipfs_microvm.md diff --git a/collections/documentation/system_administrators/advanced/ipfs/ipfs_toc.md b/collections/tfmanual/documentation/system_administrators/advanced/ipfs/ipfs_toc.md similarity index 100% rename from collections/documentation/system_administrators/advanced/ipfs/ipfs_toc.md rename to collections/tfmanual/documentation/system_administrators/advanced/ipfs/ipfs_toc.md diff --git a/collections/documentation/system_administrators/advanced/list_public_ips.md b/collections/tfmanual/documentation/system_administrators/advanced/list_public_ips.md similarity index 100% rename from collections/documentation/system_administrators/advanced/list_public_ips.md rename to collections/tfmanual/documentation/system_administrators/advanced/list_public_ips.md diff --git a/collections/documentation/system_administrators/advanced/token_transfer_keygenerator.md b/collections/tfmanual/documentation/system_administrators/advanced/token_transfer_keygenerator.md similarity index 100% rename from collections/documentation/system_administrators/advanced/token_transfer_keygenerator.md rename to collections/tfmanual/documentation/system_administrators/advanced/token_transfer_keygenerator.md diff --git a/collections/documentation/system_administrators/computer_it_basics/cli_scripts_basics.md b/collections/tfmanual/documentation/system_administrators/computer_it_basics/cli_scripts_basics.md similarity index 100% rename from collections/documentation/system_administrators/computer_it_basics/cli_scripts_basics.md rename to collections/tfmanual/documentation/system_administrators/computer_it_basics/cli_scripts_basics.md diff --git a/collections/documentation/system_administrators/computer_it_basics/computer_it_basics.md b/collections/tfmanual/documentation/system_administrators/computer_it_basics/computer_it_basics.md similarity index 100% rename from collections/documentation/system_administrators/computer_it_basics/computer_it_basics.md rename to collections/tfmanual/documentation/system_administrators/computer_it_basics/computer_it_basics.md diff --git a/collections/documentation/system_administrators/computer_it_basics/docker_basics.md b/collections/tfmanual/documentation/system_administrators/computer_it_basics/docker_basics.md similarity index 100% rename from collections/documentation/system_administrators/computer_it_basics/docker_basics.md rename to collections/tfmanual/documentation/system_administrators/computer_it_basics/docker_basics.md diff --git a/collections/documentation/system_administrators/computer_it_basics/file_transfer.md b/collections/tfmanual/documentation/system_administrators/computer_it_basics/file_transfer.md similarity index 100% rename from collections/documentation/system_administrators/computer_it_basics/file_transfer.md rename to collections/tfmanual/documentation/system_administrators/computer_it_basics/file_transfer.md diff --git a/collections/documentation/system_administrators/computer_it_basics/firewall_basics/firewall_basics.md b/collections/tfmanual/documentation/system_administrators/computer_it_basics/firewall_basics/firewall_basics.md similarity index 100% rename from collections/documentation/system_administrators/computer_it_basics/firewall_basics/firewall_basics.md rename to collections/tfmanual/documentation/system_administrators/computer_it_basics/firewall_basics/firewall_basics.md diff --git a/collections/documentation/system_administrators/computer_it_basics/firewall_basics/firewalld_basics.md b/collections/tfmanual/documentation/system_administrators/computer_it_basics/firewall_basics/firewalld_basics.md similarity index 100% rename from collections/documentation/system_administrators/computer_it_basics/firewall_basics/firewalld_basics.md rename to collections/tfmanual/documentation/system_administrators/computer_it_basics/firewall_basics/firewalld_basics.md diff --git a/collections/documentation/system_administrators/computer_it_basics/firewall_basics/ufw_basics.md b/collections/tfmanual/documentation/system_administrators/computer_it_basics/firewall_basics/ufw_basics.md similarity index 100% rename from collections/documentation/system_administrators/computer_it_basics/firewall_basics/ufw_basics.md rename to collections/tfmanual/documentation/system_administrators/computer_it_basics/firewall_basics/ufw_basics.md diff --git a/collections/documentation/system_administrators/computer_it_basics/git_github_basics.md b/collections/tfmanual/documentation/system_administrators/computer_it_basics/git_github_basics.md similarity index 100% rename from collections/documentation/system_administrators/computer_it_basics/git_github_basics.md rename to collections/tfmanual/documentation/system_administrators/computer_it_basics/git_github_basics.md diff --git a/collections/documentation/system_administrators/getstarted/TF_Connect/README.md b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/README.md similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Connect/README.md rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/README.md diff --git a/collections/documentation/system_administrators/getstarted/TF_Connect/TF_Connect.md b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/TF_Connect.md similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Connect/TF_Connect.md rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/TF_Connect.md diff --git a/collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_1.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_1.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_1.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_1.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_10.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_10.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_10.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_10.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_11.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_11.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_11.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_11.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_12.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_12.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_12.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_12.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_13.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_13.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_13.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_13.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_14.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_14.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_14.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_14.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_15.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_15.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_15.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_15.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_16.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_16.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_16.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_16.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_17.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_17.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_17.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_17.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_18.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_18.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_18.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_18.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_19.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_19.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_19.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_19.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_2.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_2.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_2.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_2.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_20.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_20.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_20.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_20.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_21.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_21.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_21.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_21.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_3.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_3.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_3.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_3.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_39.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_39.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_39.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_39.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_4.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_4.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_4.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_4.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_40.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_40.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_40.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_40.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_41.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_41.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_41.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_41.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_42.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_42.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_42.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_42.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_43.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_43.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_43.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_43.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_5.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_5.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_5.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_5.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_6.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_6.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_6.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_6.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_7.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_7.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_7.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_7.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_8.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_8.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_8.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_8.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_9.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_9.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_9.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Connect/img/farming_tf_wallet_9.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Dashboard/TF_Dashboard.md b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Dashboard/TF_Dashboard.md similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Dashboard/TF_Dashboard.md rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Dashboard/TF_Dashboard.md diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_ethereum/img/tft_on_ethereum_image_1.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_ethereum/img/tft_on_ethereum_image_1.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_ethereum/img/tft_on_ethereum_image_1.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_ethereum/img/tft_on_ethereum_image_1.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_ethereum/img/tft_on_ethereum_image_2.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_ethereum/img/tft_on_ethereum_image_2.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_ethereum/img/tft_on_ethereum_image_2.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_ethereum/img/tft_on_ethereum_image_2.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_ethereum/img/tft_on_ethereum_image_3.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_ethereum/img/tft_on_ethereum_image_3.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_ethereum/img/tft_on_ethereum_image_3.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_ethereum/img/tft_on_ethereum_image_3.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_ethereum/img/tft_on_ethereum_image_4.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_ethereum/img/tft_on_ethereum_image_4.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_ethereum/img/tft_on_ethereum_image_4.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_ethereum/img/tft_on_ethereum_image_4.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_ethereum/img/tft_on_ethereum_image_5.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_ethereum/img/tft_on_ethereum_image_5.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_ethereum/img/tft_on_ethereum_image_5.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_ethereum/img/tft_on_ethereum_image_5.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_ethereum/tft_ethereum.md b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_ethereum/tft_ethereum.md similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_ethereum/tft_ethereum.md rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_ethereum/tft_ethereum.md diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_1.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_1.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_1.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_1.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_10.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_10.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_10.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_10.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_11.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_11.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_11.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_11.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_12.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_12.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_12.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_12.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_13.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_13.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_13.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_13.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_14.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_14.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_14.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_14.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_15.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_15.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_15.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_15.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_16.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_16.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_16.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_16.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_17.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_17.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_17.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_17.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_18.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_18.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_18.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_18.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_19.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_19.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_19.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_19.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_2.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_2.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_2.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_2.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_20.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_20.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_20.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_20.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_21.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_21.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_21.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_21.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_22.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_22.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_22.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_22.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_23.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_23.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_23.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_23.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_24.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_24.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_24.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_24.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_25.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_25.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_25.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_25.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_26.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_26.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_26.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_26.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_27.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_27.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_27.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_27.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_28.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_28.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_28.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_28.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_29.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_29.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_29.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_29.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_3.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_3.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_3.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_3.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_30.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_30.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_30.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_30.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_31.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_31.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_31.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_31.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_32.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_32.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_32.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_32.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_33.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_33.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_33.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_33.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_34.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_34.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_34.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_34.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_4.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_4.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_4.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_4.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_5.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_5.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_5.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_5.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_6.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_6.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_6.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_6.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_7.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_7.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_7.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_7.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_8.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_8.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_8.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_8.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_9.png b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_9.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_9.png rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/img/gettft_9.png diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/tft_lobstr.md b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/tft_lobstr.md similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/tft_lobstr.md rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_lobstr/tft_lobstr.md diff --git a/collections/documentation/system_administrators/getstarted/TF_Token/tft_toc.md b/collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_toc.md similarity index 100% rename from collections/documentation/system_administrators/getstarted/TF_Token/tft_toc.md rename to collections/tfmanual/documentation/system_administrators/getstarted/TF_Token/tft_toc.md diff --git a/collections/documentation/system_administrators/getstarted/img/endlessscalable.png b/collections/tfmanual/documentation/system_administrators/getstarted/img/endlessscalable.png similarity index 100% rename from collections/documentation/system_administrators/getstarted/img/endlessscalable.png rename to collections/tfmanual/documentation/system_administrators/getstarted/img/endlessscalable.png diff --git a/collections/documentation/system_administrators/getstarted/img/network_concepts_.jpg b/collections/tfmanual/documentation/system_administrators/getstarted/img/network_concepts_.jpg similarity index 100% rename from collections/documentation/system_administrators/getstarted/img/network_concepts_.jpg rename to collections/tfmanual/documentation/system_administrators/getstarted/img/network_concepts_.jpg diff --git a/collections/documentation/system_administrators/getstarted/img/peer2peer_net_.jpg b/collections/tfmanual/documentation/system_administrators/getstarted/img/peer2peer_net_.jpg similarity index 100% rename from collections/documentation/system_administrators/getstarted/img/peer2peer_net_.jpg rename to collections/tfmanual/documentation/system_administrators/getstarted/img/peer2peer_net_.jpg diff --git a/collections/documentation/system_administrators/getstarted/img/stfgrid3_storage_concepts_.jpg b/collections/tfmanual/documentation/system_administrators/getstarted/img/stfgrid3_storage_concepts_.jpg similarity index 100% rename from collections/documentation/system_administrators/getstarted/img/stfgrid3_storage_concepts_.jpg rename to collections/tfmanual/documentation/system_administrators/getstarted/img/stfgrid3_storage_concepts_.jpg diff --git a/collections/documentation/system_administrators/getstarted/img/webgw_.jpg b/collections/tfmanual/documentation/system_administrators/getstarted/img/webgw_.jpg similarity index 100% rename from collections/documentation/system_administrators/getstarted/img/webgw_.jpg rename to collections/tfmanual/documentation/system_administrators/getstarted/img/webgw_.jpg diff --git a/collections/documentation/system_administrators/getstarted/planetarynetwork.md b/collections/tfmanual/documentation/system_administrators/getstarted/planetarynetwork.md similarity index 100% rename from collections/documentation/system_administrators/getstarted/planetarynetwork.md rename to collections/tfmanual/documentation/system_administrators/getstarted/planetarynetwork.md diff --git a/collections/documentation/system_administrators/getstarted/remote-desktop_gui/cockpit_guide/cockpit_guide.md b/collections/tfmanual/documentation/system_administrators/getstarted/remote-desktop_gui/cockpit_guide/cockpit_guide.md similarity index 100% rename from collections/documentation/system_administrators/getstarted/remote-desktop_gui/cockpit_guide/cockpit_guide.md rename to collections/tfmanual/documentation/system_administrators/getstarted/remote-desktop_gui/cockpit_guide/cockpit_guide.md diff --git a/collections/documentation/system_administrators/getstarted/remote-desktop_gui/guacamole_guide/guacamole_guide.md b/collections/tfmanual/documentation/system_administrators/getstarted/remote-desktop_gui/guacamole_guide/guacamole_guide.md similarity index 100% rename from collections/documentation/system_administrators/getstarted/remote-desktop_gui/guacamole_guide/guacamole_guide.md rename to collections/tfmanual/documentation/system_administrators/getstarted/remote-desktop_gui/guacamole_guide/guacamole_guide.md diff --git a/collections/documentation/system_administrators/getstarted/remote-desktop_gui/remote-desktop_gui.md b/collections/tfmanual/documentation/system_administrators/getstarted/remote-desktop_gui/remote-desktop_gui.md similarity index 100% rename from collections/documentation/system_administrators/getstarted/remote-desktop_gui/remote-desktop_gui.md rename to collections/tfmanual/documentation/system_administrators/getstarted/remote-desktop_gui/remote-desktop_gui.md diff --git a/collections/documentation/system_administrators/getstarted/remote-desktop_gui/xrdp_guide/xrdp_guide.md b/collections/tfmanual/documentation/system_administrators/getstarted/remote-desktop_gui/xrdp_guide/xrdp_guide.md similarity index 100% rename from collections/documentation/system_administrators/getstarted/remote-desktop_gui/xrdp_guide/xrdp_guide.md rename to collections/tfmanual/documentation/system_administrators/getstarted/remote-desktop_gui/xrdp_guide/xrdp_guide.md diff --git a/collections/documentation/system_administrators/getstarted/sidebar.md b/collections/tfmanual/documentation/system_administrators/getstarted/sidebar.md similarity index 100% rename from collections/documentation/system_administrators/getstarted/sidebar.md rename to collections/tfmanual/documentation/system_administrators/getstarted/sidebar.md diff --git a/collections/documentation/system_administrators/getstarted/ssh_guide/ssh_guide.md b/collections/tfmanual/documentation/system_administrators/getstarted/ssh_guide/ssh_guide.md similarity index 100% rename from collections/documentation/system_administrators/getstarted/ssh_guide/ssh_guide.md rename to collections/tfmanual/documentation/system_administrators/getstarted/ssh_guide/ssh_guide.md diff --git a/collections/documentation/system_administrators/getstarted/ssh_guide/ssh_openssh.md b/collections/tfmanual/documentation/system_administrators/getstarted/ssh_guide/ssh_openssh.md similarity index 100% rename from collections/documentation/system_administrators/getstarted/ssh_guide/ssh_openssh.md rename to collections/tfmanual/documentation/system_administrators/getstarted/ssh_guide/ssh_openssh.md diff --git a/collections/documentation/system_administrators/getstarted/ssh_guide/ssh_putty.md b/collections/tfmanual/documentation/system_administrators/getstarted/ssh_guide/ssh_putty.md similarity index 100% rename from collections/documentation/system_administrators/getstarted/ssh_guide/ssh_putty.md rename to collections/tfmanual/documentation/system_administrators/getstarted/ssh_guide/ssh_putty.md diff --git a/collections/documentation/system_administrators/getstarted/ssh_guide/ssh_wireguard.md b/collections/tfmanual/documentation/system_administrators/getstarted/ssh_guide/ssh_wireguard.md similarity index 100% rename from collections/documentation/system_administrators/getstarted/ssh_guide/ssh_wireguard.md rename to collections/tfmanual/documentation/system_administrators/getstarted/ssh_guide/ssh_wireguard.md diff --git a/collections/documentation/system_administrators/getstarted/ssh_guide/ssh_wsl.md b/collections/tfmanual/documentation/system_administrators/getstarted/ssh_guide/ssh_wsl.md similarity index 100% rename from collections/documentation/system_administrators/getstarted/ssh_guide/ssh_wsl.md rename to collections/tfmanual/documentation/system_administrators/getstarted/ssh_guide/ssh_wsl.md diff --git a/collections/documentation/system_administrators/getstarted/tfgrid3_getstarted.md b/collections/tfmanual/documentation/system_administrators/getstarted/tfgrid3_getstarted.md similarity index 100% rename from collections/documentation/system_administrators/getstarted/tfgrid3_getstarted.md rename to collections/tfmanual/documentation/system_administrators/getstarted/tfgrid3_getstarted.md diff --git a/collections/documentation/system_administrators/getstarted/tfgrid3_network_concepts.md b/collections/tfmanual/documentation/system_administrators/getstarted/tfgrid3_network_concepts.md similarity index 100% rename from collections/documentation/system_administrators/getstarted/tfgrid3_network_concepts.md rename to collections/tfmanual/documentation/system_administrators/getstarted/tfgrid3_network_concepts.md diff --git a/collections/documentation/system_administrators/getstarted/tfgrid3_storage_concepts.md b/collections/tfmanual/documentation/system_administrators/getstarted/tfgrid3_storage_concepts.md similarity index 100% rename from collections/documentation/system_administrators/getstarted/tfgrid3_storage_concepts.md rename to collections/tfmanual/documentation/system_administrators/getstarted/tfgrid3_storage_concepts.md diff --git a/collections/documentation/system_administrators/getstarted/tfgrid3_what_to_know.md b/collections/tfmanual/documentation/system_administrators/getstarted/tfgrid3_what_to_know.md similarity index 100% rename from collections/documentation/system_administrators/getstarted/tfgrid3_what_to_know.md rename to collections/tfmanual/documentation/system_administrators/getstarted/tfgrid3_what_to_know.md diff --git a/collections/documentation/system_administrators/getstarted/tfgrid_services/tf_grid_services_readme.md b/collections/tfmanual/documentation/system_administrators/getstarted/tfgrid_services/tf_grid_services_readme.md similarity index 100% rename from collections/documentation/system_administrators/getstarted/tfgrid_services/tf_grid_services_readme.md rename to collections/tfmanual/documentation/system_administrators/getstarted/tfgrid_services/tf_grid_services_readme.md diff --git a/collections/documentation/system_administrators/gpu/gpu.md b/collections/tfmanual/documentation/system_administrators/gpu/gpu.md similarity index 100% rename from collections/documentation/system_administrators/gpu/gpu.md rename to collections/tfmanual/documentation/system_administrators/gpu/gpu.md diff --git a/collections/documentation/system_administrators/gpu/gpu_toc.md b/collections/tfmanual/documentation/system_administrators/gpu/gpu_toc.md similarity index 100% rename from collections/documentation/system_administrators/gpu/gpu_toc.md rename to collections/tfmanual/documentation/system_administrators/gpu/gpu_toc.md diff --git a/collections/documentation/system_administrators/gpu/img/gpu_1.png b/collections/tfmanual/documentation/system_administrators/gpu/img/gpu_1.png similarity index 100% rename from collections/documentation/system_administrators/gpu/img/gpu_1.png rename to collections/tfmanual/documentation/system_administrators/gpu/img/gpu_1.png diff --git a/collections/documentation/system_administrators/gpu/img/gpu_2.png b/collections/tfmanual/documentation/system_administrators/gpu/img/gpu_2.png similarity index 100% rename from collections/documentation/system_administrators/gpu/img/gpu_2.png rename to collections/tfmanual/documentation/system_administrators/gpu/img/gpu_2.png diff --git a/collections/documentation/system_administrators/gpu/img/gpu_3.png b/collections/tfmanual/documentation/system_administrators/gpu/img/gpu_3.png similarity index 100% rename from collections/documentation/system_administrators/gpu/img/gpu_3.png rename to collections/tfmanual/documentation/system_administrators/gpu/img/gpu_3.png diff --git a/collections/documentation/system_administrators/gpu/img/gpu_4.png b/collections/tfmanual/documentation/system_administrators/gpu/img/gpu_4.png similarity index 100% rename from collections/documentation/system_administrators/gpu/img/gpu_4.png rename to collections/tfmanual/documentation/system_administrators/gpu/img/gpu_4.png diff --git a/collections/documentation/system_administrators/gpu/img/gpu_5.png b/collections/tfmanual/documentation/system_administrators/gpu/img/gpu_5.png similarity index 100% rename from collections/documentation/system_administrators/gpu/img/gpu_5.png rename to collections/tfmanual/documentation/system_administrators/gpu/img/gpu_5.png diff --git a/collections/documentation/system_administrators/gpu/img/gpu_6.png b/collections/tfmanual/documentation/system_administrators/gpu/img/gpu_6.png similarity index 100% rename from collections/documentation/system_administrators/gpu/img/gpu_6.png rename to collections/tfmanual/documentation/system_administrators/gpu/img/gpu_6.png diff --git a/collections/documentation/system_administrators/gpu/img/gpu_7.png b/collections/tfmanual/documentation/system_administrators/gpu/img/gpu_7.png similarity index 100% rename from collections/documentation/system_administrators/gpu/img/gpu_7.png rename to collections/tfmanual/documentation/system_administrators/gpu/img/gpu_7.png diff --git a/collections/documentation/system_administrators/gpu/img/gpu_8.png b/collections/tfmanual/documentation/system_administrators/gpu/img/gpu_8.png similarity index 100% rename from collections/documentation/system_administrators/gpu/img/gpu_8.png rename to collections/tfmanual/documentation/system_administrators/gpu/img/gpu_8.png diff --git a/collections/documentation/system_administrators/gpu/img/gpu_9.png b/collections/tfmanual/documentation/system_administrators/gpu/img/gpu_9.png similarity index 100% rename from collections/documentation/system_administrators/gpu/img/gpu_9.png rename to collections/tfmanual/documentation/system_administrators/gpu/img/gpu_9.png diff --git a/collections/documentation/system_administrators/mycelium/api_yaml.md b/collections/tfmanual/documentation/system_administrators/mycelium/api_yaml.md similarity index 100% rename from collections/documentation/system_administrators/mycelium/api_yaml.md rename to collections/tfmanual/documentation/system_administrators/mycelium/api_yaml.md diff --git a/collections/documentation/system_administrators/mycelium/data_packet.md b/collections/tfmanual/documentation/system_administrators/mycelium/data_packet.md similarity index 100% rename from collections/documentation/system_administrators/mycelium/data_packet.md rename to collections/tfmanual/documentation/system_administrators/mycelium/data_packet.md diff --git a/collections/documentation/system_administrators/mycelium/information.md b/collections/tfmanual/documentation/system_administrators/mycelium/information.md similarity index 100% rename from collections/documentation/system_administrators/mycelium/information.md rename to collections/tfmanual/documentation/system_administrators/mycelium/information.md diff --git a/collections/documentation/system_administrators/mycelium/installation.md b/collections/tfmanual/documentation/system_administrators/mycelium/installation.md similarity index 100% rename from collections/documentation/system_administrators/mycelium/installation.md rename to collections/tfmanual/documentation/system_administrators/mycelium/installation.md diff --git a/collections/documentation/system_administrators/mycelium/message.md b/collections/tfmanual/documentation/system_administrators/mycelium/message.md similarity index 100% rename from collections/documentation/system_administrators/mycelium/message.md rename to collections/tfmanual/documentation/system_administrators/mycelium/message.md diff --git a/collections/documentation/system_administrators/mycelium/mycelium_toc.md b/collections/tfmanual/documentation/system_administrators/mycelium/mycelium_toc.md similarity index 100% rename from collections/documentation/system_administrators/mycelium/mycelium_toc.md rename to collections/tfmanual/documentation/system_administrators/mycelium/mycelium_toc.md diff --git a/collections/documentation/system_administrators/mycelium/overview.md b/collections/tfmanual/documentation/system_administrators/mycelium/overview.md similarity index 100% rename from collections/documentation/system_administrators/mycelium/overview.md rename to collections/tfmanual/documentation/system_administrators/mycelium/overview.md diff --git a/collections/documentation/system_administrators/mycelium/packet.md b/collections/tfmanual/documentation/system_administrators/mycelium/packet.md similarity index 100% rename from collections/documentation/system_administrators/mycelium/packet.md rename to collections/tfmanual/documentation/system_administrators/mycelium/packet.md diff --git a/collections/documentation/system_administrators/pulumi/img/pulumi_logo.svg b/collections/tfmanual/documentation/system_administrators/pulumi/img/pulumi_logo.svg similarity index 100% rename from collections/documentation/system_administrators/pulumi/img/pulumi_logo.svg rename to collections/tfmanual/documentation/system_administrators/pulumi/img/pulumi_logo.svg diff --git a/collections/documentation/system_administrators/pulumi/pulumi_deployment_details.md b/collections/tfmanual/documentation/system_administrators/pulumi/pulumi_deployment_details.md similarity index 100% rename from collections/documentation/system_administrators/pulumi/pulumi_deployment_details.md rename to collections/tfmanual/documentation/system_administrators/pulumi/pulumi_deployment_details.md diff --git a/collections/documentation/system_administrators/pulumi/pulumi_examples.md b/collections/tfmanual/documentation/system_administrators/pulumi/pulumi_examples.md similarity index 100% rename from collections/documentation/system_administrators/pulumi/pulumi_examples.md rename to collections/tfmanual/documentation/system_administrators/pulumi/pulumi_examples.md diff --git a/collections/documentation/system_administrators/pulumi/pulumi_install.md b/collections/tfmanual/documentation/system_administrators/pulumi/pulumi_install.md similarity index 100% rename from collections/documentation/system_administrators/pulumi/pulumi_install.md rename to collections/tfmanual/documentation/system_administrators/pulumi/pulumi_install.md diff --git a/collections/documentation/system_administrators/pulumi/pulumi_intro.md b/collections/tfmanual/documentation/system_administrators/pulumi/pulumi_intro.md similarity index 100% rename from collections/documentation/system_administrators/pulumi/pulumi_intro.md rename to collections/tfmanual/documentation/system_administrators/pulumi/pulumi_intro.md diff --git a/collections/documentation/system_administrators/pulumi/pulumi_readme.md b/collections/tfmanual/documentation/system_administrators/pulumi/pulumi_readme.md similarity index 100% rename from collections/documentation/system_administrators/pulumi/pulumi_readme.md rename to collections/tfmanual/documentation/system_administrators/pulumi/pulumi_readme.md diff --git a/collections/documentation/system_administrators/system_administrators.md b/collections/tfmanual/documentation/system_administrators/system_administrators.md similarity index 100% rename from collections/documentation/system_administrators/system_administrators.md rename to collections/tfmanual/documentation/system_administrators/system_administrators.md diff --git a/collections/documentation/system_administrators/terraform/advanced/img/terraform_.png b/collections/tfmanual/documentation/system_administrators/terraform/advanced/img/terraform_.png similarity index 100% rename from collections/documentation/system_administrators/terraform/advanced/img/terraform_.png rename to collections/tfmanual/documentation/system_administrators/terraform/advanced/img/terraform_.png diff --git a/collections/documentation/system_administrators/terraform/advanced/terraform_advanced_readme.md b/collections/tfmanual/documentation/system_administrators/terraform/advanced/terraform_advanced_readme.md similarity index 100% rename from collections/documentation/system_administrators/terraform/advanced/terraform_advanced_readme.md rename to collections/tfmanual/documentation/system_administrators/terraform/advanced/terraform_advanced_readme.md diff --git a/collections/documentation/system_administrators/terraform/advanced/terraform_capacity_planning.md b/collections/tfmanual/documentation/system_administrators/terraform/advanced/terraform_capacity_planning.md similarity index 100% rename from collections/documentation/system_administrators/terraform/advanced/terraform_capacity_planning.md rename to collections/tfmanual/documentation/system_administrators/terraform/advanced/terraform_capacity_planning.md diff --git a/collections/documentation/system_administrators/terraform/advanced/terraform_mariadb_synced_databases.md b/collections/tfmanual/documentation/system_administrators/terraform/advanced/terraform_mariadb_synced_databases.md similarity index 100% rename from collections/documentation/system_administrators/terraform/advanced/terraform_mariadb_synced_databases.md rename to collections/tfmanual/documentation/system_administrators/terraform/advanced/terraform_mariadb_synced_databases.md diff --git a/collections/documentation/system_administrators/terraform/advanced/terraform_mounts.md b/collections/tfmanual/documentation/system_administrators/terraform/advanced/terraform_mounts.md similarity index 100% rename from collections/documentation/system_administrators/terraform/advanced/terraform_mounts.md rename to collections/tfmanual/documentation/system_administrators/terraform/advanced/terraform_mounts.md diff --git a/collections/documentation/system_administrators/terraform/advanced/terraform_nextcloud_aio.md b/collections/tfmanual/documentation/system_administrators/terraform/advanced/terraform_nextcloud_aio.md similarity index 100% rename from collections/documentation/system_administrators/terraform/advanced/terraform_nextcloud_aio.md rename to collections/tfmanual/documentation/system_administrators/terraform/advanced/terraform_nextcloud_aio.md diff --git a/collections/documentation/system_administrators/terraform/advanced/terraform_nextcloud_redundant.md b/collections/tfmanual/documentation/system_administrators/terraform/advanced/terraform_nextcloud_redundant.md similarity index 100% rename from collections/documentation/system_administrators/terraform/advanced/terraform_nextcloud_redundant.md rename to collections/tfmanual/documentation/system_administrators/terraform/advanced/terraform_nextcloud_redundant.md diff --git a/collections/documentation/system_administrators/terraform/advanced/terraform_nextcloud_single.md b/collections/tfmanual/documentation/system_administrators/terraform/advanced/terraform_nextcloud_single.md similarity index 100% rename from collections/documentation/system_administrators/terraform/advanced/terraform_nextcloud_single.md rename to collections/tfmanual/documentation/system_administrators/terraform/advanced/terraform_nextcloud_single.md diff --git a/collections/documentation/system_administrators/terraform/advanced/terraform_nextcloud_toc.md b/collections/tfmanual/documentation/system_administrators/terraform/advanced/terraform_nextcloud_toc.md similarity index 100% rename from collections/documentation/system_administrators/terraform/advanced/terraform_nextcloud_toc.md rename to collections/tfmanual/documentation/system_administrators/terraform/advanced/terraform_nextcloud_toc.md diff --git a/collections/documentation/system_administrators/terraform/advanced/terraform_nextcloud_vpn.md b/collections/tfmanual/documentation/system_administrators/terraform/advanced/terraform_nextcloud_vpn.md similarity index 100% rename from collections/documentation/system_administrators/terraform/advanced/terraform_nextcloud_vpn.md rename to collections/tfmanual/documentation/system_administrators/terraform/advanced/terraform_nextcloud_vpn.md diff --git a/collections/documentation/system_administrators/terraform/advanced/terraform_nomad.md b/collections/tfmanual/documentation/system_administrators/terraform/advanced/terraform_nomad.md similarity index 100% rename from collections/documentation/system_administrators/terraform/advanced/terraform_nomad.md rename to collections/tfmanual/documentation/system_administrators/terraform/advanced/terraform_nomad.md diff --git a/collections/documentation/system_administrators/terraform/advanced/terraform_provider.md b/collections/tfmanual/documentation/system_administrators/terraform/advanced/terraform_provider.md similarity index 100% rename from collections/documentation/system_administrators/terraform/advanced/terraform_provider.md rename to collections/tfmanual/documentation/system_administrators/terraform/advanced/terraform_provider.md diff --git a/collections/documentation/system_administrators/terraform/advanced/terraform_provisioners.md b/collections/tfmanual/documentation/system_administrators/terraform/advanced/terraform_provisioners.md similarity index 100% rename from collections/documentation/system_administrators/terraform/advanced/terraform_provisioners.md rename to collections/tfmanual/documentation/system_administrators/terraform/advanced/terraform_provisioners.md diff --git a/collections/documentation/system_administrators/terraform/advanced/terraform_updates.md b/collections/tfmanual/documentation/system_administrators/terraform/advanced/terraform_updates.md similarity index 100% rename from collections/documentation/system_administrators/terraform/advanced/terraform_updates.md rename to collections/tfmanual/documentation/system_administrators/terraform/advanced/terraform_updates.md diff --git a/collections/documentation/system_administrators/terraform/advanced/terraform_wireguard_ssh.md b/collections/tfmanual/documentation/system_administrators/terraform/advanced/terraform_wireguard_ssh.md similarity index 100% rename from collections/documentation/system_administrators/terraform/advanced/terraform_wireguard_ssh.md rename to collections/tfmanual/documentation/system_administrators/terraform/advanced/terraform_wireguard_ssh.md diff --git a/collections/documentation/system_administrators/terraform/advanced/terraform_wireguard_vpn.md b/collections/tfmanual/documentation/system_administrators/terraform/advanced/terraform_wireguard_vpn.md similarity index 100% rename from collections/documentation/system_administrators/terraform/advanced/terraform_wireguard_vpn.md rename to collections/tfmanual/documentation/system_administrators/terraform/advanced/terraform_wireguard_vpn.md diff --git a/collections/documentation/system_administrators/terraform/grid3_terraform_home.md b/collections/tfmanual/documentation/system_administrators/terraform/grid3_terraform_home.md similarity index 100% rename from collections/documentation/system_administrators/terraform/grid3_terraform_home.md rename to collections/tfmanual/documentation/system_administrators/terraform/grid3_terraform_home.md diff --git a/collections/documentation/system_administrators/terraform/grid_terraform.md b/collections/tfmanual/documentation/system_administrators/terraform/grid_terraform.md similarity index 100% rename from collections/documentation/system_administrators/terraform/grid_terraform.md rename to collections/tfmanual/documentation/system_administrators/terraform/grid_terraform.md diff --git a/collections/documentation/system_administrators/terraform/img/terraform_install.png b/collections/tfmanual/documentation/system_administrators/terraform/img/terraform_install.png similarity index 100% rename from collections/documentation/system_administrators/terraform/img/terraform_install.png rename to collections/tfmanual/documentation/system_administrators/terraform/img/terraform_install.png diff --git a/collections/documentation/system_administrators/terraform/img/terraform_works.png b/collections/tfmanual/documentation/system_administrators/terraform/img/terraform_works.png similarity index 100% rename from collections/documentation/system_administrators/terraform/img/terraform_works.png rename to collections/tfmanual/documentation/system_administrators/terraform/img/terraform_works.png diff --git a/collections/documentation/system_administrators/terraform/img/weblets_contracts.png b/collections/tfmanual/documentation/system_administrators/terraform/img/weblets_contracts.png similarity index 100% rename from collections/documentation/system_administrators/terraform/img/weblets_contracts.png rename to collections/tfmanual/documentation/system_administrators/terraform/img/weblets_contracts.png diff --git a/collections/documentation/system_administrators/terraform/resources/img/graphql_publicconf.png b/collections/tfmanual/documentation/system_administrators/terraform/resources/img/graphql_publicconf.png similarity index 100% rename from collections/documentation/system_administrators/terraform/resources/img/graphql_publicconf.png rename to collections/tfmanual/documentation/system_administrators/terraform/resources/img/graphql_publicconf.png diff --git a/collections/documentation/system_administrators/terraform/resources/terraform_caprover.md b/collections/tfmanual/documentation/system_administrators/terraform/resources/terraform_caprover.md similarity index 100% rename from collections/documentation/system_administrators/terraform/resources/terraform_caprover.md rename to collections/tfmanual/documentation/system_administrators/terraform/resources/terraform_caprover.md diff --git a/collections/documentation/system_administrators/terraform/resources/terraform_k8s.md b/collections/tfmanual/documentation/system_administrators/terraform/resources/terraform_k8s.md similarity index 100% rename from collections/documentation/system_administrators/terraform/resources/terraform_k8s.md rename to collections/tfmanual/documentation/system_administrators/terraform/resources/terraform_k8s.md diff --git a/collections/documentation/system_administrators/terraform/resources/terraform_k8s_demo.md b/collections/tfmanual/documentation/system_administrators/terraform/resources/terraform_k8s_demo.md similarity index 100% rename from collections/documentation/system_administrators/terraform/resources/terraform_k8s_demo.md rename to collections/tfmanual/documentation/system_administrators/terraform/resources/terraform_k8s_demo.md diff --git a/collections/documentation/system_administrators/terraform/resources/terraform_qsfs.md b/collections/tfmanual/documentation/system_administrators/terraform/resources/terraform_qsfs.md similarity index 100% rename from collections/documentation/system_administrators/terraform/resources/terraform_qsfs.md rename to collections/tfmanual/documentation/system_administrators/terraform/resources/terraform_qsfs.md diff --git a/collections/documentation/system_administrators/terraform/resources/terraform_qsfs_on_full_vm.md b/collections/tfmanual/documentation/system_administrators/terraform/resources/terraform_qsfs_on_full_vm.md similarity index 100% rename from collections/documentation/system_administrators/terraform/resources/terraform_qsfs_on_full_vm.md rename to collections/tfmanual/documentation/system_administrators/terraform/resources/terraform_qsfs_on_full_vm.md diff --git a/collections/documentation/system_administrators/terraform/resources/terraform_qsfs_on_microvm.md b/collections/tfmanual/documentation/system_administrators/terraform/resources/terraform_qsfs_on_microvm.md similarity index 100% rename from collections/documentation/system_administrators/terraform/resources/terraform_qsfs_on_microvm.md rename to collections/tfmanual/documentation/system_administrators/terraform/resources/terraform_qsfs_on_microvm.md diff --git a/collections/documentation/system_administrators/terraform/resources/terraform_resources_readme.md b/collections/tfmanual/documentation/system_administrators/terraform/resources/terraform_resources_readme.md similarity index 100% rename from collections/documentation/system_administrators/terraform/resources/terraform_resources_readme.md rename to collections/tfmanual/documentation/system_administrators/terraform/resources/terraform_resources_readme.md diff --git a/collections/documentation/system_administrators/terraform/resources/terraform_scheduler.md b/collections/tfmanual/documentation/system_administrators/terraform/resources/terraform_scheduler.md similarity index 100% rename from collections/documentation/system_administrators/terraform/resources/terraform_scheduler.md rename to collections/tfmanual/documentation/system_administrators/terraform/resources/terraform_scheduler.md diff --git a/collections/documentation/system_administrators/terraform/resources/terraform_vm.md b/collections/tfmanual/documentation/system_administrators/terraform/resources/terraform_vm.md similarity index 100% rename from collections/documentation/system_administrators/terraform/resources/terraform_vm.md rename to collections/tfmanual/documentation/system_administrators/terraform/resources/terraform_vm.md diff --git a/collections/documentation/system_administrators/terraform/resources/terraform_vm_gateway.md b/collections/tfmanual/documentation/system_administrators/terraform/resources/terraform_vm_gateway.md similarity index 100% rename from collections/documentation/system_administrators/terraform/resources/terraform_vm_gateway.md rename to collections/tfmanual/documentation/system_administrators/terraform/resources/terraform_vm_gateway.md diff --git a/collections/documentation/system_administrators/terraform/resources/terraform_zdb.md b/collections/tfmanual/documentation/system_administrators/terraform/resources/terraform_zdb.md similarity index 100% rename from collections/documentation/system_administrators/terraform/resources/terraform_zdb.md rename to collections/tfmanual/documentation/system_administrators/terraform/resources/terraform_zdb.md diff --git a/collections/documentation/system_administrators/terraform/resources/terraform_zlogs.md b/collections/tfmanual/documentation/system_administrators/terraform/resources/terraform_zlogs.md similarity index 100% rename from collections/documentation/system_administrators/terraform/resources/terraform_zlogs.md rename to collections/tfmanual/documentation/system_administrators/terraform/resources/terraform_zlogs.md diff --git a/collections/documentation/system_administrators/terraform/sidebar.md b/collections/tfmanual/documentation/system_administrators/terraform/sidebar.md similarity index 100% rename from collections/documentation/system_administrators/terraform/sidebar.md rename to collections/tfmanual/documentation/system_administrators/terraform/sidebar.md diff --git a/collections/documentation/system_administrators/terraform/terraform_basic_example.md b/collections/tfmanual/documentation/system_administrators/terraform/terraform_basic_example.md similarity index 100% rename from collections/documentation/system_administrators/terraform/terraform_basic_example.md rename to collections/tfmanual/documentation/system_administrators/terraform/terraform_basic_example.md diff --git a/collections/documentation/system_administrators/terraform/terraform_basics.md b/collections/tfmanual/documentation/system_administrators/terraform/terraform_basics.md similarity index 100% rename from collections/documentation/system_administrators/terraform/terraform_basics.md rename to collections/tfmanual/documentation/system_administrators/terraform/terraform_basics.md diff --git a/collections/documentation/system_administrators/terraform/terraform_full_vm.md b/collections/tfmanual/documentation/system_administrators/terraform/terraform_full_vm.md similarity index 100% rename from collections/documentation/system_administrators/terraform/terraform_full_vm.md rename to collections/tfmanual/documentation/system_administrators/terraform/terraform_full_vm.md diff --git a/collections/documentation/system_administrators/terraform/terraform_get_started.md b/collections/tfmanual/documentation/system_administrators/terraform/terraform_get_started.md similarity index 100% rename from collections/documentation/system_administrators/terraform/terraform_get_started.md rename to collections/tfmanual/documentation/system_administrators/terraform/terraform_get_started.md diff --git a/collections/documentation/system_administrators/terraform/terraform_gpu_support.md b/collections/tfmanual/documentation/system_administrators/terraform/terraform_gpu_support.md similarity index 100% rename from collections/documentation/system_administrators/terraform/terraform_gpu_support.md rename to collections/tfmanual/documentation/system_administrators/terraform/terraform_gpu_support.md diff --git a/collections/documentation/system_administrators/terraform/terraform_install.md b/collections/tfmanual/documentation/system_administrators/terraform/terraform_install.md similarity index 100% rename from collections/documentation/system_administrators/terraform/terraform_install.md rename to collections/tfmanual/documentation/system_administrators/terraform/terraform_install.md diff --git a/collections/documentation/system_administrators/terraform/terraform_readme.md b/collections/tfmanual/documentation/system_administrators/terraform/terraform_readme.md similarity index 100% rename from collections/documentation/system_administrators/terraform/terraform_readme.md rename to collections/tfmanual/documentation/system_administrators/terraform/terraform_readme.md diff --git a/collections/documentation/system_administrators/terraform/terraform_toc.md b/collections/tfmanual/documentation/system_administrators/terraform/terraform_toc.md similarity index 100% rename from collections/documentation/system_administrators/terraform/terraform_toc.md rename to collections/tfmanual/documentation/system_administrators/terraform/terraform_toc.md diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/albedo_buy.md b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/albedo_buy.md new file mode 100644 index 0000000..ef6d18e --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/albedo_buy.md @@ -0,0 +1,50 @@ +

Get TFT (Stellar) on Albedo Wallet

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Get Started](#get-started) + - [Get TFT By Token Swapping](#get-tft-by-token-swapping) +- [Important Notice](#important-notice) +- [Disclaimer](#disclaimer) +*** +## Introduction + +Welcome to our guide on how to buy TFT tokens (Stellar) via the [Albedo wallet](https://albedo.link/)! Albedo is a secure and trustworthy keystore web app and browser extension designed for Stellar token accounts. With Albedo, you can safely manage and transact with your Stellar account without having to share your secret key with any third parties. + +In this tutorial, we will walk you through the process of buying Stellar TFT tokens using the Albedo wallet. +*** +## Prerequisites + +- **XLM**: When buying TFT tokens using the Albedo wallet, the process involves swapping XLM (Stellar Lumens) or other Stellar tokens into TFT. Please note that a certain amount of XLM funding is required to facilitate the sending and receiving of assets on the Stellar network. + +- **Create a Wallet and Add TFT Asset**: Create an Albedo Wallet Account and add TFT as an asset. Read [**here**](../storing_tft/storing_tft.md) for the complete manual of how to create an Albedo Wallet. +*** +## Get Started + +### Get TFT By Token Swapping + +Once you have completed the prerequisites, you can get TFT on Albedo by clicking 'Swap' and swapping your existing tokens to TFT, for example, XLM or USDC. + +Insert the amount of TFT you'd like to buy or the amount of XLM you'd like to swap for TFT. Click 'Swap' to confirm the transaction. + +Congratulations. You just swapped some XLM to TFT. Go to 'Balance' page to see your recently purchased TFT tokens. +*** +## Important Notice + +If you are looking for ways to provide liquidity for TFT (Stellar) on Albedo, you will find the according information [here](../liquidity/liquidity_albedo.md). +*** +## Disclaimer + +The information provided in this tutorial or any related discussion is not intended as investment advice. The purpose is to provide educational and informational content only. Investing in cryptocurrencies or any other assets carries inherent risks, and it is crucial to conduct your own research and exercise caution before making any investment decisions. + +**The ThreeFold Token (TFT)** is not to be considered as a traditional investment instrument. The value of cryptocurrencies can be volatile, and there are no guarantees of profits or returns. Always be aware of the risks involved and make informed choices based on your own assessment and understanding. We strongly encourage you to read our [full disclaimer](https://library.threefold.me/info/legal/#/legal__disclaimer) and seek advice from a qualified financial professional if needed. + + + + + + + + diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/bettertoken.md b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/bettertoken.md new file mode 100644 index 0000000..3dafa10 --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/bettertoken.md @@ -0,0 +1,36 @@ +

Get TFT Stellar via BetterToken

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Get Started](#get-started) +- [Important Notice](#important-notice) +- [Disclaimer](#disclaimer) + +*** +## Introduction + +Alternatively, you can get TFT from Mazraa [BetterToken](https://bettertoken.com/) farmers. + +**BetterToken** is the first-ever ThreeFold Farming Cooperative in Europe that aims to make it easy for individuals to engage and become part of the ThreeFold Movement. Their primary goal is to enable anyone to become a farmer in simple ways and assist customers in getting started with their services and applications on the ThreeFold Grid. + +As a ThreeFold Farming Cooperative, BetterToken is dedicated to promoting participation in the ThreeFold ecosystem. They provide support and resources for individuals who want to join the farming community and contribute to the decentralized and sustainable ThreeFold Grid. +*** +## Get Started + +If you are interested in purchasing TFT as a future capacity reservation through BetterToken.com, you can do so using a wire transfer. It's important to note that BetterToken handles orders of $1000 or more. To explore purchase possibilities, you can contact BetterToken directly at **orders@bettertoken.com**. + +By reaching out to them, you can inquire about the process, requirements, and any additional details related to purchasing TFT as a future capacity reservation. BetterToken will be able to provide you with the necessary information and assist you throughout the purchase process. + +Remember to provide them with your specific requirements and any relevant details to ensure a smooth transaction. +*** +## Important Notice + +Remember to exercise caution and verify the authenticity of any communication or transaction related to purchasing TFT. Scammers may try to impersonate BetterToken or ThreeFold representatives, so it's crucial to ensure you are dealing with the official channels and contacts provided by BetterToken. +*** +## Disclaimer + +The information provided in this tutorial or any related discussion is not intended as investment advice. The purpose is to provide educational and informational content only. Investing in cryptocurrencies or any other assets carries inherent risks, and it is crucial to conduct your own research and exercise caution before making any investment decisions. + +**The ThreeFold Token (TFT)** is not to be considered as a traditional investment instrument. The value of cryptocurrencies can be volatile, and there are no guarantees of profits or returns. Always be aware of the risks involved and make informed choices based on your own assessment and understanding. We strongly encourage you to read our [full disclaimer](https://library.threefold.me/info/legal/#/legal__disclaimer) and seek advice from a qualified financial professional if needed. + diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/btc_alpha.md b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/btc_alpha.md new file mode 100644 index 0000000..c80d633 --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/btc_alpha.md @@ -0,0 +1,125 @@ +

Get TFT (Stellar) on BTC-Alpha

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Get Started](#get-started) + - [Sign up for an Account](#sign-up-for-an-account) + - [Secure Your Account](#secure-your-account) + - [Deposit Funds to Account](#deposit-funds-to-account) + - [Start Trading](#start-trading) + - [Important Notice](#important-notice) +- [Disclaimer](#disclaimer) + +*** + +## Introduction + +Welcome to our tutorial on how to get TFT (Stellar) using [**BTC-Alpha**](https://btc-alpha.com/en)! + +BTC-Alpha is a cryptocurrency exchange platform that provides a secure and user-friendly environment for trading various digital assets, including TFT (Stellar). With its robust features and intuitive interface, BTC-Alpha offers a convenient way to buy and sell cryptocurrencies. + +In this guide, we will walk you through the process of buying TFT on the BTC-Alpha exchange. + +## Prerequisites + +- **ID for verification:** To get TFT (Stellar) on the BTC-Alpha exchange, you will need to have your identification (ID) ready for the verification process. This is a standard requirement to ensure compliance with regulatory guidelines and maintain a secure trading environment. Your ID may include documents such as a valid passport or government-issued identification card. + +- **BTC-Alpha Account**: You must have an active account on the BTC-Alpha exchange. If you don't have one, you can sign up on their website and complete the registration process. Make sure to secure your account with strong passwords and two-factor authentication for enhanced security. + +- **Funds for Deposit**: To buy TFT (Stellar), you will need to have funds in your BTC-Alpha account. BTC-Alpha supports various deposit options, including USDT (Tether), USDC (USD Coin), BTC (Bitcoin), and other tokens listed on the exchange. You can deposit these tokens from your external wallet or exchange into your BTC-Alpha account to use for purchasing TFT. + +## Get Started + +### Sign up for an Account + +**Sign up for a BTC-Alpha Account:** Visit the BTC-Alpha website [https://btc-alpha.com/](https://btc-alpha.com/) and click on the "**Sign up**" button. Fill in the required information, including your email address, a secure password, and any additional details requested for the account creation process. + +**Login to your account**: You will then receive a notification that allow you to login to your new account. + +Now, you can proceed to log in to your account and start exploring the platform. Follow these steps to log in: + +Visit the BTC-Alpha website (https://btc-alpha.com/) on your web browser. Click on the "Login" button located on the top-right corner of the website. + +Enter the email address and password you used during the registration process in the respective fields. + +**Verify Your Account:** After completing the registration, you may need to verify your account by providing some personal identification information. This is a standard procedure for most cryptocurrency exchanges to ensure compliance with regulations and security measures. Follow the instructions provided by BTC-Alpha to complete the verification process. + +Congratulations on completing the registration process for your BTC-Alpha account and are logged in to your account successfully! + +### Secure Your Account + +**Secure Your Account**: Set up two-factor authentication (2FA) to add an extra layer of security to your BTC-Alpha account. This typically involves linking your account to a 2FA app, such as Google Authenticator or Authy, and enabling it for login and transaction verification. + +To enable two-factor authentication (2FA) on your BTC-Alpha account, follow these steps: + +Install either the [2FA Alp Authenticator](https://play.google.com/store/apps/details?id=com.alp.two_fa) or [Google Authenticator](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2&hl=en&gl=US) app on your mobile phone. You can find Authy on the App Store or Google Play, and Google Authenticator on the Google Play Store or Apple App Store. + +Once you have installed the app, log in to your BTC-Alpha account. + +Right-Click on your name or profile icon located at the top-right corner of the website to access the account settings, and look for the option "**Enable Two-factor Authentication**" and click on it. + +Follow the instructions provided to link your BTC-Alpha account with the Authy or Google Authenticator app. This usually involves scanning a QR code or manually entering a code provided by the app. + +Once the link is established, the app will start generating unique codes that you will need to enter during the login process for additional security. + +By enabling two-factor authentication, you add an extra layer of security to your BTC-Alpha account, helping to protect your funds and personal information. Make sure to keep your mobile device with the authenticator app secure, as it will be required each time you log in to your BTC-Alpha account. + +### Deposit Funds to Account + +To begin trading and acquiring TFT on the BTC-Alpha exchange, you will first need to deposit funds into your account. The specific token you choose to deposit will depend on your preference and the available options on the exchange. + +In this guide, we will focus on depositing BTC (Bitcoin) into your BTC-Alpha account. BTC is a widely recognized and popular cryptocurrency, making it a convenient choice for funding your account. + +To deposit BTC into your BTC-Alpha account, follow these steps: + +Log in to your BTC-Alpha account and Click on the "Wallets" tab located in the top menu. + +Search for "**BTC**" or "Bitcoin" in the list of available cryptocurrencies. + +You will be provided with a BTC deposit address. Copy this address or scan the QR code associated with it. + +Use your personal external BTC wallet or the wallet of another exchange to initiate a withdrawal to the provided deposit address. +Ensure that you specify the correct deposit address and double-check it before confirming the transaction. + +Wait for the transaction to be confirmed on the Bitcoin network. This may take some time depending on network congestion. +Once the transaction is confirmed, the BTC will be credited to your BTC-Alpha account balance. + +You can check your account balance by clicking on the "**Wallets**" tab or by navigating to the "**Balances**" section. + +Please note that the exact steps for depositing BTC may vary depending on the specific wallet or exchange you are using to send the funds. It is essential to double-check the deposit address and follow the instructions provided by your wallet or exchange to ensure a successful deposit. + +### Start Trading + +Once you have signed up for a BTC-Alpha account and completed the necessary verification steps, you will be ready to proceed with depositing funds and buying TFT (Stellar) on the exchange. On this example we will be buying TFT using BTC on BTC-Alpha Exchange. + +To trade BTC for TFT on the BTC-Alpha exchange, follow these steps: + +Log in to your BTC-Alpha account and Click on the "**Trade**" > "**Spot Trading Terminal**" tab located in the top menu. + +In the trading interface, find and select the trading pair that represents the BTC-TFT market at the top right corner. For example, it could be "BTC/TFT" or "TFT/BTC". + +You will be presented with the trading chart and order book for the selected market on the left bottom of the page. Take some time to familiarize yourself with the interface and the available options. In the "Limit" section, enter the desired amount of TFT you want to acquire. You can choose to specify the quantity or the total value in BTC. + +Review the order details, including the price and fees, before proceeding. + +Click on the "**Limit Buy TFT**" button to place your order. Once the order is placed, it will be processed by the exchange. You can monitor the status of your order in the "Open Orders" or "Order History" section. + +If your order is successfully executed, the TFT tokens will be credited to your BTC-Alpha account balance. You can check your account balance by clicking on the "**Wallets**" tab or by navigating to the "**Balances**" section. + +### Important Notice + +While it is possible to keep your TFT in your exchange wallet on BTC-Alpha, it is generally not recommended to store your funds there for an extended period. Public exchanges are more susceptible to security breaches and hacking attempts compared to personal wallets. + +To ensure the safety and security of your TFT holdings, it is advisable to transfer them to a dedicated TFT wallet. There are several options available for creating a TFT wallet, each with its own unique features and benefits. + +To explore different TFT wallet options and choose the one that best suits your needs, you can refer to our comprehensive [**TFT Wallet guide**](../storing_tft/storing_tft.md) that provides a list of recommended TFT wallets. This guide will help you understand the features, security measures, and compatibility of each wallet, enabling you to make an informed decision on where to store your TFT securely. + +Remember, maintaining control over your private keys and taking precautions to protect your wallet information are essential for safeguarding your TFT investments. + +## Disclaimer + +> The information provided in this tutorial or any related discussion is not intended as investment advice. The purpose is to provide educational and informational content only. Investing in cryptocurrencies or any other assets carries inherent risks, and it is crucial to conduct your own research and exercise caution before making any investment decisions. +> +> **The ThreeFold Token (TFT)** is not to be considered as a traditional investment instrument. The value of cryptocurrencies can be volatile, and there are no guarantees of profits or returns. Always be aware of the risks involved and make informed choices based on your own assessment and understanding. We strongly encourage you to read our [full disclaimer](https://library.threefold.me/info/legal/#/legal__disclaimer) and seek advice from a qualified financial professional if needed. \ No newline at end of file diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/buy_sell_tft.md b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/buy_sell_tft.md new file mode 100644 index 0000000..a97b90c --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/buy_sell_tft.md @@ -0,0 +1,20 @@ +

Buy and Sell TFT

+ +> If you're looking for a simple way to get TFT with crypto or fiat, check out the [Quick Start guide](./tft_lobstr/tft_lobstr_short_guide.md)! + +There are multiple ways to buy and sell TFT depending on your preferences and the blockchain network you choose to transact on. + +You can buy and sell TFT on Stellar Chain, Ethereum Chain and BNB Smart Chain, and you can use the [TFT bridges](../tft_bridges/tft_bridges.md) to go from one chain to another. + +With TFTs, you can [deploy workloads](../../system_administrators/getstarted/tfgrid3_getstarted.md) on the ThreeFold Grid and benefit from [staking discounts](../../../knowledge_base/cloud/pricing/staking_discount_levels.md) up to 60%! + +

Table of Contents

+ +- [Quick Start (Stellar)](./tft_lobstr/tft_lobstr_short_guide.md) +- [Lobstr Wallet (Stellar)](./tft_lobstr/tft_lobstr_complete_guide.md) +- [MetaMask (BSC & ETH)](./tft_metamask/tft_metamask.md) +- [Pancake Swap (BSC)](./pancakeswap.md) + +## More on TFT + +The [Threefold token (TFT)](../threefold_token.md) is the token of the Threefold Grid, a decentralized and open-source project offering network, compute and storage capacity. TFTs are created by TFChain, the ThreeFold blockchain, only when new Internet capacity is added to the ThreeFold Grid by cloud service providers (farmers) deploying 3Nodes, a process we call [farming](../../farmers/farmers.md). \ No newline at end of file diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/buy_sell_tft_archive.md b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/buy_sell_tft_archive.md new file mode 100644 index 0000000..9e16570 --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/buy_sell_tft_archive.md @@ -0,0 +1,37 @@ + +

Buy and Sell TFT: Getting Started

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Set up a Stellar Address](#set-up-a-stellar-address) +- [Methods to Get TFT](#methods-to-get-tft) +- [Disclaimer](#disclaimer) + +*** + +## Introduction + +There are multiple ways to acquire [TFT](../threefold_token.md) depending on your preferences and the blockchain network you choose to transact on. Note that you can use the [TFT bridges](../tft_bridges/tft_bridges.md) to go from one chain to another. To start, you need to have a supporting wallet to [store your TFT](../storing_tft/storing_tft.md). + +It's important to explore the available options and select the most convenient and secure method for acquiring TFT. Always exercise caution and ensure the legitimacy and reliability of the platforms or individuals you engage with to obtain TFT. + +## Set up a Stellar Address + +In general, to set up a Stellar address to transact TFT on Stellar chain, you can use any Stellar wallet that has a TFT trustline enabled. Note that on Stellar chain, fees are paid in XLM. + +The easiest way is to simply create an account on the [ThreeFold Connect App](../storing_tft/tf_connect_app.md) (for [Android](https://play.google.com/store/apps/details?id=org.jimber.threebotlogin) and [iOS](https://apps.apple.com/us/app/threefold-connect/id1459845885)) and to then use the TFT wallet of the app, which has by default a TFT trustline on Stellar chain and also comes with 1 XLM sponsored by Threefold for transaction fees. + +## Methods to Get TFT + +The ThreeFold manual covers numerous methods [to buy and sell TFT](./buy_sell_tft_methods.md). For a complete tutorial on getting TFT with crypto or fiat, read the [Lobstr guide](./tft_lobstr/tft_lobstr_complete_guide.md). + +If you're interested in trading or swapping other cryptocurrencies for TFT, you can visit various crypto exchanges that list TFT. Additionally, you can leverage swapping services available on decentralized exchanges (DEXs) or automated market makers (AMMs) to exchange your tokens for TFT (BSC). + +Moreover, you can purchase TFT using fiat currency directly from TFT Official's Live Desk, or [ThreeFold's official TFT Shop](https://gettft.com/). Another option is to obtain TFT from ThreeFold Farmers. You can engage with Farmers to purchase TFT directly from them, contributing to the growth and decentralization of the ThreeFold network. + +## Disclaimer + +> The information provided in this tutorial or any related discussion is not intended as investment advice. The purpose is to provide educational and informational content only. Investing in cryptocurrencies or any other assets carries inherent risks, and it is crucial to conduct your own research and exercise caution before making any investment decisions. +> +> **The ThreeFold Token (TFT)** is not to be considered as a traditional investment instrument. The value of cryptocurrencies can be volatile, and there are no guarantees of profits or returns. Always be aware of the risks involved and make informed choices based on your own assessment and understanding. We strongly encourage you to read our [full disclaimer](https://library.threefold.me/info/legal/#/legal__disclaimer) and seek advice from a qualified financial professional if needed. \ No newline at end of file diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/buy_sell_tft_methods.md b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/buy_sell_tft_methods.md new file mode 100644 index 0000000..f7d7175 --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/buy_sell_tft_methods.md @@ -0,0 +1,36 @@ +# All Methods + +There are many ways to buy and sell TFT on the different chains where it lives. Explore the possibilities and find the best way for you to transact the token. + +

Table of Contents

+ +- Ethereum and BSC + - [MetaMask](./tft_metamask/tft_metamask.md) + - [1inch.io](./oneinch.md) + + +- BSC + - [Pancake Swap](./pancakeswap.md) + +- Stellar Chain + - [Lobstr Wallet](./tft_lobstr/tft_lobstr.md) + - [Lobstr Wallet: Short Guide](./tft_lobstr/tft_lobstr_short_guide.md) + - [Lobstr Wallet: Complete Guide](./tft_lobstr/tft_lobstr_complete_guide.md) + - [GetTFT.com](./gettft.md) + - [Albedo Wallet](./albedo_buy.md) + - [Solar Wallet](./solar_buy.md) + - [Coinbase (XLM)](./coinbase_xlm.md) + - [StellarTerm](./stellarterm.md) + - [Interstellar](./interstellar.md) + +- CEX + - [BTC-Alpha](./btc_alpha.md) + +- OTC + - [ThreeFold Live Desk](./tf_otc.md) + +- Farmers + - [BetterToken Farmers](./bettertoken.md) + - [Mazraa Farmers](./mazraa.md) + +> Note: You can [use TFT bridges](../tft_bridges/tft_bridges.md) to move from one chain to another. \ No newline at end of file diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/coinbase_xlm.md b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/coinbase_xlm.md new file mode 100644 index 0000000..a9113cc --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/coinbase_xlm.md @@ -0,0 +1,47 @@ +

Buy XLM on Coinbase

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Tutorial](#tutorial) +- [Important Notice](#important-notice) +- [Withdrawing XLM From Coinbase to Your Stellar Wallet](#withdrawing-xlm-from-coinbase-to-your-stellar-wallet) +*** +## Introduction + +In order to engage in seamless TFT transactions on the Stellar network, it is essential to acquire XLM (Stellar Lumens) as a prerequisite. XLM serves as the native cryptocurrency of the Stellar network, enabling fast and low-cost cross-border transactions. + +This section of the manual will guide you through the process of obtaining XLM using [**Coinbase Exchange**](https://www.coinbase.com/exchange/), a reputable cryptocurrency exchange service. Coinbase offers a user-friendly platform that simplifies the buying, selling, and storing of various cryptocurrencies, including XLM. + +By acquiring XLM, you will have the necessary funds to cover transaction fees on the Stellar network, ensuring smooth and efficient TFT transactions within your chosen Stellar wallet. While this guide focuses on **Coinbase Exchange** as the preferred exchange platform, please note that XLM can also be purchased from other exchanges that support it. + +Follow the steps outlined in this manual to acquire XLM on Coinbase and lay the foundation for your TFT transactions. Let's get started on this crucial prerequisite to enable your seamless engagement with TFT on the Stellar network. +*** +## Prerequisites + +- **Coinbase Exchange Account**: You will need a Coinbase Exchange account to get started using Coinbase. Click [here](https://help.coinbase.com/en/coinbase/getting-started) for the complete guide of getting started with Coinbase. + +- **Fiat Payment Methods**: Additionally, to purchase XLM (Stellar Lumens) on Coinbase Exchange, you will need link a fiat payment method to your Coinbase account, such as a linked bank account or a credit card. This fiat currency will be used to exchange for XLM. Click [here](https://help.coinbase.com/en/coinbase/getting-started/add-a-payment-method/how-do-i-add-a-payment-method-when-using-the-mobile-app) for the complete guide of adding payment method to Coinbase. +*** +## Tutorial + +Coinbase Exchange has taken steps to simplify the process of purchasing Stellar Lumens (XLM) by providing a this [**comprehensive XLM Purchase guide**](https://www.coinbase.com/how-to-buy/stellar). + +This guide offers detailed instructions on how to buy XLM directly from the Coinbase platform. By following the steps outlined in the guide, you can navigate through the buying process seamlessly. + +> Read about the difference in between Coinbase vs Coinbase Wallet [here](https://help.coinbase.com/en/wallet/getting-started/what-s-the-difference-between-coinbase-com-and-wallet) +*** +## Important Notice + +Important Notice: Please be aware that this tutorial specifically focuses on buying XLM (Stellar Lumens) from the **Coinbase Exchange** on [https://www.coinbase.com/exchange/](https://www.coinbase.com/exchange/), not the Coinbase Wallet. It is important to note that as of February 2023, [Coinbase Wallet no longer supports XLM](https://help.coinbase.com/en/wallet/other-topics/move-unsupported-assets). However, rest assured that these two platforms, Coinbase exchange and Coinbase Wallet, are distinct and serve different purposes. + +Remember to exercise caution and verify the compatibility of your chosen wallet or exchange with XLM before initiating any transactions. Keeping this distinction in mind will help ensure a seamless experience and prevent any potential confusion between the different platforms. +*** +## Withdrawing XLM From Coinbase to Your Stellar Wallet + +After successfully purchasing XLM from Coinbase, you can begin the process of withdrawing your XLM to another Stellar wallet of your choice. This allows you to have full control over your XLM and engage in transactions within the Stellar network. + +To learn more about the steps involved in withdrawing XLM from Coinbase to another Stellar wallet, click [here](https://help.coinbase.com/en/exchange/trading-and-funding/withdraw-funds). This resource will provide you with detailed instructions and guidelines on how to initiate the withdrawal process and ensure a smooth transfer of your XLM to your preferred Stellar wallet. + +> Get a TFT (Stellar) Wallet of your choice [here](../storing_tft/storing_tft.md)! diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/gettft.md b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/gettft.md new file mode 100644 index 0000000..8153ce8 --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/gettft.md @@ -0,0 +1,76 @@ +

Get TFT (Stellar) on GetTFT.com

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Get Started](#get-started) + - [Link TF Wallet to GetTFT.com](#link-tf-wallet-to-gettftcom) + - [Get TFT using BTC](#get-tft-using-btc) + - [Get TFT using Fiat Currency (USD / EUR)](#get-tft-using-fiat-currency-usd--eur) +- [Important Notice](#important-notice) +- [Disclaimer](#disclaimer) +*** +## Introduction + +Welcome to our tutorial on how to buy TFT tokens (Stellar / Native) via [GetTFT.com](https://gettft.com/)! + +GetTFT.com provides a seamless experience for purchasing TFT tokens (Stellar / Native), allowing you to be a part of the ThreeFold ecosystem. As a product developed by the ThreeFold team, GetTFT.com ensures a reliable and secure platform to facilitate the acquisition of TFT tokens. Whether you're an investor looking to support the ThreeFold mission or a technology enthusiast interested in participating in the decentralized internet revolution, this guide will walk you through the process of buying TFT tokens on GetTFT.com. + +On GetTFT.com, you have the flexibility to buy TFT tokens using either Bitcoin (BTC), or fiat currency like US Dollars (USD), or Euros (EUR). This allows you to choose the currency that is most convenient for you. Whether you already hold Bitcoin, prefer to use traditional fiat currencies, or want to explore various options, GetTFT.com caters to your needs. +*** +## Prerequisites + +Before you can buy TFT on [GetTFT.com](https://gettft.com/), there are a few prerequisites you need to fulfill. Here's what you'll need: + +- **TF Connect Wallet on TF Connect App**: Download and install the TF Connect app on your iOS or Android device. Create a TF Connect wallet within the app, following the provided instructions [here](../storing_tft/tf_connect_app.md#create-a-wallet). This wallet will be used to receive and store your TFT tokens purchased on GetTFT.com. + +- **BTC Wallet**: If you prefer to purchase TFT tokens using Bitcoin (BTC), make sure you have a BTC wallet of your own preference. This can be a hardware wallet, software wallet, or any other secure wallet that supports BTC transactions. You will need this wallet to send BTC from your personal wallet to GetTFT.com for the purchase. + +- **Mercuryo.io Account**: If you plan to buy TFT tokens using fiat currency (such as USD or EUR), you will need to create an account on [Mercuryo.io](https://mercuryo.io). Mercuryo.io is a fiat payment provider that allows you to purchase cryptocurrencies using traditional fiat currencies. This account will enable you to complete the fiat-to-TFT purchase process on GetTFT.com. +*** +## Get Started + +### Link TF Wallet to GetTFT.com + +After completing the prerequisites, you can directly go to [GetTFT.com](https://gettft.com/) and click on the 'Get TFT' button to start the process. + +You will be then redirected to the TF wallet connection page. Link your mobile TF Connect App wallet to the transaction page by clicking the 'Login via ThreeFold Connect'. Follow the further instructions on your TFConnect App and complete the linking process. + +#### Get TFT using BTC + +After successfully logged in, you will be redirected to the transaction page. select the amount of TFT you would like to buy and choose the 'BTC' icon as your payment method. Verify that you're providing the correct Stellar TFT wallet address (the wallet you have previously linked), read the t&c of the purchase and hit 'Submit' once everything is verified. + +You will then be redirected to the transfer BTC Page. On this page you will see the instruction on how much BTC you should send and the BTC deposit address for your TFT purchase. transfer the exact BTC amount via your BTC wallet by entering this information manually or by scanning the QR Code provided. + +After completing your transfer, you will receive a notification on the page confirming the successful transaction. It is important to stay on the page until you receive this confirmation to ensure that the transaction is processed correctly. Go to TF Connect App on your mobile to check the successfully purchased TFT. + +Please note that it may take some time, typically up to 30 minutes, for the TFT tokens to appear in your TF Connect wallet app after the transfer process. This delay is normal and can be attributed to various factors, including network congestion and blockchain confirmations. + +During this waiting period, it is important to remain patient and refrain from making multiple purchase attempts or transactions. Rest assured that the TFT tokens will be delivered to your TF Connect wallet as soon as the process is completed. + +#### Get TFT using Fiat Currency (USD / EUR) + +When purchasing TFT tokens using fiat currency on GetTFT.com, the transaction is facilitated through the Mercuryo.io exchange platform. The process involves with firstly buying Bitcoin (BTC) through the fiat gateway provided by Mercuryo.io. After the successful purchase of BTC, GetTFT.com will automatically convert the BTC amount into TFT tokens and send them to your TF Connect wallet. Please note that there is a minimum purchase amount of 110 USD for TFT tokens when using this platform. + +To get started, complete the same login process described on '**Get Started: Link TF Wallet to GetTFT.com**' section above. After successfully logged in, you will be redirected to the transaction page. select the amount of TFT you would like to buy and choose the 'USD' or 'EUR' icon as your payment method. Verify that you're providing the correct Stellar TFT wallet address (the wallet you have previously linked), read the t&c of the purchase and hit '**Submit**' once everything is verified. + +Once clicked, you will be redirected to [https://exchange.mercuryo.io/](https://exchange.mercuryo.io/) widget. Please read [Mercuryo.io's FAQ](https://help.mercuryo.io/) to learn more about Mercuryo widget. Follow the prompts to complete the purchase, which typically involves connecting your bank account or using a supported payment method to transfer the USD equivalent for the desired amount of BTC tokens. + +Once the BTC purchase is complete, the GetTFT.com platform will automatically convert the BTC amount into TFT tokens based on the prevailing exchange rate. The TFT tokens will be sent directly to your TF Connect wallet on the TF Connect app. + +Please note that it may take some time, typically up to 30 minutes, for the TFT tokens to appear in your TF Connect wallet app after the automatic conversion and transfer process. This delay is normal and can be attributed to various factors, including network congestion and blockchain confirmations. + +During this waiting period, it is important to remain patient and refrain from making multiple purchase attempts or transactions. Rest assured that the TFT tokens will be delivered to your TF Connect wallet as soon as the process is completed. +*** +## Important Notice + +If, for any reason, you encounter any issues or face difficulties during the purchase process, we recommend contacting the our customer support team via the popup chat box on the page or by going to [support.grid.tf](https://support.grid.tf/). They will be able to assist you and provide the necessary guidance to resolve any problems you may encounter. + +Remember to reach out to the support team promptly and provide them with relevant details regarding your issue, such as your account information, public wallet address and transaction details. +*** +## Disclaimer + +The information provided in this tutorial or any related discussion is not intended as investment advice. The purpose is to provide educational and informational content only. Investing in cryptocurrencies or any other assets carries inherent risks, and it is crucial to conduct your own research and exercise caution before making any investment decisions. + +**The ThreeFold Token (TFT)** is not to be considered as a traditional investment instrument. The value of cryptocurrencies can be volatile, and there are no guarantees of profits or returns. Always be aware of the risks involved and make informed choices based on your own assessment and understanding. We strongly encourage you to read our [full disclaimer](https://library.threefold.me/info/legal/#/legal__disclaimer) and seek advice from a qualified financial professional if needed. \ No newline at end of file diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/interstellar.md b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/interstellar.md new file mode 100644 index 0000000..e12ef25 --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/interstellar.md @@ -0,0 +1,51 @@ +

Get TFT (Stellar) on Interstellar

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Get Started](#get-started) + - [Get TFT By Trading](#get-tft-by-trading) +- [Store TFT on Interstellar](#store-tft-on-interstellar) +- [Disclaimer](#disclaimer) + +*** + +## Introduction +Welcome to our guide on how to get TFT tokens (Stellar) via the [**Interstellar**](https://interstellar.exchange/)! + +Interstellar is a decentralized exchange built on the Stellar network that enables users to trade various assets, including TFT (Stellar). As an intuitive and user-friendly platform, Interstellar provides a seamless trading experience for Stellar users. With its focus on security and privacy, Interstellar ensures that users maintain control over their funds and private keys. + +In this guide, we will walk you through the process of buying TFT on the Interstellar exchange, allowing you to participate in the vibrant Stellar ecosystem. + +## Prerequisites + +- **XLM**: To get TFT tokens using Interstellar, a certain amount of XLM funding is required to facilitate the sending and receiving of assets on the Stellar network. + +- **Create Interstellar Account and Add TFT Asset**: Create an Interstellar Account via desktop, and add TFT as an asset. Read [**here**](../storing_tft/interstellar_store.md) for the complete manual of how to create an Interstellar Account. + +## Get Started + +### Get TFT By Trading + +Once you have completed the prerequisites, signed up and added TFT as an asset, you can get TFT on Interstellar by clicking the menu bar and clicking '**Trading**' on the left menu on your homepage. + +On this page, we will try to trade some XLM into TFT. Click on the **custom** icon as shown + +Find **XLM** and **TFT** asset on the '**All (unverified)**' list. + +Once all is set (XLM and TFT), click on '**Go**' to start trading + +You can choose to fullfill sell orders, or create your own buy order. Once the buy order or trade has been fulfilled your TFT will show up in your wallet. Please Remember to review and double-check all order details before confirming the trade. + +## Store TFT on Interstellar + +If you are looking for ways to store TFT on Interstellar, you will find the according information [here](../storing_tft/interstellar_store.md). + +To explore different TFT wallet options and choose the one that best suits your needs, you can refer to our comprehensive [**TFT Wallet guide**](../storing_tft/storing_tft.md) that provides a list of recommended TFT wallets. This guide will help you understand the features, security measures, and compatibility of each wallet, enabling you to make an informed decision on where to store your TFT securely. + +## Disclaimer + +The information provided in this tutorial or any related discussion is not intended as investment advice. The purpose is to provide educational and informational content only. Investing in cryptocurrencies or any other assets carries inherent risks, and it is crucial to conduct your own research and exercise caution before making any investment decisions. + +**The ThreeFold Token (TFT)** is not to be considered as a traditional investment instrument. The value of cryptocurrencies can be volatile, and there are no guarantees of profits or returns. Always be aware of the risks involved and make informed choices based on your own assessment and understanding. We strongly encourage you to read our [full disclaimer](https://library.threefold.me/info/legal/#/legal__disclaimer) and seek advice from a qualified financial professional if needed. \ No newline at end of file diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/mazraa.md b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/mazraa.md new file mode 100644 index 0000000..9d1af85 --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/mazraa.md @@ -0,0 +1,73 @@ +

Get TFT (Stellar) from Mazraa Farmers

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Get Started](#get-started) + - [Get TFT via Mazraa.io Website](#get-tft-via-mazraaio-website) + - [Get TFT via Wire Transfer](#get-tft-via-wire-transfer) + - [Get TFT via PaypPal](#get-tft-via-payppal) + - [Get TFT via Credit Card (Transcoin)](#get-tft-via-credit-card-transcoin) +- [Important Notice](#important-notice) +- [Disclaimer](#disclaimer) +*** +## Introduction + +Alternatively, you can get TFT from [Mazraa](https://mazraa.io) farmers. + +Mazraa is a pioneering provider of Peer2Peer Internet capacity on the ThreeFold Grid. Founded in the United Arab Emirates in early 2016, Mazraa has been at the forefront of leveraging the ThreeFold technology to offer decentralized and peer-to-peer compute and storage resources. + +Through Mazraa, individuals and organizations can access the capacity pool of storage and compute resources on the ThreeFold Grid. These resources can be utilized for various purposes, such as developing workloads, running applications, or storing data in a secure and decentralized manner. + +By purchasing TFT (ThreeFold Tokens) from Mazraa, individuals can not only support the growth and expansion of the ThreeFold Grid but also gain access to the capacity pool provided by Mazraa. This allows them to leverage the decentralized computing resources for their specific needs. +*** +## Get Started + +If you are interested in purchasing TFT from Mazraa, there are a few options available: + +### Get TFT via Mazraa.io Website + +Go to Mazraa.io and click on 'Purchase TFT' button. + +From there, you will be redirected to the '**Contact**' Page where you can send Mazraa staff the details of your TFT Purchase request. +You will then be contacted from Mazraa's official email **connect@Mazraa.io** to proceed to further steps. + +### Get TFT via Wire Transfer +Wire Transfer: To make a purchase via wire transfer, you can reach out to Mazraa directly at connect@Mazraa.io. They will provide you with the necessary instructions and facilitate the process for you. + +### Get TFT via PaypPal +PayPal (Soon): Mazraa is planning to introduce the option to buy tokens using PayPal. If you prefer this payment method, you can express your interest by contacting Mazraa at connect@Mazraa.io. They will provide you with further details once the option becomes available. + +It's important to note that if you are from the U.S.A., specific instructions may apply. In such cases, it is recommended to reach out to Mazraa directly at connect@Mazraa.io for further guidance and support. + +### Get TFT via Credit Card (Transcoin) + +If you prefer to pay for TFT using a credit card, Mazraa has partnered with Transcoin to offer a convenient and quick purchasing process. Here are the steps to follow: + +Visit Mazraa's Official Transcoin Checkout on [**https://transcoin.me/pay_from_api**](https://transcoin.me/pay_from_api) and enter Contact Details. Fill in your contact details and click on "**Send Verification Code**." This step is necessary for account verification. + +Please keep in mind to double check that you are entering the exact web address provided. Beware of scammers pretending to be Mazraa's Transcoin. + +Verification Code: Check your email for the verification code and enter it on the Transcoin Checkout page. + +Step 4: KYC Procedure: Complete the KYC (Know Your Customer) procedure by providing the required documents to Transcoin for verification. The specific documents needed will vary for each user. + +Specify the amount in euros (€) that you would like to purchase and provide the TFT wallet address where you want to receive the TFT. Your wallet address can be found in the [ThreeFold Connect a wallet](../storing_tft/tf_connect_app.md#create-a-wallet) or any other [TFT (Stellar) Wallet](../storing_tft/storing_tft.md) you prefer. + +Select your preferred payment method from the options provided by Transcoin. + +Once Mazraa receives the transaction details from Transcoin, they will initiate the transfer of TFT tokens to the wallet address you provided. Please note that it may take some time for the tokens to be received in your wallet. + +It's important to keep in mind that the process and timeline may vary, and additional verification steps may be required based on the regulations and policies of both Mazraa and Transcoin. +*** +## Important Notice + +Remember to exercise caution and verify the authenticity of any communication or transaction related to purchasing TFT. Scammers may try to impersonate Mazraa or ThreeFold representatives, so it's crucial to ensure you are dealing with the official channels and contacts provided by Mazraa. +*** +## Disclaimer + +The information provided in this tutorial or any related discussion is not intended as investment advice. The purpose is to provide educational and informational content only. Investing in cryptocurrencies or any other assets carries inherent risks, and it is crucial to conduct your own research and exercise caution before making any investment decisions. + +**The ThreeFold Token (TFT)** is not to be considered as a traditional investment instrument. The value of cryptocurrencies can be volatile, and there are no guarantees of profits or returns. Always be aware of the risks involved and make informed choices based on your own assessment and understanding. We strongly encourage you to read our [full disclaimer](https://library.threefold.me/info/legal/#/legal__disclaimer) and seek advice from a qualified financial professional if needed. + + diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/oneinch.md b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/oneinch.md new file mode 100644 index 0000000..b0aef23 --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/oneinch.md @@ -0,0 +1,69 @@ +

Get TFT on 1inch.io (TFT-BSC)

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [How to Get TFT on 1inch.io (TFT-BSC)](#how-to-get-tft-on-1inchio-tft-bsc) + - [Connect a BSC Wallet to 1inch.io](#connect-a-bsc-wallet-to-1inchio) + - [Swapping tokens to TFT](#swapping-tokens-to-tft) + - [Important Notice](#important-notice) +- [Disclaimer](#disclaimer) +*** +## Introduction + +Welcome to our tutorial on how to buy TFT on Binance Smart Chain (BSC) using [1inch.io](https://1inch.io/)! + +1inch is a decentralized exchange (DEX) aggregator that aims to provide the best possible trading rates for users by sourcing liquidity from various DEX platforms. It combines smart contract technology with an intuitive user interface to enable users to swap tokens at the most favorable rates with minimal slippage and fees. 1inch.io scans multiple liquidity sources, including popular DEXs like Uniswap and SushiSwap, to ensure users get the most competitive prices for their trades. For more details about 1inch you can find a review of the 1inch exchange [here](https://www.coinbureau.com/review/1inch-exchange/) + +By following the steps outlined in this guide, you'll be able to purchase TFT tokens on 1inch.io seamlessly and take advantage of the benefits offered by the Binance Smart Chain network. +*** +## Prerequisites + +Before you can buy TFT on 1inch.io, there are a few prerequisites you need to fulfill. Here's what you'll need: + +- **BSC Wallet**: To interact with the Binance Smart Chain and 1inch.io, you'll need a BSC-compatible wallet. [Trust Wallet](https://trustwallet.com/) and [MetaMask](https://metamask.io/) are popular options that support BSC. Make sure to set up and secure your wallet before proceeding. On this tutorial, we will use Metamask as our connecting wallet. + +> [Set up a Metamask Wallet](../storing_tft/metamask.md) +> +> [Set up a Trust Wallet](../storing_tft/trustwallet.md) + +- **Get BNB Tokens**: As the native cryptocurrency of Binance Smart Chain, BNB is required to pay for transaction fees on the network. You will need to have Ensure you have some BNB tokens in your BSC wallet to cover these fees when buying TFT on 1inch.io. Read [this tutorial](https://fortunly.com/articles/how-to-buy-bnb/) to know where you can buy BNB and transfer them to your BSC Wallet. + +> [Get BNB Tokens](https://docs.pancakeswap.finance/readme/get-started/bep20-guide) +*** +## How to Get TFT on 1inch.io (TFT-BSC) + +By utilizing 1inch.io, you can easily convert your existing crypto assets on BSC network into TFT-BSC by using the Swap function. Once you have obtained TFT-BSC, you have the option to bridge it into TFT Native on the Stellar network by utilizing the [TFT-Stellar bridge](../tft_bridges/tfchain_stellar_bridge.md). Let's swap some tokens! + +### Connect a BSC Wallet to 1inch.io + +To get started, head to 1inch.io and click on '**Launch dApp**' icon on the homepage as shown below + +Click on '**Connect Wallet**' account to connect your BSC Wallet. + +A pop up window will appear, and you will be asked to select the network and wallet you would like to use connect to your 1inch.io account. In this case, since we would like to trade TFT on BSC , we would choose the '**BNB Chain**' icon (other name for BSC), for the network, and **Metamask** for the wallet. You can also connect other BSC supported wallet of your preference, such as Trust Wallet, etc. + +You will now be redirected to your Metamask wallet page, or you can click on the 'Metamask' icon on your browser manually to accept the 1inch.io connection request. Select the BSC Wallet you'd like to connect to your 1inch.io account, and click '**Next**'. On the next step, Click '**Connect**' to finalize the connection. + +Once your wallet is connected, you will see that you have your wallet connected on 1inch.io homepage shown as Metamask icon on the top right corner of the 1inch.io homepage. To start swapping tokens to TFT, make sure that BNB Chain icon is shown as selected network on the top right corner of your page, usually it's automatically shown as BNB if you previously connected your Metamask's BNB Wallet. If not, you can change it by clicking on the icon and selecting BNB Chain from the list. + +### Swapping tokens to TFT + +To start swapping tokens to TFT, click on the '**Select Token**' button on the Swap page. Depending which existing BSC-supported tokens that you have in your Metamask wallet, you can swap them to to TFT as long as they're listed on 1inch.io. On this tutorial we will try to swap some BUSD tokens to TFT. + +Type '**TFT on BSC**' on the listing page, and clicked on the result shown as below + +Once selected, define the amount of BNB you'd like to swap to TFT and click '**Confirm Swap**' button. + +Wait for the banner in the upper-right corner informing you about the success of your transaction. You will be notified once the swap is successful, and Congrats! You have just swapped some BUSD to TFT. + +### Important Notice + +If you are looking for ways to provide liquidity for TFT on Binance Smart Chain on 1inch.io, you will find the according information [here](../liquidity/liquidity_1inch.md). +*** +## Disclaimer + +The information provided in this tutorial or any related discussion is not intended as investment advice. The purpose is to provide educational and informational content only. Investing in cryptocurrencies or any other assets carries inherent risks, and it is crucial to conduct your own research and exercise caution before making any investment decisions. + +**The ThreeFold Token (TFT)** is not to be considered as a traditional investment instrument. The value of cryptocurrencies can be volatile, and there are no guarantees of profits or returns. Always be aware of the risks involved and make informed choices based on your own assessment and understanding. We strongly encourage you to read our [full disclaimer](https://library.threefold.me/info/legal/#/legal__disclaimer) and seek advice from a qualified financial professional if needed. \ No newline at end of file diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/pancakeswap.md b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/pancakeswap.md new file mode 100644 index 0000000..ed09435 --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/pancakeswap.md @@ -0,0 +1,55 @@ +

Get TFT: Pancake Swap (BSC)

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Buy TFT on PancakeSwap](#buy-tft-on-pancakeswap) +- [Important Notice](#important-notice) +- [Disclaimer](#disclaimer) + +*** + +## Introduction + +In this guide, we present how to buy and sell ThreeFold Tokens on BNB Smart Chain (BSC) using [Pancake Swap](https://pancakeswap.finance/). + +**BNB Smart Chain** is a blockchain network that enables the execution of smart contracts and decentralized applications, while **Pancake Swap** is a popular decentralized exchange (DEX) built on BSC. + +## Prerequisites + +Before you can buy TFT on Pancake Swap, there are a few prerequisites you need to fulfill. Here's what you'll need: + +- **BSC Wallet**: To interact with the BNB Smart Chain and Pancake Swap, you'll need a BSC-compatible wallet. [MetaMask](https://metamask.io/) is a popular option that supports BSC. Make sure to set up and secure your wallet before proceeding. + +> [Set up a MetaMask Wallet](../storing_tft/metamask.md) + +- **Connect BSC Wallet to Pancake Swap**: Visit the Pancake Swap website and connect your BSC wallet to your Pancake Swap account. + +> [Connect Wallet to Pancake Swap](https://docs.pancakeswap.finance/readme/get-started/connection-guide) + +- **Get BNB Tokens**: As the native cryptocurrency of BNB Smart Chain, BNB is required to pay for transaction fees on the network. Ensure you have some BNB tokens in your BSC wallet to cover these fees when buying TFT on Pancake Swap. Read [this tutorial](https://fortunly.com/articles/how-to-buy-bnb/) to know where you can buy BNB and transfer them to your BSC Wallet. + +> [Get BNB Tokens](https://docs.pancakeswap.finance/readme/get-started/bep20-guide) + +## Buy TFT on PancakeSwap + +On Pancake Swap, you can easily convert your existing crypto assets on BSC network into TFT-BSC by using the Swap function. Once you have obtained TFT-BSC, you have the option to bridge it into TFT Native on the Stellar network by utilizing the [TFT-Stellar bridge](../tft_bridges/tfchain_stellar_bridge.md). Let's swap some tokens! + +Now that you're all set, go to your [PancakeSwap homepage](https://pancakeswap.finance/) and click on **Trade > Swap** button as shown. Please Make sure you're on **BNB Smart Chain** network. + +On the Swap Page, you would see that it displays swapping from BNB to CAKE as default. Here we'd like to change that to BNB (or any other tokens you have) to TFT. click on '**CAKE**' and find TFT on the token listing pop up page, and click '**Import**'. + +Once selected, define how much BNB or other token you would like to swap into TFT, and click on the '**Swap**' button. + +That's it! You have officially swapped BNB into TFT. + +## Important Notice + +If you are looking for ways to provide liquidity for TFT on BNB Smart Chain on Pancake Swap, you will find the according information [here](../liquidity/liquidity_pancake.md). + +## Disclaimer + +> The information provided in this tutorial or any related discussion is not intended as investment advice. The purpose is to provide educational and informational content only. Investing in cryptocurrencies or any other assets carries inherent risks, and it is crucial to conduct your own research and exercise caution before making any investment decisions. +> +> **The ThreeFold Token (TFT)** is not to be considered as a traditional investment instrument. The value of cryptocurrencies can be volatile, and there are no guarantees of profits or returns. Always be aware of the risks involved and make informed choices based on your own assessment and understanding. We strongly encourage you to read our [full disclaimer](../../../knowledge_base/legal/disclaimer.md) and seek advice from a qualified financial professional if needed. diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/quick_start_lobstr.md b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/quick_start_lobstr.md new file mode 100644 index 0000000..05cf8c1 --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/quick_start_lobstr.md @@ -0,0 +1 @@ +# Quick Start diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/solar_buy.md b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/solar_buy.md new file mode 100644 index 0000000..5155d82 --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/solar_buy.md @@ -0,0 +1,47 @@ +

Get TFT(Stellar) on Solar Wallet

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Get Started](#get-started) + - [Get TFT by Trading](#get-tft-by-trading) +- [Disclaimer](#disclaimer) +*** +## Introduction + +Welcome to our guide on how to buy TFT tokens (Stellar) via the [**Solar Wallet**](https://solarwallet.io/)! + +**Solar Wallet** is a user-friendly wallet designed for storing and managing Stellar-based assets like the ThreeFold Token (TFT). It provides a secure way to store your TFT tokens and access them conveniently. With Solar Wallet, you have full control over your assets and can interact with various Stellar services and decentralized applications. Solar Wallet is available as a web-based wallet and also offers mobile versions for iOS and Android devices. This guide will explain how to store TFT (Stellar) on Solar Wallet, including setup, adding tokens, and important security tips. +*** +## Prerequisites + +- **XLM**: When getting TFT tokens using the Solar wallet, the process involves swapping XLM (Stellar Lumens) or other Stellar tokens into TFT. Please note that a certain amount of XLM funding is required to facilitate the sending and receiving of assets on the Stellar network. + +- **Create a Wallet and Add TFT Asset**: Create a Solar Wallet Account via the mobile app or desktop, and add TFT as an asset. Read [**here**](../storing_tft/storing_tft.md) for the complete manual of how to create an Albedo Wallet. + +## Get Started + +### Get TFT by Trading + + you can start trading TFT on Solar by clicking the menu bar and clicking '**TFT**' icon or 'My Account' on your wallet homepage to start trading your existing tokens to TFT, for example, XLM or USDC. + +You will now be redirected to your Asset List. Click on the **TFT asset** to start trading. + +You will now be redirected to TFT asser info page. Start trading TFT by clicking '**Trade**'. + +To start buying TFT, click '**Buy**' on the asset trading page. + +Choose the trading pair token that you want to trade with, in this tutorial we will be trading XLM to TFT. Specify the amount of XLM you would like to sell, and click '**Place order**' to start trading. + +Confirm your trade on the pop up box shown. + +Wait until your order is successfully made. You will then be redirected to the wallet homepage, and Congratulations! The new TFT asset has been successfully added to your Solar Wallet account. + +> Read the full details about Solar trading feature on [Lobstr's knowledge base](https://docs.solarwallet.io/guide/08-dex.html#trade-view). +*** +## Disclaimer + +The information provided in this tutorial or any related discussion is not intended as investment advice. The purpose is to provide educational and informational content only. Investing in cryptocurrencies or any other assets carries inherent risks, and it is crucial to conduct your own research and exercise caution before making any investment decisions. + +**The ThreeFold Token (TFT)** is not to be considered as a traditional investment instrument. The value of cryptocurrencies can be volatile, and there are no guarantees of profits or returns. Always be aware of the risks involved and make informed choices based on your own assessment and understanding. We strongly encourage you to read our [full disclaimer](https://library.threefold.me/info/legal/#/legal__disclaimer) and seek advice from a qualified financial professional if needed. \ No newline at end of file diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/stellarterm.md b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/stellarterm.md new file mode 100644 index 0000000..be4aba0 --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/stellarterm.md @@ -0,0 +1,72 @@ +

Get TFT(Stellar) on StellarTerm

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Get Started](#get-started) + - [Login with an Existing Wallet](#login-with-an-existing-wallet) + - [Adding TFT as an Asset](#adding-tft-as-an-asset) + - [Get TFT by Trading](#get-tft-by-trading) + - [Get TFT by Swapping](#get-tft-by-swapping) +- [Disclaimer](#disclaimer) +*** +## Introduction + +Welcome to our tutorial on how to get TFT (Stellar) using [**Stellarterm**](https://stellarterm.com/)! + +Stellarterm is a user-friendly decentralized exchange (DEX) built on the Stellar blockchain. It allows you to trade and manage various assets directly from your Stellar wallet. With Stellarterm, you have full control over your funds as it operates in a non-custodial manner, meaning you retain ownership of your private keys and maintain complete security. + +In this tutorial, we will walk you through the process of buying TFT (ThreeFold Token) on Stellarterm by connecting your preferred Stellar wallet. By following the steps outlined in this guide, you will be able to access the Stellarterm DEX, navigate the trading interface, and execute transactions to acquire TFT tokens seamlessly. +*** +## Prerequisites + +- **An external Stellar Wallet**: You should have a Stellar wallet of your choice set up for it to be connected to StellarTerm. Read [**here**](../storing_tft/storing_tft.md) for the complete list of Stellar Wallet you can use. + +- **XLM**: When buying TFT tokens using StellarTerm, the process involves swapping XLM (Stellar Lumens) or other Stellar tokens into TFT. Please note that a certain amount of XLM funding is required to facilitate the sending and receiving of assets on the Stellar network. +*** +## Get Started + +### Login with an Existing Wallet + +Once you have completed the prerequisites, you can get TFT on StellarTerm by going to [https://stellarterm.com/](https://stellarterm.com/), click '**LOGIN**' button in the top right corner and welect your desired wallet provider from the list of options. + +Once connected, you will see your wallet's account details and balances on the dashboard. If you already have added TFT as an asset in your wallet, it will show TFT on the asset list. + +### Adding TFT as an Asset + +- IF you didn't already have TFT asset on your wallet, you can add it by going to [https://stellarterm.com/markets/](https://stellarterm.com/markets/) , go to the very bottom of the page, find the '**Exchange Pair**' section, and Select the trading pair you wish to trade. For example, if you want to trade TFT for XLM, choose the TFT/XLM pair, and click on '**Start Trading**'. + +- You can also add TFT by manually entering TFT asset infos on 'Markets' > 'Custom Exchange Pair' at the very bottom of the page, + - Asset Code: TFT + - Issuer Account ID or federation: `GBOVQKJYHXRR3DX6NOX2RRYFRCUMSADGDESTDNBDS6CDVLGVESRTAC47` + +Select the trading pair you wish to trade. For example, XLM and click on the trading pair. + +- Or you can also start trading by directly going to [https://stellarterm.com/exchange/TFT-threefold.io/XLM-native](https://stellarterm.com/exchange/TFT-threefold.io/XLM-native) + +**IMPORTANT**: It is important to ensure that you also see the name "**threefold.io**" next to the logo, the correct Asset code, or the correct Issuer Account ID or federation, as this verifies that you are selecting the genuine TFT asset associated with ThreeFold. **Beware of imposters or fraudulent assets that may attempt to mimic TFT.** ThreeFold cannot assume responsibility for any errors or mistakes made during the trustline creation process done by users. If you have any uncertainties or doubts, it is always recommended to seek assistance from official support channels or trusted sources to ensure the accuracy of the trustline configuration. + + ### Get TFT by Trading + +Once you completed the previous step, you can start trading TFT on StelarTerm by placing a new trade offer on the 'Create new offer' section of the TFT/XLM exchange page, or any other trading pair you prefer. Please Remember to review and double-check all order details before confirming the trade. + +> Read the full details about StellarTerm's trading feature on [StellarTerm's knowledge base](https://stellarterm.freshdesk.com/support/solutions/articles/151000012428-basics-how-to-place-an-offer-on-sdex-with-stellarterm). + +### Get TFT by Swapping + +You can also get TFT on StellarTerm by using it's '**Swap**' feature by going to [https://stellarterm.com/swap/](https://stellarterm.com/swap/) and Select the trading pair you wish to trade. For example, if you want to trade TFT for XLM, choose the TFT/XLM pair. + +Enter the amount of the selected token you wish to swap from XLM to TFT. Review the details of the swap, including the estimated rate and any applicable fees. + +Click on the "Swap" button to initiate the swap. + +Stellarterm will generate a transaction for you to review. Confirm the transaction details, including the amount and destination address. If everything appears correct, approve and sign the transaction using your connected wallet. + +Stellarterm will process the swap transaction on the Stellar network. Once the transaction is confirmed, you will see the acquired TFT tokens in your wallet's balance. +*** +## Disclaimer + +The information provided in this tutorial or any related discussion is not intended as investment advice. The purpose is to provide educational and informational content only. Investing in cryptocurrencies or any other assets carries inherent risks, and it is crucial to conduct your own research and exercise caution before making any investment decisions. + +**The ThreeFold Token (TFT)** is not to be considered as a traditional investment instrument. The value of cryptocurrencies can be volatile, and there are no guarantees of profits or returns. Always be aware of the risks involved and make informed choices based on your own assessment and understanding. We strongly encourage you to read our [full disclaimer](https://library.threefold.me/info/legal/#/legal__disclaimer) and seek advice from a qualified financial professional if needed. \ No newline at end of file diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tf_otc.md b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tf_otc.md new file mode 100644 index 0000000..137bd80 --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tf_otc.md @@ -0,0 +1,40 @@ +

Get TFT (Stellar) via ThreeFold's Live Desk

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Get Started](#get-started) +- [Disclaimer](#disclaimer) + +*** + +## Introduction + +If you have a large sum TFT purchase or non-standard purchase/sell requests that may be challenging to process through other methods, ThreeFold offers an Over the Counter (OTC) service. The OTC service allows you to make custom purchases or sell requests for TFT directly through ThreeFold. + +## Get Started + +Here's how you can proceed with an OTC purchase or sell request: + +**Contact the OTC Team**: To initiate an OTC purchase/sell request, send an email to **otc@gettft.com**. Make sure to cc: **info@threefold.io** as well. + +Provide Required Information: In your email, include the following details: + +**Your Name:** Provide your full name for identification purposes. +**Residency:** Specify your country of residency. +**Amount of TFT:** Indicate the quantity of TFT you wish to purchase or sell. +**Preferred Purchase/Sell Options**: State your preferred method or options for the transaction. +**Preferred Price:** If applicable, mention your desired price for the purchase or sell. +**Double-check the Email Address:** It's essential to ensure that you send your email to the correct address, which is **otc@gettft.com** cc to **info@threefold.io**. + +Be cautious and vigilant of potential scams or fraudulent individuals pretending to be ThreeFold employees. Please note that ThreeFold's employees never sells TFT personally on a 1-1 basis, and **sales are not conducted via Telegram, WhatsApp, or any other chat platform.** + +Take necessary precautions and exercise due diligence when engaging in any financial transactions. ThreeFold is committed to maintaining the security and integrity of its services, and the OTC service is only designed to handle larger or non-standard TFT transactions efficiently. + +Remember to follow the provided instructions, include accurate information, and be cautious of potential fraudulent activities. By adhering to the official process, you can proceed with your TFT purchase/sell request through the OTC service provided by ThreeFold. + +## Disclaimer + +> The information provided in this tutorial or any related discussion is not intended as investment advice. The purpose is to provide educational and informational content only. Investing in cryptocurrencies or any other assets carries inherent risks, and it is crucial to conduct your own research and exercise caution before making any investment decisions. +> +> **The ThreeFold Token (TFT)** is not to be considered as a traditional investment instrument. The value of cryptocurrencies can be volatile, and there are no guarantees of profits or returns. Always be aware of the risks involved and make informed choices based on your own assessment and understanding. We strongly encourage you to read our [full disclaimer](https://library.threefold.me/info/legal/#/legal__disclaimer) and seek advice from a qualified financial professional if needed. \ No newline at end of file diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_getting_started.md b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_getting_started.md new file mode 100644 index 0000000..0667376 --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_getting_started.md @@ -0,0 +1,53 @@ + +

Getting Started

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Buying and Storing TFTs](#buying-and-storing-tfts) +- [How to set up a Stellar address for TFT transactions](#how-to-set-up-a-stellar-address-for-tft-transactions) +- [Disclaimer](#disclaimer) + - [Learn All the Methods](#learn-all-the-methods) + +*** + +## Introduction + +There are multiple ways to acquire TFT depending on your preferences and the blockchain network you choose to transact on. To start, you need to have a supporting wallet to store your TFTs. Read more about how to store your TFTs [here](../storing_tft/storing_tft.md) + +If you're interested in trading or swapping other cryptocurrencies for TFT, you can visit various crypto exchanges that list TFT as shown on te next section of this page. Additionally, you can leverage swapping services available on decentralized exchanges (DEXs) or automated market makers (AMMs) to exchange your tokens for TFT (BSC). + +Moreover, you can purchase TFT using fiat currency directly from TFT Official's Live Desk, or [ThreeFold's official TFT Shop](https://gettft.com/). Another option is to obtain TFT from ThreeFold Farmers. You can engage with Farmers to purchase TFT directly from them, contributing to the growth and decentralization of the ThreeFold network. + +It's important to explore the available options and select the most convenient and secure method for acquiring TFT. Always exercise caution and ensure the legitimacy and reliability of the platforms or individuals you engage with to obtain TFT. + + + +## Buying and Storing TFTs + +Discover step-by-step instructions on buying and storing TFTs across different platforms. + +If you're looking to navigate the [TFT Ecosystem](https://library.threefold.me/info/manual/#/tokens/threefold__tft_ecosystem), this collection of tutorials and manuals is here to help. Learn how to purchase, trade, and securely store your TFTs with ease. + +For a comprehensive introduction to TFT, we recommend exploring the [TFT Home Section in the ThreeFold Library](https://library.threefold.me/info/threefold#/tokens/threefold__tokens_home). + + + +## How to set up a Stellar address for TFT transactions + +In general, to set up a Stellar address to transact TFT on Stellar chain, you can use any Stellar wallet that has a TFT trustline enabled. Note that on Stellar chain, fees are paid in XLM. + +The easiest way is to simply create an account on the ThreeFold Connect App (for [Android](https://play.google.com/store/apps/details?id=org.jimber.threebotlogin) and [iOS](https://apps.apple.com/us/app/threefold-connect/id1459845885)) and to then use the TFT wallet of the app, which has by default a TFT trustline on Stellar chain and also comes with 1 XLM sponsored by Threefold for transaction fees. + + + +## Disclaimer + +The information provided in this tutorial or any related discussion is not intended as investment advice. The purpose is to provide educational and informational content only. Investing in cryptocurrencies or any other assets carries inherent risks, and it is crucial to conduct your own research and exercise caution before making any investment decisions. + +**The ThreeFold Token (TFT)** is not to be considered as a traditional investment instrument. The value of cryptocurrencies can be volatile, and there are no guarantees of profits or returns. Always be aware of the risks involved and make informed choices based on your own assessment and understanding. We strongly encourage you to read our [full disclaimer](https://library.threefold.me/info/legal/#/legal__disclaimer) and seek advice from a qualified financial professional if needed. + + +### Learn All the Methods + +You can learn [all the different ways to transact TFT](./buy_sell_tft.md). \ No newline at end of file diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_1.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_1.png new file mode 100644 index 0000000..265dcc1 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_1.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_10.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_10.png new file mode 100644 index 0000000..37e04bb Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_10.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_11.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_11.png new file mode 100644 index 0000000..6f05038 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_11.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_12.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_12.png new file mode 100644 index 0000000..ad81a3d Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_12.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_13.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_13.png new file mode 100644 index 0000000..8d808cc Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_13.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_14.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_14.png new file mode 100644 index 0000000..014edde Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_14.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_15.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_15.png new file mode 100644 index 0000000..895d432 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_15.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_16.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_16.png new file mode 100644 index 0000000..b8ca3c9 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_16.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_17.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_17.png new file mode 100644 index 0000000..5919d0c Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_17.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_18.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_18.png new file mode 100644 index 0000000..8ea142f Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_18.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_19.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_19.png new file mode 100644 index 0000000..14688ab Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_19.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_2.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_2.png new file mode 100644 index 0000000..cb638bd Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_2.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_20.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_20.png new file mode 100644 index 0000000..b072502 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_20.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_21.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_21.png new file mode 100644 index 0000000..709e50a Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_21.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_22.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_22.png new file mode 100644 index 0000000..6e588cd Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_22.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_23.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_23.png new file mode 100644 index 0000000..b47c4f0 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_23.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_24.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_24.png new file mode 100644 index 0000000..df06bec Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_24.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_25.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_25.png new file mode 100644 index 0000000..7ba5402 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_25.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_26.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_26.png new file mode 100644 index 0000000..f34d4ff Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_26.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_27.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_27.png new file mode 100644 index 0000000..1de6ee5 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_27.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_28.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_28.png new file mode 100644 index 0000000..c3e8cd0 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_28.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_29.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_29.png new file mode 100644 index 0000000..888067f Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_29.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_3.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_3.png new file mode 100644 index 0000000..4a18f4c Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_3.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_30.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_30.png new file mode 100644 index 0000000..f28e697 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_30.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_31.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_31.png new file mode 100644 index 0000000..84fe32e Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_31.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_32.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_32.png new file mode 100644 index 0000000..3ab05eb Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_32.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_33.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_33.png new file mode 100644 index 0000000..b30050a Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_33.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_34.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_34.png new file mode 100644 index 0000000..553db13 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_34.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_4.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_4.png new file mode 100644 index 0000000..b2a0d03 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_4.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_5.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_5.png new file mode 100644 index 0000000..2b28aef Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_5.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_6.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_6.png new file mode 100644 index 0000000..a3601b3 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_6.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_7.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_7.png new file mode 100644 index 0000000..879a735 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_7.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_8.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_8.png new file mode 100644 index 0000000..b1a9321 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_8.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_9.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_9.png new file mode 100644 index 0000000..eb2e80e Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/gettft_9.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/lobstr_swap.jpeg b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/lobstr_swap.jpeg new file mode 100644 index 0000000..0ca13b9 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/lobstr_swap.jpeg differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/lobstr_trade.jpeg b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/lobstr_trade.jpeg new file mode 100644 index 0000000..28a5ad0 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/lobstr_trade.jpeg differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/threefold__lobstr_swap_tft_.jpg b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/threefold__lobstr_swap_tft_.jpg new file mode 100644 index 0000000..d8955a6 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/img/threefold__lobstr_swap_tft_.jpg differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/tft_lobstr.md b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/tft_lobstr.md new file mode 100644 index 0000000..25fdda7 --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/tft_lobstr.md @@ -0,0 +1,10 @@ +

Get TFT on Lobstr Wallet

+ +It is very easy to purchase TFT on Lobstr Wallet. + +We present here a quick guide to give you the essential information to purchase TFT and a complete guide to guide you step-by-step in the process. + +

Table of Contents

+ +- [Quick Guide](./tft_lobstr_short_guide.md) +- [Complete Guide](./tft_lobstr_complete_guide.md) \ No newline at end of file diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/tft_lobstr_complete_guide.md b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/tft_lobstr_complete_guide.md new file mode 100644 index 0000000..e1fd2f6 --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/tft_lobstr_complete_guide.md @@ -0,0 +1,200 @@ +

Get TFT: Lobstr Wallet (Stellar)

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Download the App and Create an Account](#download-the-app-and-create-an-account) +- [Connect Your TF Connect App Wallet](#connect-your-tf-connect-app-wallet) +- [Buy XLM with Fiat Currency](#buy-xlm-with-fiat-currency) +- [Swap XLM for TFT](#swap-xlm-for-tft) +- [Disclaimer](#disclaimer) + +*** + +## Introduction + +In this guide, you'll learn how to buy ThreeFold Tokens with [Lobstr](https://lobstr.co/) using a credit or a debit card and a TF Connect wallet. This is a simple method that works well for small to medium purchases. + +Lobstr is an app for managing digital assets like TFT on the Stellar blockchain. In this case, we'll first obtain Stellar's native currency, Lumens (XLM) and swap them for TFT. + +> Note that it is possible to do these steps without connecting the Lobstr wallet to the TF Connect App wallet (read [docs](./tft_lobstr_short_guide.md)). But doing this has a clear advantage: when we buy and swap on Lobstr, the TFT is directly accessible on the TF Connect app wallet. + +## Download the App and Create an Account + +Go on [www.lobstr.co](https://www.lobstr.co) and download the Lobstr app. +You can download it for Android or iOS. + +![image](./img/gettft_1.png) + +We will show here the steps for Android, but it is very similar with iOS. +Once you've clicked on the Android button, you can click install on the Google Store page: + +![image](./img/gettft_2.png) + +Once the app is downloaded, open it: + +![image](./img/gettft_3.png) + +On the Lobstr app, click on **Create Account**: + +![image](./img/gettft_4.png) + +You will then need to enter your email address: + +![image](./img/gettft_5.png) + +Then, choose a safe password for your account: + +![image](./img/gettft_6.png) + +Once this is done, you will need to verify your email. + +Click on **Verify Email** and then go check your email inbox. + +![image](./img/gettft_7.png) + +Simply click on **Verify Email** on the email you've received. + +![image](./img/gettft_8.png) + +Once your email is verified, you can sign in to your Lobstr account: + +![image](./img/gettft_9.png) + +![image](./img/gettft_10.png) + + + +## Connect Your TF Connect App Wallet + +You will then need to either create a new wallet or connect an existing wallet. + +For this guide, we will show how to connect your TF Connect app wallet, but please note that you can create a new wallet on Lobstr by clicking **Create Stellar Wallet**. + +Since we are working with the Threefold ecosystem, it is very easy and practical to simply connect your TF Connect app wallet to Lobstr. This way, when you buy XLM and swap XLM tokens for TFTs, they will be directly available on your TF Connect app wallet. + +![image](./img/gettft_11.png) + +To connect your TF Connect app wallet, you will need to find your Stellar address and chain secret key. +This is very simple to do. + +Click on **I have a public or secret key**. + +![image](./img/gettft_12.png) + +As you can see on this next picture, you need the Stellar address and secret key to properly connect your TF Connect app wallet to Lobstr: + +![image](./img/gettft_18.png) + +To find your Stellar address and secret key, go on the TF Connect app and select the **Wallet** section: + +![image](./img/gettft_13.png) + +At the top of the section, click on the **copy** button to copy your Stellar Address: + +![image](./img/gettft_17.png) + +Now, we will find the Stellar secret key. +At the botton of the section, click on the encircled **i** button: + +![image](./img/gettft_14.png) + +Next, click on the **eye** button to reveal your secret key: + +![image](./img/gettft_15.png) + +You can now simply click on the **copy** button on the right: + +![image](./img/gettft_16.png) + +That's it! You've now connected your TF Connect app wallet to your Lobstr account. + +## Buy XLM with Fiat Currency + +Now, all we need to do, is buy XLM and then swap it for TFT. +It will be directly available in your TF Connect App wallet. + +On the Lobstr app, click on the top right menu button: + +![image](./img/gettft_19.png) + +Then, click on **Buy Crypto**: + +![image](./img/gettft_20.png) + +By default, the crypto selected is XLM. This is alright for us as we will quickly swap the XLM for TFT. + +On the Buy Crypto page, you can choose the type of Fiat currency you want. +By default it is in USD. To select some othe fiat currency, you can click on **ALL** and see the available fiat currencies: + +![image](./img/gettft_21.png) + +You can search or select the current you want for the transfer: + +![image](./img/gettft_22.png) + +You will then need to decide how much XLM you want to buy. Note that there can be a minimum amount. +Once you chose the desired amount, click on **Continue**. + +![image](./img/gettft_23.png) + +Lobstr will then ask you to proceed to a payment method. In this case, it is Moonpay. +Note that in some cases, your credit card won't accept Moonpay payments. You will simply need to confirm with them that you agree with transacting with Moonpay. This can be done by phone. Check with your bank and credit card company if this applies. + +![image](./img/gettft_24.png) + +Once you've set up your Moonpay payment method, you will need to process and confirm the transaction: + +![image](./img/gettft_25.png) +![image](./img/gettft_26.png) + +You will then see a processing window. +This process is usually fast. Within a few minutes, you should receive your XLM. + +![image](./img/gettft_27.png) + +Once the XLM is delivered, you will receive a notification: + +![image](./img/gettft_28.png) + +When your transaction is complete, you will see this message: + +![image](./img/gettft_29.png) + +On the Trade History page, you can choose to download the csv file version of your transaction: + +![image](./img/gettft_30.png) + +That's it! You've bought XLM on Lobstr and Moonpay. + +## Swap XLM for TFT + +Now we want to swap the XLM tokens for the Threefold tokens (TFT). +This is even easier than the previous steps. + +Go to the Lobstr Home menu and select **Swap**: + +![image](./img/gettft_31.png) + +On the **Swap** page, write "tft" and select the Threefold token: + +![image](./img/gettft_32.png) + +Select the amount of XLM you want to swap. It is recommended to keep at least 1 XLM in your wallet for transaction fees. + +![image](./img/gettft_33.png) + +Within a few seconds, you will receive a confirmation that your swap is completed: +Note that the TFT is directly sent on your TF Connect app wallet. + +![image](./img/gettft_34.png) + +That's it. You've swapped XLM for TFT. + +You can now use your TFT to deploy workloads on the Threefold Grid. + +## Disclaimer + +> The information provided in this tutorial or any related discussion is not intended as investment advice. The purpose is to provide educational and informational content only. Investing in cryptocurrencies or any other assets carries inherent risks, and it is crucial to conduct your own research and exercise caution before making any investment decisions. +> +> **The ThreeFold Token (TFT)** is not to be considered as a traditional investment instrument. The value of cryptocurrencies can be volatile, and there are no guarantees of profits or returns. Always be aware of the risks involved and make informed choices based on your own assessment and understanding. We strongly encourage you to read our [full disclaimer](../../../../knowledge_base/legal/disclaimer.md) and seek advice from a qualified financial professional if needed. diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/tft_lobstr_short_guide.md b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/tft_lobstr_short_guide.md new file mode 100644 index 0000000..eb1d86e --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/tft_lobstr_short_guide.md @@ -0,0 +1,76 @@ +

Get TFT: Quick Start (Stellar)

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Install Lobstr](#install-lobstr) +- [Create Wallet](#create-wallet) +- [Buy XLM](#buy-xlm) +- [Swap XLM for TFT](#swap-xlm-for-tft) +- [Disclaimer](#disclaimer) + +*** + +## Introduction + +In this guide, we show how to buy and sell ThreeFold Tokens with [Lobstr wallet](https://lobstr.co/) using a credit or a debit card. This is a simple method that works well for small to medium purchases. You can buy TFT on Lobstr with your smartphone (Android and iOS) and your computer. + +Lobstr is an app for managing digital assets like TFT on the Stellar blockchain. In this case, we'll first obtain Stellar's native currency, Lumens (XLM) and swap them for TFT. + +> [Moonpay](https://www.moonpay.com/) is the service integrated in Lobstr to enable users to buy digital assets like XLM with fiat currencies like US Dollars and Euros. Moonpay is available in most regions, but there are some [exceptions](https://support.moonpay.com/hc/en-gb/articles/6557330712721-What-are-our-non-supported-countries-states-and-territories-for-on-ramp-product). If your country or state isn't supported by Moonpay, you will need to find another cryptocurrency exchange or on ramp to obtain XLM. From there, you can follow the rest of this guide. + +## Install Lobstr + +To get Lobstr, just head to [lobstr.co](https://lobstr.co/) where you'll find buttons to download the app for both Android and iOS. Once the app is installed, open it to continue. To use Lobstr directly on your browser, simply click on **Get Started** in the top menu of the Lobstr website. This allows you to use Lobstr on your computer instead of your smartphone. + +Hit the **Create Account** button and proceed to create an account by entering your email address and choosing a password. Verify your email address and then sign in. + +## Create Wallet + +After you sign in to Lobstr for the first time, you'll be prompted to create or connect a Stellar wallet. If you already have the TF Connect App, follow the instructions at [this link](./tft_lobstr_complete_guide.html#connect-your-tf-connect-app-wallet) to import your existing wallet into Lobstr. Otherwise, just press the **Create Stellar Wallet** button. + +Lobstr will then present you with 12 words to write down and store safely. Keep in mind that anyone who can access these words can also access any funds in your account. They can also be used to recover your account later. Be sure not to lose them. + +## Buy XLM + +In this step, we'll buy XLM with a credit or debit card (actually a few forms of bank transfer and other payment methods are [supported](https://support.moonpay.com/customers/docs/moonpays-supported-payment-methods-1) too). + +On the Lobstr app, click on the hamburger menu button: + +![image](./img/gettft_19.png) + +Then click on **Buy Crypto**: + +![image](./img/gettft_20.png) + +By default XLM is selected to buy, which is what we want. Above you can choose how much to buy in the currency of your choosing. Press **ALL** to see a full list of available currencies. + +Once you've entered the amount you want to buy, hit **Continue** and proceed through the checkout process with Moonpay. On the final screen, you'll see a message that it can take some time to complete the order: + +![image](./img/gettft_27.png) + +Usually this happens quickly and you'll receive a notification if notifications are enabled for the Lobstr app. + +## Swap XLM for TFT + +Once you have the XLM, use the hamburger menu again and this time select **Swap**: + +![image](./img/gettft_31.png) + +Enter TFT in the search bar and select the entry that includes **threefold.io**. + +> Be careful at this step! There are fake scam coins using the ThreeFold logo. We can't remove these tokens from Stellar, unfortunately, so you will need to be sure to choose the right one. + +![image](./img/gettft_32.png) + +On the next screen, XLM will be automatically selected as the currency to trade for TFT. The amount that's available to trade will be shown in blue. You can just tap this amount to trade the maximum amount. A couple XLM will be reserved to keep your account open and pay for future Stellar transaction fees. + +Hit the green button at the bottom to complete the trade. There will be a few more prompts and potentially some warnings about scam tokens (again, look for **threefold.io**). + +When you're finished you'll see a screen that says **Swap completed**. Congrats, you just bought TFT! + +## Disclaimer + +> The information provided in this tutorial or any related discussion is not intended as investment advice. The purpose is to provide educational and informational content only. Investing in cryptocurrencies or any other assets carries inherent risks, and it is crucial to conduct your own research and exercise caution before making any investment decisions. +> +> **The ThreeFold Token (TFT)** is not to be considered as a traditional investment instrument. The value of cryptocurrencies can be volatile, and there are no guarantees of profits or returns. Always be aware of the risks involved and make informed choices based on your own assessment and understanding. We strongly encourage you to read our [full disclaimer](../../../../knowledge_base/legal/definitions_legal.md) and seek advice from a qualified financial professional if needed. \ No newline at end of file diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/tft_lobstr_short_guide_archive.md b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/tft_lobstr_short_guide_archive.md new file mode 100644 index 0000000..7d30e5e --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_lobstr/tft_lobstr_short_guide_archive.md @@ -0,0 +1,58 @@ +

Lobstr Wallet: Quick Guide

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Get Started](#get-started) + - [Get TFT By Swapping](#get-tft-by-swapping) + - [Get TFT by Trading](#get-tft-by-trading) +- [Disclaimer](#disclaimer) + +*** + +## Introduction + +In this tutorial, we will guide you through the process of getting TFT on the [Lobstr Wallet](https://lobstr.co/). The wallet is available for both desktop and mobile as a web and mobile app. + +Lobstr Wallet is a secure and user-friendly wallet designed specifically for the Stellar blockchain. It allows you to store, manage, and transact with your Stellar-based assets, including TFT (ThreeFold Token). + +## Prerequisites + +- **XLM**: When getting TFT tokens using the Lobstr wallet, the process involves swapping XLM (Stellar Lumens) or other Stellar tokens into TFT. Please note that a certain amount of XLM funding is required to facilitate the sending and receiving of assets on the Stellar network. + +- **Create a Lobstr Wallet and Add TFT Asset**: Create a [Lobstr Wallet](https://lobstr.co/) account via the mobile app or desktop, and [add TFT as an asset](https://lobstr.freshdesk.com/support/solutions/articles/151000001061-adding-custom-assets-on-lobstr) (with either the code `TFT` or the home domain `threefold.io`). + +## Get Started + +### Get TFT By Swapping + +On this tutorial, we will be using the mobile app to guide you through the process of buying TFT via Lobstr. + +Once you have completed the prerequisites, you can get TFT on Lobstr by clicking the menu bar and clicking '**Swap**' to start swapping your existing tokens to TFT, for example, XLM or USDC. + +![](IMG/../img/lobstr_swap.jpeg) + +Insert the amount of TFT you'd like to buy or the amount of XLM you'd like to swap for TFT. Click '**Swap XLM to TFT**' to confirm the transaction. + +![](img/threefold__lobstr_swap_tft_.jpg) + + Congratulations. You just swapped some XLM to TFT. Go to 'Assets' page from the menu bar to see your recently purchased TFT tokens. + +### Get TFT by Trading + +For advanced traders, Lobstr provides access to the full orderbook trading functionality in the Trade section. + +You can start trading TFT on Lobstr by clicking the menu bar and clicking '**Trade**' to start trading your existing tokens to TFT, for example, XLM or USDC. + +![](IMG/../img/lobstr_trade.jpeg) + +You can choose to fullfill sell orders, or create your own buy order. Once the buy order or trade has been fulfilled your TFT will show up in your wallet. + +> Read the full details about Lobstr trading feature on [Lobstr's knowledge base](https://lobstr.freshdesk.com/support/solutions/articles/151000001080-trading-in-lobstr-wallet). + +## Disclaimer + +> The information provided in this tutorial or any related discussion is not intended as investment advice. The purpose is to provide educational and informational content only. Investing in cryptocurrencies or any other assets carries inherent risks, and it is crucial to conduct your own research and exercise caution before making any investment decisions. +> +> **The ThreeFold Token (TFT)** is not to be considered as a traditional investment instrument. The value of cryptocurrencies can be volatile, and there are no guarantees of profits or returns. Always be aware of the risks involved and make informed choices based on your own assessment and understanding. We strongly encourage you to read our [full disclaimer](../../../wiki/disclaimer.md) and seek advice from a qualified financial professional if needed. diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_metamask/img/tft_on_ethereum_image_1.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_metamask/img/tft_on_ethereum_image_1.png new file mode 100644 index 0000000..0db09d3 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_metamask/img/tft_on_ethereum_image_1.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_metamask/img/tft_on_ethereum_image_2.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_metamask/img/tft_on_ethereum_image_2.png new file mode 100644 index 0000000..b7b21f2 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_metamask/img/tft_on_ethereum_image_2.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_metamask/img/tft_on_ethereum_image_3.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_metamask/img/tft_on_ethereum_image_3.png new file mode 100644 index 0000000..85b01b2 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_metamask/img/tft_on_ethereum_image_3.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_metamask/img/tft_on_ethereum_image_4.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_metamask/img/tft_on_ethereum_image_4.png new file mode 100644 index 0000000..753c0dd Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_metamask/img/tft_on_ethereum_image_4.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_metamask/img/tft_on_ethereum_image_5.png b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_metamask/img/tft_on_ethereum_image_5.png new file mode 100644 index 0000000..073a4a7 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_metamask/img/tft_on_ethereum_image_5.png differ diff --git a/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_metamask/tft_metamask.md b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_metamask/tft_metamask.md new file mode 100644 index 0000000..99fea4c --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/buy_sell_tft/tft_metamask/tft_metamask.md @@ -0,0 +1,91 @@ +

Get TFT: MetaMask (BSC & ETH)

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [TFT Addresses](#tft-addresses) + - [Ethereum Chain Address](#ethereum-chain-address) + - [BSC Address](#bsc-address) +- [Add TFT to Metamask](#add-tft-to-metamask) +- [Buy TFT on Metamask](#buy-tft-on-metamask) +- [Disclaimer](#disclaimer) + +*** + +## Introduction + +In this guide, we present how to buy and sell ThreeFold Tokens on BNB Smart Chain and Ethereum using [Metamask](https://metamask.io/). + +**BNB Smart Chain** and **Ethereum** chain are blockchain networks that enable the execution of smart contracts and decentralized applications, while **MetaMask** is a software cryptocurrency wallet used to interact with Ethereum and BNB Smart Chain. + +## TFT Addresses + +With MetaMask, you can buy and sell TFT on both BNB Smart Chain and the Ethereum chain. Make sure to use the correct TFT address when doing transactions. + +### Ethereum Chain Address + +The ThreeFold Token (TFT) is available on Ethereum. +It is implemented as a wrapped asset with the following token address: + +``` +0x395E925834996e558bdeC77CD648435d620AfB5b +``` + +### BSC Address + +The ThreeFold Token (TFT) is available on BSC. +It is implemented as a wrapped asset with the following token address: + +``` +0x8f0FB159380176D324542b3a7933F0C2Fd0c2bbf +``` + +## Add TFT to Metamask + +We present the steps on Ethereum chain. Make sure to switch to BSC and to use the TFT BSC address if you want to proceed on BSC. + +Open Metamask and import the ThreeFold Token. First click on `import tokens`: + +![Metamask-Main|297x500](./img/tft_on_ethereum_image_1.png) + +Then, choose `Custom Token`: + +![Metamask-ImportToken|298x500](./img/tft_on_ethereum_image_2.png) + +To add the ThreeFold Token, paste its Ethereum address in the field `Token contract address field`. The address is the following: + +``` +0x395E925834996e558bdeC77CD648435d620AfB5b +``` + +Once you paste the TFT contract address, the parameter `Token symbol` should automatically be filled with `TFT`. + +Click on the button `Add Custom Token`. + +![Metamask-importCustomToken|297x500](./img/tft_on_ethereum_image_3.png) + +To confirm, click on the button `Import tokens`: + +![Metamask-ImporttokensQuestion|298x500](./img/tft_on_ethereum_image_4.png) + +TFT is now added to Metamask. + + +## Buy TFT on Metamask + +Liquidity is present on Ethereum so you can use the "Swap" functionality from Metamask directly or go to [Uniswap](https://app.uniswap.org/#/swap) to swap Ethereum, or any other token, to TFT. + +When using Uniswap, paste the TFT token address in the field `Select a token` to select TFT on Ethereum. The TFT token address is the following: + +``` +0x395E925834996e558bdeC77CD648435d620AfB5b +``` + +![Uniswap-selecttoken|315x500](./img/tft_on_ethereum_image_5.png) + + +## Disclaimer + +> The information provided in this tutorial or any related discussion is not intended as investment advice. The purpose is to provide educational and informational content only. Investing in cryptocurrencies or any other assets carries inherent risks, and it is crucial to conduct your own research and exercise caution before making any investment decisions. +> +> **The ThreeFold Token (TFT)** is not to be considered as a traditional investment instrument. The value of cryptocurrencies can be volatile, and there are no guarantees of profits or returns. Always be aware of the risks involved and make informed choices based on your own assessment and understanding. We strongly encourage you to read our [full disclaimer](../../../../knowledge_base/legal/disclaimer.md) and seek advice from a qualified financial professional if needed. \ No newline at end of file diff --git a/collections/documentation/threefold_token/storing_tft/img/albedo_home.png b/collections/tfmanual/documentation/threefold_token/img/albedo_balance.png similarity index 100% rename from collections/documentation/threefold_token/storing_tft/img/albedo_home.png rename to collections/tfmanual/documentation/threefold_token/img/albedo_balance.png diff --git a/collections/tfmanual/documentation/threefold_token/img/albedo_home.png b/collections/tfmanual/documentation/threefold_token/img/albedo_home.png new file mode 100644 index 0000000..52cef5e Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/img/albedo_home.png differ diff --git a/collections/tfmanual/documentation/threefold_token/img/threefold__albedo_send_receive.png b/collections/tfmanual/documentation/threefold_token/img/threefold__albedo_send_receive.png new file mode 100644 index 0000000..3f3b773 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/img/threefold__albedo_send_receive.png differ diff --git a/collections/tfmanual/documentation/threefold_token/img/token_distribution.png b/collections/tfmanual/documentation/threefold_token/img/token_distribution.png new file mode 100644 index 0000000..a05ad5a Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/img/token_distribution.png differ diff --git a/collections/tfmanual/documentation/threefold_token/liquidity/img/1inch_pool_details.png b/collections/tfmanual/documentation/threefold_token/liquidity/img/1inch_pool_details.png new file mode 100644 index 0000000..07521c7 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/liquidity/img/1inch_pool_details.png differ diff --git a/collections/tfmanual/documentation/threefold_token/liquidity/img/1inch_pool_total.png b/collections/tfmanual/documentation/threefold_token/liquidity/img/1inch_pool_total.png new file mode 100644 index 0000000..de818e7 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/liquidity/img/1inch_pool_total.png differ diff --git a/collections/tfmanual/documentation/threefold_token/liquidity/img/1inch_provide.png b/collections/tfmanual/documentation/threefold_token/liquidity/img/1inch_provide.png new file mode 100644 index 0000000..cb577ca Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/liquidity/img/1inch_provide.png differ diff --git a/collections/tfmanual/documentation/threefold_token/liquidity/img/1inch_submit.png b/collections/tfmanual/documentation/threefold_token/liquidity/img/1inch_submit.png new file mode 100644 index 0000000..93dead2 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/liquidity/img/1inch_submit.png differ diff --git a/collections/tfmanual/documentation/threefold_token/liquidity/img/1inch_tftpool.png b/collections/tfmanual/documentation/threefold_token/liquidity/img/1inch_tftpool.png new file mode 100644 index 0000000..b8cd2ce Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/liquidity/img/1inch_tftpool.png differ diff --git a/collections/tfmanual/documentation/threefold_token/liquidity/img/albedo_confirm.png b/collections/tfmanual/documentation/threefold_token/liquidity/img/albedo_confirm.png new file mode 100644 index 0000000..d09eefc Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/liquidity/img/albedo_confirm.png differ diff --git a/collections/tfmanual/documentation/threefold_token/liquidity/img/albedo_liquidity.png b/collections/tfmanual/documentation/threefold_token/liquidity/img/albedo_liquidity.png new file mode 100644 index 0000000..b27aef6 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/liquidity/img/albedo_liquidity.png differ diff --git a/collections/tfmanual/documentation/threefold_token/liquidity/img/assets.png b/collections/tfmanual/documentation/threefold_token/liquidity/img/assets.png new file mode 100644 index 0000000..96ed489 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/liquidity/img/assets.png differ diff --git a/collections/tfmanual/documentation/threefold_token/liquidity/img/liquidity_1inch_unlock.png b/collections/tfmanual/documentation/threefold_token/liquidity/img/liquidity_1inch_unlock.png new file mode 100644 index 0000000..e449cce Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/liquidity/img/liquidity_1inch_unlock.png differ diff --git a/collections/tfmanual/documentation/threefold_token/liquidity/img/liquidity_approve.jpeg b/collections/tfmanual/documentation/threefold_token/liquidity/img/liquidity_approve.jpeg new file mode 100644 index 0000000..e4fd5b6 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/liquidity/img/liquidity_approve.jpeg differ diff --git a/collections/tfmanual/documentation/threefold_token/liquidity/img/liquidity_busd.jpeg b/collections/tfmanual/documentation/threefold_token/liquidity/img/liquidity_busd.jpeg new file mode 100644 index 0000000..6721463 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/liquidity/img/liquidity_busd.jpeg differ diff --git a/collections/tfmanual/documentation/threefold_token/liquidity/img/pancake_liquidity.png b/collections/tfmanual/documentation/threefold_token/liquidity/img/pancake_liquidity.png new file mode 100644 index 0000000..c16b551 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/liquidity/img/pancake_liquidity.png differ diff --git a/collections/tfmanual/documentation/threefold_token/liquidity/img/threefold__confirmation.jpg b/collections/tfmanual/documentation/threefold_token/liquidity/img/threefold__confirmation.jpg new file mode 100644 index 0000000..b9c1f11 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/liquidity/img/threefold__confirmation.jpg differ diff --git a/collections/tfmanual/documentation/threefold_token/liquidity/img/threefold__lp_tokens.jpg b/collections/tfmanual/documentation/threefold_token/liquidity/img/threefold__lp_tokens.jpg new file mode 100644 index 0000000..a7b0432 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/liquidity/img/threefold__lp_tokens.jpg differ diff --git a/collections/tfmanual/documentation/threefold_token/liquidity/img/threefold__supply.jpg b/collections/tfmanual/documentation/threefold_token/liquidity/img/threefold__supply.jpg new file mode 100644 index 0000000..1b2eda6 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/liquidity/img/threefold__supply.jpg differ diff --git a/collections/tfmanual/documentation/threefold_token/liquidity/liquidity_1inch.md b/collections/tfmanual/documentation/threefold_token/liquidity/liquidity_1inch.md new file mode 100644 index 0000000..99845ad --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/liquidity/liquidity_1inch.md @@ -0,0 +1,79 @@ +

Provide TFT (BSC) Liquidity on Pancake Swap

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Become a TFT LP on 1inch.io](#become-a-tft-lp-on-1inchio) +- [Important Notice](#important-notice) +- [Disclaimer](#disclaimer) + +*** + +## Introduction + +In the case of TFT on Binance Smart Chain (BSC) and [1inch.io](https://1inch.io/), becoming a liquidity provider involves providing TFT(BSC) and another token (such as BUSD) to the TFT- BSC liquidity pool on 1inch.io. + +By adding liquidity to this pool, the LP helps to ensure that there is a consistent and sufficient supply of TFT available for trading on the BSC network. This contributes to the overall liquidity of the TFT token on 1inch.io, making it easier for users to buy and sell TFT(BSC) without experiencing significant price slippage. + +By participating in the liquidity provision process, you actively contribute to the growth and adoption of the TFT token. As more users trade TFT(BSC) on 1inch.io, the liquidity and trading volume increase, which can attract more traders and investors to the token. This increased activity can lead to a broader awareness of TFT and potentially drive its value and market presence. + +## Prerequisites + +BBefore you can buy TFT on 1inch.io, there are a few prerequisites you need to fulfill. Here's what you'll need: + +- **BSC Wallet**: To interact with the Binance Smart Chain and 1inch.io, you'll need a BSC-compatible wallet. [MetaMask](https://metamask.io/) is a popular option that supports BSC. Make sure to set up and secure your wallet before proceeding. On this tutorial, we will use Metamask as our connecting wallet. + +> [Set up a Metamask Wallet](../storing_tft/metamask.md) + +- **Get BNB Tokens**: As the native cryptocurrency of Binance Smart Chain, BNB is required to pay for transaction fees on the network. You will need to have Ensure you have some BNB tokens in your BSC wallet to cover these fees when buying TFT on 1inch.io. Read [this tutorial](https://fortunly.com/articles/how-to-buy-bnb/) to know where you can buy BNB and transfer them to your BSC Wallet. + +> [Get BNB Tokens](https://docs.pancakeswap.finance/readme/get-started/bep20-guide) + +## Become a TFT LP on 1inch.io + +Anyone who fullfill the prerequisites can create a TFT(BSC) liquidity pool on 1inch.io. Currently as June 2023 on 1inch.io there is one existing BUSD - TFT(BSC) liquidity pool available where you can participate in providing liquidity into on address: + +[**https://app.1inch.io/#/56/earn/pools?filter=TFT**](https://app.1inch.io/#/56/earn/pools?filter=TFT). + +Click on the arrow as shown below to see the details of the BUSD - TFT pool. + +![](./img/1inch_tftpool.png) + +Next, click on the '**Provide Liquidity**' button in the lower right corner. A new window will open as shown below. Click on 'Provide Liquidity' icon to start the transaction process. + +![](./img/1inch_pool_details.png) + +A new window will open that will ask you to enter the amount of BUSD tokens or the amount of TFT(BSC) tokens you want to provide. As you can see in the screenshot below, before you can proceed, you have to unlock the tokens. This is required and will allow 1inch to execute smart contract transactions on your behalf. Unlocking tokens costs a small amount of BNB fees. +To unlock, click on the "Unlock" button and follow the instructions given by 1inch. You will have to confirm the transaction on your wallet. + +![](./img/liquidity_1inch_unlock.png) + +Once the tokens are unlocked, you can provide liquidity. To do so, enter the amount of BUSD tokens or the amount TFT(BSC) tokens you want to provide. The amount of the other token will adjust accordingly. + +To make the process a bit easier to understand, you can also enter the USD$ value in the corresponding field and it will adjust the token amounts automatically, according to the amount you specify. You can also click on the "Max:" link to provide the maximum amount you have available. + +On below screenshot example, we are providing $2100 into the pool, which means roughly 169354,8378 TFT(BSC) tokens, which also means we have to provide around 2100 BUSD tokens (note that these numbers will be different when you do this as prices fluctuate). +Once you have dialed in the number of tokens you want to provide to the pool, click on the "**Provide liquidity**" button. + +![](./img/1inch_provide.png) + +In the next step, you will have to confirm the transaction with your wallet. Once confirmed, you will get this screen as shown below. Make sure you bookmark the link to the Etherscan transaction, you will need it to confirm everything went according to plan. Once the transaction is confirmed on chain (see Etherscan), you are basically done. + +![](./img/1inch_submit.png) + +Once done, you can go back to the TFT pool section on 1inch.io Pools page on [**https://app.1inch.io/#/56/earn/pools?filter=TFT**](https://app.1inch.io/#/56/earn/pools?filter=TFT). and expand the BUSD-TFT pool entry. There you can see your liquidity in the pool. + +![](./img/1inch_pool_total.png) + +Note that the number of TFT and BUSD tokens will change constantly and will not be the same as you initially provided. This is because of the way liquidity pools work and is absolutely normal. + +## Important Notice + +It's important to note that being a liquidity provider involves certain risks, such as impermanent loss, which occurs when the value of the tokens in the liquidity pool fluctuates. However, if you believe in the potential of TFT and want to actively contribute to the liquidity ecosystem on 1inch.io, becoming a liquidity provider can be a rewarding opportunity to earn fees and support the growth of the platform. + +## Disclaimer + +> The information provided in this tutorial or any related discussion is not intended as investment advice. The purpose is to provide educational and informational content only. Investing in cryptocurrencies or any other assets carries inherent risks, and it is crucial to conduct your own research and exercise caution before making any investment decisions. +> +> **The ThreeFold Token (TFT)** is not to be considered as a traditional investment instrument. The value of cryptocurrencies can be volatile, and there are no guarantees of profits or returns. Always be aware of the risks involved and make informed choices based on your own assessment and understanding. We strongly encourage you to read our [full disclaimer](../../../knowledge_base/legal/disclaimer.md) and seek advice from a qualified financial professional if needed. diff --git a/collections/tfmanual/documentation/threefold_token/liquidity/liquidity_albedo.md b/collections/tfmanual/documentation/threefold_token/liquidity/liquidity_albedo.md new file mode 100644 index 0000000..7528868 --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/liquidity/liquidity_albedo.md @@ -0,0 +1,58 @@ +

Provide TFT (Stellar) Liquidity on Albedo Wallet

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Get Started](#get-started) + - [Provide Liquidity](#provide-liquidity) +- [Important Notice](#important-notice) +- [Disclaimer](#disclaimer) + +*** + +## Introduction + +Becoming a TFT liquidity provider on the Albedo wallet allows you to actively participate in the ecosystem by contributing to the liquidity of TFT tokens. As a liquidity provider, you play a crucial role in facilitating efficient trading and swapping of TFT tokens for other assets. By providing liquidity, you can earn rewards in the form of transaction fees and other incentives. This tutorial will guide you through the process of becoming a TFT liquidity provider on the Albedo wallet, enabling you to contribute to the vibrant TFT ecosystem while potentially earning additional benefits for your participation. + +## Prerequisites + +To become a liquidity provider on Albedo and join Stellar DEX Liquidity Pools, you'll need the following prerequisites: + +- **Albedo Wallet and TFT asset setup**: Set up an Albedo wallet and add the TFT (ThreeFold Token) asset to your Albedo wallet. + +- **XLM for Transactions**: Have a sufficient amount of XLM (Stellar Lumens) in your Albedo wallet to cover transaction fees. XLM is required to execute transactions and interact with the Stellar network. + +- **Sufficient TFT**: To become a liquidity provider on Albedo, you will need a sufficient amount of TFT (Stellar) tokens. You can acquire these tokens by either depositing them from another wallet into your Albedo wallet or swapping other tokens within your Albedo wallet to obtain TFT. Additionally, you'll need an equivalent value of another token that you want to contribute to the desired liquidity pool. TFT tokens represent your share in the liquidity pool and allow you to earn a portion of the trading fees. + +## Get Started + +Anyone who fullfill the prerequisites can create a liquidity pool on Albedo wallet. In this guide, we will focus on depositing TFT and USDC to provide liquidity for the pool as an example. + +After creating and activating your account on Albedo, the next step is to activate both the TFT and USDC assets within your Albedo wallet. Ensure that you have an adequate balance of both assets for the liquidity provision. Once you have activated and balanced your assets, you are ready to add liquidity to the TFT <> USDC pool on Albedo. + +### Provide Liquidity + +You can become an LP by signing into your [Albedo wallet homepage](https://albedo.link/) and click on **Liquidity** button on the navbar as shown. Please Make sure you're on **Public** network. select the two assets you’d like to provide liquidity to, in this case, TFT & USDC. + +Set the amount of TFT and USDC you would like to provide to this pool. + +![](./img/albedo_liquidity.png) + +Click '**Deposit Liquidity to the Pool**' button to confirm the transaction. + +![](./img/albedo_confirm.png) + +Congrats, you’ve just added liquidity to the TFT <> USDC pool on Albedo Wallet. + +## Important Notice + +It's important to note that being a liquidity provider involves certain risks, such as impermanent loss, which occurs when the value of the tokens in the liquidity pool fluctuates. However, if you believe in the potential of TFT and want to actively contribute to the liquidity ecosystem on PancakeSwap, becoming a liquidity provider can be a rewarding opportunity to earn fees and support the growth of the platform. + +## Disclaimer + +> The information provided in this tutorial or any related discussion is not intended as investment advice. The purpose is to provide educational and informational content only. Investing in cryptocurrencies or any other assets carries inherent risks, and it is crucial to conduct your own research and exercise caution before making any investment decisions. +> +> **The ThreeFold Token (TFT)** is not to be considered as a traditional investment instrument. The value of cryptocurrencies can be volatile, and there are no guarantees of profits or returns. Always be aware of the risks involved and make informed choices based on your own assessment and understanding. We strongly encourage you to read our [full disclaimer](../../../knowledge_base/legal/disclaimer.md) and seek advice from a qualified financial professional if needed. + + diff --git a/collections/tfmanual/documentation/threefold_token/liquidity/liquidity_pancake.md b/collections/tfmanual/documentation/threefold_token/liquidity/liquidity_pancake.md new file mode 100644 index 0000000..b2d378f --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/liquidity/liquidity_pancake.md @@ -0,0 +1,73 @@ +

Provide TFT Liquidity on Pancake Swap

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Become a TFT - BSC LP](#become-a-tft---bsc-lp) +- [Important Notice](#important-notice) +- [Disclaimer](#disclaimer) +*** +## Introduction + +In the case of TFT on Binance Smart Chain (BSC) and PancakeSwap, becoming a liquidity provider involves providing TFT and another token (such as BNB) to the TFT-BNB liquidity pool on PancakeSwap. + +By adding liquidity to this pool, the LP helps to ensure that there is a consistent and sufficient supply of TFT(BSC) available for trading on the BSC network. This contributes to the overall liquidity of the TFT token on PancakeSwap, making it easier for users to buy and sell TFT(BSC) without experiencing significant price slippage. + +Becoming a liquidity provider for TFT(BSC) on PancakeSwap can have several benefits. Firstly, as an LP, you earn trading fees proportional to the amount of liquidity you have provided. **Anyone interested in providing Liquidity to the ThreeFold pools on PancakeSwap will be incentivized and rewarded with trading fees. 0.17% of all trading fees of all transactions go to Liquidity providers.** These fees are distributed to LPs based on their share of the total liquidity pool. + +Additionally, by participating in the liquidity provision process, you actively contribute to the growth and adoption of the TFT token. As more users trade TFT on PancakeSwap, the liquidity and trading volume increase, which can attract more traders and investors to the token. This increased activity can lead to a broader awareness of TFT and potentially drive its value and market presence. + +## Prerequisites + +Before you can become a TFT(BSC) LP on Pancake Swap, there are a few prerequisites you need to fulfill. Here's what you'll need: + +- **BSC Wallet**: To interact with the Binance Smart Chain and Pancake Swap, you'll need a BSC-compatible wallet. [MetaMask](https://metamask.io/) is a popular option that supports BSC. Make sure to set up and secure your wallet before proceeding. + +> [Set up a Metamask Wallet](../storing_tft/metamask.md) + +- **Connect BSC Wallet TO Pancake Swap**: Visit the Pancake Swap website and connect your BSC wallet to your Pancake Swap account. + +> [Connect Wallet to Pancake Swap](https://docs.pancakeswap.finance/readme/get-started/connection-guide) + +- **Get BNB Tokens**: As the native cryptocurrency of Binance Smart Chain, BNB is required to pay for transaction fees on the network. Ensure you have some BNB tokens in your BSC wallet to cover these fees when buying TFT(BSC) on Pancake Swap. Read [this tutorial](https://fortunly.com/articles/how-to-buy-bnb/) to know where you can buy BNB and transfer them to your BSC Wallet. + +> [Get BNB Tokens](https://docs.pancakeswap.finance/readme/get-started/bep20-guide) + +- **Sufficient TFT**: To participate as a liquidity provider on PancakeSwap, you will need to acquire **TFT(BSC)** tokens and deposit them into your BSC Wallet, along with an equivalent value of another token, into the desired liquidity pool. The TFT tokens act as your share of the liquidity pool and entitle you to a portion of the trading fees generated by the platform. + +## Become a TFT - BSC LP + +Anyone who fullfill the prerequisites can create a liquidity pool on Pancake Swap. + +Now that you're all set, you can become an LP by going to your [PancakeSwap homepage](https://pancakeswap.finance/) and click on **Trade > Liquidity** button on the navbar as shown. Please Make sure you're on **BNB Smart Chain** network. + +![](./img/pancake_liquidity.png) + +You will now be directed to the Liquidity page. When providing liquidity for TFT(BSC) on PancakeSwap, we recommend you to pair it with BUSD (Binance USD), which already has significant liquidity. The ratio between TFT(BSC) and BUSD in the existing pool is fixed by market prices. Simply choose the amount of liquidity you want to provide for both currencies. Consider the potential risks associated with impermanent loss. Join the TFT pool on PancakeSwap to contribute and trade TFT(BSC) tokens. + +![](./img/liquidity_busd.jpeg) + +Click “approve” for both currencies, then c;ick 'confirm' to accept the wallet prompts and fees. + +![](./img/liquidity_approve.jpeg) + +![](./img/threefold__confirmation.jpg) + +Click “supply” and confirm the wallet prompt and fee. + +![](./img/threefold__supply.jpg) + +Congratulations! You have now exchanged the selected amounts for both currencies for LPs (Liquidity Tokens) and you are providing liquidity and earning a part of the transaction fees. + +![](./img/threefold__lp_tokens.jpg) + +## Important Notice + +It's important to note that being a liquidity provider involves certain risks, such as impermanent loss, which occurs when the value of the tokens in the liquidity pool fluctuates. However, if you believe in the potential of TFT and want to actively contribute to the liquidity ecosystem on PancakeSwap, becoming a liquidity provider can be a rewarding opportunity to earn fees and support the growth of the platform. + +## Disclaimer + +> The information provided in this tutorial or any related discussion is not intended as investment advice. The purpose is to provide educational and informational content only. Investing in cryptocurrencies or any other assets carries inherent risks, and it is crucial to conduct your own research and exercise caution before making any investment decisions. +> +> **The ThreeFold Token (TFT)** is not to be considered as a traditional investment instrument. The value of cryptocurrencies can be volatile, and there are no guarantees of profits or returns. Always be aware of the risks involved and make informed choices based on your own assessment and understanding. We strongly encourage you to read our [full disclaimer](../../../knowledge_base/legal/disclaimer.md) and seek advice from a qualified financial professional if needed. diff --git a/collections/tfmanual/documentation/threefold_token/liquidity/liquidity_readme.md b/collections/tfmanual/documentation/threefold_token/liquidity/liquidity_readme.md new file mode 100644 index 0000000..3a1d592 --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/liquidity/liquidity_readme.md @@ -0,0 +1,33 @@ +

Become a TFT Liquidity Provider

+ +

Table of Contents

+ +- [Liquidity Provider on Pancake Swap](./liquidity_pancake.md) +- [Liquidity Provider on 1inch.io](./liquidity_1inch.md) +- [Liquidity Provider on Albedo](./liquidity_albedo.md) + + +*** + +## Introduction + +A **liquidity provider** (LP) is an individual or entity that contributes liquidity to a decentralized exchange or automated market maker (AMM) platform. In the context of cryptocurrency, a liquidity provider typically deposits an equal value of two different tokens into a liquidity pool. By doing so, they enable traders to easily swap between these tokens at any time, ensuring there is sufficient liquidity in the market. + +Indeed, becoming a TFT liquidity provider can vary based on the platform, wallet, or exchange, as well as the underlying blockchain. The pairing token also plays a role in determining the available liquidity pools for TFT. + +For instance, on PancakeSwap, you can become a TFT(BSC) liquidity provider by pairing it with BNB (Binance Coin) on the Binance Smart Chain (BSC). On the other hand, platforms like 1inch.io may offer different pairing options, such as TFT(BSC) with BUSD (Binance USD) or other compatible tokens. + +Similarly, the blockchain being used can affect the liquidity provision options. For example, you can become a TFT liquidity provider on the Stellar blockchain using wallets like Albedo, specifically designed for Stellar assets. However, you cannot become a TFT(Stellar) liquidity provider on PancakeSwap, but you can become a TFT(BSC) liquidity provider instead, since it currently supports assets on the Binance Smart Chain (BSC), not the Stellar blockchain. + +It is important to consider the specific platform, wallet, or exchange you are using, as well as the blockchain and available pairing tokens, to determine the appropriate method for becoming a TFT liquidity provider. Ensure you follow the guidelines and instructions provided by the respective platforms to successfully participate in the desired liquidity pool. + +*** +## Important Notice + +It's important to note that being a liquidity provider involves certain risks, such as impermanent loss, which occurs when the value of the tokens in the liquidity pool fluctuates. However, if you believe in the potential of TFT and want to actively contribute to the liquidity ecosystem on PancakeSwap, becoming a liquidity provider can be a rewarding opportunity to earn fees and support the growth of the platform. +*** +## Disclaimer + +The information provided in this tutorial or any related discussion is not intended as investment advice. The purpose is to provide educational and informational content only. Investing in cryptocurrencies or any other assets carries inherent risks, and it is crucial to conduct your own research and exercise caution before making any investment decisions. + +**The ThreeFold Token (TFT)** is not to be considered as a traditional investment instrument. The value of cryptocurrencies can be volatile, and there are no guarantees of profits or returns. Always be aware of the risks involved and make informed choices based on your own assessment and understanding. We strongly encourage you to read our [full disclaimer](https://library.threefold.me/info/legal/#/legal__disclaimer) and seek advice from a qualified financial professional if needed. \ No newline at end of file diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/albedo_store.md b/collections/tfmanual/documentation/threefold_token/storing_tft/albedo_store.md new file mode 100644 index 0000000..b849c0b --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/storing_tft/albedo_store.md @@ -0,0 +1,102 @@ +

Store TFT (Stellar) on Albedo Wallet

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Get Started](#get-started) + - [Create and Fund Albedo Wallet](#create-and-fund-albedo-wallet) + - [Add TFT asset to Albedo Wallet](#add-tft-asset-to-albedo-wallet) + - [Storing / Receiving and Sending TFT](#storing--receiving-and-sending-tft) +- [Important Notice](#important-notice) +- [Disclaimer](#disclaimer) +*** +## Introduction + +Welcome to our guide on how to store TFT tokens (Stellar) via the [Albedo wallet](https://albedo.link/)! + +Albedo is a secure and trustworthy keystore web app and browser extension designed for Stellar token accounts. With Albedo, you can safely manage and transact with your Stellar account without having to share your secret key with any third parties. +Developed by the creators of stellar.expert explorer, Albedo offers a range of features, including storage, swaps, and participation in liquidity pools. It is an open-source solution that can be accessed directly from your browser or installed as a browser add-on, currently available for Chrome and Firefox. + +In this tutorial, we will walk you through the process of storing Stellar TFT tokens using the Albedo wallet. +*** +## Prerequisites + +- **XLM**: When storing TFT tokens using the Albedo wallet, a certain amount of XLM funding is required to facilitate the sending and receiving of assets on the Stellar network. + +There are multiple ways to acquire XLM and send it to your wallet. One option is to utilize XLM-supported exchanges, which provide a convenient platform for purchasing XLM. Click [here](https://www.coinlore.com/coin/stellar/exchanges) to access a comprehensive list of exchanges that support XLM. + +As an example, we have created a tutorial specifically focusing on how to buy XLM on Coinbase, one of the popular cryptocurrency exchanges. This tutorial provides step-by-step instructions on the process of purchasing XLM on **Coinbase Exchange**. You can find the tutorial [**here**](../buy_sell_tft/coinbase_xlm.md). +*** +## Get Started + +### Create and Fund Albedo Wallet + +Go to [https://albedo.link/signup](https://albedo.link/signup) to start your sign up process. + +![](img/albedo_signup.png) + +Ensure you save your 24-word recovery passphrase. This is very important! +Click “**I saved recovery phrase**” (Again, it is critical that you save this recovery phrase somewhere, and do so securely). This key is the only way you could recover your account if you ever lose access to it. + +![](img/albedo_secret.png) + +Congrats! You just created an Albedo wallet. To get started swapping tokens into TFT, firstly we would need to fund your wallet with XLM by clicking '**fund it**' on the homepage. + +![](img/albedo_fund.png) + +Send some XLM for a third party wallets or stellar exchanger of your choice to your Albedo XLM wallet. + +![](img/albedo_receive.png) + +Once you sent the XLM, you will see the balance added to the homepage. now we are ready to do some token transactions! + +![](img/albedo_home.png) + +### Add TFT asset to Albedo Wallet + +To store TFT in our Albedo Wallet, we will need to have a TFT wallet added into our account. This is done by creating a trustline for TFT. Creating a trustline means granting permission for your Albedo wallet to recognize and interact with TFT tokens on the Stellar network. It allows you to view your TFT balance, send and receive TFT tokens, and engage in swapping or trading activities involving TFT within the Albedo wallet. + +To add a trustline, go to the “**Balance**” section, and click “**Add trustline**” button. + +![](img/albedo_activate.png) + +A popup window will appear presenting Albedo's asset list. In the search field that appears, type in '**TFT**' as the asset you want to add. + +**It is important to ensure that you also see the name "threefold.io" next to the logo** , as this verifies that you are selecting the genuine TFT asset associated with ThreeFold. **Beware of imposters or fraudulent assets that may attempt to mimic TFT.** ThreeFold cannot assume responsibility for any errors or mistakes made during the trustline creation process done by users. If you have any uncertainties or doubts, it is always recommended to seek assistance from official support channels or trusted sources to ensure the accuracy of the trustline configuration. + +![](img/albedo_select_asset.png) + +Confirm the selected asset by pressing “**Add trustline**”. + +![](img/albedo_trustline.png) + +Congrats! You have now successfully added TFT as an asset to your Albedo wallet. + +### Storing / Receiving and Sending TFT + +You can now store TFT by depositing it from another wallet by copying your public Albedo wallet address and sending it to the withdrawer. + +You can also transfer TFT to another stellar wallet by clicking the '**Transfer**' icon on your wallet navbar and specify the amount of TFT and the receipient's wallet address and memo (if any), and click 'Transfer' button to finish the transaction. + +![](img/albedo_send_receive.png) +*** +## Important Notice + +If you are looking for ways to get / purchase TFT (Stellar) on Albedo, you will find the according information [here](../buy_sell_tft/albedo_buy.md). +*** +## Disclaimer + +The information provided in this tutorial or any related discussion is not intended as investment advice. The purpose is to provide educational and informational content only. Investing in cryptocurrencies or any other assets carries inherent risks, and it is crucial to conduct your own research and exercise caution before making any investment decisions. + +**The ThreeFold Token (TFT)** is not to be considered as a traditional investment instrument. The value of cryptocurrencies can be volatile, and there are no guarantees of profits or returns. Always be aware of the risks involved and make informed choices based on your own assessment and understanding. We strongly encourage you to read our [full disclaimer](https://library.threefold.me/info/legal/#/legal__disclaimer) and seek advice from a qualified financial professional if needed. + + + + + + + + + + diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/btc_alpha_deposit.md b/collections/tfmanual/documentation/threefold_token/storing_tft/btc_alpha_deposit.md new file mode 100644 index 0000000..bd65ebc --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/storing_tft/btc_alpha_deposit.md @@ -0,0 +1,131 @@ +

Store TFT on BTC-Alpha Exchange

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Get Started](#get-started) + - [Sign up for an Account](#sign-up-for-an-account) + - [Secure Your Account](#secure-your-account) +- [Deposit TFT(Stellar) to Account](#deposit-tftstellar-to-account) + - [Important Notice](#important-notice) +- [Disclaimer](#disclaimer) +*** +## Introduction + +Welcome to our tutorial on how to get TFT (Stellar) using [**BTC-Alpha**](https://btc-alpha.com/en)! + + +BTC-Alpha is a cryptocurrency exchange platform that provides a secure and user-friendly environment for trading various digital assets, including TFT (Stellar). With its robust features and intuitive interface, BTC-Alpha offers a convenient way to buy and sell cryptocurrencies. + +In this guide, we will walk you through the process of storing TFT on the BTC-Alpha exchange by depositing TFT from your external wallet to your BTC-Alpha Exchange. + +> If you are looking for ways to get / purchase TFT (Stellar) on BTC-Alpha by trading, you will find the according information [here](../buy_sell_tft/btc_alpha.md). +*** +## Prerequisites + +- **ID for verification:** To get TFT (Stellar) on the BTC-Alpha exchange, you will need to have your identification (ID) ready for the verification process. This is a standard requirement to ensure compliance with regulatory guidelines and maintain a secure trading environment. Your ID may include documents such as a valid passport or government-issued identification card. + +- **BTC-Alpha Account**: You must have an active account on the BTC-Alpha exchange. If you don't have one, you can sign up on their website and complete the registration process. Make sure to secure your account with strong passwords and two-factor authentication for enhanced security. +*** +## Get Started + +### Sign up for an Account + +**Sign up for a BTC-Alpha Account:** Visit the BTC-Alpha website [https://btc-alpha.com/](https://btc-alpha.com/) and click on the "**Sign up**" button. Fill in the required information, including your email address, a secure password, and any additional details requested for the account creation process. +![](img/alpha_signup.png) + +**Login to your account**: You will then receive a notification that allow you to login to your new account. + +![](img/alpha_login.png) + +Now, you can proceed to log in to your account and start exploring the platform. Follow these steps to log in: + +Visit the BTC-Alpha website (https://btc-alpha.com/) on your web browser. Click on the "Login" button located on the top-right corner of the website. + +Enter the email address and password you used during the registration process in the respective fields. + +![](img/alpha_email.png) + + +**Verify Your Account:** After completing the registration, you may need to verify your account by providing some personal identification information. This is a standard procedure for most cryptocurrency exchanges to ensure compliance with regulations and security measures. Follow the instructions provided by BTC-Alpha to complete the verification process. + +![](img/alpha_verify.png) + +Congratulations on completing the registration process for your BTC-Alpha account and are logged in to your account successfully! + +![](img/alpha_home.png) + +### Secure Your Account + +**Secure Your Account**: Set up two-factor authentication (2FA) to add an extra layer of security to your BTC-Alpha account. This typically involves linking your account to a 2FA app, such as Google Authenticator or Authy, and enabling it for login and transaction verification. + +To enable two-factor authentication (2FA) on your BTC-Alpha account, follow these steps: + +Install either the [2FA Alp Authenticator](https://play.google.com/store/apps/details?id=com.alp.two_fa) or [Google Authenticator](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2&hl=en&gl=US) app on your mobile phone. You can find Authy on the App Store or Google Play, and Google Authenticator on the Google Play Store or Apple App Store. + +Once you have installed the app, log in to your BTC-Alpha account. + +Right-Click on your name or profile icon located at the top-right corner of the website to access the account settings, and look for the option "**Enable Two-factor Authentication**" and click on it. + +![](img/alpha_auth.png) + +Follow the instructions provided to link your BTC-Alpha account with the Authy or Google Authenticator app. This usually involves scanning a QR code or manually entering a code provided by the app. + +![](img/alpha_2fa.png) + +Once the link is established, the app will start generating unique codes that you will need to enter during the login process for additional security. + +By enabling two-factor authentication, you add an extra layer of security to your BTC-Alpha account, helping to protect your funds and personal information. Make sure to keep your mobile device with the authenticator app secure, as it will be required each time you log in to your BTC-Alpha account. +*** +## Deposit TFT(Stellar) to Account + +To begin storing **TFT** on the BTC-Alpha exchange, you will need to deposit some TFT funds into your account. + +To deposit TFT into your BTC-Alpha account, follow these steps: + +Log in to your BTC-Alpha account and Click on the "Wallets" tab located in the top menu. + +![](img/alpha_wallet.png) + +Search for "**TFT**" in the list of available cryptocurrencies. + +![](./img/alpha_tft.png) + +You will be provided with a TFT deposit address. +Make sure you choose **ThreeFold Token (Stellar)** as your deposit method. + +To deposit, Copy this address or scan the QR code associated with it. As well as the Memo. + +Use your personal external TFT wallet or the wallet of another exchange to initiate a withdrawal to the provided deposit address. + +Ensure that you specify the correct deposit address and Memo. Double-check it before confirming the transaction. + +**IMPORTANT**: It is crucial to always include the correct memo when sending TFT (Stellar) tokens to ensure the transaction is processed accurately. Failing to include the memo or entering an incorrect memo can lead to the loss of TFT tokens. + +Wait for the transaction to be confirmed on the Stellar network. This may take some time depending on network congestion. +Once the transaction is confirmed, the TFT will be credited to your BTC-Alpha account balance. + +You can check your account balance by clicking on the "**Wallets**" tab or by navigating to the "**Balances**" section. + +Please note that the exact steps for depositing TFT may vary depending on the specific wallet or exchange you are using to send the funds. It is essential to double-check the deposit address and follow the instructions provided by your wallet or exchange to ensure a successful deposit. + +### Important Notice + +While it is possible to keep your TFT in your exchange wallet on BTC-Alpha, it is generally not recommended to store your funds there for an extended period. Public exchanges are more susceptible to security breaches and hacking attempts compared to personal wallets. + +To ensure the safety and security of your TFT holdings, it is advisable to transfer them to a dedicated TFT wallet. There are several options available for creating a TFT wallet, each with its own unique features and benefits. + +To explore different TFT wallet options and choose the one that best suits your needs, you can refer to our comprehensive [**TFT Wallet guide**](../storing_tft/tf_connect_app.md#create-a-wallet) that provides a list of recommended TFT wallets. This guide will help you understand the features, security measures, and compatibility of each wallet, enabling you to make an informed decision on where to store your TFT securely. + +Remember, maintaining control over your private keys and taking precautions to protect your wallet information are essential for safeguarding your TFT investments. + +If you are looking for ways to get / purchase TFT (Stellar) on BTC-Alpha by trading, you will find the according information [here](../buy_sell_tft/btc_alpha.md). +*** +## Disclaimer + +The information provided in this tutorial or any related discussion is not intended as investment advice. The purpose is to provide educational and informational content only. Investing in cryptocurrencies or any other assets carries inherent risks, and it is crucial to conduct your own research and exercise caution before making any investment decisions. + +**The ThreeFold Token (TFT)** is not to be considered as a traditional investment instrument. The value of cryptocurrencies can be volatile, and there are no guarantees of profits or returns. Always be aware of the risks involved and make informed choices based on your own assessment and understanding. We strongly encourage you to read our [full disclaimer](https://library.threefold.me/info/legal/#/legal__disclaimer) and seek advice from a qualified financial professional if needed. + + diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/hardware_wallet.md b/collections/tfmanual/documentation/threefold_token/storing_tft/hardware_wallet.md new file mode 100644 index 0000000..a00c9f9 --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/storing_tft/hardware_wallet.md @@ -0,0 +1,75 @@ + +

Hardware Wallet

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Setting up a TFT Trustline on Stellar Blockchain](#setting-up-a-tft-trustline-on-stellar-blockchain) +- [Conclusion](#conclusion) +- [Disclaimer](#disclaimer) + +*** + +## Introduction + +You can store TFT on a hardwallet for optimal security. + +Also, if you are a farmer, instead of using the ThreeFold Connect app to receive your farming rewards (TFTs), you can also have your farming rewards sent to a hardware wallet. In this case, you will need to enable a TFT trustline to receive TFT. + +You can store TFT on a hardware wallet on Stellar chain, BSC or the Ethereum chain. For this guide, we show how to store TFT on a hardware wallet on Stellar chain. + +To store TFT on Stellar, you can use any hardware wallet that supports the Stellar Blockchain, such as a [Ledger](https://www.ledger.com/). + +## Setting up a TFT Trustline on Stellar Blockchain + +Setting up a trustline is simple. + +We will show an example with a Ledger hardware wallet. The process is similar with other hardware wallets. Just make sure that your hardware wallet is compatible with the Stellar blockchain, as the TFT from farming rewards will be sent on the Stellar Blockchain. + +* First, [download Ledger Live](https://www.ledger.com/ledger-live/download) and download the Stellar application in **Manager**. +* Go on an official Stellar website such as [Stellarterm](https://stellarterm.com/) or [StellarX](https://www.stellarx.com/). For this example, we will be using Stellarterm.com. + +* Unlock your Ledger by entering your password. + +* Select the Stellar App. + * In our case, we do not need to create an account on Stellerterm, since we are using a hardware wallet. + +* On Stellarterm.com, click on the button **LOGIN**. + +![farming_wallet_7](./img/farming_wallet_7.png) + + +* At the bottom of the page, select the option **Ledger** or another option if you are using a different hardware wallet. + +![farming_wallet_8](./img/farming_wallet_8.png) + +* Click **Connect with Ledger**. + +![farming_wallet_9](./img/farming_wallet_9.png) + + +* Read and accept the Terms of Use. + +![farming_wallet_10](./img/farming_wallet_10.png) + + +* On the main page, click on **Assets**. + +![farming_wallet_11](./img/farming_wallet_11.png) + +* Scroll down and write **Threefold.io** in the Text box. Select **TFT Threefold.io**. Click **Accept**. Then follow the steps presented on your hardware wallet to confirm the trust line. + +![farming_wallet_12](./img/farming_wallet_12.png) +![farming_wallet_13](./img/farming_wallet_13.png) + +## Conclusion + +You now have a TFT trust line on the Stellar Blockchain. You can now receive TFT on this wallet. This is a perfect setup to farm TFT safely. + +When it comes to choosing where to send your farming rewards, you simply need to enter the address associated with your hardware wallet. + +## Disclaimer + +> The information provided in this tutorial or any related discussion is not intended as investment advice. The purpose is to provide educational and informational content only. Investing in cryptocurrencies or any other assets carries inherent risks, and it is crucial to conduct your own research and exercise caution before making any investment decisions. +> +> **The ThreeFold Token (TFT)** is not to be considered as a traditional investment instrument. The value of cryptocurrencies can be volatile, and there are no guarantees of profits or returns. Always be aware of the risks involved and make informed choices based on your own assessment and understanding. We strongly encourage you to read our [full disclaimer](../../../knowledge_base/legal/disclaimer.md) and seek advice from a qualified financial professional if needed. diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/INTER_TFT.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/INTER_TFT.png new file mode 100644 index 0000000..6d2ff0a Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/INTER_TFT.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_activate.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_activate.png new file mode 100644 index 0000000..4fe338e Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_activate.png differ diff --git a/collections/documentation/threefold_token/storing_tft/img/albedo_balance.jpeg b/collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_balance.jpeg similarity index 100% rename from collections/documentation/threefold_token/storing_tft/img/albedo_balance.jpeg rename to collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_balance.jpeg diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_fund.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_fund.png new file mode 100644 index 0000000..a0bcc0c Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_fund.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_home.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_home.png new file mode 100644 index 0000000..52cef5e Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_home.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_receive.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_receive.png new file mode 100644 index 0000000..bf1f2a0 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_receive.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_secret.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_secret.png new file mode 100644 index 0000000..7e76183 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_secret.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_select_asset.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_select_asset.png new file mode 100644 index 0000000..f06f2e3 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_select_asset.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_send_receive.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_send_receive.png new file mode 100644 index 0000000..3f3b773 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_send_receive.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_signup.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_signup.png new file mode 100644 index 0000000..f70733b Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_signup.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_swap.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_swap.png new file mode 100644 index 0000000..f7e0943 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_swap.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_swap1.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_swap1.png new file mode 100644 index 0000000..d215a22 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_swap1.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_trustline.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_trustline.png new file mode 100644 index 0000000..8e43505 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/albedo_trustline.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_2fa.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_2fa.png new file mode 100644 index 0000000..2714d3e Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_2fa.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_auth.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_auth.png new file mode 100644 index 0000000..df46d5a Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_auth.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_deposit.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_deposit.png new file mode 100644 index 0000000..8039284 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_deposit.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_email.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_email.png new file mode 100644 index 0000000..84fceea Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_email.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_home.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_home.png new file mode 100644 index 0000000..faacb0b Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_home.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_limit.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_limit.png new file mode 100644 index 0000000..f0b361a Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_limit.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_login.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_login.png new file mode 100644 index 0000000..3c93fdb Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_login.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_search.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_search.png new file mode 100644 index 0000000..3880273 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_search.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_signup.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_signup.png new file mode 100644 index 0000000..5840e77 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_signup.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_tft.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_tft.png new file mode 100644 index 0000000..227bff3 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_tft.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_trade.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_trade.png new file mode 100644 index 0000000..ef7c9cb Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_trade.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_verify.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_verify.png new file mode 100644 index 0000000..8065339 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_verify.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_wallet.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_wallet.png new file mode 100644 index 0000000..01b2916 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/alpha_wallet.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_1.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_1.png new file mode 100644 index 0000000..6e1f766 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_1.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_10.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_10.png new file mode 100644 index 0000000..d990568 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_10.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_11.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_11.png new file mode 100644 index 0000000..1a0d5b9 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_11.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_12.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_12.png new file mode 100644 index 0000000..9ffb19d Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_12.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_13.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_13.png new file mode 100644 index 0000000..1b96f81 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_13.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_14.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_14.png new file mode 100644 index 0000000..c0b301f Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_14.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_15.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_15.png new file mode 100644 index 0000000..120be6a Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_15.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_16.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_16.png new file mode 100644 index 0000000..781bf30 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_16.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_17.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_17.png new file mode 100644 index 0000000..51130a3 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_17.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_18.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_18.png new file mode 100644 index 0000000..8fe5d2f Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_18.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_19.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_19.png new file mode 100644 index 0000000..6c6796c Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_19.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_2.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_2.png new file mode 100644 index 0000000..564b312 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_2.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_20.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_20.png new file mode 100644 index 0000000..da5c0ca Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_20.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_21.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_21.png new file mode 100644 index 0000000..27abf0c Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_21.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_22.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_22.png new file mode 100644 index 0000000..adde6b0 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_22.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_23.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_23.png new file mode 100644 index 0000000..aabf0a0 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_23.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_24.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_24.png new file mode 100644 index 0000000..01ea640 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_24.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_25.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_25.png new file mode 100644 index 0000000..72566b2 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_25.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_26.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_26.png new file mode 100644 index 0000000..e9931d3 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_26.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_27.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_27.png new file mode 100644 index 0000000..b20e7c1 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_27.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_28.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_28.png new file mode 100644 index 0000000..ddace3b Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_28.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_29.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_29.png new file mode 100644 index 0000000..52a66cd Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_29.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_3.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_3.png new file mode 100644 index 0000000..0a45687 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_3.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_30.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_30.png new file mode 100644 index 0000000..2e30308 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_30.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_31.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_31.png new file mode 100644 index 0000000..ff1b9ac Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_31.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_32.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_32.png new file mode 100644 index 0000000..ab617bf Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_32.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_33.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_33.png new file mode 100644 index 0000000..3c6d591 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_33.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_34.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_34.png new file mode 100644 index 0000000..944688f Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_34.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_35.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_35.png new file mode 100644 index 0000000..845bd35 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_35.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_36.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_36.png new file mode 100644 index 0000000..b294bcb Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_36.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_37.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_37.png new file mode 100644 index 0000000..c61e06e Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_37.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_38.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_38.png new file mode 100644 index 0000000..732f98a Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_38.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_39.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_39.png new file mode 100644 index 0000000..0c78bc0 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_39.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_4.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_4.png new file mode 100644 index 0000000..11ef6d7 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_4.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_40.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_40.png new file mode 100644 index 0000000..6651627 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_40.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_41.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_41.png new file mode 100644 index 0000000..839e929 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_41.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_42.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_42.png new file mode 100644 index 0000000..5f84480 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_42.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_43.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_43.png new file mode 100644 index 0000000..eb3a017 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_43.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_44.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_44.png new file mode 100644 index 0000000..4a10071 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_44.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_45.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_45.png new file mode 100644 index 0000000..0d6e86d Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_45.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_46.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_46.png new file mode 100644 index 0000000..2039941 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_46.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_47.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_47.png new file mode 100644 index 0000000..71ea72e Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_47.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_48.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_48.png new file mode 100644 index 0000000..fd357c7 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_48.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_49.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_49.png new file mode 100644 index 0000000..0f82c97 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_49.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_5.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_5.png new file mode 100644 index 0000000..2dd845d Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_5.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_50.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_50.png new file mode 100644 index 0000000..0ecbc06 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_50.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_51.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_51.png new file mode 100644 index 0000000..86ecf04 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_51.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_52.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_52.png new file mode 100644 index 0000000..9d2b5a4 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_52.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_53.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_53.png new file mode 100644 index 0000000..141c24d Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_53.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_54.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_54.png new file mode 100644 index 0000000..2c97d1b Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_54.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_55.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_55.png new file mode 100644 index 0000000..2d7fe0e Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_55.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_56.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_56.png new file mode 100644 index 0000000..e090e08 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_56.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_57.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_57.png new file mode 100644 index 0000000..b9289a4 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_57.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_58.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_58.png new file mode 100644 index 0000000..a78d6d8 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_58.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_59.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_59.png new file mode 100644 index 0000000..4f6e7f2 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_59.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_6.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_6.png new file mode 100644 index 0000000..5766b18 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_6.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_7.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_7.png new file mode 100644 index 0000000..c9256be Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_7.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_8.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_8.png new file mode 100644 index 0000000..0901cf6 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_8.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_9.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_9.png new file mode 100644 index 0000000..a913e4b Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_tf_wallet_9.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_wallet_10.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_wallet_10.png new file mode 100644 index 0000000..7ae95fc Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_wallet_10.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_wallet_11.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_wallet_11.png new file mode 100644 index 0000000..6ce3313 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_wallet_11.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_wallet_12.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_wallet_12.png new file mode 100644 index 0000000..b26559e Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_wallet_12.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_wallet_13.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_wallet_13.png new file mode 100644 index 0000000..9486799 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_wallet_13.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_wallet_5.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_wallet_5.png new file mode 100644 index 0000000..9a83dd3 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_wallet_5.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_wallet_7.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_wallet_7.png new file mode 100644 index 0000000..ce1f1ba Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_wallet_7.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_wallet_8.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_wallet_8.png new file mode 100644 index 0000000..b8039d9 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_wallet_8.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_wallet_9.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_wallet_9.png new file mode 100644 index 0000000..882bcf7 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/farming_wallet_9.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/inter_deposit.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/inter_deposit.png new file mode 100644 index 0000000..e59bb17 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/inter_deposit.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/inter_funded.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/inter_funded.png new file mode 100644 index 0000000..3fe4ef6 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/inter_funded.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/inter_home.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/inter_home.png new file mode 100644 index 0000000..382c8c3 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/inter_home.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/inter_home1.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/inter_home1.png new file mode 100644 index 0000000..fb71577 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/inter_home1.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/inter_key.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/inter_key.png new file mode 100644 index 0000000..42ec8ea Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/inter_key.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/inter_login.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/inter_login.png new file mode 100644 index 0000000..108bced Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/inter_login.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/inter_ok.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/inter_ok.png new file mode 100644 index 0000000..8c3cc6d Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/inter_ok.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/inter_pass.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/inter_pass.png new file mode 100644 index 0000000..d3a3fce Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/inter_pass.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/inter_popup.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/inter_popup.png new file mode 100644 index 0000000..5954232 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/inter_popup.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/inter_success.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/inter_success.png new file mode 100644 index 0000000..dc3ad7a Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/inter_success.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/lobstr_asset.jpeg b/collections/tfmanual/documentation/threefold_token/storing_tft/img/lobstr_asset.jpeg new file mode 100644 index 0000000..6ffbf2b Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/lobstr_asset.jpeg differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/lobstr_assets.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/lobstr_assets.png new file mode 100644 index 0000000..f7a6715 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/lobstr_assets.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/lobstr_download.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/lobstr_download.png new file mode 100644 index 0000000..3dd7f3c Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/lobstr_download.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/lobstr_fed.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/lobstr_fed.png new file mode 100644 index 0000000..74b1d5d Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/lobstr_fed.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/lobstr_key.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/lobstr_key.png new file mode 100644 index 0000000..af2322e Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/lobstr_key.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/lobstr_new.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/lobstr_new.png new file mode 100644 index 0000000..7994dad Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/lobstr_new.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/lobstr_pass.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/lobstr_pass.png new file mode 100644 index 0000000..b72a626 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/lobstr_pass.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/lobstr_verify.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/lobstr_verify.png new file mode 100644 index 0000000..846de25 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/lobstr_verify.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/lobstr_web.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/lobstr_web.png new file mode 100644 index 0000000..318c0cc Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/lobstr_web.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_add.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_add.png new file mode 100644 index 0000000..bae4fd7 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_add.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_choose.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_choose.png new file mode 100644 index 0000000..d86ac35 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_choose.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_confirm.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_confirm.png new file mode 100644 index 0000000..dd75dea Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_confirm.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_custom.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_custom.png new file mode 100644 index 0000000..8255593 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_custom.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_import.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_import.png new file mode 100644 index 0000000..5c02164 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_import.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_installed.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_installed.png new file mode 100644 index 0000000..8fc1c32 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_installed.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_new.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_new.png new file mode 100644 index 0000000..4efc236 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_new.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_pass.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_pass.png new file mode 100644 index 0000000..069a091 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_pass.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_privatekey.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_privatekey.png new file mode 100644 index 0000000..d584de2 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_privatekey.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_success.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_success.png new file mode 100644 index 0000000..dd75dea Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_success.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_switch.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_switch.png new file mode 100644 index 0000000..0d05255 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_switch.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_tft.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_tft.png new file mode 100644 index 0000000..dd75dea Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_tft.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_tft_auto.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_tft_auto.png new file mode 100644 index 0000000..996499c Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_tft_auto.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_tft_home.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_tft_home.png new file mode 100644 index 0000000..d0a2dda Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/metamask_tft_home.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_account.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_account.png new file mode 100644 index 0000000..55d157f Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_account.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_add.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_add.png new file mode 100644 index 0000000..10e5eca Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_add.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_asset.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_asset.png new file mode 100644 index 0000000..c47ede4 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_asset.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_confirm.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_confirm.png new file mode 100644 index 0000000..e5a03b8 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_confirm.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_copy.jpeg b/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_copy.jpeg new file mode 100644 index 0000000..266484f Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_copy.jpeg differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_desktop.jpeg b/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_desktop.jpeg new file mode 100644 index 0000000..27f14f5 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_desktop.jpeg differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_home.jpeg b/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_home.jpeg new file mode 100644 index 0000000..4898bbf Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_home.jpeg differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_home.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_home.png new file mode 100644 index 0000000..530adb4 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_home.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_install.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_install.png new file mode 100644 index 0000000..380f6d1 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_install.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_receive.jpeg b/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_receive.jpeg new file mode 100644 index 0000000..4898bbf Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_receive.jpeg differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_search.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_search.png new file mode 100644 index 0000000..0247b7e Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_search.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_secret.jpeg b/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_secret.jpeg new file mode 100644 index 0000000..7a677a6 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_secret.jpeg differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_success.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_success.png new file mode 100644 index 0000000..57eb039 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_success.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_tft.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_tft.png new file mode 100644 index 0000000..b94af2a Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_tft.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_tftinfo.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_tftinfo.png new file mode 100644 index 0000000..a5df0f1 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_tftinfo.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_verify.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_verify.png new file mode 100644 index 0000000..39a462e Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_verify.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_xlm.jpeg b/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_xlm.jpeg new file mode 100644 index 0000000..75612ea Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/solar_xlm.jpeg differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/threefold__trustwallet_overview.jpg b/collections/tfmanual/documentation/threefold_token/storing_tft/img/threefold__trustwallet_overview.jpg new file mode 100644 index 0000000..e8e84e4 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/threefold__trustwallet_overview.jpg differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/threefold__trustwallet_tft_added.jpg b/collections/tfmanual/documentation/threefold_token/storing_tft/img/threefold__trustwallet_tft_added.jpg new file mode 100644 index 0000000..23cc0a3 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/threefold__trustwallet_tft_added.jpg differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/threefold__trustwallet_tft_config.jpg b/collections/tfmanual/documentation/threefold_token/storing_tft/img/threefold__trustwallet_tft_config.jpg new file mode 100644 index 0000000..a62a447 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/threefold__trustwallet_tft_config.jpg differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/threefold__xlm_solar_tft_manual_image_19.jpg b/collections/tfmanual/documentation/threefold_token/storing_tft/img/threefold__xlm_solar_tft_manual_image_19.jpg new file mode 100644 index 0000000..7a677a6 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/threefold__xlm_solar_tft_manual_image_19.jpg differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/trust_backup.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/trust_backup.png new file mode 100644 index 0000000..8d2d170 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/trust_backup.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/trust_create.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/trust_create.png new file mode 100644 index 0000000..f98174a Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/trust_create.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/trust_created.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/trust_created.png new file mode 100644 index 0000000..f1a9fc5 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/trust_created.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/trust_notfound.jpeg b/collections/tfmanual/documentation/threefold_token/storing_tft/img/trust_notfound.jpeg new file mode 100644 index 0000000..fe46b8b Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/trust_notfound.jpeg differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/trust_notfound.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/trust_notfound.png new file mode 100644 index 0000000..c70f2af Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/trust_notfound.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/trust_recover.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/trust_recover.png new file mode 100644 index 0000000..7b4a869 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/trust_recover.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/img/trust_verify.png b/collections/tfmanual/documentation/threefold_token/storing_tft/img/trust_verify.png new file mode 100644 index 0000000..5600e1a Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/storing_tft/img/trust_verify.png differ diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/interstellar_store.md b/collections/tfmanual/documentation/threefold_token/storing_tft/interstellar_store.md new file mode 100644 index 0000000..3c85bd5 --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/storing_tft/interstellar_store.md @@ -0,0 +1,116 @@ +

Interstellar (TFT-Stellar)

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Get Started](#get-started) + - [Create a New Interstellar account](#create-a-new-interstellar-account) + - [Create a New Wallet](#create-a-new-wallet) + - [Adding TFT as an Asset](#adding-tft-as-an-asset) +- [Purchase TFT on Interstellar](#purchase-tft-on-interstellar) +- [Disclaimer](#disclaimer) + +*** + +## Introduction + +Welcome to our guide on how to store TFT tokens (Stellar) via the [**Interstellar**](https://interstellar.exchange/)! + +Interstellar is a decentralized exchange built on the Stellar network that enables users to trade various assets, including TFT (Stellar). As an intuitive and user-friendly platform, Interstellar provides a seamless trading experience for Stellar users. With its focus on security and privacy, Interstellar ensures that users maintain control over their funds and private keys. + +In this guide, we will walk you through the process of buying TFT on the Interstellar exchange, allowing you to participate in the vibrant Stellar ecosystem. + +> If you are looking for ways to get / purchase TFT (Stellar) on Interstellar by trading, you will find the according information [here](../buy_sell_tft/interstellar.md). + +## Prerequisites + +- **XLM**: To get TFT tokens using Interstellar, a certain amount of XLM funding is required to facilitate the sending and receiving of assets on the Stellar network. + +If you already have some XLMs stored in another Stellar wallet or exchange, you could simply withdraw them to your new Interstellar account after you complete the signup process (we will explain how to do it later on). If not, there are multiple ways to acquire XLM and send it to your wallet. One option is to utilize XLM-supported exchanges, which provide a convenient platform for purchasing XLM. Click [**here**](https://www.coinlore.com/coin/stellar/exchanges) to access a comprehensive list of exchanges that support XLM. + +As an example, we have created a tutorial specifically focusing on how to buy XLM on Coinbase, one of the popular cryptocurrency exchanges. This tutorial provides step-by-step instructions on the process of purchasing XLM on **Coinbase Exchange**. You can find the tutorial [**here**](../buy_sell_tft/coinbase_xlm.md). + + +## Get Started + +### Create a New Interstellar account + +For this guide, we will focus on creating the desktop version of Interstellar account. Go to [https://interstellar.exchange/](https://interstellar.exchange/) from your desktop and click the '**Login/signup**' button. + +![](img/inter_login.png) + +after selecting the preferred language and theme (dark/light) by following the login dialogue, you will be redirected to Interstellar homepage. Click '**Enter Account**' to start the signup process. + +![](img/inter_home.png) + +Create a new password for your new Interstellar account, and click '**Login**' + +![](img/inter_pass.png) + +### Create a New Wallet + +You are now redirected to your new Interstellar wallet homepage. You can either generate a new wallet randomly, or creating a new custom wallet. On this case, we will generate a new wallet randomly by clicking '**Generate Random Wallet**' button. + +![](img/inter_home1.png) + +Write down your Secret Key, which is needed to recover access to your account in case of a password loss or if your phone is lost or stolen. The word order is very important. + +Note: It is essential to save your secret key securely during the process of creating a new account or importing an existing one. The secret key is a critical component that grants access to your wallet and funds. Make sure to store it in a safe and offline location, such as a password manager or a physical backup, to prevent unauthorized access. Do not share your secret key with anyone and exercise caution to protect your assets. + +Tick all the boxes and click '**Go to Account**' to proceed. + +![](img/inter_key.png) + +Congratulations! You have successfully created a new Interstellar wallet. + +![](img/inter_success.png) + +you will have to send funds (digital currencies that run on the Stellar Blockchain only) to one of the wallets attached to your account. + +We have funded our wallet with $408 or 10.000 XLMs for this manual as you can see these are now shown in the account overview. + +![](img/inter_funded.png) + +This step is obligatory because you will need to pay some XLM in order to start adding TFT asset to your wallet in the following tutorial below. + +### Adding TFT as an Asset + +To store and trade TFT in your Interstellar wallet, we will need to have a TFT wallet added into our account. This is done by adding TFT Asset. This will allow you to view your TFT balance, send and receive TFT tokens, and engage in trading activities involving TFT within the Solar wallet. + +To add the TFT (ThreeFold Token) asset to your Solar Wallet account, follow these steps: + +Click on '**Add Token**' button on your wallet homepage. + +![](img/inter_success.png) + +At the pop-up 'Select Asset; window, and click on All (unverified) option. From there you can search for **TFT** and it will show TFT and Click on the TFT icon. + +**IMPORTANT**: It is important to ensure that you also see the name "**threefold.io**" next to the logo , as this verifies that you are selecting the genuine TFT asset associated with ThreeFold. **Beware of imposters or fraudulent assets that may attempt to mimic TFT.** ThreeFold cannot assume responsibility for any errors or mistakes made during the trustline creation process done by users. If you have any uncertainties or doubts, it is always recommended to seek assistance from official support channels or trusted sources to ensure the accuracy of the trustline configuration. + +![](img/inter_popup.png) + + +Click '**Trust Asset**' once you have confirmed that the TFT asset you're adding is the official one from https://threefold.io. Remember that you have to firstly fund your wallet with some XLM, otherwise, this step won't be done successfully. + + +![](img/INTER_TFT.png) + +Congratulations! TFT asset has been successfully added to your account. + +![](img/inter_ok.png) + +You can now store TFT into your Interstellar account by clicking on the TFT Asset icon, and clicking 'Receive' to deposit some TFT from another wallet to your TFT Asset wallet. + +![](img/inter_deposit.png) + +## Purchase TFT on Interstellar + +If you are looking for ways to get / purchase TFT (Stellar) on Interstellar by trading, you will find the according information [here](../buy_sell_tft/interstellar.md). + +## Disclaimer + +The information provided in this tutorial or any related discussion is not intended as investment advice. The purpose is to provide educational and informational content only. Investing in cryptocurrencies or any other assets carries inherent risks, and it is crucial to conduct your own research and exercise caution before making any investment decisions. + +**The ThreeFold Token (TFT)** is not to be considered as a traditional investment instrument. The value of cryptocurrencies can be volatile, and there are no guarantees of profits or returns. Always be aware of the risks involved and make informed choices based on your own assessment and understanding. We strongly encourage you to read our [full disclaimer](https://library.threefold.me/info/legal/#/legal__disclaimer) and seek advice from a qualified financial professional if needed. + diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/lobstr_wallet.md b/collections/tfmanual/documentation/threefold_token/storing_tft/lobstr_wallet.md new file mode 100644 index 0000000..f43f174 --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/storing_tft/lobstr_wallet.md @@ -0,0 +1,103 @@ +

Lobstr Wallet

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Get Started](#get-started) + - [Create a New Lobstr Wallet](#create-a-new-lobstr-wallet) + - [Fund XLM to Wallet](#fund-xlm-to-wallet) + - [Adding TFT Asset to Lobstr Wallet](#adding-tft-asset-to-lobstr-wallet) +- [Important Notice](#important-notice) +- [Disclaimer](#disclaimer) + +*** + +## Introduction + +Welcome to our guide on how to store TFT tokens (Stellar) via the [**Lobstr Wallet**](https://lobstr.co/)! + +Lobster Wallet is a secure and user-friendly wallet designed specifically for the Stellar blockchain. It allows you to store, manage, and transact with your Stellar-based assets, including TFT (ThreeFold Token). In this tutorial, we will guide you through the process of setting up Lobster Wallet and storing your TFT (Stellar) tokens. By following the steps outlined in this guide, you will be able to access and manage your TFT assets with ease and confidence using the Lobster Wallet platform. + +## Prerequisites + +- **XLM**: When storing TFT tokens using Lobstr wallet, a certain amount of XLM funding is required to facilitate the sending and receiving of assets on the Stellar network. + +If you already have some XLMs stored in another Stellar wallet or exchange, you could simply withdraw them to your new Lobstr wallet account after you complete the signup process. If not, there are multiple ways to acquire XLM and send it to your wallet. One option is to utilize XLM-supported exchanges, which provide a convenient platform for purchasing XLM. Click [**here**](https://www.coinlore.com/coin/stellar/exchanges) to access a comprehensive list of exchanges that support XLM. + +You could also purchase some XLMs directly inside yor new Lobstr wallet account by using Fiat currency payment like credit and debit cards. + +## Get Started + +### Create a New Lobstr Wallet + +For this guide, we will focus on creating the mobile app version of Lobstr Wallet. Go to [https://lobstr.co/](https://lobstr.co/) from your mobile app and download the Lobstr Wallet App to your mobile phone. + +![](./img/lobstr_download.png) + +You can also create and use the web version of Lobstr wallet by signing up on the official website at [hhttps://lobstr.co/](https://lobstr.co/). Go to [Lobstr's knowledge base](https://lobstr.freshdesk.com/support/solutions/articles/151000001052-how-to-create-an-account-in-lobstr-) for the web sign up tutorial. + +Insert your email address and choose a strong and unique password. + +![](./img/lobstr_pass.png) + +Verify your account by clicking on the '**Verify Email**' button in the message sent to your email address. + +![](./img/lobstr_verify.png) + +Press the '**Create Wallet**' button if you'd like to create a new Stellar wallet. + +![](./img/lobstr_new.png) + +Write down your Recovery Phrase, which is needed to recover access to your account in case of a password loss or if your phone is lost or stolen. The word order is very important. + +Note: It is essential to save your secret key securely during the process of creating a new account or importing an existing one. The secret key is a critical component that grants access to your wallet and funds. Make sure to store it in a safe and offline location, such as a password manager or a physical backup, to prevent unauthorized access. Do not share your secret key with anyone and exercise caution to protect your assets. + +![](./img/lobstr_key.png) + +(Optional) Set a federation address, which is the unique name of your new Stellar wallet that can be shared with others to receive funds and click '**Save**'. + +![](./img/lobstr_fed.png) + +Congratulations! You just created a new Lobstr wallet account. + +### Fund XLM to Wallet + +To initiate the process of storing TFT in Solar, the first step is to fund your wallet with XLM (Stellar Lumens). Transfer at least 1 XLM to your wallet to activate it. + +To purchase Stellar lumens with Lobstr using credit / debit card, you can use the ‘[**Buy Lumens**](https://lobstr.co/buy-xlm/)’ option on the LOBSTR web and mobile apps. + +Note: Services relating to credit card payments are provided by[Moonpay](https://www.moonpay.com/), which is a separate platform owned by a third party. Click [here](https://lobstr.freshdesk.com/support/solutions/articles/151000001053-buying-crypto-with-lobstr-wallet) to read the full tutorial. + +Once XLM is successfuly sent, it will appear on your Lobstr wallet homepage. + +### Adding TFT Asset to Lobstr Wallet + +To store TFT in your Lobstr Wallet, we will need to have a TFT wallet added into our account. This is done by adding TFT Asset. This will allow you to view your TFT balance, send and receive TFT tokens, and engage in trading activities involving TFT within the Solar wallet. + +To add the TFT (ThreeFold Token) asset to your Solar Wallet account, follow these steps: + +Open the "Assets" screen from the left side menu + +![](./img/lobstr_assets.png) + +Use the search at the top of the "Assets" screen. From there you can search for TFT and it will show TFT and Click on Add button. + +**IMPORTANT**: It is important to ensure that you also see the name "**threefold.io**" next to the logo , as this verifies that you are selecting the genuine TFT asset associated with ThreeFold. **Beware of imposters or fraudulent assets that may attempt to mimic TFT.** ThreeFold cannot assume responsibility for any errors or mistakes made during the trustline creation process done by users. If you have any uncertainties or doubts, it is always recommended to seek assistance from official support channels or trusted sources to ensure the accuracy of the trustline configuration. + +![](./img/lobstr_asset.jpeg) + +Congratulations! TFT asset has been successfully added to your Lobstr Wallet account. If you've performed the steps above correctly and there are no assets displayed, contact [Lobstr support](https://lobstr.freshdesk.com/support/tickets/new) with the details and the home domain of the asset. + +You can now store TFT by depositing it from another wallet on your TFT Asset page. + +## Important Notice + +If you are looking for ways to get / purchase TFT (Stellar) on Lobstr Wallet by trading or swapping, you will find the according information [here](../buy_sell_tft/tft_lobstr/tft_lobstr_complete_guide.md). + + +## Disclaimer + +> The information provided in this tutorial or any related discussion is not intended as investment advice. The purpose is to provide educational and informational content only. Investing in cryptocurrencies or any other assets carries inherent risks, and it is crucial to conduct your own research and exercise caution before making any investment decisions. +> +> **The ThreeFold Token (TFT)** is not to be considered as a traditional investment instrument. The value of cryptocurrencies can be volatile, and there are no guarantees of profits or returns. Always be aware of the risks involved and make informed choices based on your own assessment and understanding. We strongly encourage you to read our [full disclaimer](../../../knowledge_base/legal/disclaimer.md) and seek advice from a qualified financial professional if needed. diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/metamask.md b/collections/tfmanual/documentation/threefold_token/storing_tft/metamask.md new file mode 100644 index 0000000..a70c8d6 --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/storing_tft/metamask.md @@ -0,0 +1,142 @@ +

MetaMask Wallet

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [TFT Addresses](#tft-addresses) + - [Ethereum Chain Address](#ethereum-chain-address) + - [BSC Address](#bsc-address) +- [Get Started](#get-started) + - [Install \& Create Metamask Account](#install--create-metamask-account) + - [Configure a BSC Wallet (Mainnet) for your TFT](#configure-a-bsc-wallet-mainnet-for-your-tft) + - [Switch Network from ETH to BSC (Auto Add)](#switch-network-from-eth-to-bsc-auto-add) + - [Add TFT Asset to BSC Wallet (Mainnet)](#add-tft-asset-to-bsc-wallet-mainnet) +- [Important Notice](#important-notice) +- [Disclaimer](#disclaimer) + +*** + +## Introduction + +[MetaMask](https://metamask.io/) is a popular browser extension wallet that allows users to interact with various blockchain networks, including BSC and the Ethereum networks. By following the steps outlined in this guide, you'll be able to configure your MetaMask wallet to support TFT tokens on BSC and seamlessly participate in the TFT ecosystem. So let's dive in and explore how to set up TFT on MetaMask with Binance Smart Chain. + +## TFT Addresses + +With MetaMask, you can store TFT on both Binance Smart Chain and the Ethereum chain. Make sure to use the correct TFT address when doing transactions. + +### Ethereum Chain Address + +The ThreeFold Token (TFT) is available on Ethereum. +It is implemented as a wrapped asset with the following token address: + +``` +0x395E925834996e558bdeC77CD648435d620AfB5b +``` + +### BSC Address + +The ThreeFold Token (TFT) is available on BSC. +It is implemented as a wrapped asset with the following token address: + +``` +0x8f0FB159380176D324542b3a7933F0C2Fd0c2bbf +``` + +## Get Started + +We present the steps on BSC. Make sure to switch to Ethereum and to use the TFT Ethereum address if you want to proceed on Ethereum. + +### Install & Create Metamask Account + +Go to the [Metamask website](https://metamask.io/) to download and install the Metamask extension for your browser. Follow [this tutorial](https://support.metamask.io/hc/en-us/articles/360015489531-Getting-started-with-MetaMask) to install metamask to your preferred browser and create. + +Once you’ve installed MetaMask, you’ll see the small fox icon at the top right of your screen, and a notification will appear, letting you know that the install was successful. + +![](./img/metamask_installed.png) + +**Create a Metamask account** + +![](./img/metamask_new.png) + +Assuming you are a new user, click the “**Create a Wallet**” button on the right to get started with a new wallet. + +![](./img/metamask_pass.png) + +This is your password for access to your wallet on your local device. As with all online accounts, you should ensure that you are using a strong password. On the next page, you’ll be given a set of 12 words that act as your **private key**. + +![](./img/metamask_privatekey.png) + +You can think of these words as your master key to all your digital assets. If you have lost or forgotten your password, you can use this set of 12 words to restore your wallet on any device. However, if anyone were to gain access to these 12 words, they could do the same. + +This passphrase is very important, so be sure to keep it safe. Once you have written them down, you can click the “Next” button. Then, just to make sure that you have written them down, MetaMask asks you to confirm your secret recovery phrase by selecting the words in the order they were originally given. You must write down your 12 words in the correct order. + +Once you’ve entered those words, you can click “Continue.” Then, you’re done! It’s that easy. + +### Configure a BSC Wallet (Mainnet) for your TFT + +MetaMask supports various wallet networks, including Ethereum, Binance Smart Chain (BSC), and more. By adding the BSC network, you can seamlessly manage and transact with BSC-based assets like TFT tokens directly within your MetaMask wallet. + + To configure a BSC wallet on MetaMask, you can add the BSC network by specifying the network details such as the chain ID, RPC URL, and symbol. + +### Switch Network from ETH to BSC (Auto Add) + +You might notice straight away that we’re still dealing with an Ethereum wallet. But we want to have a Wallet on BSC Network. To add a new network, click it to access a drop-down menu and hit the "**Add Network**” tab to proceed to the next step. + +![](./img/metamask_add.png) + +You can add BNB Smart Chain from the list of popular networks by clicking "Add", and approving the request once it pops up. + +![](./img/metamask_choose.png) + +After it's added. you will realize that your mainnet network has turned into “**Smart Chain**.” If you wish to change back to the Ethereum network, simply press on the “Smart Chain” menu on the top. + +![](./img/metamask_switch.png) + + +### Add TFT Asset to BSC Wallet (Mainnet) + +Now that you have successfully created a BSC Wallet, we will need to add TFT onto your BSC Wallet. + +To add, go to your 'assets' page and click on '**Import Tokens**' at the bottom of the page. + +![](./img/metamask_import.png) + +You can add TFT onto your wallet by either automatically adding it by typing '**TFT ON BSC (TFT)**' on '**search**' page, + +![](./img/metamask_tft_auto.png) + +or by going to '**custom token**' page and entering TFT details manually. Make sure you enter the right details below to add TFT to your wallet successfully: + +- **Token Contract Address**: ```0x8f0fb159380176d324542b3a7933f0c2fd0c2bbf``` + +Metamask will add the rest of the details, once added, click 'Add custom token'. + +![](./img/metamask_custom.png) + +After the click, you will be asked by Metamask to confirm the token import. Click '**Import Tokens**'. + +![](./img/metamask_confirm.png) + +Congratulations, you have successfully added TFT to your BSC Wallet on Metamask. + +![](./img/metamask_tft.png) + +You should be seeing TFT listed on your Wallet homepage's 'Assets' section. Now that we've successfully listed TFT, we can go ahead and do TFT transactions via Metamask. + +![](./img/metamask_tft_home.png) + +## Important Notice + +To deposit TFT tokens to your MetaMask BSC wallet, **you can only initiate a transfer or swap from any other wallet or exchange platform that operates on the Binance Smart Chain (BSC) network.** Ensure that the platform you are using is on BSC to avoid the risk of losing tokens. + +For example, you cannot transfer TFT tokens directly from the TFConnect app to MetaMask, because TFT tokens on TFT Connect operate on the Stellar network, while TFT on MetaMask lives on Binance Smart Chain (BSC) Network. + +But don't worry! You can still swap your Stellar TFT into BSC TFT and vice versa by bridging them using our [TFT BSC Bridge](https://bridge.bsc.threefold.io/). See tutorial [here](../tft_bridges/bsc_stellar_bridge.md). + +You can also buy TFTs on BSC-supported exchangers like [Pancake Swap](https://pancakeswap.finance/). See tutorial [here](../buy_sell_tft/pancakeswap.md) + +## Disclaimer + +> The information provided in this tutorial or any related discussion is not intended as investment advice. The purpose is to provide educational and informational content only. Investing in cryptocurrencies or any other assets carries inherent risks, and it is crucial to conduct your own research and exercise caution before making any investment decisions. +> +> **The ThreeFold Token (TFT)** is not to be considered as a traditional investment instrument. The value of cryptocurrencies can be volatile, and there are no guarantees of profits or returns. Always be aware of the risks involved and make informed choices based on your own assessment and understanding. We strongly encourage you to read our [full disclaimer](../../../knowledge_base/legal/disclaimer.md) and seek advice from a qualified financial professional if needed. diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/solar_wallet.md b/collections/tfmanual/documentation/threefold_token/storing_tft/solar_wallet.md new file mode 100644 index 0000000..3cd8d62 --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/storing_tft/solar_wallet.md @@ -0,0 +1,122 @@ +

Solar Wallet (TFT-Stellar)

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Get Started](#get-started) + - [Create a New Solar Wallet](#create-a-new-solar-wallet) + - [Fund XLM to New Wallet](#fund-xlm-to-new-wallet) + - [Adding TFT Asset to Solar Wallet](#adding-tft-asset-to-solar-wallet) +- [Storing / Receiving and Sending TFT](#storing--receiving-and-sending-tft) +- [Important Notice](#important-notice) +- [Disclaimer](#disclaimer) +*** +## Introduction + +Welcome to our guide on how to store TFT tokens (Stellar) via the [**Solar Wallet**](https://solarwallet.io/)! + +**Solar Wallet** is a user-friendly wallet designed for storing and managing Stellar-based assets like the ThreeFold Token (TFT). It provides a secure way to store your TFT tokens and access them conveniently. With Solar Wallet, you have full control over your assets and can interact with various Stellar services and decentralized applications. Solar Wallet is available as a web-based wallet and also offers mobile versions for iOS and Android devices. This guide will explain how to store TFT (Stellar) on Solar Wallet, including setup, adding tokens, and important security tips. +*** +## Prerequisites + +- **XLM**: When storing TFT tokens using the Solar wallet, a certain amount of XLM funding is required to facilitate the sending and receiving of assets on the Stellar network. + +There are multiple ways to acquire XLM and send it to your wallet. One option is to utilize XLM-supported exchanges, which provide a convenient platform for purchasing XLM. Click [**here**](https://www.coinlore.com/coin/stellar/exchanges) to access a comprehensive list of exchanges that support XLM. + +As an example, we have created a tutorial specifically focusing on how to buy XLM on Coinbase, one of the popular cryptocurrency exchanges. This tutorial provides step-by-step instructions on the process of purchasing XLM on **Coinbase Exchange**. You can find the tutorial [**here**](../buy_sell_tft/coinbase_xlm.md). +*** +## Get Started + +### Create a New Solar Wallet + +For this guide, we will focus on using the desktop wallet version of Solar Wallet for MacOS. You can download the appropriate version for your operating system by visiting the official website at [https://solarwallet.io/](https://solarwallet.io/) and clicking '**Get Wallet Now**'. + +![](img/solar_home.png) + +![](img/solar_desktop.jpeg) + +Note: It is essential to save your secret key securely during the process of creating a new account or importing an existing one. The secret key is a critical component that grants access to your wallet and funds. Make sure to store it in a safe and offline location, such as a password manager or a physical backup, to prevent unauthorized access. Do not share your secret key with anyone and exercise caution to protect your assets. + +![](img/solar_secret.jpeg) + +After the download is finished, locate the downloaded file on your computer and double-click on it to initiate the installation process. Follow the on-screen instructions to install Solar Wallet on your macOS device. This may involve dragging the application to your Applications folder or following prompts from the installation wizard. + +![](img/solar_install.png) + +Once downloaded, open your Solar wallet and congratulations! You just created a new Solar wallet account. + +![](img/solar_home.jpeg) + +### Fund XLM to New Wallet + +To initiate the process of storing TFT in Solar, the first step is to fund your wallet with XLM (Stellar Lumens). By funding your wallet with XLM, you will have the necessary cryptocurrency to cover future transaction fees and engage in token transaction activities on Solar Wallet. Follow these steps: + +On the Solar Wallet homepage, click on the '**Receive**' button. This will provide you with a wallet address to receive XLM. + +![](img/solar_receive.jpeg) + +Copy the generated wallet address or use the provided QR code to receive XLM from your preferred source. You can use an external exchange, another wallet, or any platform that supports XLM transfers. + +![](img/solar_copy.jpeg) + +Send the desired amount of XLM to the generated wallet address. Ensure that you are sending XLM from a compatible source, and double-check the address to prevent any errors. Wait for the XLM transaction to be confirmed on the Stellar network. This typically takes a few moments, but it may vary depending on network congestion. + +Once XLM is successfuly sent, it will appear on your Solar homepage. + +![](img/solar_xlm.jpeg) + +### Adding TFT Asset to Solar Wallet + +To store TFT in our Solar Wallet, we will need to have a TFT wallet added into our account. This is done by adding TFT Asset. This will allow you to view your TFT balance, send and receive TFT tokens, and engage in trading activities involving TFT within the Solar wallet. + +To add the TFT (ThreeFold Token) asset to your Solar Wallet account, follow these steps: + +Click on the top-right menu icon in your Solar Wallet interface. This will open a dropdown menu with various options. From the dropdown menu, select "**Assets & Balances.**" This will navigate you to the Assets & Balances section of your wallet. + +![](img/solar_asset.png) + +In the Assets & Balances section, click on the "**+ Add Asset To Your Account" button**. This will allow you to add a new asset to your wallet. + +![](img/solar_account.png) + +A search box will appear. Type "**TFT**" in the search box to find the ThreeFold Token asset. Click on the search result as shown below. + +![](img/solar_search.png) + +**IMPORTANT**: It is important to ensure that you also see the name "**threefold.io**" next to the logo , as this verifies that you are selecting the genuine TFT asset associated with ThreeFold. **Beware of imposters or fraudulent assets that may attempt to mimic TFT.** ThreeFold cannot assume responsibility for any errors or mistakes made during the trustline creation process done by users. If you have any uncertainties or doubts, it is always recommended to seek assistance from official support channels or trusted sources to ensure the accuracy of the trustline configuration. + +Once you see the TFT asset, click on the "**Add Asset To Account**" button. Please note that adding the asset will require a small amount of XLM to set up a trustline for the TFT asset. + +![](img/solar_tftinfo.png) + +Confirm Adding TFT Asset to your wallet. + +![](img/solar_confirm.png) + +After confirming the transaction, wait until the process is successful. + +![](img/solar_success.png) + +the TFT icon will now be displayed in your wallet overview. + +![](img/solar_tft.png) + +Congratulations! TFT asset has been successfully added to your Solar Wallet account. +*** +## Storing / Receiving and Sending TFT + +You can now store TFT by depositing it from another wallet by clicking '**Receive**' on your TFT Asset page, and copying your public TFT Solar wallet address and sending it to the withdrawer. + +You can also transfer TFT to another stellar wallet by clicking the '**Send**' icon on your wallet navbar and following further instructions. +*** +## Important Notice + +If you are looking for ways to get / purchase TFT (Stellar) on Solar Wallet, you will find the according information [here](../buy_sell_tft/solar_buy.md). +*** +## Disclaimer + +The information provided in this tutorial or any related discussion is not intended as investment advice. The purpose is to provide educational and informational content only. Investing in cryptocurrencies or any other assets carries inherent risks, and it is crucial to conduct your own research and exercise caution before making any investment decisions. + +**The ThreeFold Token (TFT)** is not to be considered as a traditional investment instrument. The value of cryptocurrencies can be volatile, and there are no guarantees of profits or returns. Always be aware of the risks involved and make informed choices based on your own assessment and understanding. We strongly encourage you to read our [full disclaimer](https://library.threefold.me/info/legal/#/legal__disclaimer) and seek advice from a qualified financial professional if needed. + diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/storing_tft.md b/collections/tfmanual/documentation/threefold_token/storing_tft/storing_tft.md new file mode 100644 index 0000000..7d05dd6 --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/storing_tft/storing_tft.md @@ -0,0 +1,16 @@ +

Storing TFT

+ +In this section, we present different ways to store ThreeFold tokens. + +The simplest way is to use the ThreeFold Connect app to store your TFT. You can also use a hardware wallet for additional security. + +There are various options available to store TFTs, each with its own benefits and considerations. When it comes to storing TFTs (ThreeFold Tokens), users have the flexibility to choose between different wallet options depending on the blockchain platform on which the tokens are issued. + +If TFTs are issued on the Stellar blockchain, users can opt to store them in Stellar-compatible wallets. On the other hand, if TFTs are bridged and swapped from Stellar to the Binance Smart Chain (BSC) or Ethereum Network, users can utilize BSC-compatible and ETH-compatible wallets to store their tokens. + +

Table of Contents

+ +- [ThreeFold Connect App (Stellar)](./tf_connect_app.md) +- [Lobstr Wallet (Stellar)](./lobstr_wallet.md) +- [MetaMask (BSC & ETH)](./metamask.md) +- [Hardware Wallet](./hardware_wallet.md) \ No newline at end of file diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/tf_connect_app.md b/collections/tfmanual/documentation/threefold_token/storing_tft/tf_connect_app.md new file mode 100644 index 0000000..03bcdda --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/storing_tft/tf_connect_app.md @@ -0,0 +1,312 @@ +

ThreeFold Connect App Wallet

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [ThreeFold Connect Installation](#threefold-connect-installation) + - [Verify your identity by Email](#verify-your-identity-by-email) + - [Change email associated with TF account](#change-email-associated-with-tf-account) +- [Create a Wallet](#create-a-wallet) +- [See ThreeFold Connect App and Wallet Transactions](#see-threefold-connect-app-and-wallet-transactions) +- [Connect to the Planetary Network](#connect-to-the-planetary-network) +- [Show Seed Phrase - Remove Account from TF Connect App](#show-seed-phrase---remove-account-from-tf-connect-app) +- [Recover Account on the ThreeFold Connect App](#recover-account-on-the-threefold-connect-app) +- [Import Farm from the TF Connect App to the TF Dashboard](#import-farm-from-the-tf-connect-app-to-the-tf-dashboard) +- [Import TF Dashboard Wallet to the TF Connect App Wallet](#import-tf-dashboard-wallet-to-the-tf-connect-app-wallet) +- [Send and Receive TFT between TF Connect Wallets](#send-and-receive-tft-between-tf-connect-wallets) + - [Send TFT](#send-tft) + - [Receive TFT](#receive-tft) + - [Send TFT to Hardware Wallet on Stellar Blockchain](#send-tft-to-hardware-wallet-on-stellar-blockchain) +- [Disclaimer](#disclaimer) + +*** + +## Introduction + +In this section, we cover the basics of the ThreeFold Connect app. + +This app is available for [Android](https://play.google.com/store/apps/details?id=org.jimber.threebotlogin&hl=en&gl=US) and [iOS](https://apps.apple.com/us/app/threefold-connect/id1459845885). + +- Note that for Android phones, you need at minimum Android Nougat, the 8.0 software version. +- Note that for iOS phones, you need at minimum iOS 14.5. It will be soon available to iOS 13. + +![farming_wallet_5](./img/farming_wallet_5.png) + +## ThreeFold Connect Installation + +Either use the links above, or search for the ThreeFold Connect app on the Apple Store or the Google Play store. Then install and open the app. If you want to leave a 5 star review of the app, no one here will stop you! + +![farming_tf_wallet_1](./img/farming_tf_wallet_1.png) +![farming_tf_wallet_2](./img/farming_tf_wallet_2.png) + +When you try to open the app, if you get an error message such as : "Error in initialization in Flagsmith...", you might need to upgrade your phone to a newer software version (8.0 for Android and 13 for iOS). + +Once you are in the application, you will see some introduction pages to help you familiarize with the TF Connect app. You will also be asked to read and accept ThreeFold's Terms and conditions. + +![farming_tf_wallet_3](./img/farming_tf_wallet_3.png) +![farming_tf_wallet_4](./img/farming_tf_wallet_4.png) + +You will then be asked to either *SIGN UP* or *RECOVER ACCOUNT*. For now, we will show how to sign up. Later in the guide, we will show you how to recover an account. + +![farming_tf_wallet_5](./img/farming_tf_wallet_5.png) + +You will then be asked to choose a *Threefold Connect Id*. This ID will be used, as well as the seed phrase, when you want to recover an account. Choose wisely. And do not forget it! Here we will use TFExample, as an example. + +![farming_tf_wallet_6](./img/farming_tf_wallet_6.png) + +Next, you need to add a valid email address. This will be used as a broad KYC. You will need to access your email and confirm the validation email from ThreeFold to use properly the TF Connect app wallet. + +![farming_tf_wallet_7](./img/farming_tf_wallet_7.png) + +Then, the next step is crucial! Make sure no one is around looking at your screen. You will be shown your seed phrase. Keep this in a secure and offline place. You will need the 3bot ID and the seed phrase to recover your account. This seed phrase is of utmost important. Do not lose it nor give it to anyone. + +![farming_tf_wallet_8](./img/farming_tf_wallet_8.png) + +Once you've hit Next, you will be asked to write down 3 random words of your seed phrase. This is a necessary step to ensure you have taken the time to write down your seed phrase. + +![farming_tf_wallet_9](./img/farming_tf_wallet_9.png) + +Then, you'll be asked to confirm your TF 3bot name and the associated email. + +![farming_tf_wallet_10](./img/farming_tf_wallet_10.png) + +Finally, you will be asked to choose a 4-digit pin. This will be needed to use the ThreeFold Connect app. If you ever forget this 4-digit pin, you will need to recover your account from your 3bot name and your seed phrase. You will need to confirm the new pin in the next step. + +![farming_tf_wallet_11](./img/farming_tf_wallet_11.png) + +That's it! You've created your ThreeFold Connect account. You can press the hamburger menu on the top left to explore the ThreeFold Connect app. + +![farming_tf_wallet_12](./img/farming_tf_wallet_12.png) + +In the next step, we will create a ThreeFold Connect Wallet. You'll see, it's very simple! + +### Verify your identity by Email + +Once you've created your account, an email will be sent to the email address you've chosen in the account creation process. + +To verify your email, go on your email account and open the email sent by *info@openkyc.live* with the subject *Verify your email address*. + +In this email, click on the link *Verify my email address*. This will lead you to a *login.threefold.me* link. The process should be automatic. Once this is done, you will receive a confirmation on screen, as well as on your phone. + +![farming_tf_wallet_39](./img/farming_tf_wallet_39.png) + +![farming_tf_wallet_40](./img/farming_tf_wallet_40.png) + +![farming_tf_wallet_41](./img/farming_tf_wallet_41.png) + +If for some reason, you did not receive the verification email, simply click on *Verify* and another email will be sent. + +![farming_tf_wallet_42](./img/farming_tf_wallet_42.png) + +![farming_tf_wallet_43](./img/farming_tf_wallet_43.png) + +### Change email associated with TF account + +If you want to change your email, simply click on the *pencil* next to your email and write another email. You will need to redo the KYC verification process. + +![farming_tf_wallet_44](./img/farming_tf_wallet_44.png) + + +## Create a Wallet + +To create a wallet, click on the ThreeFold Connect app menu. This is what you see. Choose *Wallet*. + +![farming_tf_wallet_13](./img/farming_tf_wallet_13.png) + +Once you are in the section *Wallet*, click on *Create Initial Wallet*. If it doesn't work the first time, retry some more. If you have trouble creating a wallet, make sure your connection is reliable. You can try a couple of minutes later if it still doesn't work. With a reliable connection, there shouldn't be any problem. Contact TF Support if problems persist. + +![farming_tf_wallet_14](./img/farming_tf_wallet_14.png) + +This is what you see when the TF Grid is initializing your wallet. + +![farming_tf_wallet_15](./img/farming_tf_wallet_15.png) + +Once your wallet is initialized, you will see *No blanace found for this wallet*. You can click on this button to enter the wallet. + +![farming_tf_wallet_16](./img/farming_tf_wallet_16.png) + +Once inside your wallet, this is what you see. + +![farming_tf_wallet_17](./img/farming_tf_wallet_17.png) + +We will now see where the Stellar and the TF Chain Addresses and Secrets are to be found. We will also changing the wallet name. To do so, click on the *circled i* at the bottom right of the screen. + +![farming_tf_wallet_18](./img/farming_tf_wallet_18.png) + +![farming_tf_wallet_19](./img/farming_tf_wallet_19.png) + +You can choose the name you want for your wallet. Here we use TFWalletExample. Note that you can also use alphanumeric characters. + +![farming_tf_wallet_20](./img/farming_tf_wallet_20.png) + +At the top of the section *Wallet*, we can see that the name has changed. + +![farming_tf_wallet_21](./img/farming_tf_wallet_21.png) + +Now, if you want to copy your Stellar Address, simply click on the button presented with the green circle. To access the TF Chain address, click on the button presented with the red circle. When your phone has copied the address, the TF Connect app will give show a confirmation message as shown below. + +![farming_tf_wallet_22](./img/farming_tf_wallet_22.png) + +In some situations, you will want to access the Stellar and TF Chain secrets. To do so, simply click on the "eye" button of the desired chain, and then copy the secret. + +![farming_tf_wallet_23](./img/farming_tf_wallet_23.png) + +## See ThreeFold Connect App and Wallet Transactions + +To see your transactions, simply click on the two arrows at the bottom of the screen, as shown below. + +![farming_tf_wallet_29](./img/farming_tf_wallet_29.png) + +## Connect to the Planetary Network + +To connect to the Planetary Network, click on the Planetary Network on the TF menu as shown below. + +![farming_tf_wallet_30](./img/farming_tf_wallet_30.png) + +Connecting to the Planetary Network couldn't be easier. Simply click on the connection button and you will see *Connected* on the screen once the connection is settled. + +![farming_tf_wallet_31](./img/farming_tf_wallet_31.png) + +## Show Seed Phrase - Remove Account from TF Connect App + +To see your seed phrase or remove your account from the TF Connect app, choose *Settings* in the ThreeFold Connect app menu. + +![farming_tf_wallet_32](./img/farming_tf_wallet_32.png) + +First, to see your seed phrase, click on this button as shown below: + +![farming_tf_wallet_31](./img/farming_tf_wallet_38.png) + +You will then be able to see your seed phrase. You can make sure you have your seed phrase somewhere safe, offline, before removing your account. + +Now, we will remove the account from the ThreeFold Connect app. In Settings, click on the arrow circled in green and click on the red button with a white dashed in it. Beware: once done, you can only recover your account with your **3bot ID** and your **seed phrase**. + +![farming_tf_wallet_33](./img/farming_tf_wallet_33.png) + +You will be asked to confirm your action as a security check. + +![farming_tf_wallet_34](./img/farming_tf_wallet_34.png) + +## Recover Account on the ThreeFold Connect App + +Once you're removed your account, if you want to recover your account, choose the option *RECOVER ACCOUNT* on the opening screen on the app. + +![farming_tf_wallet_35](./img/farming_tf_wallet_35.png) + +You will be asked to enter your *3bot ID* as well as your *seed phrase*. + +![farming_tf_wallet_36](./img/farming_tf_wallet_36.png) + +You will then be asked to choose and confirm a new 4-digit pin code. Once this is done, you will receive the following confirmation: + +![farming_tf_wallet_37](./img/farming_tf_wallet_37.png) + +That's it! You've recovered your account. + + +## Import Farm from the TF Connect App to the TF Dashboard + +If you want to import your farm from the ThreeFold Connect app to the ThreeFold Dashboard, follow these steps. You will need to use the old version of the Dashboard for this ([https://old.dashboard.grid.tf](https://old.dashboard.grid.tf)). + +Note that as of now, you cannot import your farm from the TF Dashboard to the ThreeFold Connect app, but it is possible to import your wallet. + +First, you want to find the TF Chain Secret, this is, in short, a hex version of the private key. To find the secret, head over to the *Farmer migration* (via the TF Menu). + +In the *Farming migration* section, click on the arrow (in green here) of the farm you want to export on the ThreeFold Dashboard. + +![farming_tf_wallet_45](./img/farming_tf_wallet_45.png) + +Then, click on the arrow (in green) to see your TF Chain Secret. + +![farming_tf_wallet_46](./img/farming_tf_wallet_46.png) + +Click on the button to copy the Secret. The app will show a confirmation message. + +![farming_tf_wallet_47](./img/farming_tf_wallet_47.png) + +Now head over to the browser with your polkadot.js extension. For more information on this, check the section [Creating a Polkadot.js account](#1-creating-a-polkadotjs-account). + +On your browser, click on the extension button (in green). + +![farming_tf_wallet_48](./img/farming_tf_wallet_48.png) + +Select the polkadot{.js} extension. + +![farming_tf_wallet_49](./img/farming_tf_wallet_49.png) + +Click on the *plus* button as shown in green. + +![farming_tf_wallet_50](./img/farming_tf_wallet_50.png) + +Choose the option *Import account from pre-existing seed*. + +![farming_tf_wallet_51](./img/farming_tf_wallet_51.png) + +In the box *EXISTING 12 OR 24-WORD MNEMONIC SEED*, paste the TF Chain Secret. Note that this Secret is a HEX version of your seed phrase. + +![farming_tf_wallet_52](./img/farming_tf_wallet_52.png) + +Choose a name for your account. Choose a password. + +![farming_tf_wallet_53](./img/farming_tf_wallet_53.png) + +When you go on the [ThreeFold Dashboard](https://old.dashboard.grid.tf), you will now see your newly added account. Click on it. + +![farming_tf_wallet_54](./img/farming_tf_wallet_54.png) + +In the Farm section, you can now see your farm. You have successfully move the farm from the ThreeFold Connect app to the ThreeFold Dashboard. + +![farming_tf_wallet_55](./img/farming_tf_wallet_55.png) + +You can see here that the farming reward address is the same as before. + +![farming_tf_wallet_56](./img/farming_tf_wallet_56.png) + +That's it! You have successfully imported the farm from the ThreeFold Connect app to the ThreeFold Dashboard. + + + +## Import TF Dashboard Wallet to the TF Connect App Wallet + +Now that we've seen how to go from the TF Connect app to the ThreeFold Dashboard, we will now show how to go the other way around. This method is very simple. You will need your TF Dashboard seed phrase handy. + +Go in the Wallet section of the ThreeFold Connect app and click on import at the bottom right (in green). + +![farming_tf_wallet_57](./img/farming_tf_wallet_57.png) + +Then simply name your wallet and enter the TF Dashboard seed phrase. + +![farming_tf_wallet_58](./img/farming_tf_wallet_58.png) + +Then in the Wallet section, you will now see the wallet. + +![farming_tf_wallet_59](./img/farming_tf_wallet_59.png) + + + +## Send and Receive TFT between TF Connect Wallets + +To send and receive TFT between TF Connect Wallet, go into Wallet and select the wallet you want to use.Remember that you must always send and receive TFT on the same chain, so choose either Stellar or TFChain. + +### Send TFT + +To send tokens, select *Send Coins* in the wallet section. To send TFT, you can scan the QR code of the address you wish to send tokens to. This will enter automatically the necessary information. Make sure to double check that the information is correct to avoid any complications. Otherwise, you can simply enter the correct address in the section *To*. Choose the amount you want to send. Then click on *SEND TOKENS*. + +Note that, for such transactions, there is a maximum fee of 0.10 TFT on the Stellar blockchain, and a maximum fee of 0.01 TFT on the TFChain. This amount is taken from the amount you are sending. It is not taken directly in your wallet. + +### Receive TFT + +To receive tokens, select *Receive Coins* in the wallet section. To receive TFT, you can generate a QR code to share to the person waiting to send you tokens. Otherwise, the sender can simply use your Stellar or TFChain address and send you TFT. + +To generate the QR Code, select the chain you want to use, Stellar or TFChain, enter the amount and the message if needed and click on *GENERATE QR CODE*. Note that there is no message option for TFChain, only for Stellar. This will generate a QR Code that can be scanned by other devices. + + +### Send TFT to Hardware Wallet on Stellar Blockchain + +Before sending TFT to a hardware wallet, make sure the hardware wallet has a TFT trustline on the Stellar Blockchain. For more information, read [this section](./hardware_wallet.md). + +## Disclaimer + +> The information provided in this tutorial or any related discussion is not intended as investment advice. The purpose is to provide educational and informational content only. Investing in cryptocurrencies or any other assets carries inherent risks, and it is crucial to conduct your own research and exercise caution before making any investment decisions. +> +> **The ThreeFold Token (TFT)** is not to be considered as a traditional investment instrument. The value of cryptocurrencies can be volatile, and there are no guarantees of profits or returns. Always be aware of the risks involved and make informed choices based on your own assessment and understanding. We strongly encourage you to read our [full disclaimer](../../../knowledge_base/legal/disclaimer.md) and seek advice from a qualified financial professional if needed. diff --git a/collections/tfmanual/documentation/threefold_token/storing_tft/trustwallet.md b/collections/tfmanual/documentation/threefold_token/storing_tft/trustwallet.md new file mode 100644 index 0000000..bbd044d --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/storing_tft/trustwallet.md @@ -0,0 +1,84 @@ +

Store TFT-BSC on Trust Wallet (BSC)

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [How to Store TFT on Trust Wallet (BSC)](#how-to-store-tft-on-trust-wallet-bsc) + - [Download and Create a Trust Wallet Account](#download-and-create-a-trust-wallet-account) + - [Add TFT to Trust Wallet](#add-tft-to-trust-wallet) +- [Important Notice](#important-notice) +- [Disclaimer](#disclaimer) +*** +## Introduction + +[Trust Wallet](https://trustwallet.com/) is a widely used, free, and non-custodial mobile wallet designed for storing cryptocurrencies and non-fungible tokens (NFTs). It operates as a hot wallet, meaning it is connected directly to the internet, and is available on both iOS and Android devices. Since its acquisition by Binance in 2018, Trust Wallet has become Binance's official decentralized wallet. It supports a vast array of digital assets, with over 4.5 million supported, and is compatible with more than 65 blockchains. Trusted by millions of users, Trust Wallet stands out for its seamless integration with platforms on the Binance Smart Chain (BEP-20), including popular ones like PancakeSwap. +*** +## How to Store TFT on Trust Wallet (BSC) + +### Download and Create a Trust Wallet Account + +Once you have downloaded the app (iOS / Android) via [https://trustwallet.com/](https://trustwallet.com/), Select “Create a new wallet” and press “Continue” to accept the terms. Get a pencil and paper ready because the warning Trust Wallet gives you is real: If you lose your recovery words (sometimes also known as a seed phrase or recovery phrase) you may lose access to your wallet and the crypto within it forever. + +![](./img/trust_create.png) + +A new screen will appear, prompting you to write down your recovery phrase. It is important you manually write it down and keep it in a safe, private place. Keeping the words in digital form is less secure and not recommended. + +![](./img/trust_backup.png) + +The recovery phase for Trust Wallet consists of 12 words. These words will be used in case you lose access to your wallet – and they are the only way to regain access to the wallet. So we’ll say it again: Keep them in a safe, private place. + +![](./img/trust_recover.png) + +To verify that you backed up your recovery phrases, Trust Wallet will prompt you to write them in sequential order as you’ve received them. + +![](./img/trust_verify.png) + +You will get a screen stating, “Your wallet was successfully created.” + +![](./img/trust_created.png) + +### Add TFT to Trust Wallet + +To add TFT to your Trust Wallet, you need to configure it manually as a 'custom token'. In Trust Wallet, a custom token refers to a token that is not natively supported or pre-listed on the wallet's default token list. + +In the 'Tokens' page, click on the 'settings' icon on the upper right corner to start adding a custom token. + +![](./img/threefold__trustwallet_overview.jpg) + +Search for TFT, and you will see a “No Asset Found” message with a Add Custom Token button. Click on the 'Add Custom Token' button. You will be directed to the Custom Token page. + +![](./img/trust_notfound.png) + +On the Custom Token page, configure TFT in the wallet by completing following info : + +Network: Smart Chain +**Contract Address: 0x8f0FB159380176D324542b3a7933F0C2Fd0c2bbf** +Name: TFT +Symbol: TFT +Decimals: 7 + +![](./img/threefold__trustwallet_tft_config.jpg) + +Once this configuration is done, your TFT wallet is ready. + +![](./img/threefold__trustwallet_tft_added.jpg) +*** +## Important Notice + +To deposit TFT tokens to your Trust BSC wallet, **you can only initiate a transfer or swap from any other wallet or exchange platform that operates on the Binance Smart Chain (BSC) network.** Ensure that the platform you are using is on BSC to avoid the risk of losing tokens. + +For example, you cannot transfer TFT tokens directly from the TFConnect app to MetaMask, because TFT on TFT Connect Wallet operate on the Stellar network, while TFT on MetaMask lives on Binance Smart Chain (BSC) Network. + +But don't worry! You can still swap your Stellar TFT into BSC TFT and vice versa by bridging them using our [Stellar-BSC Bridge](https://bridge.bsc.threefold.io/). See tutorial [here](../tft_bridges/bsc_stellar_bridge.md). + +You can also buy and swap TFTs on BSC-supported exchangers by connecting your Trust Wallet to platforms like [Pancake Swap](https://pancakeswap.finance/). See the tutorial [here](../buy_sell_tft/pancakeswap.md) +*** +## Disclaimer + +The information provided in this tutorial or any related discussion is not intended as investment advice. The purpose is to provide educational and informational content only. Investing in cryptocurrencies or any other assets carries inherent risks, and it is crucial to conduct your own research and exercise caution before making any investment decisions. + +**The ThreeFold Token (TFT)** is not to be considered as a traditional investment instrument. The value of cryptocurrencies can be volatile, and there are no guarantees of profits or returns. Always be aware of the risks involved and make informed choices based on your own assessment and understanding. We strongly encourage you to read our [full disclaimer](https://library.threefold.me/info/legal/#/legal__disclaimer) and seek advice from a qualified financial professional if needed. + + + + diff --git a/collections/tfmanual/documentation/threefold_token/tft_bridges/bsc_stellar_bridge.md b/collections/tfmanual/documentation/threefold_token/tft_bridges/bsc_stellar_bridge.md new file mode 100644 index 0000000..88f5152 --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/tft_bridges/bsc_stellar_bridge.md @@ -0,0 +1,116 @@ +

BSC-Stellar Bridge

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [How to Use the BSC-Stellar Bridge](#how-to-use-the-bsc-stellar-bridge) + - [Bridge from Stellar to BSC](#bridge-from-stellar-to-bsc) + - [Bridge from BSC to Stellar](#bridge-from-bsc-to-stellar) +- [Setting Up TFT on Metamask](#setting-up-tft-on-metamask) +- [Bridge Fees](#bridge-fees) +- [Questions and Feedback](#questions-and-feedback) + +*** + +## Introduction + +We present here the main steps to use the BSC-Stellar Bridge. + + + +## How to Use the BSC-Stellar Bridge + +To use the BSC-Stellar Bridge, follow the following steps. If this is your first time with MetaMask and BSC, read the section [Setting up TFT on Metamask](#setting-up-tft-on-metamask). + +It will cost 100 TFT* to bridge from Stellar to BSC, and 1 TFT to bridge from BSC to Stellar. There is also a fixed fee of 0.01 TFT when using the Stellar blockchain. Those fees are taken from the total of what you are bridging. + +*For example, if you Bridge 200 TFT, from Stellar to BSC, you will receive 100 TFT. + +> Note: The bridge will process deposits/withdrawals within 48 hours. + + +### Bridge from Stellar to BSC + +**Pre-requisites:** + +* Metamask account +* TF Connect App+Wallet +* TFT on Stellar Blockchain + +**Steps** + +1. Go to the BSC-Stellar [Bridge website](https://bridge.bsc.threefold.io/). +2. Connect your MetaMask Wallet. +3. Sign in with MetaMask. +4. Choose the option *Deposit from Stellar*. +5. Agree to the *ThreeFold Terms*. +6. Read and tick the box of the *Warning Message*. +7. On your phone, open up your ThreeFold Connect App and go to the wallet section. +8. Select the option *Send*. +9. Select the *Stellar* chain. +10. Click on the button *Scan QR Code* . The QR Code option automatically fill up your *MESSAGE*. +11. Scan the QR code that appears on the Bridge window (or write the information manually). +12. Make sure the *MESSAGE* is correctly entered. +13. Press *Send Tokens*. +14. Press *Confirm*. + +In this method, you use the Bridge directly. Thus, it is normal if you do not see your standard MetaMask address. MetaMask is on ERC20 and TFT is on Stellar. You are sending TFT to the Bridge's address, and the Bridge sends money to your wallet afterward. + + + +### Bridge from BSC to Stellar + +**Pre-requisites:** + +* Metamask account +* TF Connect App+Wallet +* BNB for gas fees +* TFT + +**Steps** + +1. Go to the BSC-Stellar [Bridge website](https://bridge.bsc.threefold.io/). +2. Connect your MetaMask Wallet. +3. Sign in with MetaMask. +4. Choose the option *Deposit from BSC*. +5. Agree to the *ThreeFold Terms*. +6. Read and tick the box of the *Warning Message*. +7. On your phone, open up your ThreeFold Connect App and go to the wallet section. +8. Copy your Stellar address. +9. Paste your Stellar address in the proper field on The BSC-Stellar Bridge. +10. Enter the amount of TFT you want to bridge. +11. Click on *Withdraw*. +12. Follow the instructions on your Metamask Wallet. + +**General Tips** + +* It's a good idea to start with a small amount the first time. +* The process is usually quick, but it can take up to 48h. In doubt, contact [TF Support](https://threefoldfaq.crisp.help/en/). +* Going from Stellar to BSC costs 100 TFT. +* Going from BSC to Stellar costs 1 TFT. +* There is also fixed fee of 0.01 TFT when using the Stellar Blockchain. +* Gas fees on BSC is usually around 5-20 gwei. +* You can try the bridge later if gas fees are high at the moment of your transaction. + + + +## Setting Up TFT on Metamask + +* Download Metamask [here](https://metamask.io/download/). Then, install the Metamask extension in your local browser. +* Create a Metamask account +* Switch the network to `Binance chain` . You will have to create a new network with following information): + * Mainnet + * Network Name: Smart Chain + * New RPC URL: https://bsc-dataseed.binance.org/ + * ChainID: 56 + * Symbol: BNB + * Block Explorer URL: [https://bscscan.com](https://bscscan.com/) +* Add TFT token in Metamask -> custom token -> contract address = `0x8f0FB159380176D324542b3a7933F0C2Fd0c2bbf` + +## Bridge Fees + +To learn more about the bridge fees, read [this documentation](../transaction_fees.md). + +## Questions and Feedback + +If you have any question, feel free to write a post on the [Threefold Forum](https://forum.threefold.io/). diff --git a/collections/tfmanual/documentation/threefold_token/tft_bridges/bsc_stellar_bridge_verification.md b/collections/tfmanual/documentation/threefold_token/tft_bridges/bsc_stellar_bridge_verification.md new file mode 100644 index 0000000..92948a3 --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/tft_bridges/bsc_stellar_bridge_verification.md @@ -0,0 +1,98 @@ +

BSC-Stellar Bridge Verification

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [From Stellar to BSC](#from-stellar-to-bsc) +- [From BSC to Stellar](#from-bsc-to-stellar) +- [Conclusion](#conclusion) + +*** + +## Introduction + +In this guide, we show how to verify transactions on the BSC-Stellar bridge. + +When using the TFT bridge to Binance Chain (BSC), it's not simple to verify that tokens arrived at the destination wallet. The core reason is that it's not a regular token transfer, and so it doesn't show up that way in blockchain explorers. + +Instead, the result of using the bridge is a contract call that actually mints wrapped TFT on Binance Chain. The corresponding tokens are vaulted on Stellar, and when the bridge is used in the opposite direction, TFT on Binance Chain are burnt and then released on Stellar. Thus, the total number of TFT in circulation is constant throughout these operations. + +What we can do, instead of looking at token transfers, is to look for the mint events themselves. By parsing together data from a few different sources, we can verify that tokens sent to the bridge address on Stellar indeed arrived at their destination on Binance Chain. + +## From Stellar to BSC + +We start with a bridge example going from Stellar to BSC. For this tutorial, we'll use an example transaction found by looking at the transaction history from the [bridge wallet](https://stellar.expert/explorer/public/account/GBFFWXWBZDILJJAMSINHPJEUJKB3H4UYXRWNB4COYQAF7UUQSWSBUXW5). This wallet uses both directions of bridging. In our case, we want to look for an inbound transaction. Here's an example: + +![](./img/bsc_stellar_picture_1.png) + +The first thing to do is decode the destination wallet address on Binance Chain, which is contained in the memo we see here on Stellar. It's encoded in base 64 and we can convert back to the original hex using a tool like this [Base64 to Hex Converter](https://base64.guru/converter/decode/hex): + +![](./img/bsc_stellar_picture_2.png) + +The output is the destination address on Binance Chain. Since we usually write hex values with a leading `0x`, the full address in the normal format is `0x64df465bbcee5db45131e9406662818e8ba34fc0`. + +The other thing to note is the date and time of the original Stellar transaction. There are sometimes delays on the bridge, but we know that the outbound transaction on Binance Chain will always happen after the inbound transaction on Stellar. In this case, we are looking at the most recent transaction on the Stellar side of the bridge, so we can just look for the most recent transaction on the Binance side too. + +To do that, we'll go to the [Bitquery explorer](https://explorer.bitquery.io/bsc) for BSC. We're looking for the token contract for TFT on Binance Chain, which you can find in our documentation: `0x8f0fb159380176d324542b3a7933f0c2fd0c2bbf`. + +On the [contract page](https://explorer.bitquery.io/bsc/token/0x8f0fb159380176d324542b3a7933f0c2fd0c2bbf), click **Events**: + +![](./img/bsc_stellar_picture_3.png) + +Then on the row **Mint** events, click on the icon aligned with the **Event Count** column: + +![](./img/bsc_stellar_picture_4.png) + +We then arrive at [this page](https://explorer.bitquery.io/bsc/txs/events?contract=0x8f0fb159380176d324542b3a7933f0c2fd0c2bbf&event=85a66b9141978db9980f7e0ce3b468cebf4f7999f32b23091c5c03e798b1ba7a): + +![](./img/bsc_stellar_picture_5.png) + +You can use the **Date range** selector here to look for events in the past. In this case, we'll just look for the latest one, since that's what we're using for our example. Click the transaction link and then copy the transaction hash from the next page: + +![](./img/bsc_stellar_picture_6.png) + +To get a look into the contract call, we switch over to [BscScan](https://bscscan.com/) at this point for a better view. Search for the transaction hash and then select the event log. We will then see the output address and the amount of TFT minted in the data below: + +![](./img/bsc_stellar_picture_7.png) + +We can see that the address matches the one we decoded from the Stellar memo. As for the **tokens** amount, we need to account fo the fact that TFT uses 7 decimal places. For this reason, we move the decimal place by dividing by 1e7 (i.e. 1x10⁷): + +![](./img/bsc_stellar_picture_8.png) + +The original transaction on Stellar was for 2600 TFT, and the output after subtracting the 100 TFT bridge fee is 2500 TFT. + +## From BSC to Stellar + +Now, we will see a bridge example going from BSC to Stellar. This time, we start at the BscScan explorer. + +Here is an example bridge transaction, as seen from the account transactions view, which is the default view if you search for a wallet address: + +![](./img/BSC%20to%20Stellar1.jpeg) + +We can identify it because it's using the **Withdraw** method in a transaction to the TFT contract address on BSC. + +If we open the [Transaction Details page](https://bscscan.com/tx/0xae2a9b5cdad652ecb1e6252ee44a7f0e3c5fc9cdf1df9fddff3b0c100c4b3cb5) by clicking on the transaction hash and switch to the **Logs** view, we can see more details: + +![](./img/BSC%20to%20Stellar2.png) + +In particular, this shows us the destination address on Stellar and the TFT amount. To get the decimal form, we once again divide by 1e7 (i.e. 1x10⁷). + +Back on StellarExpert, we can find a transaction on the same date just shortly after the transaction on BSC, for the same amount of TFT minus the 1 TFT bridge fee. It originates from the bridge address on Stellar and the destination is the address we see in the contract call above: + +![](./img/BSC%20to%20Stellar3.png) + +As a final step, we double-check that the transaction we see on Stellar is actually the result of the bridge interaction we saw on BSC. It's possible, after all, that the user has sent multiple transactions with the same amount. To do this, we look at the memo on the Stellar transaction. As above, we need to convert from base 64 to hex again. To do so, we can once again use the [Base64 to HEX Converter](https://base64.guru/converter/decode/hex): + +![](./img/BSC%20to%20Stellar4.png) + +If the output hex doesn't already look familiar, you can compare it to the transaction hash from above, while remembering that `0x` is just a formatting convention indicating that hex data follows. Indeed, we can even search it on BscScan, to come full circle back to transaction details page we have seen before. + +We have made a direct link between the use of the bridge contract on BSC and the resulting payment from the bridge on Stellar. + +## Conclusion + +In this guide, we covered how to verify bridge transactions going from BSC to Stellar and from Stellar to BSC. + +In the world of public blockchains, all data is recorded and accessible, but sometimes it takes some investigation to find what we are looking for. + +If you have any questions, you can ask the ThreeFold community for help on the [ThreeFold Forum](http://forum.threefold.io/) or on the [ThreeFold Grid Tester Community](https://t.me/threefoldtesting) on Telegram. \ No newline at end of file diff --git a/collections/tfmanual/documentation/threefold_token/tft_bridges/img/BSC to Stellar1.jpeg b/collections/tfmanual/documentation/threefold_token/tft_bridges/img/BSC to Stellar1.jpeg new file mode 100644 index 0000000..4a8d7ab Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/tft_bridges/img/BSC to Stellar1.jpeg differ diff --git a/collections/tfmanual/documentation/threefold_token/tft_bridges/img/BSC to Stellar2.png b/collections/tfmanual/documentation/threefold_token/tft_bridges/img/BSC to Stellar2.png new file mode 100644 index 0000000..fe848ed Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/tft_bridges/img/BSC to Stellar2.png differ diff --git a/collections/tfmanual/documentation/threefold_token/tft_bridges/img/BSC to Stellar3.png b/collections/tfmanual/documentation/threefold_token/tft_bridges/img/BSC to Stellar3.png new file mode 100644 index 0000000..ab0c2c3 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/tft_bridges/img/BSC to Stellar3.png differ diff --git a/collections/tfmanual/documentation/threefold_token/tft_bridges/img/BSC to Stellar4.png b/collections/tfmanual/documentation/threefold_token/tft_bridges/img/BSC to Stellar4.png new file mode 100644 index 0000000..7720da1 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/tft_bridges/img/BSC to Stellar4.png differ diff --git a/collections/tfmanual/documentation/threefold_token/tft_bridges/img/bsc_stellar_picture_1.png b/collections/tfmanual/documentation/threefold_token/tft_bridges/img/bsc_stellar_picture_1.png new file mode 100644 index 0000000..a429ecd Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/tft_bridges/img/bsc_stellar_picture_1.png differ diff --git a/collections/tfmanual/documentation/threefold_token/tft_bridges/img/bsc_stellar_picture_2.png b/collections/tfmanual/documentation/threefold_token/tft_bridges/img/bsc_stellar_picture_2.png new file mode 100644 index 0000000..3594fd2 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/tft_bridges/img/bsc_stellar_picture_2.png differ diff --git a/collections/tfmanual/documentation/threefold_token/tft_bridges/img/bsc_stellar_picture_3.png b/collections/tfmanual/documentation/threefold_token/tft_bridges/img/bsc_stellar_picture_3.png new file mode 100644 index 0000000..4034630 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/tft_bridges/img/bsc_stellar_picture_3.png differ diff --git a/collections/tfmanual/documentation/threefold_token/tft_bridges/img/bsc_stellar_picture_4.png b/collections/tfmanual/documentation/threefold_token/tft_bridges/img/bsc_stellar_picture_4.png new file mode 100644 index 0000000..e0b9e59 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/tft_bridges/img/bsc_stellar_picture_4.png differ diff --git a/collections/tfmanual/documentation/threefold_token/tft_bridges/img/bsc_stellar_picture_5.png b/collections/tfmanual/documentation/threefold_token/tft_bridges/img/bsc_stellar_picture_5.png new file mode 100644 index 0000000..19706aa Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/tft_bridges/img/bsc_stellar_picture_5.png differ diff --git a/collections/tfmanual/documentation/threefold_token/tft_bridges/img/bsc_stellar_picture_6.png b/collections/tfmanual/documentation/threefold_token/tft_bridges/img/bsc_stellar_picture_6.png new file mode 100644 index 0000000..3400567 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/tft_bridges/img/bsc_stellar_picture_6.png differ diff --git a/collections/tfmanual/documentation/threefold_token/tft_bridges/img/bsc_stellar_picture_7.png b/collections/tfmanual/documentation/threefold_token/tft_bridges/img/bsc_stellar_picture_7.png new file mode 100644 index 0000000..b53b23f Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/tft_bridges/img/bsc_stellar_picture_7.png differ diff --git a/collections/tfmanual/documentation/threefold_token/tft_bridges/img/bsc_stellar_picture_8.png b/collections/tfmanual/documentation/threefold_token/tft_bridges/img/bsc_stellar_picture_8.png new file mode 100644 index 0000000..b0297fe Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/tft_bridges/img/bsc_stellar_picture_8.png differ diff --git a/collections/tfmanual/documentation/threefold_token/tft_bridges/img/tft_bridges_diagram.png b/collections/tfmanual/documentation/threefold_token/tft_bridges/img/tft_bridges_diagram.png new file mode 100644 index 0000000..b2d666f Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/tft_bridges/img/tft_bridges_diagram.png differ diff --git a/collections/tfmanual/documentation/threefold_token/tft_bridges/tfchain_stellar_bridge.md b/collections/tfmanual/documentation/threefold_token/tft_bridges/tfchain_stellar_bridge.md new file mode 100644 index 0000000..a09fd29 --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/tft_bridges/tfchain_stellar_bridge.md @@ -0,0 +1,43 @@ +

TFChain-Stellar Bridges: Main Net and Test Net

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [How to Use the TFChain-Stellar Bridge](#how-to-use-the-tfchain-stellar-bridge) +- [Bridge Fees](#bridge-fees) +- [Questions and Feedback](#questions-and-feedback) + +*** + +## Introduction + +We present here the general steps to use the TFChain-Stellar Bridge. Note that the only difference between using the Main net or Test net TFChain-Stellar bridge lies in the ThreeFold Dashboard URL. + +Read the [Dashboard section](../../dashboard/tfchain/tf_token_bridge.md) for more information. + + + +## How to Use the TFChain-Stellar Bridge + +1. Go on the ThreeFold Dashboard + 1. [Main Net](https://dashboard.grid.tf/) + 2. [Test Net](https://dashboard.test.grid.tf/) +2. Go to **TFChain** -> **TF Token Bridge** +3. 2-Way Bridge: + * Transfer TFT from Stellar to TFChain + * Click on *Deposit* + * Transfer TFT from TFChain to Stellar + * Click on *Withdraw* + +Note: If you are on ThreeFold Connect App, you can export your account to the Polkadot extension. Look at the section [Move Farm from the TF app to the TF Portal (polkadot.js)](../storing_tft/tf_connect_app.md#move-farm-from-the-tf-connect-app-to-the-tf-portal-polkadotjs). + + + +## Bridge Fees + +To learn more about the bridge fees, read [this documentation](../transaction_fees.md). + +## Questions and Feedback + +If you have any question, feel free to write a post on the [Threefold Forum](https://forum.threefold.io/). + diff --git a/collections/tfmanual/documentation/threefold_token/tft_bridges/tft_bridges.md b/collections/tfmanual/documentation/threefold_token/tft_bridges/tft_bridges.md new file mode 100644 index 0000000..509c380 --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/tft_bridges/tft_bridges.md @@ -0,0 +1,69 @@ +

TFT Bridges

+ +

Table of Contents

+ +- [TFChain-Stellar Bridge](./tfchain_stellar_bridge.md) +- [BSC-Stellar Bridge](./bsc_stellar_bridge.md) + - [BSC-Stellar Bridge Verification](./bsc_stellar_bridge_verification.md) +- [Ethereum-Stellar Bridge](./tft_ethereum/tft_ethereum.md) +- [Bridge Fees](../transaction_fees.md) + +*** + +## Introduction + +The ThreeFold Token (TFT) exists on different chains. To transfer TFTs between chains, you can use different TFT Bridges. + +The following diagram shows the different bridges and ways to transfer ThreeFold Tokens (TFT) from one chain to another. + +> Note: You can click on a given bridge to access its related guide. + +```mermaid + +graph LR + A((TFChain-MainNet)) === id1(Stellar / TFChain MainNet Bridge) === B((Stellar Chain)); + C((TFChain-TestNet)) === id2(Stellar / TFChain TestNet Bridge) === B((Stellar Chain)); + B((Stellar Chain)) === id3(Stellar / BSC Bridge) === E((Binance Smart Chain)); + B((Stellar Chain)) === id4(Stellar / Eth Bridge) === D((Ethereum Chain)); + + click id1 "./tfchain_stellar_bridge.html" + click id2 "./tfchain_stellar_bridge.html" + click id3 "./bsc_stellar_bridge.html" + click id4 "./tft_ethereum/tft_ethereum.html" + +``` + +## Links + +The links to the bridges for TFT are the following: + +* Stellar-Ethereum Bridge + * This bridge is accessible at the following link: [https://bridge.eth.threefold.io/](https://bridge.eth.threefold.io/) + * Read [this guide](./tft_ethereum/tft_ethereum.md) for more information +* Stellar-BSC Bridge + * This bridge is accessible at the following link: [https://bridge.bsc.threefold.io/](https://bridge.bsc.threefold.io/) + * Read [this guide](./bsc_stellar_bridge.html) for more information +* The TFChain Main net Bridge + * This bridge is accessible on the ThreeFold Main Net Dashboard: [https://dashboard.grid.tf/](https://dashboard.grid.tf/). + * Read [this guide](./tfchain_stellar_bridge.html) for more information +* The TFChain Test net Bridge + * This bridge is accessible on the ThreeFold Test Net Dashboard: [https://dashboard.test.grid.tf/](https://dashboard.test.grid.tf/). + * Read [this guide](./tfchain_stellar_bridge.html) for more information + +## Chains Functions + +The different bridges help you move your TFT and achieve different goals: + +* The TFChain-Stellar Bridge is used to go between the Stellar Chain and TF Chain for Main net and Test net. +* The BSC-Stellar Bridge is used to go between the Stellar Chain and Binance Smart Chain (BSC). +* The Stellar-Ethereum Bridge is used to go between the Stellar Chain and the Ethereum blockchain. + +As shown in the diagram, to go from BSC to TF Chain, or from TF Chain to BSC, you need to use first the BSC-Stellar bridge, then the Stellar-TFChain bridge. To go from the Ethereum blockchain to TFChain, you need to use the Ethereum-Stellar bridge then the Stellar-TFChain bridge. + +BSC, Stellar and Ethereum can be used to sell/buy TFT, while TFChain can be used to deploy Dapps on the [ThreeFold Dashboard](https://dashboard.grid.tf). The TFT minting process happens on Stellar Blockchain. + +> Note: You should always start with a small amount the first time you try a bridge. + +## Bridge Details + +When you bridge TFT from Stellar to another chain, the TFT on Stellar is vaulted. When you bridge TFT back to Stellar, the TFT on the other chain is burned and the vaulted TFT is released. \ No newline at end of file diff --git a/collections/tfmanual/documentation/threefold_token/tft_bridges/tft_ethereum/img/tft_on_ethereum_image_1.png b/collections/tfmanual/documentation/threefold_token/tft_bridges/tft_ethereum/img/tft_on_ethereum_image_1.png new file mode 100644 index 0000000..0db09d3 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/tft_bridges/tft_ethereum/img/tft_on_ethereum_image_1.png differ diff --git a/collections/tfmanual/documentation/threefold_token/tft_bridges/tft_ethereum/img/tft_on_ethereum_image_2.png b/collections/tfmanual/documentation/threefold_token/tft_bridges/tft_ethereum/img/tft_on_ethereum_image_2.png new file mode 100644 index 0000000..b7b21f2 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/tft_bridges/tft_ethereum/img/tft_on_ethereum_image_2.png differ diff --git a/collections/tfmanual/documentation/threefold_token/tft_bridges/tft_ethereum/img/tft_on_ethereum_image_3.png b/collections/tfmanual/documentation/threefold_token/tft_bridges/tft_ethereum/img/tft_on_ethereum_image_3.png new file mode 100644 index 0000000..85b01b2 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/tft_bridges/tft_ethereum/img/tft_on_ethereum_image_3.png differ diff --git a/collections/tfmanual/documentation/threefold_token/tft_bridges/tft_ethereum/img/tft_on_ethereum_image_4.png b/collections/tfmanual/documentation/threefold_token/tft_bridges/tft_ethereum/img/tft_on_ethereum_image_4.png new file mode 100644 index 0000000..753c0dd Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/tft_bridges/tft_ethereum/img/tft_on_ethereum_image_4.png differ diff --git a/collections/tfmanual/documentation/threefold_token/tft_bridges/tft_ethereum/img/tft_on_ethereum_image_5.png b/collections/tfmanual/documentation/threefold_token/tft_bridges/tft_ethereum/img/tft_on_ethereum_image_5.png new file mode 100644 index 0000000..073a4a7 Binary files /dev/null and b/collections/tfmanual/documentation/threefold_token/tft_bridges/tft_ethereum/img/tft_on_ethereum_image_5.png differ diff --git a/collections/tfmanual/documentation/threefold_token/tft_bridges/tft_ethereum/tft_ethereum.md b/collections/tfmanual/documentation/threefold_token/tft_bridges/tft_ethereum/tft_ethereum.md new file mode 100644 index 0000000..def5d6a --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/tft_bridges/tft_ethereum/tft_ethereum.md @@ -0,0 +1,36 @@ +

Ethereum-Stellar Bridge

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [How to Use the Ethereum-Stellar Bridge](#how-to-use-the-ethereum-stellar-bridge) +- [Bridge Fees](#bridge-fees) +- [Questions and Feedback](#questions-and-feedback) + +*** + +## Introduction + +The TFT Stellar-Ethereum bridge serves as a vital link between the Stellar and Ethereum blockchains, enabling the seamless transfer of TFT tokens between these two networks. This bridge enhances interoperability and expands the utility of TFT by allowing users to leverage the strengths of both platforms. With the bridge in place, TFT holders can convert their tokens from the Stellar network to the Ethereum network and vice versa, unlocking new possibilities for engagement with decentralized applications, smart contracts, and the vibrant Ethereum ecosystem. This bridge promotes liquidity, facilitates cross-chain transactions, and encourages collaboration between the Stellar and Ethereum communities. + + + +## How to Use the Ethereum-Stellar Bridge + +The easiest way to transfer TFT between Ethereum and Stellar is to use the [TFT Ethereum Bridge](https://bridge.eth.threefold.io). We present here the main steps on how to use this bridge. + +When you go to the [TFT Ethereum-Stellar bridge website](https://bridge.eth.threefold.io/), connect your Ethereum wallet. Then the bridge will present a QR code which you scan with your Stellar wallet. This will populate a transaction with the bridge wallet as the destination and an encoded form of your Ethereum address as the memo. The bridge will scan the transaction, decode the Ethereum wallet address, and deliver newly minted TFT on Ethereum, minus the bridge fees. + +For the reverse operation, going from Ethereum to Stellar, there is a smart contract interaction that burns TFT on Ethereum while embedding your Stellar wallet address. The bridge will scan that transaction and release TFT from its vault wallet to the specified Stellar address, again minus the bridge fees. + +Note that the contract address for TFT on Ethereum is the following: `0x395E925834996e558bdeC77CD648435d620AfB5b`. + +To see the ThreeFold Token on Etherscan, check [this link](https://etherscan.io/token/0x395E925834996e558bdeC77CD648435d620AfB5b). + +## Bridge Fees + +To learn more about the bridge fees, read [this documentation](../../transaction_fees.md). + +## Questions and Feedback + +If you have any question, feel free to write a post on the [Threefold Forum](https://forum.threefold.io/). \ No newline at end of file diff --git a/collections/tfmanual/documentation/threefold_token/tft_intro.md b/collections/tfmanual/documentation/threefold_token/tft_intro.md new file mode 100644 index 0000000..2472a94 --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/tft_intro.md @@ -0,0 +1,13 @@ +# An Introduction to the ThreeFold Token (TFT) + +ThreeFold tokens, or TFTs, are exclusively generated when new capacity is added to the TF Grid. There are no centralized issuers. Tokens have not been created out of thin air. + +While the ThreeFold Grid can expand, a maximum of 4 Billion TFTs can ever be in circulation. This limit ensures stability of value and incentivization for all stakeholders. + +TFT lives on the Stellar Blockchain. TFT holders benefit from a big ecosystem of proven wallets and mediums of exchange. + +By employing Stellar technology, TFT transactions and smart contracts are powered by one of the most energy-efficient blockchains available. Furthermore, TFT is the medium of exchange on the greenest internet network in the world. The market for farming, cultivating and trading TFT is open to all. + +Anyone with internet connection, power supply and necessary hardware can become a Farmer or trade ThreeFold tokens (TFT). + +By farming, buying, holding, and utilizing ThreeFold Tokens, you are actively supporting the expansion of the ThreeFold Grid and its use cases — creating a more sustainable, fair, and equally accessible Internet. \ No newline at end of file diff --git a/collections/tfmanual/documentation/threefold_token/threefold_token.md b/collections/tfmanual/documentation/threefold_token/threefold_token.md new file mode 100644 index 0000000..de0079f --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/threefold_token.md @@ -0,0 +1,95 @@ +

ThreeFold Token

+ +

Table of Contents

+ +- [Introduction to TFT](#introduction-to-tft) +- [Chains with TFT](#chains-with-tft) +- [TFT Contract Addresses on Chains](#tft-contract-addresses-on-chains) +- [Bridges Between Chains](#bridges-between-chains) +- [Storing TFT](#storing-tft) +- [Buy and Sell TFT](#buy-and-sell-tft) +- [Liquidity Provider (LP)](#liquidity-provider-lp) +- [Transaction Fees](#transaction-fees) +- [Deploy on the TFGrid with TFT](#deploy-on-the-tfgrid-with-tft) +- [Disclaimer](#disclaimer) + +*** + +## Introduction to TFT + +The ThreeFold Token (TFT) is a decentralized digital currency used to buy autonomous and decentralized Internet services (compute, storage, and application) on the ThreeFold Grid. + +ThreeFold Tokens are generated through a process called “Farming”. Farming happens when active internet capacity is added to the ThreeFold Grid. Independent farmers earn ThreeFold Tokens (TFT) by providing neutral and decentralized internet capacity, thus expending the usable TF Grid. Therefore no central entity controls the internet. + +> [Get an overview of the ThreeFold token](../../knowledge_base/about/token_overview/token_overview.md) + +## Chains with TFT + +TFT lives on 4 different chains: TFChain, Stellar chain, Ethereum chain and Binance Smart Chain. + +- TFT are minted on the Stellar chain. +- TFT are used to deploy workloads on TFChain. +- TFT can be transacted on Ethereum chain, Binance Smart Chain and Stellar chain. + +## TFT Contract Addresses on Chains + +The TFT contract address on different chains are the following: + +- [TFT Contract address on Stellar](https://stellarchain.io/assets/TFT-GBOVQKJYHXRR3DX6NOX2RRYFRCUMSADGDESTDNBDS6CDVLGVESRTAC47) + - ``` + TFT-GBOVQKJYHXRR3DX6NOX2RRYFRCUMSADGDESTDNBDS6CDVLGVESRTAC47 + ``` +- [TFT Contract address on Ethereum](https://etherscan.io/token/0x395E925834996e558bdeC77CD648435d620AfB5b) + - ``` + 0x395E925834996e558bdeC77CD648435d620AfB5b + ``` +- [TFT Contract address on BSC](https://bscscan.com/address/0x8f0FB159380176D324542b3a7933F0C2Fd0c2bbf) + - ``` + 0x8f0FB159380176D324542b3a7933F0C2Fd0c2bbf + ``` + +## Bridges Between Chains + +[Bridges](./tft_bridges/tft_bridges.md) are available to easily navigate between the chains. + +- [TFChain-Stellar Bridge](./tft_bridges/tfchain_stellar_bridge.html) +- [BSC-Stellar Bridge](./tft_bridges/bsc_stellar_bridge.html) +- [Ethereum-Stellar Bridge](./tft_bridges/tft_ethereum/tft_ethereum.html) + +## Storing TFT + +There are many ways to store TFT. The [TF Connect app wallet](./storing_tft/tf_connect_app.md) and a [hardwallet wallet](./storing_tft/hardware_wallet.md) are two of the many possibilities. + +> [Easily Store TFT](./storing_tft/storing_tft.md) + +## Buy and Sell TFT + +You can [buy and sell TFT](./buy_sell_tft/buy_sell_tft.md) with cryptocurrencies on Stellar Chain, Ethereum Chain and BNB Smart Chain. + +Using Lobstr is very effective to buy TFT with fiat or crypto in no time: + +> [Get TFT: Quick Guide](./buy_sell_tft/tft_lobstr/tft_lobstr_short_guide.md) + +## Liquidity Provider (LP) + +A liquidity provider (LP) is an individual or entity that contributes liquidity to a decentralized exchange or automated market maker (AMM) platform + +> [Become a Liquidity Provider](./liquidity/liquidity_readme.md) + +## Transaction Fees + +Each time transactions are done on chains, transaction fees apply. + +> Learn about [Transaction Fees](./transaction_fees.md) + +## Deploy on the TFGrid with TFT + +You can do almost anything on the TFGrid: as long as you're doing Linux stuff, ZOS got your back! + +> [Get Started on the TFGrid](../system_administrators/getstarted/tfgrid3_getstarted.md) + +## Disclaimer + +> The information provided in this tutorial or any related discussion is not intended as investment advice. The purpose is to provide educational and informational content only. Investing in cryptocurrencies or any other assets carries inherent risks, and it is crucial to conduct your own research and exercise caution before making any investment decisions. +> +> **The ThreeFold Token (TFT)** is not to be considered as a traditional investment instrument. The value of cryptocurrencies can be volatile, and there are no guarantees of profits or returns. Always be aware of the risks involved and make informed choices based on your own assessment and understanding. We strongly encourage you to read our [full disclaimer](../../knowledge_base/legal/disclaimer.md) and seek advice from a qualified financial professional if needed. \ No newline at end of file diff --git a/collections/tfmanual/documentation/threefold_token/transaction_fees.md b/collections/tfmanual/documentation/threefold_token/transaction_fees.md new file mode 100644 index 0000000..0684559 --- /dev/null +++ b/collections/tfmanual/documentation/threefold_token/transaction_fees.md @@ -0,0 +1,56 @@ +

TFT Transaction Fees

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Bridge Fees](#bridge-fees) +- [Chain Fees](#chain-fees) +- [Notes](#notes) + +*** + +## Introduction + +Here are the TFT transaction fees. Note that these values can be subject to change. We will do our best to update this section of the manual as needed. + +## Bridge Fees + +The following are the fees for each type of bridge transfer. + +- BSC-Stellar bridge + - From Stellar to BSC + - 100 TFT + - From BSC to Stellar + - 1 TFT +- Eth-Stellar bridge + - From Stellar to Eth + - 2000 TFT + - From Eth to Stellar + - 1 TFT +- TFChain-Stellar bridge + - From Stellar to TFChain + - 1 TFT + - From TFChain to Stellar + - 1 TFT + +## Chain Fees + +The following are the transaction fees for each chain. Every time a transaction is done on a given chain, there are fees for the operation on chain. + +- Stellar chain + - 0.01 TFT +- TFChain + - 0.001 TFT +- Ethereum chain + - Fees are the gas price + - Consult the Ethereum official documentation for more details +- BSC + - Fees are the gas price + - Consult the BSC official documentation for more details + +## Notes + +Here are some notes to take into account when doing TFT transfers: + +* The fees paid directly by the users will be shown in the user's wallet at transaction time, not on the bridge page. +* The bridge fees can vary based on current on-chain gas prices. The current fee will always be shown on the bridge page before a transaction is initiated. \ No newline at end of file diff --git a/collections/tfmanual/intro/img/intro_header.png b/collections/tfmanual/intro/img/intro_header.png new file mode 100644 index 0000000..2944708 Binary files /dev/null and b/collections/tfmanual/intro/img/intro_header.png differ diff --git a/collections/tfmanual/intro/intro_readme.md b/collections/tfmanual/intro/intro_readme.md new file mode 100644 index 0000000..1b136eb --- /dev/null +++ b/collections/tfmanual/intro/intro_readme.md @@ -0,0 +1,33 @@ +# ThreeFold Grid Manual + +*Welcome to the ThreeFold Manual!* + +This manual is organized in two main sections: + +- [ThreeFold Knowledge Base](../knowledge_base/knowledge_base.md) +- [ThreeFold Documentation](../documentation/documentation.md) + +The *ThreeFold Knowledge Base* section contains all information needed to understand how the whole ThreeFold ecosystem works. + +The *ThreeFold Documentation* section contains all the practical information of the ThreeFold Grid, from general information covering the multi-functional [Dashboard](../documentation/dashboard/dashboard.md), [TFT](../documentation/threefold_token/threefold_token.md) and our community-based [FAQ](../documentation/faq/faq.md), to specific tutorials for [developers](../documentation/developers/developers.md), [farmers](../documentation/farmers/farmers.md) and [system administrators](../documentation/system_administrators/system_administrators.md). + +> Explore the TFGrid status page for live updates on Threefold services! +> +> [Access with Grid.tf](https://status.grid.tf) | [Access with ThreeFold.io](https://status.threefold.io) + +## Join the ThreeFold Community + +The ThreeFold community is very active and its members will be more than happy to discuss and help you get started. + +* [ThreeFold Forum](https://forum.threefold.io/) +* [ThreeFold General Telegram Channel](https://t.me/threefold) +* [ThreeFold Farmer Telegram Channel](https://t.me/threefoldfarmers) +* [TFGrid Tester Telegram Channel](https://t.me/threefoldtesting) + +## Questions and Feedback + +To explore this manual, you can use the search function by hitting **'s'** on your keyboard, or by clicking on the magnifier button at the top left of each page. Answers to your questions might also be on the [ThreeFold Forum](https://forum.threefold.io/). + +If you can't find the answer to your question, our dedicated [ThreeFold Support](https://threefoldfaq.crisp.help/en/) team is here to help. + +*Welcome to the ThreeFold Grid, where together we can shape a more sustainable, self-sovereign and autonomous digital future!* diff --git a/collections/tfmanual/knowledge_base/about/about.md b/collections/tfmanual/knowledge_base/about/about.md new file mode 100644 index 0000000..ba76824 --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/about.md @@ -0,0 +1,13 @@ +

About

+ +This section of the manual covers information about ThreeFold, its history, its roadmap, its vision and more. + +It's a good place to start if you want to have an overview of ThreeFold since its beginning. + +

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 diff --git a/collections/tfmanual/knowledge_base/about/bettertoken.md b/collections/tfmanual/knowledge_base/about/bettertoken.md new file mode 100644 index 0000000..81ff291 --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/bettertoken.md @@ -0,0 +1,33 @@ +

BetterToken NV

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Income](#income) +- [Structure](#structure) +- [Expected Changes](#expected-changes) + +*** + +## Introduction + +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 +- Sale of small servers to TF Farmers, was done mainly via an online webshop + +## Income + +- Hosting fees for the maintenance & running of the farmer pool + +## Structure + +- Started 30 November 2016 +- [limited liable company in belgium](http://www.ejustice.just.fgov.be/tsv_pdf/2016/11/30/16324281.pdf) +- Peter Van der Henst is the managing director + +## Expected Changes + +BetterToken continues to be farming cooperative for Europe. Right now there is not much happening in BetterToken. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/about/dao/dao.md b/collections/tfmanual/knowledge_base/about/dao/dao.md new file mode 100644 index 0000000..61f6568 --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/dao/dao.md @@ -0,0 +1,55 @@ +

DAO

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Overview of a DAO](#overview-of-a-dao) +- [Comparisons](#comparisons) +- [DAO Rules](#dao-rules) +- [DAO and Blockchain](#dao-and-blockchain) + +*** + +## Introduction + +We present the main concept of a DAO. + +A DAO is a decentralized autonomous organization. To be more precise, this means the following: + +- Decentralized = Online, global, uncensorable. +- Autonomous = Self-governing. +- Organization = Coordination & collaboration around shared objectives. + +## Overview of a DAO + +DAOs are an effective and safe way to work with like-minded folks around the globe. + +Think of them like an internet-native business that's collectively owned and managed by its members. They have built-in treasuries that no one has the authority to access without the approval of the group. Decisions are governed by proposals and voting to ensure everyone in the organization has a voice. + +This opens up so many new opportunities for global collaboration and coordination. + +DAOs operate using smart contracts, which are essentially chunks of code that automatically execute whenever a set of criteria are met. These smart contracts establish the DAO’s rules. Those with a stake in a DAO then get voting rights and may influence how the organization operates by deciding on or creating new governance proposals. + +## Comparisons + +The following table provides some comparisons between a DAO and a traditional organization. + +| DAO | A traditional organization | +| ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | +| Usually flat, and fully democratized. | Usually hierarchical. | +| Voting required by members for any changes to be implemented. | Depending on structure, changes can be demanded from a sole party, or voting may be offered. | +| Votes tallied, and outcome implemented automatically without trusted intermediary. | If voting is allowed, votes are tallied internally, and the outcome of voting must be handled manually. | +| Services offered are handled automatically in a decentralized manner (for example distribution of philanthropic funds). | Requires human handling, or centrally controlled automation, prone to manipulation. | +| All activity is transparent and fully public. | Requires human handling, or centrally controlled automation, prone to manipulation. | + +*Info from https://ethereum.org/en/dao/, picture from https://cointelegraph.com/ethereum-for-beginners* + +## DAO Rules + +Decentralized autonomous organization (DAO), is an organization represented by rules encoded as a computer program that is transparent, controlled by the organization members and not influenced by a central government. A DAO's financial and voting transaction record and program rules are maintained on a blockchain. + +## DAO and Blockchain + +Decentralized autonomous organizations are typified by the use of blockchain technology to provide a secure digital ledger to track financial and other community interactions across the internet, hardened against forgery by trusted timestamping and dissemination of a distributed database. This approach eliminates the need to involve a mutually acceptable trusted third party in a transaction, simplifying the transaction. The costs of a blockchain-enabled transaction and of the associated data reporting may be substantially offset by the elimination of both the trusted third party and of the need for repetitive recording of contract exchanges in different records. For example, the blockchain data could, in principle and if regulatory structures permit it, replace public documents such as deeds and titles. In theory, a blockchain approach allows multiple cloud computing users to enter a loosely coupled peer-to-peer smart contract collaboration. + +*Info from [here](https://en.wikipedia.org/wiki/Decentralized_autonomous_organization)* \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/about/dao/dao_info.md b/collections/tfmanual/knowledge_base/about/dao/dao_info.md new file mode 100644 index 0000000..19aa1f8 --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/dao/dao_info.md @@ -0,0 +1,33 @@ + +![](img/dao_whatis_.jpg) + + +- Decentralized = Online, global, uncensorable. +- Autonomous = Self-governing. +- Organization = Coordination & collaboration around shared objectives. + +DAOs are an effective and safe way to work with like-minded folks around the globe. + +Think of them like an internet-native business that's collectively owned and managed by its members. They have built-in treasuries that no one has the authority to access without the approval of the group. Decisions are governed by proposals and voting to ensure everyone in the organization has a voice. + +This opens up so many new opportunities for global collaboration and coordination. + +DAOs operate using smart contracts, which are essentially chunks of code that automatically execute whenever a set of criteria are met. These smart contracts establish the DAO’s rules. Those with a stake in a DAO then get voting rights and may influence how the organization operates by deciding on or creating new governance proposals. + + +| DAO | A traditional organization | +| ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | +| Usually flat, and fully democratized. | Usually hierarchical. | +| Voting required by members for any changes to be implemented. | Depending on structure, changes can be demanded from a sole party, or voting may be offered. | +| Votes tallied, and outcome implemented automatically without trusted intermediary. | If voting is allowed, votes are tallied internally, and the outcome of voting must be handled manually. | +| Services offered are handled automatically in a decentralized manner (for example distribution of philanthropic funds). | Requires human handling, or centrally controlled automation, prone to manipulation. | +| All activity is transparent and fully public. | Requires human handling, or centrally controlled automation, prone to manipulation. | + +*Info from https://ethereum.org/en/dao/, picture from https://cointelegraph.com/ethereum-for-beginners* + +Decentralized autonomous organization (DAO), is an organization represented by rules encoded as a computer program that is transparent, controlled by the organization members and not influenced by a central government. A DAO's financial and voting transaction record and program rules are maintained on a blockchain. + +Decentralized autonomous organizations are typified by the use of blockchain technology to provide a secure digital ledger to track financial and other community interactions across the internet, hardened against forgery by trusted timestamping and dissemination of a distributed database. This approach eliminates the need to involve a mutually acceptable trusted third party in a transaction, simplifying the transaction. The costs of a blockchain-enabled transaction and of the associated data reporting may be substantially offset by the elimination of both the trusted third party and of the need for repetitive recording of contract exchanges in different records. For example, the blockchain data could, in principle and if regulatory structures permit it, replace public documents such as deeds and titles. In theory, a blockchain approach allows multiple cloud computing users to enter a loosely coupled peer-to-peer smart contract collaboration. + + + diff --git a/collections/tfmanual/knowledge_base/about/dao/dao_more_info.md b/collections/tfmanual/knowledge_base/about/dao/dao_more_info.md new file mode 100644 index 0000000..dc6599e --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/dao/dao_more_info.md @@ -0,0 +1,6 @@ +### More Info: + +- [ThreeFold DAO](@tfdao). +- [Why are DAO's important](@dao_why) +- [ThreeFold Validators](@validators_faq). +- [Decentralization Info](@decentralization). diff --git a/collections/tfmanual/knowledge_base/about/dao/dao_why.md b/collections/tfmanual/knowledge_base/about/dao/dao_why.md new file mode 100644 index 0000000..c5884f1 --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/dao/dao_why.md @@ -0,0 +1,97 @@ +# What is a decentralized autonomous organization, and how does a DAO work? + +![](img/dao_whatis_.jpg) + +A decentralized autonomous organization (DAO) is an entity with no central leadership. Decisions get made from the bottom-up, governed by a community organized around a specific set of rules enforced on a blockchain. + +DAOs are internet-native organizations collectively owned and managed by their members. They have built-in treasuries that are only accessible with the approval of their members. Decisions are made via proposals the group votes on during a specified period. + +A DAO works without hierarchical management and can have a large number of purposes. Freelancer networks where contracts pool their funds to pay for software subscriptions, charitable organizations where members approve donations and venture capital firms owned by a group are all possible with these organizations. + +Before moving on, it’s important to distinguish a DAO, an internet-native organization, from The DAO, one of the first such organizations ever created. The DAO was a project founded in 2016 that ultimately failed and led to a dramatic split of the Ethereum network. + +## How does a DAO work? + +As mentioned above, a DAO is an organization where decisions get made from the bottom-up; a collective of members owns the organization. There are various ways to participate in a DAO, usually through the ownership of a token. + +DAOs operate using smart contracts, which are essentially chunks of code that automatically execute whenever a set of criteria are met. Smart contracts are deployed on numerous blockchains nowadays, though Ethereum was the first to use them. + +These smart contracts establish the DAO’s rules. Those with a stake in a DAO then get voting rights and may influence how the organization operates by deciding on or creating new governance proposals. + +This model prevents DAOs from being spammed with proposals: A proposal will only pass once the majority of stakeholders approve it. How that majority is determined varies from DAO to DAO and is specified in the smart contracts. + +DAOs are fully autonomous and transparent. As they are built on open-source blockchains, anyone can view their code. Anyone can also audit their built-in treasuries, as the blockchain records all financial transactions. + +Typically, a DAO launch occurs in three major steps +Smart contract creation: First, a developer or group of developers must create the smart contract behind the DAO. After launch, they can only change the rules set by these contracts through the governance system. That means they must extensively test the contracts to ensure they don’t overlook important details. + +Funding: After the smart contracts have been created, the DAO needs to determine a way to receive funding and how to enact governance. More often than not, tokens are sold to raise funds; these tokens give holders voting rights. + +Deployment: Once everything is set up, the DAO needs to be deployed on the blockchain. From this point on, stakeholders decide on the future of the organization. The organization’s creators — those who wrote the smart contracts — no longer influence the project any more than other stakeholders. + +## Why do we need DAOs? + +Being internet-native organizations, DAOs have several advantages over traditional organizations. One significant advantage of DAOs is the lack of trust needed between two parties. While a traditional organization requires a lot of trust in the people behind it — especially on behalf of investors — with DAOs, only the code needs to be trusted. + +Trusting that code is easier to do as it’s publicly available and can be extensively tested before launch. Every action a DAO takes after being launched has to be approved by the community and is completely transparent and verifiable. + +Such an organization has no hierarchical structure. Yet, it can still accomplish tasks and grow while being controlled by stakeholders via its native token. The lack of a hierarchy means any stakeholder can put forward an innovative idea that the entire group will consider and improve upon. Internal disputes are often easily solved through the voting system, in line with the pre-written rules in the smart contract. + +By allowing investors to pool funds, DAOs also give them a chance to invest in early-stage startups and decentralized projects while sharing the risk or any profits that may come out of them. + +## The principal-agent dilemma + +The main advantage of DAOs is that they offer a solution to the principal-agent dilemma. This dilemma is a conflict in priorities between a person or group (the principal) and those making decisions and acting on their behalf (the agent). + +Problems can occur in some situations, with a common one being in the relationship between stakeholders and a CEO. The agent (the CEO) may work in a way that’s not in line with the priorities and goals determined by the principal (the stakeholders) and instead act in their own self-interest. + +Another typical example of the principal-agent dilemma occurs when the agent takes excessive risk because the principal bears the burden. For example, a trader can use extreme leverage to chase a performance bonus, knowing the organization will cover any downside. + +DAOs solve the principal-agent dilemma through community governance. Stakeholders aren’t forced to join a DAO and only do so after understanding the rules that govern it. They don’t need to trust any agent acting on their behalf and instead work as part of a group whose incentives are aligned. + +Token holders’ interests align as the nature of a DAO incentivizes them not to be malicious. Since they have a stake in the network, they will want to see it succeed. Acting against it would be acting against their self-interests. + +## What was The DAO? + +The DAO was an early iteration of modern decentralized autonomous organizations. It was launched back in 2016 and designed to be an automated organization that acted as a form of venture capital fund. + +Those who owned DAO tokens could profit from the organization’s investments by either reaping dividends or benefitting from price appreciation of the tokens. The DAO was initially seen as a revolutionary project and raised $150 million in Ether (ETH), one of the greatest crowdfunding efforts of the time. + +The DAO launched on April 30, 2016, after Ethereum protocol engineer Christoph Jentzsch released the open-source code for an Ethereum-based investment organization. Investors bought DAO tokens by moving Ether to its smart contracts. + +A few days into the token sale, some developers expressed concerns that a bug in The DAO’s smart contracts could allow malicious actors to drain its funds. While a governance proposal was set forth to fix the bug, an attacker took advantage of it and siphoned over $60 million worth of ETH from The DAO’s wallet. + +At the time, around 14% of all ETH in circulation was invested in The DAO. The hack was a significant blow to DAOs in general and the then one-year-old Ethereum network. A debate within the Ethereum community ensued as everyone scrambled to figure out what to do. Initially, Ethereum co-founder Vitalik Buterin proposed a soft fork that would blacklist the attacker’s address and prevent them from moving the funds. + +The attacker or someone posing as them then responded to that proposal, claiming the funds had been obtained in a “legal” way according to the smart contract’s rules. They claimed they were ready to take legal action against anyone who tried to seize the funds. + +The hacker even threatened to bribe ETH miners with some of the stolen funds to thwart a soft fork attempt. In the debate that ensued, a hard fork was determined to be the solution. That hard fork was implemented to roll back the Ethereum network’s history to before The DAO was hacked and reallocate the stolen funds to a smart contract that allowed investors to withdraw them. Those who disagreed with the move rejected the hard fork and supported an earlier version of the network, known as Ethereum Classic (ETC). + +## Disadvantages of DAOs + +Decentralized autonomous organizations aren’t perfect. They are an extremely new technology that has attracted much criticism due to lingering concerns regarding their legality, security and structure. + +MIT Technology Review has, for example, revealed it considers it a bad idea to trust the masses with important financial decisions. While MIT shared its thoughts back in 2016, the organization appears to have never changed its mind on DAOs — at not least publicly. The DAO hack also raised security concerns, as flaws in smart contracts can be hard to fix even after they are spotted. + +DAOs can be distributed across multiple jurisdictions, and there’s no legal framework for them. Any legal issues that may arise will likely require those involved to deal with numerous regional laws in a complicated legal battle. + +In July 2017, for example, the United States Securities and Exchange Commission issued a report in which it determined that The DAO sold securities in the form of tokens on the Ethereum blockchain without authorization, violating portions of securities law in the country. + +## Examples of DAOs + +Decentralized autonomous organizations have gained traction over the last few years and are now fully incorporated into many blockchain projects. The decentralized finance (DeFi) space uses DAOs to allow applications to become fully decentralized, for example. + +To some, the Bitcoin (BTC) network is the earliest example of a DAO there is. The network scales via community agreement, even though most network participants have never met each other. It also does not have an organized governance mechanism, and instead, miners and nodes have to signal support. + +However, Bitcoin is not seen as a DAO by today’s standards. By current measures, Dash would be the first true DAO, as the project has a governance mechanism that allows stakeholders to vote on the use of its treasury. + +Other, more advanced DAOs, including decentralized networks built on top of the Ethereum blockchain, are responsible for launching cryptocurrency-backed stablecoins. In some cases, the organizations that initially launched these DAOs slowly give away control of the project to one day become irrelevant. Token holders can actively vote on governance proposals to hire new contributors, add new tokens as collateral for their coins or adjust other parameters. + +In 2020, a DeFi lending protocol launched its own governance token and distributed it through a liquidity mining process. Essentially, anyone who interacted with the protocol would receive tokens as a reward. Other projects have since replicated and adapted the model. + +Now, the list of DAOs is extensive. Over time, it has become a clear concept that has been gaining traction. Some projects are still looking to achieve complete decentralization through the DAO model, but it’s worth pointing out they are only a few years old and have yet to achieve their final goals and objectives. + +As internet-native organizations, DAOs have the potential to change the way corporate governance works completely. While the concept matures and the legal gray area they operate in is cleared, more and more organizations may adopt a DAO model to help govern some of their activities. + + +> info from: https://cointelegraph.com/ethereum-for-beginners/what-is-a-decentralized-autonomous-organization-and-how-does-a-dao-work diff --git a/collections/tfmanual/knowledge_base/about/dao/gep.md b/collections/tfmanual/knowledge_base/about/dao/gep.md new file mode 100644 index 0000000..d63a0a2 --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/dao/gep.md @@ -0,0 +1,14 @@ +# Grid Enhancement Proposal + +![](img/gep.png) + +GEP stands for Grid Enhancement Proposal. A GEP is a design document providing information to the ThreeFold community, or describing a new feature for the TFGrid or its processes or environment. The GEP should provide a concise technical specification of the feature and a rationale for the feature. + +- A GEP gets registered in TFChain. TFDAO makes this possible +- Community has to approve or not a GEP +- Once enough consensus achieved the GEP will be executed upon, whereas "consensus" is a variable % per GEP and will be defined when sepcs are ready. +- Validator Nodes of our L1 TFChain will make sure GEP is properly implemented and consensus also achieved on that level. + +*some inspiration comes from https://www.python.org/dev/peps/pep-0001* + +!!!def alias:gep diff --git a/collections/tfmanual/knowledge_base/about/dao/img/dao_whatis_.jpg b/collections/tfmanual/knowledge_base/about/dao/img/dao_whatis_.jpg new file mode 100644 index 0000000..0b99259 Binary files /dev/null and b/collections/tfmanual/knowledge_base/about/dao/img/dao_whatis_.jpg differ diff --git a/collections/tfmanual/knowledge_base/about/dao/img/gep.png b/collections/tfmanual/knowledge_base/about/dao/img/gep.png new file mode 100644 index 0000000..dc20ecf Binary files /dev/null and b/collections/tfmanual/knowledge_base/about/dao/img/gep.png differ diff --git a/collections/tfmanual/knowledge_base/about/dao/tfdao.md b/collections/tfmanual/knowledge_base/about/dao/tfdao.md new file mode 100644 index 0000000..79020b5 --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/dao/tfdao.md @@ -0,0 +1,138 @@ +

ThreeFold DAO

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [DAO Tasks](#dao-tasks) +- [What is a DAO?](#what-is-a-dao) +- [How does a DAO work?](#how-does-a-dao-work) +- [Why do we need DAOs?](#why-do-we-need-daos) +- [The principal-agent dilemma](#the-principal-agent-dilemma) +- [What was The DAO?](#what-was-the-dao) +- [Disadvantages of DAOs](#disadvantages-of-daos) +- [Examples of DAOs](#examples-of-daos) + +*** + +## Introduction + +The ThreeFold DAO allows autonomous operation of the TFChain and TFGrid. + +## DAO Tasks + +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 | + +As well as + +- distribution of TFT grants +- manage code upgrade of TFChain and ZOS +- approval for changes to anything in our ecosystem, by means of GEP e.g. + - changes to tokenomics e.g. changes related to + - farming rewards + - cultivation flows + - pricing of grid capacity + - new features in TFChain + - rewards for sales channels, solution providers (v3.2+) + +## What is a DAO? + +A decentralized autonomous organization (DAO) is an entity with no central leadership. Decisions get made from the bottom-up, governed by a community organized around a specific set of rules enforced on a blockchain. + +DAOs are internet-native organizations collectively owned and managed by their members. They have built-in treasuries that are only accessible with the approval of their members. Decisions are made via proposals the group votes on during a specified period. + +A DAO works without hierarchical management and can have a large number of purposes. Freelancer networks where contracts pool their funds to pay for software subscriptions, charitable organizations where members approve donations and venture capital firms owned by a group are all possible with these organizations. + +Before moving on, it’s important to distinguish a DAO, an internet-native organization, from The DAO, one of the first such organizations ever created. The DAO was a project founded in 2016 that ultimately failed and led to a dramatic split of the Ethereum network. + +## How does a DAO work? + +As mentioned above, a DAO is an organization where decisions get made from the bottom-up; a collective of members owns the organization. There are various ways to participate in a DAO, usually through the ownership of a token. + +DAOs operate using smart contracts, which are essentially chunks of code that automatically execute whenever a set of criteria are met. Smart contracts are deployed on numerous blockchains nowadays, though Ethereum was the first to use them. + +These smart contracts establish the DAO’s rules. Those with a stake in a DAO then get voting rights and may influence how the organization operates by deciding on or creating new governance proposals. + +This model prevents DAOs from being spammed with proposals: A proposal will only pass once the majority of stakeholders approve it. How that majority is determined varies from DAO to DAO and is specified in the smart contracts. + +DAOs are fully autonomous and transparent. As they are built on open-source blockchains, anyone can view their code. Anyone can also audit their built-in treasuries, as the blockchain records all financial transactions. + +Typically, a DAO launch occurs in three major steps +Smart contract creation: First, a developer or group of developers must create the smart contract behind the DAO. After launch, they can only change the rules set by these contracts through the governance system. That means they must extensively test the contracts to ensure they don’t overlook important details. + +Funding: After the smart contracts have been created, the DAO needs to determine a way to receive funding and how to enact governance. More often than not, tokens are sold to raise funds; these tokens give holders voting rights. + +Deployment: Once everything is set up, the DAO needs to be deployed on the blockchain. From this point on, stakeholders decide on the future of the organization. The organization’s creators — those who wrote the smart contracts — no longer influence the project any more than other stakeholders. + +## Why do we need DAOs? + +Being internet-native organizations, DAOs have several advantages over traditional organizations. One significant advantage of DAOs is the lack of trust needed between two parties. While a traditional organization requires a lot of trust in the people behind it — especially on behalf of investors — with DAOs, only the code needs to be trusted. + +Trusting that code is easier to do as it’s publicly available and can be extensively tested before launch. Every action a DAO takes after being launched has to be approved by the community and is completely transparent and verifiable. + +Such an organization has no hierarchical structure. Yet, it can still accomplish tasks and grow while being controlled by stakeholders via its native token. The lack of a hierarchy means any stakeholder can put forward an innovative idea that the entire group will consider and improve upon. Internal disputes are often easily solved through the voting system, in line with the pre-written rules in the smart contract. + +By allowing investors to pool funds, DAOs also give them a chance to invest in early-stage startups and decentralized projects while sharing the risk or any profits that may come out of them. + +## The principal-agent dilemma + +The main advantage of DAOs is that they offer a solution to the principal-agent dilemma. This dilemma is a conflict in priorities between a person or group (the principal) and those making decisions and acting on their behalf (the agent). + +Problems can occur in some situations, with a common one being in the relationship between stakeholders and a CEO. The agent (the CEO) may work in a way that’s not in line with the priorities and goals determined by the principal (the stakeholders) and instead act in their own self-interest. + +Another typical example of the principal-agent dilemma occurs when the agent takes excessive risk because the principal bears the burden. For example, a trader can use extreme leverage to chase a performance bonus, knowing the organization will cover any downside. + +DAOs solve the principal-agent dilemma through community governance. Stakeholders aren’t forced to join a DAO and only do so after understanding the rules that govern it. They don’t need to trust any agent acting on their behalf and instead work as part of a group whose incentives are aligned. + +Token holders’ interests align as the nature of a DAO incentivizes them not to be malicious. Since they have a stake in the network, they will want to see it succeed. Acting against it would be acting against their self-interests. + +## What was The DAO? + +The DAO was an early iteration of modern decentralized autonomous organizations. It was launched back in 2016 and designed to be an automated organization that acted as a form of venture capital fund. + +Those who owned DAO tokens could profit from the organization’s investments by either reaping dividends or benefitting from price appreciation of the tokens. The DAO was initially seen as a revolutionary project and raised $150 million in Ether (ETH), one of the greatest crowdfunding efforts of the time. + +The DAO launched on April 30, 2016, after Ethereum protocol engineer Christoph Jentzsch released the open-source code for an Ethereum-based investment organization. Investors bought DAO tokens by moving Ether to its smart contracts. + +A few days into the token sale, some developers expressed concerns that a bug in The DAO’s smart contracts could allow malicious actors to drain its funds. While a governance proposal was set forth to fix the bug, an attacker took advantage of it and siphoned over $60 million worth of ETH from The DAO’s wallet. + +At the time, around 14% of all ETH in circulation was invested in The DAO. The hack was a significant blow to DAOs in general and the then one-year-old Ethereum network. A debate within the Ethereum community ensued as everyone scrambled to figure out what to do. Initially, Ethereum co-founder Vitalik Buterin proposed a soft fork that would blacklist the attacker’s address and prevent them from moving the funds. + +The attacker or someone posing as them then responded to that proposal, claiming the funds had been obtained in a “legal” way according to the smart contract’s rules. They claimed they were ready to take legal action against anyone who tried to seize the funds. + +The hacker even threatened to bribe ETH miners with some of the stolen funds to thwart a soft fork attempt. In the debate that ensued, a hard fork was determined to be the solution. That hard fork was implemented to roll back the Ethereum network’s history to before The DAO was hacked and reallocate the stolen funds to a smart contract that allowed investors to withdraw them. Those who disagreed with the move rejected the hard fork and supported an earlier version of the network, known as Ethereum Classic (ETC). + +## Disadvantages of DAOs + +Decentralized autonomous organizations aren’t perfect. They are an extremely new technology that has attracted much criticism due to lingering concerns regarding their legality, security and structure. + +MIT Technology Review has, for example, revealed it considers it a bad idea to trust the masses with important financial decisions. While MIT shared its thoughts back in 2016, the organization appears to have never changed its mind on DAOs — at not least publicly. The DAO hack also raised security concerns, as flaws in smart contracts can be hard to fix even after they are spotted. + +DAOs can be distributed across multiple jurisdictions, and there’s no legal framework for them. Any legal issues that may arise will likely require those involved to deal with numerous regional laws in a complicated legal battle. + +In July 2017, for example, the United States Securities and Exchange Commission issued a report in which it determined that The DAO sold securities in the form of tokens on the Ethereum blockchain without authorization, violating portions of securities law in the country. + +## Examples of DAOs + +Decentralized autonomous organizations have gained traction over the last few years and are now fully incorporated into many blockchain projects. The decentralized finance (DeFi) space uses DAOs to allow applications to become fully decentralized, for example. + +To some, the Bitcoin (BTC) network is the earliest example of a DAO there is. The network scales via community agreement, even though most network participants have never met each other. It also does not have an organized governance mechanism, and instead, miners and nodes have to signal support. + +However, Bitcoin is not seen as a DAO by today’s standards. By current measures, Dash would be the first true DAO, as the project has a governance mechanism that allows stakeholders to vote on the use of its treasury. + +Other, more advanced DAOs, including decentralized networks built on top of the Ethereum blockchain, are responsible for launching cryptocurrency-backed stablecoins. In some cases, the organizations that initially launched these DAOs slowly give away control of the project to one day become irrelevant. Token holders can actively vote on governance proposals to hire new contributors, add new tokens as collateral for their coins or adjust other parameters. + +In 2020, a DeFi lending protocol launched its own governance token and distributed it through a liquidity mining process. Essentially, anyone who interacted with the protocol would receive tokens as a reward. Other projects have since replicated and adapted the model. + +Now, the list of DAOs is extensive. Over time, it has become a clear concept that has been gaining traction. Some projects are still looking to achieve complete decentralization through the DAO model, but it’s worth pointing out they are only a few years old and have yet to achieve their final goals and objectives. + +As internet-native organizations, DAOs have the potential to change the way corporate governance works completely. While the concept matures and the legal gray area they operate in is cleared, more and more organizations may adopt a DAO model to help govern some of their activities. + + +> info from: https://cointelegraph.com/ethereum-for-beginners/what-is-a-decentralized-autonomous-organization-and-how-does-a-dao-work + + diff --git a/collections/tfmanual/knowledge_base/about/genesis_block_pool_details.md b/collections/tfmanual/knowledge_base/about/genesis_block_pool_details.md new file mode 100644 index 0000000..7c96cbb --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/genesis_block_pool_details.md @@ -0,0 +1,69 @@ +

Genesis Pool Details

+ +

Table of Contents

+ +- [Genesis Pool](#genesis-pool) +- [Genesis Block](#genesis-block) + - [Genesis Block Value](#genesis-block-value) + - [Calculation](#calculation) +- [Genesis Pool Details](#genesis-pool-details) + +*** + +## Genesis Pool + +Genesis pool is the initial capacity with which the network started, was available when the project officially launched (blockchain launch March 2018). + +- +-300 computer (all owned by ThreeFold_Dubai) + - Belgium: 117+30 (hosted by BetterToken) + - Dubai: 148 (hosted by TF FZC itself) +- total estimate resource/compute units + - CRU: 4800, + - HRU: 8100000 + - MRU: 18600 + - SRU: 106000 + +## Genesis Block + +Genesis block is the first block registered in the blockchain. This consists of a number of TFT, in our case 695M TFT. + +> Maximum amount of tokens in the ThreeFold Blockchain at launch = 100 Billion (in other words genesis pool < 1% at start of max nr TFT) + +### Genesis Block Value + +It's hard to define the value of the genesis block when it was calculated, there was no established TFT price. + +- If TFT price = USD 0.01: +-7M USD (this token price has not been established but could be 2016-17) +- Summer 2023 the price is back on USD 0.01, which we believe is too low for the value created, lets hope for a better future. + +### Calculation + +To come up with a reasonable number and show the community that there was hardware available for the genesis block, we made an excel calculation. + +- Servers as part of genesis pool calculation + - +-300 computer (all owned by ThreeFold_Dubai) + - Belgium: 117+30 (hosted by BetterToken) + - Dubai: 148 (hosted by TF FZC itself) + - Hardware as used in many years before token launch (March 2018) + - At least 100+ servers over quite some years +- Total estimate resource/compute units + - CRU: 4,800 + - HRU: 8,100,000 + - MRU: 18,600 + - SRU: 106,000 +- Cloud Units + - Results in 3,927 CU and 8,225 SU +- The farming rules used were farming/minting rules v1 but with no difficulty level and TFT price 0.01 +- Duration + - We took +- 1.5 years in our calculation + - Averaged out, it's for sure not exact science + - But we can say that the amount of capacity listed has been available long enough for our engineers during the pre-launch period. Probably not with those exact listed servers but in general. +- Result: **695M TFT** + +_The purpose of this exercise is to demonstrate there is a reasoning behind the 695M TFT and computers which have been available. It's not intended as exact proof nor defense. We believe the value given was in line with the situation at that time._ + +## Genesis Pool Details + +- Block 0: [Block 0 on Explorer](https://explorer2.threefoldtoken.com/hash.html?hash=a2ee0aa706c9de46ec57dbba1af8d352fbcc3cc5e9626fc56337fd5e9ca44c8d) +- Genesis Block Code: [Code of Block 0](https://github.com/threefoldfoundation/tfchain/blob/master/pkg/config/config.go#L103) + diff --git a/collections/tfmanual/knowledge_base/about/genesis_pool.md b/collections/tfmanual/knowledge_base/about/genesis_pool.md new file mode 100644 index 0000000..ad6fdb2 --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/genesis_pool.md @@ -0,0 +1,70 @@ +

Genesis Pool

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Genesis Pool Token Usage](#genesis-pool-token-usage) +- [Remarks](#remarks) + +*** + +## Introduction + +At the end of March 2018, ThreeFold launched the public blockchain. + +ThreeFold developed their own blockchain software called Rivine, which was probably the first proof of blockstake blockchain in the world. We did not like the way how the other blockchains at that time were doing proof of work, which is basically burning a lot of energy to prove the validity of their blockchain. + +Rivine is a fork from the blockchain work done by the team of SIA and since then a lot of work has been done on it to fulfill our own requirements. The Rivine blockchain will no longer be used after May 2020. + +ThreeFold is the result of more than 20 years of work in the Internet space, over a number of companies. + +The technology used at start in March 2018 has been developed mainly out of three companies: ThreeFold_Dubai, BetterToken(bettertoken) and GreenIT Globe. Later in 2018, TF Tech was spun off from our incubator. + +TF Tech is a company born out of our Incubator called [Incubaid](http://www.incubaid.com/) in Belgium. + +TF Tech has a purpose to further develop the software and commercialize the capabilities on a global basis, mainly by working together with tech partners. + +The public version of our blockchain was started March 2018. The servers used during development and mining tokens already started years before. + +Many hundreds of servers have been used to develop the technology which now makes up our ThreeFold_Grid. + ++-300 servers are the foundation of our TF Grid. + +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) + +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). + +## Genesis Pool Token Usage + +- A lot of the genesis pool tokens went to the original shareholders of a company who created a lot of the technology which was the basis at that time for ThreeFold. + - Most of these tokens are locked up and are not tradeable. + - 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. + +The tokens were used from out of ThreeFold_Dubai to create value for the ThreeFold Grid. + +- Initial funding: sell TFT as future IT capacity + - IT capacity delivered amongst others from the computers deployed by genesis pools (+300 servers) +- grants to community, bounties for coders, evangelists, ... + - max bounty given to contributors/founders = 2.5m TFT + - funding for projects like coding, marketing, ... + - There is a token grant program, but not really active yet. +- Fund the day-to-day operation of threefold_dubai +- Fund some development projects for our open source technology +- Public exchange fees +- Operational costs of keeping the genesis pool operational (engineers, data center, bandwidth, ...) +- Reward for the ThreeFold larger community and contributors + +## Remarks + +- ThreeFold_Dubai is run as a [not-for-profit organization](../legal/definitions_legal.md) +- All (future) profits generated, tokens=IT capacity sold are used to promote and grow the ThreeFold Project. + - None of the potential profits generated go to the shareholders of the company. + - Investments and loans given will of course be paid back to the relevant investors. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/about/genesis_pool_dubai.md b/collections/tfmanual/knowledge_base/about/genesis_pool_dubai.md new file mode 100644 index 0000000..a25dc91 --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/genesis_pool_dubai.md @@ -0,0 +1,7 @@ +## The Genesis Pool Dubai + +![](img/genesispool_1.jpg) +![](img/genesispool_2.jpg) + + +Read more about ThreeFold Dubai [here](./threefold_dubai.md). \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/about/genesis_pool_ghent.md b/collections/tfmanual/knowledge_base/about/genesis_pool_ghent.md new file mode 100644 index 0000000..2aa17b0 --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/genesis_pool_ghent.md @@ -0,0 +1,11 @@ + +## The Genesis Pool (Ghent) + + +![](img/lochristi_1_.jpg) +![](img/lochristi_2_.jpg) +![](img/lochristi_3.jpg) +![](img/lochristi_4.jpg) +![](img/lochristi_5_.jpg) +![](img/lochristi_6_.jpg) +![](img/lochristi_7.jpg) diff --git a/collections/tfmanual/knowledge_base/about/governance.md b/collections/tfmanual/knowledge_base/about/governance.md new file mode 100644 index 0000000..2381fa5 --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/governance.md @@ -0,0 +1,60 @@ +

Governance

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Project History](#project-history) +- [Type of Token](#type-of-token) +- [Governance Process](#governance-process) +- [Organic Growth](#organic-growth) +- [Genesis Pool](#genesis-pool) +- [Decentralized and Open-Source](#decentralized-and-open-source) + +*** + +## Introduction + +We introduce the ThreeFold governance and provide some context around ThreeFold in general. + +## Project History + +The project is grateful of the support of its community and the commercial entity TFTech. + +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). + +## Type of Token + +The regulators and legal advisors believe that we are a payment token with some flavor of a utility token (hybrid). + +We conducted research and obtained legal counsel in multiple jurisdictions: + +- Switzerland +- Belgium +- Dubai +- Singapore + +For more information, [read the legal opinions](https://drive.google.com/file/d/1kNu2cFjMkgqdadrOOQTTC5FPAM4OgKEb/view?usp=drive_link). + +## 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/). + +## Organic Growth + +We never organized a pump and dump or any other synthetic mechanism to boost the token price and benefit from this. We believe in organic growth and TFT going up as result of utilization and grid expansion. + +## Genesis Pool + +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). + +## Decentralized and Open-Source + +In essence, ThreeFold is a decentralized and open-source project. We invite everyone to contribute and participate within the ThreeFold ecosystem. + +You can read the code on the [ThreeFold Tech GitHub repository](https://github.com/threefoldtech). \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/about/img/al_jadaf.jpg b/collections/tfmanual/knowledge_base/about/img/al_jadaf.jpg new file mode 100644 index 0000000..b43ab97 Binary files /dev/null and b/collections/tfmanual/knowledge_base/about/img/al_jadaf.jpg differ diff --git a/collections/tfmanual/knowledge_base/about/img/aljadaf2.jpg b/collections/tfmanual/knowledge_base/about/img/aljadaf2.jpg new file mode 100644 index 0000000..f90719e Binary files /dev/null and b/collections/tfmanual/knowledge_base/about/img/aljadaf2.jpg differ diff --git a/collections/tfmanual/knowledge_base/about/img/bettertoken_web.jpg b/collections/tfmanual/knowledge_base/about/img/bettertoken_web.jpg new file mode 100644 index 0000000..a8318b4 Binary files /dev/null and b/collections/tfmanual/knowledge_base/about/img/bettertoken_web.jpg differ diff --git a/collections/tfmanual/knowledge_base/about/img/blockchain.png b/collections/tfmanual/knowledge_base/about/img/blockchain.png new file mode 100644 index 0000000..fa6290e Binary files /dev/null and b/collections/tfmanual/knowledge_base/about/img/blockchain.png differ diff --git a/collections/tfmanual/knowledge_base/about/img/crypto_valley_zug_.jpg b/collections/tfmanual/knowledge_base/about/img/crypto_valley_zug_.jpg new file mode 100644 index 0000000..08a3180 Binary files /dev/null and b/collections/tfmanual/knowledge_base/about/img/crypto_valley_zug_.jpg differ diff --git a/collections/tfmanual/knowledge_base/about/img/dubai_office1.jpg b/collections/tfmanual/knowledge_base/about/img/dubai_office1.jpg new file mode 100644 index 0000000..e29f0d3 Binary files /dev/null and b/collections/tfmanual/knowledge_base/about/img/dubai_office1.jpg differ diff --git a/collections/tfmanual/knowledge_base/about/img/foundation_header_image.jpg b/collections/tfmanual/knowledge_base/about/img/foundation_header_image.jpg new file mode 100644 index 0000000..2165278 Binary files /dev/null and b/collections/tfmanual/knowledge_base/about/img/foundation_header_image.jpg differ diff --git a/collections/tfmanual/knowledge_base/about/img/genesispool_1.jpg b/collections/tfmanual/knowledge_base/about/img/genesispool_1.jpg new file mode 100644 index 0000000..aa3c163 Binary files /dev/null and b/collections/tfmanual/knowledge_base/about/img/genesispool_1.jpg differ diff --git a/collections/tfmanual/knowledge_base/about/img/genesispool_2.jpg b/collections/tfmanual/knowledge_base/about/img/genesispool_2.jpg new file mode 100644 index 0000000..4f26416 Binary files /dev/null and b/collections/tfmanual/knowledge_base/about/img/genesispool_2.jpg differ diff --git a/collections/tfmanual/knowledge_base/about/img/korenlei_22.jpg b/collections/tfmanual/knowledge_base/about/img/korenlei_22.jpg new file mode 100644 index 0000000..5c757d4 Binary files /dev/null and b/collections/tfmanual/knowledge_base/about/img/korenlei_22.jpg differ diff --git a/collections/tfmanual/knowledge_base/about/img/korenlei_old.jpg b/collections/tfmanual/knowledge_base/about/img/korenlei_old.jpg new file mode 100644 index 0000000..72a2dd9 Binary files /dev/null and b/collections/tfmanual/knowledge_base/about/img/korenlei_old.jpg differ diff --git a/collections/tfmanual/knowledge_base/about/img/labs_it_license.jpg b/collections/tfmanual/knowledge_base/about/img/labs_it_license.jpg new file mode 100644 index 0000000..f4df0aa Binary files /dev/null and b/collections/tfmanual/knowledge_base/about/img/labs_it_license.jpg differ diff --git a/collections/tfmanual/knowledge_base/about/img/lochristi_1_.jpg b/collections/tfmanual/knowledge_base/about/img/lochristi_1_.jpg new file mode 100644 index 0000000..5e72e15 Binary files /dev/null and b/collections/tfmanual/knowledge_base/about/img/lochristi_1_.jpg differ diff --git a/collections/tfmanual/knowledge_base/about/img/lochristi_2_.jpg b/collections/tfmanual/knowledge_base/about/img/lochristi_2_.jpg new file mode 100644 index 0000000..49f3dba Binary files /dev/null and b/collections/tfmanual/knowledge_base/about/img/lochristi_2_.jpg differ diff --git a/collections/tfmanual/knowledge_base/about/img/lochristi_3.jpg b/collections/tfmanual/knowledge_base/about/img/lochristi_3.jpg new file mode 100644 index 0000000..e6e8392 Binary files /dev/null and b/collections/tfmanual/knowledge_base/about/img/lochristi_3.jpg differ diff --git a/collections/tfmanual/knowledge_base/about/img/lochristi_4.jpg b/collections/tfmanual/knowledge_base/about/img/lochristi_4.jpg new file mode 100644 index 0000000..0f16e4c Binary files /dev/null and b/collections/tfmanual/knowledge_base/about/img/lochristi_4.jpg differ diff --git a/collections/tfmanual/knowledge_base/about/img/lochristi_5_.jpg b/collections/tfmanual/knowledge_base/about/img/lochristi_5_.jpg new file mode 100644 index 0000000..08d8cab Binary files /dev/null and b/collections/tfmanual/knowledge_base/about/img/lochristi_5_.jpg differ diff --git a/collections/tfmanual/knowledge_base/about/img/lochristi_6_.jpg b/collections/tfmanual/knowledge_base/about/img/lochristi_6_.jpg new file mode 100644 index 0000000..f5b3781 Binary files /dev/null and b/collections/tfmanual/knowledge_base/about/img/lochristi_6_.jpg differ diff --git a/collections/tfmanual/knowledge_base/about/img/lochristi_7.jpg b/collections/tfmanual/knowledge_base/about/img/lochristi_7.jpg new file mode 100644 index 0000000..8b9c713 Binary files /dev/null and b/collections/tfmanual/knowledge_base/about/img/lochristi_7.jpg differ diff --git a/collections/tfmanual/knowledge_base/about/img/mazraa_web1.jpg b/collections/tfmanual/knowledge_base/about/img/mazraa_web1.jpg new file mode 100644 index 0000000..17a2451 Binary files /dev/null and b/collections/tfmanual/knowledge_base/about/img/mazraa_web1.jpg differ diff --git a/collections/tfmanual/knowledge_base/about/img/tf_companies_.jpg b/collections/tfmanual/knowledge_base/about/img/tf_companies_.jpg new file mode 100644 index 0000000..ef7bc62 Binary files /dev/null and b/collections/tfmanual/knowledge_base/about/img/tf_companies_.jpg differ diff --git a/collections/tfmanual/knowledge_base/about/img/threefold_commodities_1_.jpg b/collections/tfmanual/knowledge_base/about/img/threefold_commodities_1_.jpg new file mode 100644 index 0000000..84afbb4 Binary files /dev/null and b/collections/tfmanual/knowledge_base/about/img/threefold_commodities_1_.jpg differ diff --git a/collections/tfmanual/knowledge_base/about/img/threefold_dmcc_license_certificate.jpg b/collections/tfmanual/knowledge_base/about/img/threefold_dmcc_license_certificate.jpg new file mode 100644 index 0000000..6c6d34a Binary files /dev/null and b/collections/tfmanual/knowledge_base/about/img/threefold_dmcc_license_certificate.jpg differ diff --git a/collections/tfmanual/knowledge_base/about/img/threefold_tech.jpg b/collections/tfmanual/knowledge_base/about/img/threefold_tech.jpg new file mode 100644 index 0000000..d4d2f0b Binary files /dev/null and b/collections/tfmanual/knowledge_base/about/img/threefold_tech.jpg differ diff --git a/collections/tfmanual/knowledge_base/about/img/threefold_tech_location.jpg b/collections/tfmanual/knowledge_base/about/img/threefold_tech_location.jpg new file mode 100644 index 0000000..8bd7427 Binary files /dev/null and b/collections/tfmanual/knowledge_base/about/img/threefold_tech_location.jpg differ diff --git a/collections/tfmanual/knowledge_base/about/img/threefold_vzw_official_doc.jpg b/collections/tfmanual/knowledge_base/about/img/threefold_vzw_official_doc.jpg new file mode 100644 index 0000000..82c1173 Binary files /dev/null and b/collections/tfmanual/knowledge_base/about/img/threefold_vzw_official_doc.jpg differ diff --git a/collections/tfmanual/knowledge_base/about/img/view_dubai.jpg b/collections/tfmanual/knowledge_base/about/img/view_dubai.jpg new file mode 100644 index 0000000..022fad0 Binary files /dev/null and b/collections/tfmanual/knowledge_base/about/img/view_dubai.jpg differ diff --git a/collections/tfmanual/knowledge_base/about/mazraa.md b/collections/tfmanual/knowledge_base/about/mazraa.md new file mode 100644 index 0000000..c280c8e --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/mazraa.md @@ -0,0 +1,22 @@ +

Mazraa

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [History](#history) +- [Mission](#mission) + +*** + +## Introduction + +Mazraa is a brand name of [ThreeFold Dubai](./threefold_dubai.md). You can read about ThreeFold Dubai for more details. + +## History + +Mazraa was established in early 2016 in the United Arab Emirates and was one of the first provider's of Peer2Peer Internet capacity on the ThreeFold Grid. Currently, Mazraa's capacity pool of storage and compute capacity can be accessed for workload development on the TF Capacity Explorer. + + +## Mission + +Mazraa supports ThreeFold Foundation's mission to create a responsible Internet for all, one that is accessible, affordable and environmentally conscious. Mazraa is a founding capacity farmer on the ThreeFold Network and actively supports the expansion and adoption of ThreeFold's P2P Cloud. Mazraa's focus is to provide P2P Cloud capacity for developers, nodes for new and existing farmers, as well as, providing over the counter access to TFT's to enable reservations of Internet capacity. Additionally, Mazraa supports the promotion and growth of the ThreeFold Network, through marketing resources and funding contributions. We believe it's time for the internet to have a major upgrade to empower people and protect our planet. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/about/orgstructure.md b/collections/tfmanual/knowledge_base/about/orgstructure.md new file mode 100644 index 0000000..8f1ec9d --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/orgstructure.md @@ -0,0 +1,14 @@ +# Organisation Structure + +

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/dao.md) +- [ThreeFold DAO](./dao/tfdao.md) +- [TFChain](./tfchain.md) \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/img/releasenotes.png b/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/img/releasenotes.png new file mode 100644 index 0000000..bb1005a Binary files /dev/null and b/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/img/releasenotes.png differ diff --git a/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/releasenotes_readme.md b/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/releasenotes_readme.md new file mode 100644 index 0000000..21e8011 --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/releasenotes_readme.md @@ -0,0 +1,19 @@ +![](img/releasenotes.png) + +# ThreeFold Grid Release Notes + + We're delighted to have you here as we explore the latest updates and enhancements to our decentralized grid ecosystem. In these release notes, you'll discover a wealth of information about the exciting features, bug fixes, performance optimizations, and new functionalities that have been introduced in each release. + + 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) diff --git a/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_0.md b/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_0.md new file mode 100644 index 0000000..32ea6d9 --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_0.md @@ -0,0 +1,43 @@ +# TFGrid release 3.0 + +TFGrid 3.0 will be released gradually during Q3/Q4 2021. + +## What's new ? + +TFGrid 3.0 is a full redesign of the ThreeFold Grid architecture. The main purpose of this redesign is to decentralize all the components that the Grid is built with. + +### TFChain 3.0 + +A decentralised chain holding all information on entities that make up the ThreeFold Grid. It runs on Parity Substrate blockchain infrastructure. + +Features : +- Your identity and proofs/reputation on our blockchain +- All info about TFGrid (nodes, farmers, …) +- A Graphql interface to be able to query the blockchain +- Support of side chains (unlimited scalability, allow others to run their own blockchain) +- TFT exists now also on TFChain (allows us to work around Stellar scalability issues) +- Bridge between TFT on Stellar and TFT on TFChain (one way to start) +- Blockchain based provisioning process +- TFChain API (javascript, golang, vlang) +- Support for 'Infrastructure as Code' : IAC frameworks + - Terraform + - Kubernetes, Helm, Kubernetes + - Ansible (planned for Q4 2021) +- Use RMB = peer2peer secure Reliable Message Bus to communicate with Zero-OS + +### Proof of Utilization + +- Resource utilisation is captured and calculated on hourly basis +- Resource utilisation stored in TFChain +- An automated discount system has been put in place, rewarding users who pre-purchased their cloud needs. Price discounts are applied, in line with amount of TFT you have in your account and the period you are holding these TFT. +E.g. if you have 12 months worth of TFT in your account in relation to the last hour used capacity you get 40% discount, 36 months results in 60% discount. + +### New Explorer UI +- An updated User Interface of the TF Grid Explorer, nicer and easier to use +- It uses the Graphql layer of TFChain + +## Roadmap + +The feature overview split over different releases can be found [here](https://circles.threefold.me/project/despiegk-product_tfgrid3_roadmap/wiki/roadmap). + +More info and announcements on Grid 3.0 to be found on our [forum](https://forum.threefold.io/t/announcement-of-tfgrid-3-0/1132) diff --git a/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_0_a2.md b/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_0_a2.md new file mode 100644 index 0000000..0f9cc1a --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_0_a2.md @@ -0,0 +1,204 @@ +# ThreeFold Release Notes TFGrid 3.0.0 Alpha 2 (Live on testnet) + +## TFChain v1.0.0 + +- DAO Requests + - Becoming council member + - Becoming a validator node + - Pricing changes + - Upgrading tfchain + - Changing farming rewards + +## Admin Portal v3.0.1-rc1 + +- Terms and conditions support +- Fix reasking for activation when the balance reaches 0 +- Show amount of bridge deposit/withdraw fee +- Get more TFT button when connected to devnet + +## tfchain explorer v3.0.0-rc19 + +- certification type filter +- adding certification type to nodes +- add zos version to node details +- update map to reflect the selected node +- UX fixes for filters and data sorting +- include version of tfchain, explorer, grid proxy +- showing available resources +- showing online / offline nodes +- showing number of available IPs in a farm +- adding favicon +- statistics page improvements + +## ZOS v3.0.4 + +- public IPv6 support +- Min rootfs for more than 1 CU = 2GB, and anything less will be 500MB +- Mainnet image +- Fix IPv6 rules that broke SLAAC +- Update SRU calculation +- bug don't wait for QSFS shutdown +- Update traefik version +- Fixing crashes caused by slow disks +- Avoid lsblk blocking for QSFS +- Decommission on too many QSFS metric fetches failure +https://github.com/threefoldtech/zos/releases + +## Terraform v0.1.20 +- Support for public IPv6 +- Support planetary option for k8s + +https://github.com/threefoldtech/tf-terraform-provider/releases + + +## grid3_client_ts v1.0.3 +- Cert type for nodes +- public IPv6 support +- TwinServer command to be used from other langauges + + +## Weblets v1.2.0 + +- Support peertube +- Support funkwhale +- Remove rootfs specification from machine +- Support adding/deleting workers in kubernetes +- Add more images ubuntu, alpine, centos +- Updating the balance periodically +- Adding access for nodes by default for hidden nodes issues +- Resolving issues + +### detailed projects list + +- https://github.com/threefoldtech/grid_weblets/projects/1 +- https://github.com/threefoldtech/grid_weblets/projects/4 +- https://github.com/threefoldtech/grid_weblets/projects/6 +- https://github.com/threefoldtech/grid_weblets/projects/6 +- https://github.com/threefoldtech/grid_weblets/projects/7 +- https://github.com/threefoldtech/grid_weblets/projects/8 + +https://github.com/threefoldtech/grid_weblets/releases + +## QSFS + +TODO + +## gridproxy v1.0.0-rc8 + +- generic performance improvements +- reduce caching time +- enable CORS in version +- include certification types in nodes +- fix regression on nodes query +- + +## Known Issues 3.0.0 Alpha 2 + +Following list is incomplete but gives some issues to think about. + +- Weblets [limitations](https://library.threefold.me/info/manual/#/manual__weblets_home?id=limitations) +- QSFS integration is a work in progress +- ZOS and SSD performance [issue](https://github.com/threefoldtech/zos/issues/1467) +- Threefold Connect having [issues](https://circles.threefold.me/project/test-tfgrid3/issue/52) +- Docker & ZOS containers [differences](https://github.com/threefoldtech/zos/issues/1483) +- ZOS workloads upgrade [issue](https://github.com/threefoldtech/zos/issues/1425) +- Terraform projects [don't reflect in the weblets](https://github.com/threefoldtech/terraform-provider-grid/issues/146) +- Can't detach public IP from a VM and removing it from a contract [issue](https://github.com/threefoldtech/tfchain_pallets/issues/73), please note you can still create each in separate contracts. + +# ThreeFold Release Notes TFGrid 3.0.0 Alpha 1 (Live on mainnet) + +- [TFgrid 3.0 announcement](https://forum.threefold.io/t/announcement-of-tfgrid-3-0/1132) +- [Whats new in TFGrid 3.0](https://forum.threefold.io/t/what-is-new-in-tfgrid-3-0/1133) +- [Roadmap](https://circles.threefold.me/project/despiegk-product_tfgrid3_roadmap/wiki/home) +- +## TFChain + +- Staking support (as the moment of this writing it's only on devnet now) +- KeyValue store support +- Bridging tokens from stellar to tfchain +- Smart contract for IT +- Billing +- Consumption Reports +- Discounts support + +## Admin Portal + +- Creation of twins +- Bridge from and to Stellar +- Farm Management + + +## Tfchain explorer + +- Nodes view +- Gateways listing +- Farms information +- Resources/utilization +- Better filtering + + +## ZOS +- zmachine support +- Integration with latest subtsrate client event types +- public ipv6 support in VMs +- planetary support in VMs +- upgrade to new file system RFS +- support for QSFS +- support for gateways +- capacity reporting to the blockchain support +- Support of SR25519 +- Improvements in .zosrc creation +- Safer mechanism for environment variables and init arguments +- improvments in cleaning unused mounts + +https://github.com/threefoldtech/zos/releases + +## Terraform +- Support ZMachine +- Support Kubernetes +- Support QSFS +- Support Capacity Planning +- Support Gateways + +https://github.com/threefoldtech/tf-terraform-provider/releases + + +## grid3_client_ts +- Support ZMachine +- Support Kubernetes +- Support QSFS +- Support Capacity Planning +- Support Gateways + + +## Weblets + +- Support Profile manager +- Support Virtual machine +- Support CapRover +- Support Kubernetes +https://github.com/threefoldtech/grid_weblets/releases +- Capacity planning deployment + +## QSFS + +TODO + + +- [TFgrid 3.0 announcement](https://forum.threefold.io/t/announcement-of-tfgrid-3-0/1132) +- [Whats new in TFGrid 3.0](https://forum.threefold.io/t/what-is-new-in-tfgrid-3-0/1133) +- [Roadmap](https://circles.threefold.me/project/despiegk-product_tfgrid3_roadmap/wiki/home) + +## Known Issues 3.0.0 Alpha 1 + +Following list is incomplete but gives some issues to think about. + +- Weblets [limitations](https://library.threefold.me/info/manual/#/manual__weblets_home?id=limitations) +- Public IP6 [support](https://github.com/threefoldtech/zos/pull/1488) in ZOS +- QSFS integration is a work in progress +- ZOS and SSD performance [issue](https://github.com/threefoldtech/zos/issues/1467) +- Threefold Connect having [issues](https://circles.threefold.me/project/test-tfgrid3/issue/52) +- Docker & ZOS containers [differences](https://github.com/threefoldtech/zos/issues/1483) +- ZOS workloads upgrade [issue](https://github.com/threefoldtech/zos/issues/1425) +- Terraform projects [don't reflect in the weblets](https://github.com/threefoldtech/terraform-provider-grid/issues/146) +- Can't detach public IP from a VM and removing it from a contract [issue](https://github.com/threefoldtech/tfchain_pallets/issues/73), please note you can still create each in separate contracts. diff --git a/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_0_a4.md b/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_0_a4.md new file mode 100644 index 0000000..97a9456 --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_0_a4.md @@ -0,0 +1,53 @@ +# ThreeFold Grid v3.0.0 Alpha - 4 Release Note + +## TFConnect v3.4.0 + +### TFConnect Backend Services Migration + +We moved ThreeFold Connect’s backend services from a data storage in Lochristi to TFGrid. From TF Wallet, to TF account, and TFNews, all active services are migrated by using Helm charts. + +## TFPlay v1.1.4 + +### Listed Mattermost as Deployable Solution + +On this release, we added Mattermost as one of our deployable decentralised solutions. +Mattermost is a secure, open source platform for communication, collaboration, and workflow orchestration across tools and teams. + +### Separated TFPlay into 3 different networks + +Node upgrades could happen anytime, and it could make solution deployments on different networks incompatible. Therefore, we separated TFPlay into 3 different networks: + +- Deployment on TFGrid Mainnet: play.grid.tf +- Deployment on TFGrid Testnet: play.test.grid.tf +- Deployment on TFGrid Devnet: play.dev.grid.tf + +This way, if some nodes on one network are being upgraded, deployments on the other nets should not be affected. + +## Minting v3.0 + +### Minting V3 code + +Repo: https://github.com/threefoldtech/minting_v3 + +There was a change the way how the CU/SU are calculated from the resource units calculations, please see https://library.threefold.me/info/threefold#/resource_units_calc_cloudunits for details. +Therefore, we updated the calculations on the minting code (minting v3), as well as adjusted price calculation for workloads on TFchain. + +## GetTFT Shop v1.0.4 + +Story: https://github.com/threefoldtech/home/issues/1171 + +### Minor UX / UI improvements + +On this release we created minor UX improvements on the existing GetTFT Shop website that create a better experience for our customers, such as improved interactivity, fixed embedded media, revised UX content, improved screen responsiveness, and many more. + +## TF Capacity Explorer v0.1.0 + +### An all-in-one Unified Capacity Explorer + +Currently we have a few separate capacity explorers for both TFGrid v2 Explorer and TFGrid v3 Explorer. On this release we unified all versions and networks into one explorer, where users can find capacity information on both TFGrid v2 and v3 mainnet, testnet, and devnet. This all-in-one unified Capacity Explorer will be hosted under the domain https://explorer.threefold.io. + +## TF Farm Management v1.1 + +On TFGrid v3, node and farm management are also moved to substrate-based blockchains. A farm can be managed by making calls directly to the blockchain using objects created in TFChain called Twins. TFWallet app can reuse the wallet keypair to support a twin. A twin is also associated with a Planetary Network address that is supported by the Threefold Connect App. + +Therefore we added a ‘Farm Management’ feature on the TFConnect App that would enable farmers to list their farms and create new ones directly on the mobile app. The ‘Farm Management’ feature will allow users to create new farms, list farms, as well as migrate their farms from TFGrid v2 to TFGrid v3. diff --git a/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_0_a5.md b/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_0_a5.md new file mode 100644 index 0000000..94b28b2 --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_0_a5.md @@ -0,0 +1,72 @@ +# ThreeFold Grid v3.0.0 Alpha - 5 Release Note + +This is the release note of TFGrid v3.0.0 Alpha 5. It includes updates, improvements and fixes of numerous grid components as described below. + +## TFT Shop v1.1.0 + +On the first initial release of TFT Shop v1.0.0, we have made it easier for users to buy TFT by BTC on the [TFT Shop website](https://gettft.com/gettft/). + +On this v1.1.0 release, we are giving users another **option to buy TFT by using fiat currency**. This is made possible by integrating [mercuryo.io](http://www.mercuryo.io/) (third-party) widget onto the shop. By buying TFT using TFT Shop, you confirm that you have read and agree to [ThreeFold’s terms and conditions](https://library.threefold.me/info/legal/#/legal__terms_conditions_gettft). + + +## ZOS v3.1.0 + +### Performance Improvements + +This new feature release of ZOS v3.1.0 includes a lot of improvements such as **improvements on performance issues** (disk and IO), grid events handling, and improvement on the current yggdrasil network by start and maintaining our public peers. + +### ZOS Supoort Dedicated Nodes + +To empower community-driven decentralization on the TFGrid, we would like to soon invite anyone to deploy their own solutions on the TFGrid. This is feasible to do by allowing any external developers to** deploy their own workloads on** **dedicated nodes** and provide the deployment documentation. By choosing to deploy on dedicated nodes, a user can reserve an entire node, then use it exclusively to deploy solutions for themselves or for other customers. Therefore on this release we are happy to announce that we are supporting dedicated nodes deployment, apply the dedicated node contracts on TFChain and support mechanism on ZOS' next release. + + +## TF Playground v3.0.0 Alpha-5 + +### New community and blockchain solutions +On the last release, we have added new deployable community solutions on [TF Playground](https://play.grid.tf/#/), such as Peertube, Funkwhale and Taiga, Mattermost as well as some developer tools like CapRover, Virtual Machine, Kubernetes and Owncloud. + +On this release, we have added **community and blockchain solutions** such as Discourse (forum), Presearch Node and Casperlabs validator node. + +## Uhuru v1.1 (beta) + +### Uhuru Backend Changes + +[Uhuru](https://www.uhuru.me) is a digital product on top of a the TFGrid that enhance collaboration with features such as chat, videocall, office tools, and file storage, all in one platform. + + +## ThreeFold Wallet v3.0.0 + +### Add (substrate-based) TFChain Wallet + +TFGrid v3 is powered by substrate-based blockchain. A TFT is moveable from Stellar blockchain to TFChain through the use of a bridge.ThreeFold Wallet now has successfully **added (substrate-based) TFChain Wallet in order to support the bridge transaction**. + +However, TFT is still the native currency on TFChain. As such, there is no need for an external service to transfer tokens on TFChain. A transaction fee is charged (currently 0.01 TFT) for every transaction/extrinsic call. + +## TF Farm Management Tool v3.0.2 + +### Adjust farm management for the latest TFChain upgrade + +On the last release of 3 alpha-4, we have released Farm Management Tool v3.0.1 which allows farmers to migrate their farms from v2 to v3 through the TF Connect application. + +Recently a change was made within the codes of TFChain, thus broke the farm management function in the wallet. Therefore, on the v3.0.2 release, code changes were done on **Farm Management Tool to adapt itself with TFChain changes**. This was done quickly in production. + +## TFConnect App v3.5.0 + +### Generic Frontend and Backend Improvements +This new feature release of TFConnect App includes new features such as **enabling user to sign documents on the app** directly, and many other backend improvements. + +### Integrate TFConnect SSO to TFPlay Solutions + +We need to simplify peer-to-peer collaboration and how users interact with their TFPlay solutions. On this release, we have eliminated a complicated way of signing up to solutions (emails, username and password) by replacing it using **TFConnect app SSO login**. Therefore on this release, we successfully created TFConnect Native SSO backend environments for the following TFPlay solutions**: Discourse. Mattermost, and Gitea, that will allow users to sign in and start using the solutions with just few clicks. + +## TFChain v1.2.0 + +### ThreeFold DAO Pt. 2: Adjoint Validator-Council member request + +From version 3.0 on, [ThreeFold Grid operates as a DAO](https://library.threefold.me/info/threefold#/tfgrid/threefold__dao). On the last release of TFChain v1.0.0, we have successfully implemented The first TF-DAO that allows users to request to become DAO council members. + +On this release we also have successfully implemented **ThreeFold DAO Request part 2 where any user could request to become an adjoint validator-council member**: by running a a validator node, not only that they become a validator, they would also gain a seat as DAO council member that give them the right to vote for organizational changes. + +### ThreeFold DAO Pt. 2: Enable Validator Application + +On this release we implemented ThreeFold DAO Request part 2 any user could **apply to become a validator **and register the validator application on-chain if they meet the validator requirements. diff --git a/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_10_0.md b/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_10_0.md new file mode 100644 index 0000000..8cad3e3 --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_10_0.md @@ -0,0 +1,119 @@ +# ThreeFold Grid v3.10.0 Release Note + +Release Note of ThreeFold Grid v3.10.0. + +- Deployed on Mainnet on 3rd July 2023. + +## Components and Services + +The following components and services have been upgraded in this release: + +- TFChain +- ZOS +- Terraform +- TFGrid-SDK-GO +- TF Gridclient +- TF Gridproxy +- RMB +- TF Weblets +- TF Playground +- TF-Grid-CLI +- Gridify +- TFGrid-SDK-TS + +## Upgrades and Improvement Highlights + +Below are some of the key highlights of the TFGrid v3.10.0 component upgrades and improvements. + +### TFChain 2.4.0 + +- Addressed syncing issues. +- Introduced the attachment of solution provider IDs to contracts. +- Enabled the bonding of a stash account to a twin. +- Implemented various bug fixes. + +### ZOS 3.7.1 + +- Restructured the capacity to enhance dynamism. +- Added support for proxying traffic to private networks using WireGuard-based gateways. +- Introduced support for cloud-based consoles. +- Resolved various issues related to error messages, user validations, and error handling. + +### Terraform 1.9 + +- Added support for WireGuard-based gateway options. +- Implemented proper timeout handling for deployments. +- Introduced gateway node validation before submitting deployments. +- Resolved various bugs and issues. + +### TFGrid-SDK-GO 0.8.0 + +- Consolidated multiple Go projects into a single repository for simplified administration and quicker releases. +- Extracted reusable code from the Terraform project and created a standalone library for creating new platforms or plugins. + +#### Grid-Client + +- Enhanced the grid client to serve as the foundation layer for the Terraform plugin, enabling deployment of networks, virtual machines, and Kubernetes. + +#### Grid-Proxy + +- Added support for standby status for nodes powered off by the farmerbot. +- Enabled farm filtering based on requested resources. + +#### RMB + +- Improved the direct client's resilience to recover from close connections. + +#### 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). + +#### Gridify + +- An experimental project that allows developers to deploy their projects on ThreeFold as a platform with a single command, "gridify," using a Procfile in their code repository. +- Currently supported platforms include: + - Go 1.18 + - Python 3.10.10 + - Node 16.17.1 + - NPM 8.10.0 + - Caddy +- Learn more [here](https://github.com/threefoldtech/tfgrid-sdk-go/tree/development/gridify). + +### TFGrid-SDK-TS 2.0.0 + +- Consolidated all components targeting web/TypeScript developers and frontend efforts into a single repository for easier management and rapid releases. +- Moved gridclient, dashboard, statistics websites, and other TypeScript-based projects to the new repository [here](https://github.com/threefoldtech/tfgrid-sdk-ts). + +#### Grid-Client + +- Gateways now support WireGuard backends. +- Added support for hex secrets. +- Various fixes are detailed [here](https://github.com/orgs/threefoldtech/projects/192/views/12?filterQuery=repo%3A%22threefoldtech%2Ftfgrid-sdk-ts%22+label%3Agrid_client). + +#### TF Dashboard + +- Added support for IPv4 pricing in the resources calculator. +- Included TFT/USD exchange rate in the dashboard navbar. +- Introduced new standby status for nodes powered off by the farmerbot. +- In the explorer, a node monitoring page is now available. +- Fixed high CPU usage in the DAO Pages. +- Tracking improperly set serial number on nodes with a clear message. + +#### TFGrid Weblets + +- We are phasing out the TFGrid Weblets for a newer playground rewritten in vue3, however, we introduced some maintenance bugfixes. +- [Support umbrel on the grid](https://github.com/threefoldtech/home/issues/1394). + +### TF Playground v2.0.0 + +This release introduces a new playground with a more consistent user experience. Some components have been reworked for consistency. + +- Simplified the profile manager, requiring only the provision of a mnemonic and a password for encryption on the device. Mnemonics are never shared or sent across the network. +- Real-time calculation of deployment costs. +- Ability to generate WireGuard configurations. +- Direct link to the monitoring page of a deployment’s hosting node. + +## RMB 1.0.5 + +- Deprecated seed flag. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_6_0.md b/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_6_0.md new file mode 100644 index 0000000..533a1a3 --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_6_0.md @@ -0,0 +1,67 @@ +# ThreeFold Grid v3.6 Release Note + +Release Note of ThreeFold Grid v3.6. It includes updates, improvements and fixes of numerous grid components as described below. + +## TFPlayground v1.4.3 +- Updated Farming Calculator +- Better node-filtering mechanism by adding 'capacity' filter +- Simplified K8s solution deployment by eliminating 'add ssh key' part +- Improved UX for manual solution deployment on dedicated nodes +- Fixed solution's post-deployment bad gateway issue. +- Validation enhancements + +## Uhuru v1.2 (beta) +- Tackled the UI/UX issues and bugs. +- Added many features except for main missing things such as 'logout' option. + +## ThreeFold Wallet v3.1.0 +- Enable token unlocking feature +- Allow users to unlock their locked tokens via TFwallet. +- Improvements and fixes included, including usability supports for iOS devices that will be greatly improved. + +## TFConnect App v3.6.0 + +- Better usability and user experience through the app workflow improvements as well as +- Improved design and interface, look and feel. + +## TF Planetary Network v0.3.0 +TF Planetary Network is an application that allows users to access[ Peer To Peer end2end encrypted global network](https://library.threefold.me/info/manual/#/technology/threefold__planetary_network) which lives on top of the existing internet or other Peer To Peer networks created. This release's improvements: + +- New P2P functionalities on Desktop Client +- Improved the desktop clients for planetary network by adding support for M1 version of Mac. +- Allowed the application to refresh the list of ‘peers’, allowing extra ‘peers’ to be added by TF org +- Debugged multiple account issues on Mac. + +## TFTShop (GetTFT) v1.1.1 + +- Better usability and user experience through the app workflow improvements +- Improved design and interface, look and feel, such as Improvement on TFT purchase flows on all BTC-TFT, and FIAT-TFT transactions + +## TFGrid Proxy v1.5.0 +TFGrid Proxy is a REST API-based server used to interact with TFGridDB (Database) in order to access all available node-related information. This release's improvements: + +- Added querying for dedicated nodes support in gridproxy API. +- Added support for twins and contracts. +- Added filter for dedicated nodes +- Added missing queries on farms +- Added country API for node distribution + +## ZOS v3.1.0 +- Support pausing workloads to allow grace period before canceling contract. +- Enabled log streaming from VMs/Containers to a remote logs aggregation server. + +## TFNode-Pilot v0.1.0 +Pocket Network is a blockchain data platform built for applications that use cost-efficient economics to coordinate and distribute data at scale, enabling seamless interactions between blockchains and applications. This release's content: + +- Reverse-engineered the Pokt node pilot into Node Pilot Light. +- Deployed first version of PoktNetwork with TF Terraform Grid Provider. + +## TFChain v1.12 +- DAO support +- Dedicated nodes support +- General stability improvement +- Reworked farming policies +- Introduction of contract grace periods +- Farm certificaation through DAO +- New bridge code + diff --git a/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_6_1.md b/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_6_1.md new file mode 100644 index 0000000..cc1bc3d --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_6_1.md @@ -0,0 +1,103 @@ +# ThreeFold Grid v3.6.1 Release Note + +Release Note of ThreeFold Grid v3.6.1 It includes updates, improvements and fixes of numerous grid components as described below. + +## TFGrid 3.6.1 components + - testnet tfchain 1.12.1 + - substrate client (go) release for type change + - tfchain client (JS) release for type change + - graphql 2.3.3 + - tfchain bridge v2.1.0 + - ZOS 3.1.0-rc1 + - weblets 1.4.3-rc1 + - terraform 1.2.1 + - gridproxy v1.5.1 + - explorer 3.2.2 + - tfgrid_dashboard 1.0.6 + +## Component Upgrades + +### TFPlayground v1.4.3 +- Updated Farming Calculator +- Better node-filtering mechanism by adding 'capacity' filter +- Simplified K8s solution deployment by eliminating 'add ssh key' part +- Improved UX for manual solution deployment on dedicated nodes +- Fixed solution's post-deployment bad gateway issue. +- Validation enhancements + + +### ThreeFold Wallet v3.1.0 +- Enable token unlocking feature +- Allow users to unlock their locked tokens via TFwallet. +- Improvements and fixes included, including usability supports for iOS devices that will be greatly improved. + +### TFConnect App v3.6.0 + +- Better usability and user experience through the app workflow improvements as well as +- Improved design and interface, look and feel. + +### TF Planetary Network v0.3.0 +TF Planetary Network is an application that allows users to access[ Peer To Peer end2end encrypted global network](https://library.threefold.me/info/manual/#/technology/threefold__planetary_network) which lives on top of the existing internet or other Peer To Peer networks created. This release's improvements: + +- New P2P functionalities on Desktop Client +- Improved the desktop clients for planetary network by adding support for M1 version of Mac. +- Allowed the application to refresh the list of ‘peers’, allowing extra ‘peers’ to be added by TF org +- Debugged multiple account issues on Mac. + +### TFTShop (GetTFT) v1.1.1 + +- Better usability and user experience through the app workflow improvements +- Improved design and interface, look and feel, such as Improvement on TFT purchase flows on all BTC-TFT, and FIAT-TFT transactions + +### TFGrid Proxy v1.5.0 +TFGrid Proxy is a REST API-based server used to interact with TFGridDB (Database) in order to access all available node-related information. This release's improvements: + +- Added querying for dedicated nodes support in gridproxy API. +- Added support for twins and contracts. +- Added filter for dedicated nodes +- Added missing queries on farms +- Added country API for node distribution + +### ZOS v3.1.0 +- Support pausing workloads to allow grace period before canceling contract. +- Enabled log streaming from VMs/Containers to a remote logs aggregation server. + +### TFNode-Pilot v0.1.0 +Pocket Network is a blockchain data platform built for applications that use cost-efficient economics to coordinate and distribute data at scale, enabling seamless interactions between blockchains and applications. This release's content: + +- Optimized node pilot by Threefold. +- Deployed first version of PoktNetwork with TF Terraform Grid Provider. + +### TFChain v1.12 +- DAO support +- Dedicated nodes support +- General stability improvement +- Reworked farming policies +- Introduction of contract grace periods +- Farm certificaation through DAO +- New bridge code + +### TFgrid Dashboard +Tfgrid Dashboard is the mainhighlight of this release. We aim to have a simpler workflow for our Threefold users and more unified experience. The supported functionalites for this release are: +- Farm management +- Twin management +- Dedicated nodes +- Tfchain DAO +- Transferring money to TFChain accounts +- Swapping tokens on Binance and stellar +- Exploring farms +- Explorring nodes +- Grid statistics + +service is deployed on https://dashboard.test.grid.tf + +### Uhuru v1.4.0 (beta) +- Improved mobile View +- Improved multiple screen size views +- Added support and usability for more browsers (Firefox, Safari, etc) +- Added features on chat group management +- Full backend rewrite for improved performance, stability and security + +### TFConnect App v3.6.0 +- UX rewrite on for userflows like the welcome screen, registration screen, planetary network and many more +- Added Planetary network for iOS users \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_7_0.md b/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_7_0.md new file mode 100644 index 0000000..5294152 --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_7_0.md @@ -0,0 +1,101 @@ +# ThreeFold Grid v3.7.0 Release Note + +Release Note of ThreeFold Grid v3.7.0. +It includes updates, improvements and fixes of numerous grid components as described below. + + +## Component Upgrades + +### ThreeFold Wallet v3.7.0 +- Include the option to show transaction details (Sender, Receiver, Memo, Blockchain hash, Amount, Asset, Date +- Added Farmer types details +- GraphQL types fix +- Enabled wallet deletion +- Wallet Cache fixes +- Bugs fixes and generic improvements + +### ThreeFold Connect v3.7.0 +- Improved loading of webpages +- Released the IOS version of planetary network +- Improved login flow (backend) +- Removed the concept of .3bot from the app registration and other display +- Re-enable TFChain bridge after twin changed +- Backend: Upgraded from Vue v2 to Vue v3 +- Backend: Full kubernetes test deploy stack. +- Frontend: Add typescript, tailwind. Removed the use of vuetify +- Generic Bug fixes + + +### ThreeFold Grid Proxy Client v1.5.9 +- Initial Grid Proxy Client implementation +- Includes the gridproxy API client along with API-specific information +- Includes classes that represent entities in the context of the API in the sub-module model (for making conversions between JSON objects and V objects). +- Added CI pipeline to run tests + + +### ThreeFold Chain v2.1.0 +- Improved Validation for Public Config (Node) by Implementing a maximum size on all types that are filled in by the user or ZOS tfchain +- Improved Validation for Interfaces (Node) by Implementing a maximum size on all types that are filled in by the user or ZOS tfchain +- Improved Validationfor Public IPs (Farm) +- Improved Validation for Twin IPs +- Reworked public IPs on Contract, they are now shown as a list with the actual public IP object +- Executed billing in a transactional operation tfchain +- Added Restriction of deployment hash length (32 bytes) + +### Planetary Network v.3.7.0 +- Added support for M1 Mac. +- Refresh list of peers. +- Allow extra peers to be added by TF org. +- Fix UI crashing/lags +- Build for Ubuntu, Windows, Build for Mac + +### Freeflow Twin Beta 1.5 +- Major Rebranding from Uhuru to Freeflow Twin +- Generic Bug fixes +- Enabled tagging people in chats +- Improved dev setup +- Improved staging+production link setup. +- Self-deploy improvements. +- PWA support +- Add info labels +- HTML encoding of messages +- Overflow handling +- Remember login session +- Chat: Added File upload progress view +- Chat: Added Link preview +- Chat: Adding more search options + +### TFGrid Dashboard v1.1.4 +- UX/UI : Updated Color Palette +- Updated Font styles +- Updated sidebar menu UX to include TF Portal, TF Explorer +- Enabled day/night mode +- TFGrid Explorer: Added Nodes page, Statistic Page, and Farms page ON TFGrid Explorer +- TFGrid Explorer: Added category of listed nodes as (dedicated, rented, and arentable) +- TFGrid Stats: Updated Minting Details on TF Dashboard +- TFGrid Stats: show receipts of previous nodes +- TFGrid Stats: Added Calendar UI +- Clickable Live Support Chat Popup + +### TF Playground v1.4.4 +- UX/UI : Updated Color Palette +- Updated Fonts. +- New Deployment/Solutions Icons in the sidebar. +- New Actions Icons in the deployment list. +- Added Solution Categories +- Enabled custom ‘Presearch instance’ deployment +- New Capacity Filter +- Add IPv4 Planetary Network Filter for specific instance deployments +- Newly improved Capacity Management for solution deployment: enabling the setting of a full VM as the default Virtual Machine for deployment, +- Easily fund a deployment profile / ID by scanning your ID wallet QR Code +- Profile Manager: Avoid losing deployment with Grace Period Listing +- provide a simple list where you can select one of the online Grid gateways +- Profile Management: Add ‘Confirmation’ popup before deleting a deployment profile +- Added an Identifier for the current network in the sidebar (main/test/devnet) +- TF Playground Wallet: show unlocked/locked tokens in balance +- Profile Management: allow a user to create a profile with no SSH key. +- TFGrid Client TS supports Algorand, Stellar, and TFChain Modules. +- NEW Node Pilot Instance Deployment +- NEW Subsquid Solution + + diff --git a/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_8_0.md b/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_8_0.md new file mode 100644 index 0000000..9142adf --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_8_0.md @@ -0,0 +1,74 @@ +# ThreeFold Grid v3.8.0 Release Note + +Release Note of ThreeFold Grid v3.8.0. +Live on Testnet 02/02/2023 + +This release note includes updates, improvements and fixes of numerous grid components as described below: + +## The Components + +- TFChain v2.2.0 +- ZOS v3.4.0 +- TF Weblets v1.6.0 +- TF Dashboard v1.3.0 +- TFGrid Client v1.5.0 +- TFGrid Proxy v1.6.5 +- Terraform v1.6.0 + +## 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. +- 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 + +### ZOS v3.4.0 +This release was mainly focused on the stabilization of ZOS, Monitoring Support, upgrading components and fixing bugs as described below: +- Vector and Node-exporter support for [monitoring](https://metrics.grid.tf/) +- Bugfixes / hardening around uptime reports, capacity reports and QSFS workloads cleanup +- Added fixes for Grace Period regression +- Added fixes for ZOS Nodes Recovery after Network Outages +- Uptime reports rework: allowing it to happen every 40 minutes, instead of evey 2 hours +- Added Grace Period Workload Regression fixes + +[3.4 milestone](https://github.com/threefoldtech/zos/milestone/11) for more details + +### TF Weblets v1.6.0 +- Support [Algorand](https://www.algorand.com/) solution deployment +- Simplified Weblet's Profile Manager +- Support [Mastodon](https://joinmastodon.org/) solution deployment +- Upgraded [Discourse](https://www.discourse.org/) solution deployment support +- Various bugfixes and [UI Improvements](https://github.com/orgs/threefoldtech/projects/172/views/6) + +For more detailed information on this component release, please see [TF Weblets v1.6.0 Milestone](https://github.com/threefoldtech/grid_weblets/milestone/10) + +### TF Dashboard v1.3.0 +- Fixed broken 'Filter by Farm ID' +- Added fixes on HRU Filter +- Added Validation function on recipient's TFT address +- Added updates to sidebar icons +- Improved new farm addition function +- Added node filters validations fix +- Support filtering nodes by farm name +- Added Monitoring dashboard + +For more detailed information on this component release, please see [TF Dashboard v1.3.0 Milestone](https://github.com/threefoldtech/tfgrid_dashboard/milestone/12) + +### TFGrid Client 1.5.0 +- Added ZLogs workload support +- Added documentation updates + +### Terraform 1.6.0 +- Capacity planning upgrade +- Added Kubernetes token validation function + +## TFGrid Proxy v1.6.5 +- Added fixes on dedicated nodes reservation +- Added fixes on TCP connection leaks +- Added Swagger Docs fixes +- Added Updates to stats endpoint +- Added new queries for total resources +- Added more parameters to /nodes enpoint for filter by twin_id and node_id + +For more detailed information on this component release, please see [TFGrid Proxy v1.6.5 Milestone](https://github.com/threefoldtech/tfgridclient_proxy/milestone/5) diff --git a/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_9_0.md b/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_9_0.md new file mode 100644 index 0000000..972cb78 --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/roadmap/releasenotes/tfgrid_release_3_9_0.md @@ -0,0 +1,170 @@ +# ThreeFold Grid v3.9.0 Release Note + +Release Note of ThreeFold Grid v3.9.0. + +- Live on Mainnet 12/04/2023 +- Live on Testnet 23/03/2023 + + +This release is mainly around power management/capacity planning orchestrated by the farmerbot based on Wake-on Lan (WOL) and the reliable message bus (RMB) and the toolings update to utilize both. It also includes several other updates, improvements and fixes of numerous grid components as described below: + +## The Components + +- TFChain v2.3.0 +- ZOS v3.6.0 +- TF Farmerbot v1.0.0 +- TF Weblets v1.7.0 +- TF Dashboard v1.4.0 +- TF Gridclient v2.0.0 +- TF Gridproxy v1.7.0 +- Terraform v1.8.x +- RMB-RS v1.0.2 +- TFChain-GraphQL v2.9.0 + +## Upgrades and Improvement Highlights + +Below are some of the highlights of TFGrid v3.9.0 component upgrades and improvements. +Feel free to check [TFGrid v3.9.0 Project](https://github.com/orgs/threefoldtech/projects/172) for a more detailed overview of the TFGrid v3.9.0 release. + + +### RMB-RS v1.0.2 + +Reliable Message Bus Relay (RMB-RS) is a secure communication panel that allows bots to communicate together in a chat-like way. It makes it very easy to host a service or a set of functions to be used by anyone, even if your service is running behind NAT. + +- Guarantee authenticity of the messages. You are always sure that the received message is authentic from the sender. +- 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. + +> Below is the list of the __Public Relay Addresses__ hosted by Threefold: + +- Dev: wss://relay.dev.grid.tf +- QA: wss://relay.qa.grid.tf +- Test: wss://relay.test.grid.tf +- Main: wss://relay.grid.tf + +__Impacted Clients:__ + +- [RMB-SDK-TS](https://github.com/threefoldtech/rmb-sdk-ts/releases/tag/v1.1.1) +- [RMB-SDK-GO](https://github.com/threefoldtech/rmb-sdk-go/releases/tag/v1.0.0) + + +### TFChain v2.3.0 + +On this release, we modified the twin objects on TFChain and removed the notion of an `IP`. We added 2 fields (`Relay` and `PK`) onto the twins. + +- __Relay__: an RMB Relay Address which a client can connect to (See RMB changes) +- __PK__: a public key for an encryption key which can be used to encrypt messages on the Public Relay, if not set, traffic will be unencrypted. + +__Impacted Clients:__ + +- [Grid3_Client_RS](https://github.com/threefoldtecharchive/grid3_client_rs/releases/tag/v0.2.0) + +### TFChain-GraphQL v2.9.0 + +An important note for users, that multiple steps would be required to upgrade your TFChain-GraphQL into the latest v2.9.0 release, as described below: + +1. Restart the ingester from scratch using the new config +2. Restart the processor from scratch using the new code + +Please make sure all data is wiped before restarting both services. + +### TF Famerbot v1.0.0 + +TF Farmerbot is a new component that aim as a power management solution that would allow farmer to setup to enable Wake-on-LAN mechanism on their farms. + +## Other Component Changelogs + +### TFChain v2.3.0 + +- Fixed locked balances +- Added extra field to twin for publickey +- Fixed serial number validation was blocking nodes from registration +- Added fixes on Farming policies on Testnet +- Allow farms to Add public IP ranges +- Support power management and capacity planning +- Fixed TFT price on mainnet +- Reworked migrations +- Set node's last uptime when the node send an uptime event +- Disable twin deletion +- Bug fixes around data validations, and more. + +Please follow [this milestone](https://github.com/threefoldtech/tfchain/milestone/11) for more. + +### ZOS v3.6.0 + +- Support Switching dhcpd from udhcpd +- WOL support +- Power Management support +- Fixed gateways backend validation +- Added number of workloads and deployments to zos reported statistics +- Support the new RMB and Relay +- Provide clearer messaging during twin registration + +Please follow [this milestone](https://github.com/threefoldtech/zos/milestone/12) for more details + +### TF Farmerbot v1.0.0 + +- Initial Release +- Added Support for Power Management feature +- Added Support for Capacity Planning feature + +### TF Weblets v1.7.0 + +- NEW Wordpress solution +- NEW Umbrel solution +- Added live button support +- Better error reporting mechanism +- Support Mnemonics field editing +- Removed flash messages after successfull deployment + +Please follow [this milestone](https://github.com/threefoldtech/grid_weblets/milestone/9) for more details + +### TF Dashboard v1.4.0 + +- Public IP validation +- RenameD 'Swap' page to 'Bridge' +- Support setting Relay and Public Key +- Added filter by Country validation +- Filter farms by pricing policy support +- Resource pricing calculator discount distinction between shared and dedicated nodes + +Please follow [this milestone](https://github.com/threefoldtech/tfgrid_dashboard/milestone/13) for more details + +### TF GridClient v2.0.0 + +- Added Support for RMB and Public Key of Twins +- Added Support for Farmerbot +- Added pricing calculator module +- Support service contracts +- Added size property to QSFS model +- HTTP server mode allows configuration file for user credentials +- Added fixes on 'Filter nodes by farmID' featue + +### Terraform v1.8.x + +- Added Support for RMB and RMB Relay +- Added Support for deployment using direct client +- Added Support for parallel deployment of resources +- Expand resources and data sources documentation + +Please follow [this milestone](https://github.com/threefoldtech/terraform-provider-grid/milestone/16) for more details + +## RMB v1.0.2 + +The new version of RMB written in Rust + +- Added Federation support +- Added Signing and end-to-end encryption +- RMB-Peer for compatibility +- Added Ratelimiting support + +## TFGrid Proxy v1.7.0 + +- Removed the proxying features, obsoleted by the new RMB. + +Please follow [this milestone](https://github.com/threefoldtech/tfgridclient_proxy/milestone/6) for more details + + + diff --git a/collections/tfmanual/knowledge_base/about/roadmap/roadmap_readme.md b/collections/tfmanual/knowledge_base/about/roadmap/roadmap_readme.md new file mode 100644 index 0000000..acf698c --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/roadmap/roadmap_readme.md @@ -0,0 +1,11 @@ +# ThreeFold Grid and Product Roadmap + +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 + +## 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 diff --git a/collections/tfmanual/knowledge_base/about/tfchain.md b/collections/tfmanual/knowledge_base/about/tfchain.md new file mode 100644 index 0000000..f7d875a --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/tfchain.md @@ -0,0 +1,30 @@ +

TFChain

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [TFChain Uses](#tfchain-uses) + +*** + +## Introduction + +TFChain is a blockchain based on Parity Substrate which manages the TFGrid 3.x. + +TFChain is a combination of TFChain nodes. + +## TFChain Uses + +This blockchain is used for: + +- storing information as needed on the ThreeFold Grid + - identity information of entities (person and company) + - 3node phone book, where are the 3nodes, how much capacity, which farmer + - TF Farmer's, where are they based, how long active, reputation + - DigitalTwin Phonebook, registry of all digital_twins, where are they, public key, unique id, ... (\*1) + - Reputation information : how good is a farmer, uptime of a 3Node (\*2) + - Account_Metadata which is information about a digital currency wallet/account needed for vesting, locking, ... +- backend for Consensus_Engine. +- smartcontract_it layer (how to provision workloads on top of TFGrid) +- the backend for TFChainDB + diff --git a/collections/tfmanual/knowledge_base/about/threefold_ag.md b/collections/tfmanual/knowledge_base/about/threefold_ag.md new file mode 100644 index 0000000..cd5ba89 --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/threefold_ag.md @@ -0,0 +1,30 @@ +

ThreeFold Switzerland

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Some Plans](#some-plans) + +*** + +## Introduction + +ThreeFold Switzerland is officially called ThreeFold AG. + +While there are activities done at this time, we are preparing for future activities. + +## Some Plans + +- Promotion of ThreeFold, specifically in Zug Communities (CH). + + + +![](img/crypto_valley_zug_.jpg) \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/about/threefold_companies.md b/collections/tfmanual/knowledge_base/about/threefold_companies.md new file mode 100644 index 0000000..280a3f0 --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/threefold_companies.md @@ -0,0 +1,40 @@ +

ThreeFold Related Companies

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Companies Overview](#companies-overview) + +*** + +## Introduction + +The following companies are related parties to ThreeFold. Our terms and conditions apply. + +## Companies Overview + +| 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 | +| 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 | + + +| SOME LARGER FARMERS | | +| ------------------- | ---------------------------------------------------------------- | +| Green Edge | Early ThreeFold Farmer providing decentralized compute & storage | +| Bancadati | Large ThreeFold Farmer in Switzerland | +| 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 diff --git a/collections/tfmanual/knowledge_base/about/threefold_dubai.md b/collections/tfmanual/knowledge_base/about/threefold_dubai.md new file mode 100644 index 0000000..9c1836b --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/threefold_dubai.md @@ -0,0 +1,61 @@ +

ThreeFold Dubai

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Responsibilities](#responsibilities) +- [NEW 2023](#new-2023) +- [Some memories from 2015+](#some-memories-from-2015) +- [Structure: Oct 2021 - Dec 2022](#structure-oct-2021---dec-2022) +- [Official License](#official-license) + +*** + +## Introduction + +ThreeFold Dubai is the original team of ThreeFold operated from Dubai and Belgium. We started in 2016. + +## Responsibilities + +- Promote ThreeFold Grid and the ThreeFold Token +- 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 + +## NEW 2023 + +ThreeFold Dubai = ThreeFold DMCC and will launch a commercial business on top of the TFGrid. + +See more info in [this google doc](https://docs.google.com/document/d/10Ieu1D00vZdVNP9nQESk4WMszAM5vqi8XoWzSBy3xPU/edit) + +## Some memories from 2015+ + +At one point in time we had our office on the 74th floor of a building close to the Dubai International Airport. It was a cool spot with a great view, but we also realized the importance of being located closer to the ground. We only stayed there for just a little more than 1 year. + +![](img/view_dubai.jpg) +![](img/dubai_office1.jpg) + +Our main office was and still is in Al Jadaf which is, interestingly enough, a boat shipyard. This is where a lot of the ideas and work has been done to make ThreeFold possible. + +![](img/al_jadaf.jpg) +![](img/aljadaf2.jpg) + +The tower on the left in the photo above is where our office was. The place behind (to the right) is called Al Jadaf. We decided to do something different compared to most. No office in a fancy office building. Instead we have our office next to the water in a very old shipyard. Very unique, and it much more cost effective as well. (-: + +Still today there are more than 100 servers located there in our testlab, and the ThreeFold Dubai was run from there. + +## Structure: Oct 2021 - Dec 2022 + +- ThreeFold Dubai is our operational HQ from where all Foundation activities are coordinated. +- ThreeFold Dubai was mainly funded from TFTech (during 2019-2022), this will now change in 2023 +- ThreeFold Dubai sometimes uses ThreeFold Labs IT which is a Dubai onshore company for when we need onshore activities like visa's for our people, workpermits, invoicing, ... ThreeFold Labs IT is just a services company to deal with some of these practical elements. + +Adnan Fatayerji is the managing director and shareholder, in the future the shares of ThreeFold Dubai will be 100% owned by The OurWorld Venture Creator + +## Official License + +Please see below the ThreeFold DMCC license: + +![](img/threefold_dmcc_license_certificate.jpg) + diff --git a/collections/tfmanual/knowledge_base/about/threefold_history.md b/collections/tfmanual/knowledge_base/about/threefold_history.md new file mode 100644 index 0000000..df6c74c --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/threefold_history.md @@ -0,0 +1,59 @@ +

ThreeFold History

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [History](#history) +- [ThreeFold Project Funding Total](#threefold-project-funding-total) +- [Status](#status) +- [Genesis Pool](#genesis-pool) +- [History of Tokens](#history-of-tokens) + +*** + +## Introduction + +The project, now in its sixth year and is gratefulf or the support of its community and commercial entity [ThreeFold Tech](https://github.com/threefoldtech). + +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. + +Our founders have largely retained their tokens, with only minimal sales, if any. Their intent is clear: they plan to hold onto their tokens until the grid achieves global recognition and the token value surpasses 0.2 USD. + +## History + +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. + +The ThreeFold Grid is the result of many farmers using the open source technology of ThreeFold Tech. + +Originally, the technology used was created by three companies: GreenIT Globe, ThreeFold Dubai & ThreeFold Tech. The last two still actively participate in the creation of tech components or content as used by all ThreeFold Farmers today. + +## ThreeFold Project Funding Total + +How much funding was used to make the ThreeFold project possible? + +> +- 50M USD + +- +20M USD for all farming (thank you farmers) +- 15M USD in ThreeFold Tech as convertible loan (by 50+ investors) +- 5M USD in early IT capacity purchases (as TFT) +- +10M USD funding from Incubaid/Kristof (estimate) + - ThreeFold Tech was established Oct 2018, from out of Incubaid + - Related to people related to [Incubaid](https://www.incubaid.com) + - Over quite some years, multiple companies/projects + +## Status + +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) + + +## 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. + +## History of Tokens + +For more info about history of tokens, see [token history](./token_history.md). \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/about/threefold_tech.md b/collections/tfmanual/knowledge_base/about/threefold_tech.md new file mode 100644 index 0000000..5f90ee4 --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/threefold_tech.md @@ -0,0 +1,41 @@ +

ThreeFold Tech

+ +

Table of Contents

+ +- [Overview](#overview) +- [Location](#location) + +*** + +## Overview + +Company developing & promoting software for self-healing, self-driving cloud & blockchain workloads. Has developed most of the software as used in the ThreeFold_Grid. + +- TFTech is working together with industry partners to sell its software + - Major partners: HPE, Solidaridad, Kleos (learn more on [threefold.io/partners](https://threefold.io/partners) +- Income - License and OEM agreements involving the TFTech technology: - License fees can be in the form of a revenue share on commercial products being developed on top of the TF platform. - With respect to the TF Grid, a fee of 10% of revenue generated is charged + for as a license fee for certified edge Internet Capacity registered on the TF Grid + network +- Investors to this point: + - Self-funded by founders & current funding round + +see https://threefold.tech/ + +We believe that doing good for the world and growing a successful software company can go hand in hand. + +ThreeFold Tech is a Belgium-based for-profit software company that believes that doing good for the world and building a successful company can go hand-in-hand. They are responsible for the technology behind the ThreeFold_Grid. + +ThreeFold Tech business wise focusses on + +- [X] sell licenses to companies and/or governments to deploy private versions of our cloud technology. +- [X] create an antidote for the Cyberpandemic, help customers to protect themselves against this huge threat. + +The company is 80% engineering centric today. + +> TFTech has no links to tokens, at this point (March 2021) does not own any of them either. All Token & TFGrid activities are coordinate from ThreeFold Dubai. + +![](img/threefold_tech.jpg) + +## Location + +![](img/threefold_tech_location.jpg) diff --git a/collections/tfmanual/knowledge_base/about/threefold_vzw.md b/collections/tfmanual/knowledge_base/about/threefold_vzw.md new file mode 100644 index 0000000..584653f --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/threefold_vzw.md @@ -0,0 +1,48 @@ +

ThreeFold VZW

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Functions](#functions) +- [Some History](#some-history) +- [Belgium Official Doc](#belgium-official-doc) + +*** + +## Introduction + +ThreeFold VZW is a non for profit organization based in Belgium. + +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) + +## Some History + +We all started in Belgium from Korenlei 22, a super old building in the middle of the town. It dates back to 1731. + +![](img/korenlei_22.jpg) + +![](img/korenlei_old.jpg) + +Now the foundation has another address in Lochristi. + + + +## Belgium Official Doc + +![](img/threefold_vzw_official_doc.jpg) + + + +See also https://trendstop.knack.be/en/detail/747872572/threefold-foundation.aspx \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/about/token_history.md b/collections/tfmanual/knowledge_base/about/token_history.md new file mode 100644 index 0000000..613d000 --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/token_history.md @@ -0,0 +1,96 @@ +

Token History

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Quick History Overview](#quick-history-overview) +- [Organic Growth](#organic-growth) +- [Farming Model Improvements](#farming-model-improvements) + - [TFT Versions](#tft-versions) +- [Migration](#migration) + - [Migration from TFTv1 Rivine to TFTv1 Stellar (2020)](#migration-from-tftv1-rivine-to-tftv1-stellar-2020) + - [Migration from TFTv1 Stellar (Staking Pool=TFTA) to TFTv2 Stellar (Trading or Production Pool=TFT)](#migration-from-tftv1-stellar-staking-pooltfta-to-tftv2-stellar-trading-or-production-pooltft) + - [Technical Information](#technical-information) + +*** + +## Introduction + +We present the ThreeFold token history and the path from TFT v1 towards TFT v2. + +## Quick History Overview + +- 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 + - 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 + - The TFT v1 was launched on a blockchain called Rivine (PTO) + - The genesis pool resulted in the first batch initial TFT + - The blockchain nodes were hosted by +30 different parties completely unrelated to each other +- In Q2 2019, ThreeFold_Dubai launched our generation 1 of our TF Grid +- April 2020 ThreeFold_Dubai launched the TFGrid v2.0 which is now public and usable by the world + - ThreeFold has a new website and a new wiki + - The farmers & TFT holders have at their own will upgraded their wallets, zero-nodes, ... +- May 2020: ThreeFold_Dubai launched our 2nd version of our token called TFT but this time on Stellar + - The original TFTv1 kept all same properties and benefits and is now called TFTA also on Stellar (is technology choice), anyone can move from TFTv1 to TFTv2 + - TF Foundation Dubai has provisioned the TFTv1 & TFTv2 on Stellar blockchain, but has no influence or access to any of the wallets or for that matter the 3Nodes (the boxes providing IT capacity) + - See below for more info, this was the result of 12 months of work with our community and of-course consensus to do this. + +## Organic Growth + +We didn't artificially pump the value of the tokens. + +We did not issue (print) tokens and go out onto an exchange to offer these tokens to the market. This is referred to as a public ICO. Some ICOs were not very clean in how they created hype and convinced people to invest. Because of our decision not to do a public ICO, we have not been able to raise much money, but we feel that this was more aligned with our values. + +We have sold some TFT over the counter but please note every buyer could at any point in time use these TFTs to buy IT capacity, this makes these TFT purposeful, even from the very start. + +## Farming Model Improvements + +In Q2 2020 we were launching TF Grid 2.0 with updated minting rules. As part of these farming rules the max number of tokens became 4 billion, which changes the optics of the original size of the genesis token pool. + +In Q3 2021 we launched TF Grid 3.0 which has again brought improvement to the farming model. Its up to the farmers to choose if they want to change to the new farming model or not. + +### TFT Versions + +| | version 1 Rivine | version 1 Stellar | version 2 Stellar | +| ------------------------------- | --------------------------- | ----------------- | --------------------------- | +| blockchain tech | Rivine, proof of blockstake | Public, Stellar | Public, Stellar | +| on public blockchain | march 2018 | 2020 May | 2020 May | +| farmed since | +-2017 | 2020 May | tbd | +| freely transferable (\*) | YES | YES | YES | +| complete blockchain feature set | YES | YES | YES | +| decentralized exchange | YES (atomic swap) | YES (Stellar) | YES (Stellar) | +| public exchange | BTC Alpha till Dec 2019 | Stellar | Stellar, BTC Alpha & Liquid (until August 2022) | +| freely tradable on exchange | YES | YES | YES | +| Name on Blockchain | TFT | TFTA | TFT | +| Purpose | v1 token | Staking Pool | Trading Pool | + +## Migration + +### Migration from TFTv1 Rivine to TFTv1 Stellar (2020) + +- TF Tech decided to no longer support development of Rivine, at this time there are better technologies available as blockchain +- The Foundation investigated many blockchain platforms & recommended to use Stellar +- Jimber (company which maintains the wallet, which is open source code), has made the changes in the wallet to be able to support this new blockchain +- The conversation had to be a mandatory one, because otherwise there would be the potential of double-spending problems over both simultaneously-active blockchains +- What happened here can be compared to a website deciding to change the database backend (change from e.g. MS Sql to Oracle). The users of the website should not have to be aware of this migration +- Every user had to do the transaction themselves, no developer or anyone else had control over this migration step. This was an automatic step +- Everyone can use the validation scripts available to check the correct conversion between two blockchain technologies. The validation scripts prove that every transaction in the conversion happened well + +### Migration from TFTv1 Stellar (Staking Pool=TFTA) to TFTv2 Stellar (Trading or Production Pool=TFT) + +- See [TFTA to TFT](../legal/terms_conditions/tfta_to_tft.md) + +### Technical Information + +[TFTA TrustLine](https://stellar.expert/explorer/public/asset/TFTA-GBUT4GP5GJ6B3XW5PXENHQA7TXJI5GOPW3NF4W3ZIW6OOO4ISY6WNLN2) + +Accounts that got initial balances migrated them from the previous blockchain, [rivine](https://explorer2.threefoldtoken.com/). + +To validate this, each migration transaction contain hash of the rivine lock transaction in their memo in hex format. + +[Rivine block explorer](https://explorer2.threefoldtoken.com/) can be used for validation purposes. + +> Important note: The ThreeFold Token (TFT) is not an investment instrument. TFTs represent IT capacity on the ThreeFold Grid, farmers create TFT, developers use TFT. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/about/token_overview/img/token_distribution.png b/collections/tfmanual/knowledge_base/about/token_overview/img/token_distribution.png new file mode 100644 index 0000000..a05ad5a Binary files /dev/null and b/collections/tfmanual/knowledge_base/about/token_overview/img/token_distribution.png differ diff --git a/collections/tfmanual/knowledge_base/about/token_overview/special_wallets/stats_special_wallets.md b/collections/tfmanual/knowledge_base/about/token_overview/special_wallets/stats_special_wallets.md new file mode 100644 index 0000000..2ee00a3 --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/token_overview/special_wallets/stats_special_wallets.md @@ -0,0 +1,56 @@ +

ThreeFold Special Wallets

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Exchange and OTC Wallets](#exchange-and-otc-wallets) +- [ThreeFold Contribution Wallets](#threefold-contribution-wallets) +- [Wisdom Council Wallets](#wisdom-council-wallets) +- [Important Note](#important-note) +- [Remarks](#remarks) + +*** + +## Introduction + +We present special wallets that hold a given amount of TFT. + +## Exchange and OTC Wallets + +| **Description** | **TFT Balance** | **Address** | +| ------------------ | ----------- | -------------------------------------------------------------------------------- | +| Liquid Exchange #1 | {{#include ./wallet_data/GA7OPN4A3JNHLPHPEWM4PJDOYYDYNZOM7ES6YL3O7NC3PRY3V3UX6ANM.md}} | [GA7OPN4A3JNHLPHPEWM4PJDOYYDYNZOM7ES6YL3O7NC3PRY3V3UX6ANM](https://stellar.expert/explorer/public/account/GA7OPN4A3JNHLPHPEWM4PJDOYYDYNZOM7ES6YL3O7NC3PRY3V3UX6ANM) | +| Liquid Exchange #2 | {{#include ./wallet_data/GDSKFYNMZWTB3V5AN26CEAQ27643Q3KB4X6MY4UTO2LIIDFND4SPQZYU.md}} | [GDSKFYNMZWTB3V5AN26CEAQ27643Q3KB4X6MY4UTO2LIIDFND4SPQZYU](https://stellar.expert/explorer/public/account/GDSKFYNMZWTB3V5AN26CEAQ27643Q3KB4X6MY4UTO2LIIDFND4SPQZYU) | +| gettft.com | {{#include ./wallet_data/GBQHN7RL4LSRPR2TT74ID2UJPZ2AXCHQY2WKGCTDLJM3NXVJ7GQHUCOD.md}} | [GBQHN7RL4LSRPR2TT74ID2UJPZ2AXCHQY2WKGCTDLJM3NXVJ7GQHUCOD](https://stellar.expert/explorer/public/account/GBQHN7RL4LSRPR2TT74ID2UJPZ2AXCHQY2WKGCTDLJM3NXVJ7GQHUCOD) | +| BTC-Alpha Exchange | {{#include ./wallet_data/GBTPAXXP6534UPC4MLNGFGJWCD6DNSRVIPPOZWXAQAWI4FKTLOJY2A2S.md}} | [GBTPAXXP6534UPC4MLNGFGJWCD6DNSRVIPPOZWXAQAWI4FKTLOJY2A2S](https://stellar.expert/explorer/public/account/GBTPAXXP6534UPC4MLNGFGJWCD6DNSRVIPPOZWXAQAWI4FKTLOJY2A2S) | + +## ThreeFold Contribution Wallets + +| **Description** | **TFT Balance** | **Address** | +| ------------------------------- | ----------- | -------------------------------------------------------------------------------- | +| TF DAY2DAY operations | {{#include ./wallet_data/GB2C5HCZYWNGVM6JGXDWQBJTMUY4S2HPPTCAH63HFAQVL2ALXDW7SSJ7.md}} | [GB2C5HCZYWNGVM6JGXDWQBJTMUY4S2HPPTCAH63HFAQVL2ALXDW7SSJ7](https://stellar.expert/explorer/public/account/GB2C5HCZYWNGVM6JGXDWQBJTMUY4S2HPPTCAH63HFAQVL2ALXDW7SSJ7) | +| TF Promotion Wallet | {{#include ./wallet_data/GDLVIB44LVONM5K67LUPSFZMSX7G2RLYVBM5MMHUJ4NAQJU7CH4HBJBO.md}} | [GDLVIB44LVONM5K67LUPSFZMSX7G2RLYVBM5MMHUJ4NAQJU7CH4HBJBO](https://stellar.expert/explorer/public/account/GDLVIB44LVONM5K67LUPSFZMSX7G2RLYVBM5MMHUJ4NAQJU7CH4HBJBO) | +| TF Grants Wallet | {{#include ./wallet_data/GDKXTUYNW4BJKDM2L7B5XUYFUISV52KUU4G7VPNLF4ZSIKBURM622YPZ.md}} | [GDKXTUYNW4BJKDM2L7B5XUYFUISV52KUU4G7VPNLF4ZSIKBURM622YPZ](https://stellar.expert/explorer/public/account/GDKXTUYNW4BJKDM2L7B5XUYFUISV52KUU4G7VPNLF4ZSIKBURM622YPZ) | +| ThreeFold Carbon Credit Funding | {{#include ./wallet_data/GDIJY6K2BBRIRX423ZFUYKKFDN66XP2KMSBZFQSE2PSNDZ6EDVQTRLSU.md}} | [GDIJY6K2BBRIRX423ZFUYKKFDN66XP2KMSBZFQSE2PSNDZ6EDVQTRLSU](https://stellar.expert/explorer/public/account/GDIJY6K2BBRIRX423ZFUYKKFDN66XP2KMSBZFQSE2PSNDZ6EDVQTRLSU) | +| TF Team Wallet | {{#include ./wallet_data/GCWHWDRXYPXQAOYMQKB66SZPLM6UANKGMSL4SP7LSOIA6OTTOYQ6HBIH.md}} | [GCWHWDRXYPXQAOYMQKB66SZPLM6UANKGMSL4SP7LSOIA6OTTOYQ6HBIH](https://stellar.expert/explorer/public/account/GCWHWDRXYPXQAOYMQKB66SZPLM6UANKGMSL4SP7LSOIA6OTTOYQ6HBIH) | + +## Wisdom Council Wallets + +| **Description** | **TFT Balance** | **Address** | +| --------------------------------------- | ----------- | -------------------------------------------------------------------------------- | +| Liquidity/Ecosystem Contribution Wisdom | {{#include ./wallet_data/GBV734I2SV4YDDPVJMYXU3IZ2AIU5GEAJRAD4E4BQG7CA2N63NXSPMD6.md}} | [GBV734I2SV4YDDPVJMYXU3IZ2AIU5GEAJRAD4E4BQG7CA2N63NXSPMD6](https://stellar.expert/explorer/public/account/GBV734I2SV4YDDPVJMYXU3IZ2AIU5GEAJRAD4E4BQG7CA2N63NXSPMD6) | +| TF Promotion Wisdom | {{#include ./wallet_data/GAI4C2BGOA3YHVQZZW7OW4FHOGGYWTUBEVNHB6MW4ZAFG7ZAA7D5IPC3.md}} | [GAI4C2BGOA3YHVQZZW7OW4FHOGGYWTUBEVNHB6MW4ZAFG7ZAA7D5IPC3](https://stellar.expert/explorer/public/account/GAI4C2BGOA3YHVQZZW7OW4FHOGGYWTUBEVNHB6MW4ZAFG7ZAA7D5IPC3) | +| TF Grants Wisdom | {{#include ./wallet_data/GCEJ7DMULFTT25UH4FAAGOZ6KER4WXAYQGJUSIITQD527DGTKSXKBQGR.md}} | [GCEJ7DMULFTT25UH4FAAGOZ6KER4WXAYQGJUSIITQD527DGTKSXKBQGR](https://stellar.expert/explorer/public/account/GCEJ7DMULFTT25UH4FAAGOZ6KER4WXAYQGJUSIITQD527DGTKSXKBQGR) | +| TF Team Wisdom | {{#include ./wallet_data/GAQXBLFG4BZGIVY6DBJVWE5EAP3UNHMIA2PYCUVLY2JUSPVWPUF36BW4.md}} | [GAQXBLFG4BZGIVY6DBJVWE5EAP3UNHMIA2PYCUVLY2JUSPVWPUF36BW4](https://stellar.expert/explorer/public/account/GAQXBLFG4BZGIVY6DBJVWE5EAP3UNHMIA2PYCUVLY2JUSPVWPUF36BW4) | +| Wisdom Council Locked | {{#include ./wallet_data/GAUGOSYLCX7JZTQYF2K7RIMHFWKSA3WSI2OQ4IRKXMDMVE6ABJIJMFQR.md}} | [GAUGOSYLCX7JZTQYF2K7RIMHFWKSA3WSI2OQ4IRKXMDMVE6ABJIJMFQR](https://stellar.expert/explorer/public/account/GAUGOSYLCX7JZTQYF2K7RIMHFWKSA3WSI2OQ4IRKXMDMVE6ABJIJMFQR) | + +## Important Note + +ThreeFold DMCC (Dubai) is in the process of acquiring a substantial number of tokens. While these tokens possess liquidity from a technical standpoint, they are not currently accessible or traded on the open market. This reserve of tokens has been allocated for our upcoming commercial rollout, and their governance will be managed through consensus based system with input from the community. + +## Remarks + +- All wisdom council wallets are protected by multisignature of the members of the wisdom council +- All foundation wallets are protected by members of the foundation (4 on 6 need to sign) +- Signatures can be checked by going to detail of account and then to the stellar link +- The foundation will never spend tokens if the markets cannot support it and all proceeds are 100% used for the benefit of the ThreeFold project. diff --git a/collections/tfmanual/knowledge_base/about/token_overview/token_overview.md b/collections/tfmanual/knowledge_base/about/token_overview/token_overview.md new file mode 100644 index 0000000..4319621 --- /dev/null +++ b/collections/tfmanual/knowledge_base/about/token_overview/token_overview.md @@ -0,0 +1,90 @@ +

ThreeFold Token Overview

+ +

Table of Contents

+ +- [Introduction to TFT](#introduction-to-tft) +- [Proof-of-Capacity](#proof-of-capacity) +- [Proof-of-Utilization](#proof-of-utilization) + - [Proof-of-Utility Distribution Flow](#proof-of-utility-distribution-flow) +- [TFT Distribution](#tft-distribution) +- [TFT Marketcap and Market Price](#tft-marketcap-and-market-price) +- [Complemetary Information](#complemetary-information) +- [Disclaimer](#disclaimer) + +*** + +## Introduction to TFT + +ThreeFold tokens, or TFTs, are exclusively generated when new capacity is added to the TF Grid. There are no centralized issuers. Tokens have not been created out of thin air. + +While the ThreeFold Grid can expand, a maximum of 1 billion TFTs can ever be in circulation. This limit ensures stability of value and incentivization for all stakeholders. + +TFT lives on the Stellar Blockchain. TFT holders benefit from a big ecosystem of proven wallets and mediums of exchange. + +By employing Stellar technology, TFT transactions and smart contracts are powered by one of the most energy-efficient blockchains available. Furthermore, TFT is the medium of exchange on the greenest internet network in the world. The market for farming, cultivating and trading TFT is open to all. + +Anyone with internet connection, power supply and necessary hardware can become a Farmer or trade ThreeFold tokens (TFT). + +By farming, buying, holding, and utilizing ThreeFold Tokens, you are actively supporting the expansion of the ThreeFold Grid and its use cases — creating a more sustainable, fair, and equally accessible Internet. + +## Proof-of-Capacity + +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) + +## Proof-of-Utilization + +TFT is used on the TFGrid to purchase network, compute and storage resources through the proof-of-utilization protocol. + +### Proof-of-Utility Distribution Flow + +![](img/token_distribution.png) + +> For more details, see [Proof-of-Utilization](../../farming/proof_of_utilization.md) + +## TFT Distribution + +The supply distribution of TFT is as follows: + +| Supply Distribution | Qty (Millions) | +| ------------------- | -------------- | +| Total supply | 942 | +| TF Foundation Supply | 162 | +| Circulating supply | 780 | +| Maximum supply | 1000 | + +The total supply of TFT is distributed as follows: + +| Total Supply Distribution | Qty (Millions) | +| ------------------------------------------- | -------------- | +| TF Foundation: Ecosystem Grants | 22 | +| TF Foundation: Promotion & Marketing Effort | 100 | +| TF Foundation: Ecosystem Contribution & Liquidity Exchanges | 40 | +| Genesis Pool & Farming Rewards | 780 | + +## TFT Marketcap and Market Price + +The TFT market price and marketcap are as follows: + +| **Description** | **Value** | +| ------------------------- | ------------- | +| TFT Market Price | {{#include ../../../values/tft_value.md}} USD | +| TFT Market Cap | {{#include ../../../values/tft_marketcap.md}} USD | + +The market cap is equal to the product of the TFT market price and the circulating supply. + +> Market Cap = (TFT Market Price) X (TFT Circulating Supply) + +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) + +## Disclaimer + +> Important Note: The ThreeFold Token (TFT) is not an investment instrument. +TFTs represent IT capacity on the ThreeFold Grid, farmers create TFT, developers use TFT. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/cloud/cloud_toc.md b/collections/tfmanual/knowledge_base/cloud/cloud_toc.md new file mode 100644 index 0000000..4a50bd7 --- /dev/null +++ b/collections/tfmanual/knowledge_base/cloud/cloud_toc.md @@ -0,0 +1,16 @@ +

Cloud

+ +This section covers the essential information concerning Cloud utilization. + +To deploy on the ThreeFold Grid, refer to the [System Administrators](../../documentation/system_administrators/system_administrators.md) section. + +

Table of Contents

+ +- [Cloud Units](./cloudunits.md) +- [Pricing](./pricing/pricing_toc.md) + - [Pricing Overview](./pricing/pricing.md) + - [Staking Discounts](./pricing/staking_discount_levels.md) + - [Cloud Pricing Compare](./pricing/cloud_pricing_compare.md) + - [Grid Billing](./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/tfmanual/knowledge_base/cloud/cloudunits.md b/collections/tfmanual/knowledge_base/cloud/cloudunits.md new file mode 100644 index 0000000..e9f34c4 --- /dev/null +++ b/collections/tfmanual/knowledge_base/cloud/cloudunits.md @@ -0,0 +1,69 @@ +

Cloud Units

+ +

Table of Contents

+ +- [What are Cloud Units?](#what-are-cloud-units) +- [How is the price of Cloud Units (v4) calculated?](#how-is-the-price-of-cloud-units-v4-calculated) + - [Compute Capacity](#compute-capacity) + - [Storage Capacity](#storage-capacity) + - [Network](#network) + +*** + +## What are Cloud Units? +Cloud units are the basis for price calculation for anyone intending to use/deploy on the Threefold Grid. + +Cloud units are a unified way to account for virtual hardware resources on the ThreeFold Grid. They represent compute, storage and network equivalents to energy (kW - kilowatt). The are three categories of cloud units: + +- Compute Unit (CU): The amount of data processing power in terms of virtual CPU (vCPU) cores (logical [CPUs](https://en.wikipedia.org/wiki/Central_processing_unit)) and Random Access Momory ([RAM](https://en.wikipedia.org/wiki/Random-access_memory)). +- 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. + +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. + +## How is the price of Cloud Units (v4) calculated? + +The following tables display how cloud units (v4) are calculated on the ThreeFold Grid. The 4th version of cloud units are used since Grid 2.2+ in mid 2020. + +### Compute Capacity + +| CU (Compute Unit) | | | | | +| ------------------------------------- | --- | --- | ---- | --------------- | +| GB Memory | 4 | 8 | 2 | | +| nr vCPU | 2 | 1 | 4 | | +| Passmark Minimum (expected is double) | 500 | 250 | 1000 | CPU performance | + +The passmark (CPU benchmark or alternative) is not measured on the grid yet. It is used in simulators to check the mechanisms and ensure enough performance per CU is delivered. + +Example of Compute unit: +- 4 GB memory & 2 virtual CPU (and 50GB of SSD disk space) +- 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). + +### Storage Capacity + +| SU (Storage Unit) | HDD | SSD | +| ------------------- | ---- | --- | +| GB Storage Capacity | 1200 | 200 | + +HDD is only usable for Zero Database driven storage (e.g. ThreeFold Quantum Safe Storage). 1.2 TB of HDD is provided following the advised storage policy of 16+4 with 20% overhead. So the net usable storage would be 1TB. In other words, the SU corresponds in that case to 1TB of net usable storage and an extra 200GB for redundancy. + +Example of Storage unit: + +- 1TB of usable storage as provided by the Zero-DBs (the backend storage systems) +- 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). + +### Network + +| NU (Network Unit = per GB) = NRU per month | GB (NRU) | +| ------------------------------------------ | -------- | +| 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 diff --git a/collections/tfmanual/knowledge_base/cloud/cloudunits_advanced.md b/collections/tfmanual/knowledge_base/cloud/cloudunits_advanced.md new file mode 100644 index 0000000..05bd98c --- /dev/null +++ b/collections/tfmanual/knowledge_base/cloud/cloudunits_advanced.md @@ -0,0 +1,52 @@ +# Cloud Units Advanced + +## How is the price of Cloud Units (v4) calculated? + +The following tables display how cloud units (v4) are calculated on the ThreeFold Grid. The 4th version of cloud units are used since Grid 2.2+ in mid 2020. + +> Note: [Resource units](resource_units.md) are used to calculate SU & CU. Resource Units are used to measure compute and storage capacity produced by hardware. + +### Compute Capacity + +| CU (Compute Unit) | | | | | +| ------------------------------------- | --- | --- | ---- | --------------- | +| GB Memory | 4 | 8 | 2 | | +| nr vCPU | 2 | 1 | 4 | | +| Passmark Minimum (expected is double) | 500 | 250 | 1000 | CPU performance | + +The passmark (CPU benchmark or alternative) is not measured on the grid yet. It is used in simulators to check the mechanisms and ensure enough performance per CU is delivered. + +Example of Compute unit: + +- 4 GB memory & 2 virtual CPU (and 50GB of SSD disk space) +- 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). + +### Storage Capacity + +| SU (Storage Unit) | HDD | SSD | +| ------------------- | ---- | --- | +| GB Storage Capacity | 1200 | 200 | + +HDD is only usable for Zero Database driven storage (e.g. ThreeFold Quantum Safe Storage). 1.2 TB of HDD is provided following the advised storage policy of 16+4 with 20% overhead. So the net usable storage would be 1TB. In other words, the SU corresponds in that case to 1TB of net usable storage and an extra 200GB for redundancy. + +Example of Storage unit: + +- 1TB of usable storage as provided by the Zero-DBs (the backend storage systems) +- 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). + +### Network + +| NU (Network Unit = per GB) = NRU per month | GB (NRU) | +| ------------------------------------------ | -------- | +| 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), a way to measure the compute and storage capacity produced by hardware. + + + diff --git a/collections/tfmanual/knowledge_base/cloud/grid_billing/grid_billing.md b/collections/tfmanual/knowledge_base/cloud/grid_billing/grid_billing.md new file mode 100644 index 0000000..771d59d --- /dev/null +++ b/collections/tfmanual/knowledge_base/cloud/grid_billing/grid_billing.md @@ -0,0 +1,422 @@ +

Grid Billing

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Resources to Update](#resources-to-update) + - [Current TFT Price](#current-tft-price) + - [Current Cloud Units Values](#current-cloud-units-values) +- [Node Contract](#node-contract) + - [Calculating the CU](#calculating-the-cu) + - [Calculating the SU](#calculating-the-su) + - [Calculating the Billing Rate for the Contract](#calculating-the-billing-rate-for-the-contract) + - [Applying the Discounts](#applying-the-discounts) +- [Rent Contract](#rent-contract) + - [Getting the Resources](#getting-the-resources) + - [Calculating the CU](#calculating-the-cu-1) + - [Calculating the SU](#calculating-the-su-1) + - [Calculating the Billing Rate for the Contract](#calculating-the-billing-rate-for-the-contract-1) + - [Applying the Dedicated Node Discount](#applying-the-dedicated-node-discount) + - [Applying the Staking Discount](#applying-the-staking-discount) +- [Name Contract](#name-contract) + - [Applying the Staking Discount](#applying-the-staking-discount-1) +- [Public IP](#public-ip) + - [Applying the Staking Discount](#applying-the-staking-discount-2) +- [Network Usage](#network-usage) + - [Data Usage](#data-usage) + - [NU Value](#nu-value) + - [Applying the Staking Discount](#applying-the-staking-discount-3) +- [Billing History](#billing-history) + +*** + +## Introduction + +In this section, we explain how the billing works on the TFGrid by showing different examples such as node, rent and name contracts as well as public IP and network usage. + + + +## Resources to Update + +Some of the used resources should be updated whenever you try to do these calculations, these resources are the TFT price and the cloud units (SU and CU). + +### Current TFT Price + +TFT price can be retrieved directly through [Stellar](https://stellar.expert/explorer/public/asset/TFT-GBOVQKJYHXRR3DX6NOX2RRYFRCUMSADGDESTDNBDS6CDVLGVESRTAC47-1?asset[]=TFT-GBOVQKJYHXRR3DX6NOX2RRYFRCUMSADGDESTDNBDS6CDVLGVESRTAC47-1&filter=markets&market=USDC-GA5ZSEJYB37JRC5AVCIA5MOP4RHTM335X2KGX3IHOJAPP5RE34K4KZVN-1) or from the [Dashboard](https://dashboard.grid.tf/), through the price available in the header. + +![image](./img/grid_billing_1.png) + +### Current Cloud Units Values + +The current cloud units values can be retrieved directly from TChain with the [Polkadot UI](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Ftfchain.grid.tf#/chainstate) and the current chain state. + +- On the page `Chain State`, select `tfgridModule` as the `selected state query` +- Select `pricingPolicies(u32): Option` +- Enter the value of the default pricing policy, which is `1`, or enter the value of any other policy if you need to use a custom one +- Press `Enter` + +![image](./img/grid_billing_2.png) + +> Note: Values on chain are expressed as "units USD per hour", where "1 unit USD" == 10.000.000 (or 1e7) + +## Node Contract + +For this example, we will assume that the resources for this deployment are the following: + +``` +CRU: 2 +MRU: 2 +SRU: 15 +HRU: 0 +``` + +### Calculating the CU + +Let's calculate the CU of this deployment. + +For our example, the CU value is `10 mUSD/h`. Make sure that this value is updated according to the current values. + +``` +CU = min( max(MRU/4, CRU/2), max(MRU/8, CRU), max(MRU/2, CRU/4) ) + = min( max(2/4, 2/2), max(2/8, 2), max(2/2, 2/4) ) + = min( max(0.5, 1), max(0.25, 2), max(1, 0.5) ) + = min( 1, 2, 1 ) + = 1 +CU cost/hour = CU * CU pricing + = 1 * 10 mUSD/h + = 10 mUSD/h +``` + + +### Calculating the SU + +Let's calculate the SU of this deployment. + +The current SU value is `5 mUSD/h`. Make sure that this value is updated according to the current values. + +``` +SU = HRU/1200 + SRU/200 + = 0/1200 + 15/200 + = 0 + 0.075 + = 0.075 +SU cost/hour = SU * SU pricing + = 0.075 * 5 mUSD/h + = 0.375 mUSD/h +``` + + +### Calculating the Billing Rate for the Contract + +Let's calculate the billing rate by combining the CU and SU from above. + +For this example, the current TFT value is `0.011 USD`. Make sure that this value is updated according to the current TFT value. + +``` +Contract cost/hour = CU cost/hour + SU cost/hour + = 10 mUSD/h + 0.375 mUSD/h + = 10.375 mUSD/h + = 0.010375 USD/h + = 0.010375 * 24 * 30 + = 7.47 USD/month + = 679.090909 TFT/month + = 0.943182 TFT/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). + +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). + +The 60% discount is thus equivalent to paying only 40% of the total price, as shown below: + +``` +Cost with 60% discount = 0.943182 * 0.4 + = 0.377273 TFT/hour +``` + + +## Rent Contract + + +### Getting the Resources + +You can get the resources of a node using different methods. You can use Grid Proxy, GraphQL and the Polkadot UI. + +- Using Grid Proxy + - Grid Proxy API + - Go to the section [nodes endpoint](https://gridproxy.grid.tf/swagger/index.html#/GridProxy/get_nodes__node_id_) + - Click on `Try it out` + - Write the node ID + - Click on `Execute` + - Grid Proxy URL + - You can use the following URL and replace by the node ID: + ``` + https://gridproxy.grid.tf/nodes/ + ``` + +- Using GraphQL + + Navigate to [ThreeFold's GraphQL](https://graphql.grid.tf/graphql), then use the following query and replace the node id with the desired node id. + + ``` + query MyQuery { + nodes(where: {nodeID_eq: 83}) { + id + farmingPolicyId + resourcesTotal { + cru + mru + sru + hru + } + } + } + + ``` + +- TFChain and Polkadot UI + - On the page Chain State of the [polakdot UI](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Ftfchain.grid.tf#/chainstate), select `tfgridModule` as the `selected state query` + - Select `nodes(u32): Option` + - Enter the node ID + - Press `Enter` + + ![image](./img/grid_billing_3.png) + + +For our example, these are the resources for node `83` that will be used for the calculations. + +``` +CRU = 4 +SRU = 119.24 +HRU = 1863 +MRU = 15.55 +``` + +### Calculating the CU + +Let's calculate the CU of this deployment. + +For our example, the CU value is `10 mUSD/h`. Make sure that this value is updated according to the current values. + +``` +CU = min( max(MRU/4, CRU/2), max(MRU/8, CRU), max(MRU/2, CRU/4) ) + = min( max(15.55/4, 4/2), max(15.55/8, 4), max(15.55/2, 4/4) ) + = min( max(3.8875, 2), max(1.94375, 4), max(7.775, 1) ) + = min( 3.8875, 4, 7.775 ) + = 3.8875 +CU cost/hour = CU * CU pricing + = 3.8875 * 10 mUSD/h + = 38.875 mUSD/h +``` + + +### Calculating the SU + +For our example, the SU value is `5 mUSD/h`. Make sure that this value is updated according to the current values. + +``` +SU = HRU/1200 + SRU/200 + = 1863/1200 + 119.24/200 + = 1.5525 + 0.5962 + = 2.1487 +SU cost/hour = SU * SU pricing + = 2.1487 * 5 mUSD/h + = 10.7435 mUSD/h +``` + +### Calculating the Billing Rate for the Contract + +For our example, the current TFT value is `0.011 USD`. Make sure that this value is updated according to the current values. + +``` +Contract cost/hour = CU cost/hour + SU cost/hour + = 38.875 mUSD/h + 10.7435 mUSD/h + = 49.6185 mUSD/h + = 0.0496185 USD/h + = (0.0496185 * 24 * 30) + = 35.72532 USD/month + = 3247.75636 TFT/month +``` + +### 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). + +``` +Cost with 50% discount = 35.72532 * 0.5 + = 17.86266 TFT/month +``` + +### 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). + +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). + + + +``` +Cost with 60% discount = 17.86266 * 0.4 + = 7.145064 TFT/month +``` + +## Name Contract + +Let's calculate the cost of a name contract. + +For our example, we use the following value from the Pricing Policy. + +![image](./img/grid_billing_4.png) + +This value can then be converted to USD. + +``` +uniqueName in USD = 2500 / 10000000 + = 0.00025 USD/hour + +``` +Since the current TFT conversion rate is `1 USD = 100 TFT`, we have the following: + +``` +uniqueName in TFT = 0.00025 * 100 + = 0.025 TFT/hour +``` + +### 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). + +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). + +``` +Cost with 60% discount = 0.025 * 0.4 + = 0.01 TFT/hour + +``` + +## Public IP + +Let's calculate the cost of public IPs. + +For our example, we use the following value from the Pricing Policy. + +![image](./img/grid_billing_5.png) + +This value can then be converted to USD. + +``` +Public IP in USD = 40000 / 10000000 + = 0.004 USD/hour + +``` + +Since the current TFT conversion rate is `1 USD = 100 TFT`, we have the following: + +``` +Public IP in TFT = 0.004 * 100 + = 0.4 TFT/hour +``` + +### 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). + +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). + +``` +Cost with 60% discount = 0.4 * 0.4 + = 0.16 TFT/hour + +``` + +> Note: This value gets added to the billing rate of your deployment. + + +## Network Usage + +Network Usage is calculated for deployments with public IPs. It's reported every hour and its cost can be calculated approximately as follows, where the data usage is the value of data sent and received: + +``` +network usage = data usage * NU value +``` + +### Data Usage + +To start, let's calculate the data usage. This can be tracked with a network tool like [nload](https://github.com/rolandriegel/nload), where the total amount of data sent and received can be displayed. + +![image](./img/grid_billing_6.png) + + +### NU Value + +Let's find the NU value of this deployment. + +For our example, we use the following value from the Pricing Policy. + +![image](./img/grid_billing_7.png) + +This value can then be converted to USD. + +``` +NU price in USD = 15000 / 10000000 + = 0.0015 USD/hour + +``` +Since in our example the current TFT conversion rate is `1 USD = 100 TFT`, we have the following: + +``` +NU price in TFT = 0.0015 * 100 + = 0.15 TFT/hour +``` + +### 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). + +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). + +``` +Cost with 60% discount = 0.15 * 0.4 + = 0.06 TFT/hour + +``` + +As an example, let's assume that we used a total of 10GB in the last hour, so the next hour the billing rate should be updated to: + +``` +Total network usage = 10GB * 0.06 TFT/hour + = 0.6 TFT/hour +``` + +The billing rate in the next hour should be the following: + +``` +hourly billing rate = actual cost of the deployment + total network usage +``` + + +> Note: The calculated value will always be an approximation since it's not possible to manually calculate the exact value of the data used. + + +## Billing History + +Since the billing rate gets updated hourly, you can check the billing history from [GraphQL](https://graphql.grid.tf/graphql) using the following query. Make sure to enter the proper contract ID. + +``` +query MyQuery { + contractBillReports(where: {contractID_eq: ""}) { + contractID + amountBilled + discountReceived + timestamp + } +} + +``` \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/cloud/grid_billing/img/grid_billing_1.png b/collections/tfmanual/knowledge_base/cloud/grid_billing/img/grid_billing_1.png new file mode 100644 index 0000000..b6123fa Binary files /dev/null and b/collections/tfmanual/knowledge_base/cloud/grid_billing/img/grid_billing_1.png differ diff --git a/collections/tfmanual/knowledge_base/cloud/grid_billing/img/grid_billing_2.png b/collections/tfmanual/knowledge_base/cloud/grid_billing/img/grid_billing_2.png new file mode 100644 index 0000000..a3d647e Binary files /dev/null and b/collections/tfmanual/knowledge_base/cloud/grid_billing/img/grid_billing_2.png differ diff --git a/collections/tfmanual/knowledge_base/cloud/grid_billing/img/grid_billing_3.png b/collections/tfmanual/knowledge_base/cloud/grid_billing/img/grid_billing_3.png new file mode 100644 index 0000000..216ebb6 Binary files /dev/null and b/collections/tfmanual/knowledge_base/cloud/grid_billing/img/grid_billing_3.png differ diff --git a/collections/tfmanual/knowledge_base/cloud/grid_billing/img/grid_billing_4.png b/collections/tfmanual/knowledge_base/cloud/grid_billing/img/grid_billing_4.png new file mode 100644 index 0000000..9a6f291 Binary files /dev/null and b/collections/tfmanual/knowledge_base/cloud/grid_billing/img/grid_billing_4.png differ diff --git a/collections/tfmanual/knowledge_base/cloud/grid_billing/img/grid_billing_5.png b/collections/tfmanual/knowledge_base/cloud/grid_billing/img/grid_billing_5.png new file mode 100644 index 0000000..8b9a85c Binary files /dev/null and b/collections/tfmanual/knowledge_base/cloud/grid_billing/img/grid_billing_5.png differ diff --git a/collections/tfmanual/knowledge_base/cloud/grid_billing/img/grid_billing_6.png b/collections/tfmanual/knowledge_base/cloud/grid_billing/img/grid_billing_6.png new file mode 100644 index 0000000..51a0e26 Binary files /dev/null and b/collections/tfmanual/knowledge_base/cloud/grid_billing/img/grid_billing_6.png differ diff --git a/collections/tfmanual/knowledge_base/cloud/grid_billing/img/grid_billing_7.png b/collections/tfmanual/knowledge_base/cloud/grid_billing/img/grid_billing_7.png new file mode 100644 index 0000000..6317825 Binary files /dev/null and b/collections/tfmanual/knowledge_base/cloud/grid_billing/img/grid_billing_7.png differ diff --git a/collections/tfmanual/knowledge_base/cloud/img/cloudunits_abstract.jpg b/collections/tfmanual/knowledge_base/cloud/img/cloudunits_abstract.jpg new file mode 100644 index 0000000..4e5e089 Binary files /dev/null and b/collections/tfmanual/knowledge_base/cloud/img/cloudunits_abstract.jpg differ diff --git a/collections/tfmanual/knowledge_base/cloud/pricing/cloud_pricing_compare.md b/collections/tfmanual/knowledge_base/cloud/pricing/cloud_pricing_compare.md new file mode 100644 index 0000000..5b95675 --- /dev/null +++ b/collections/tfmanual/knowledge_base/cloud/pricing/cloud_pricing_compare.md @@ -0,0 +1,55 @@ +

Price comparison Cloudorado

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Compute](#compute) + - [Compute Conclusion](#compute-conclusion) +- [Storage](#storage) + - [Storage Conclusion](#storage-conclusion) + +*** + +## Introduction + +We compare cloud pricing with Cloudorado. Note that the information here can be subject to change and might not reflect current market prices. + +## Compute + +A ThreeFold Compute Unit is (CU) + +- 4 GB memory +- 2 virtual CPU cores + +A good site to compare is Cloudorado: https://www.cloudorado.com/ + +![](img/cloudorado_compute_choices.jpg ':size=600x240') + +| Compute | Compute | +| --------------------------------- | --------------------------------- | +| ![](img/cloudorado_compute_1.jpg) | ![](img/cloudorado_compute_2.jpg) | + + +### Compute Conclusion + +> Our price can easily be < 10 USD for 1 compute unit (CU)
+> In market, this is between 36 and 202 USD + +## Storage + +A ThreeFold Storage Unit is (SU) + +- 1 TB of storage + +Again, a good site to compare is Cloudorado: https://www.cloudorado.com/ + +![](img/cloudorado_storage_choices.jpg ':size=600x270') + +![](img/cloudorado_storage_1.jpg ':size=500x610') + +### Storage Conclusion + +> Our price can easily be < 8 USD for 1 storage unit (CU)
+> In market, this is between 19 and 154 USD + + \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/cloud/pricing/cloudunits_pricing.md b/collections/tfmanual/knowledge_base/cloud/pricing/cloudunits_pricing.md new file mode 100644 index 0000000..f8ab13d --- /dev/null +++ b/collections/tfmanual/knowledge_base/cloud/pricing/cloudunits_pricing.md @@ -0,0 +1,69 @@ + +![](img/tfgrid_pricing.jpg) + +## Cloud Unit Pricing + +| Cloud Units | description | mUSD | mTFT | +| ----------------- | ------------------------------------------------ | ------------------ | ------------------ | +| Compute Unit (CU) | typically 2 vcpu, 4 GB mem, 50 GB storage | $CU_MUSD_HOUR/hour | $CU_MTFT_HOUR/hour | +| Storage Unit (SU) | typically 1 TB of netto usable storage (*) | $SU_MUSD_HOUR/hour | $SU_MTFT_HOUR/hour | +| Network Unit (NU) | 1 GB transfer, bandwidth as used by TFGrid users | $NU_MUSD_GB/GB | $NU_MTFT_GB/GB | + + +| Network Addressing | description | mUSD | mTFT | +| ------------------ | ------------------------------------------ | --------------------- | --------------------- | +| IPv4 Address | Public Ip Address as used by a TFGrid user | $IP_MUSD_HOUR/hour | $IP_MTFT_HOUR/hour | +| Unique Name | Usable as name on webgateways | $NAME_MUSD_HOUR/hour | $NAME_MTFT_HOUR/hour | +| Unique Domain Name | Usable as dns name on webgateways | $DNAME_MUSD_HOUR/hour | $DNAME_MTFT_HOUR/hour | + +- mUSD = 1/1000 of USD, mTFT = 1/1000 of TFT +- TFT pricing pegged to USD (pricing changes in line with TFT/USD rate) +- **current TFT to USD price is $TFTUSD** , calculated on $NOW +- pricing is calculated per hour for the TFGrid 3.0 + + + +### Pricing Expressed Per Month + +| Cloud Units | description | USD NO DISCOUNT | USD 60% DISCOUNT | +| ----------------- | ------------------------------------------------ | ------------------- | ---------------------------- | +| Compute Unit (CU) | typically 2 vcpu, 4 GB mem, 50 GB storage | $CU_USD_MONTH/month | $CU_USD_MONTH_DISCOUNT/month | +| Storage Unit (SU) | typically 1 TB of netto usable storage (*) | $SU_USD_MONTH/month | $SU_USD_MONTH_DISCOUNT/month | +| Network Unit (NU) | 1 GB transfer, bandwidth as used by TFGrid users | $NU_USD_GB/GB | $NU_USD_MONTH_DISCOUNT/GB | +| IPv4 Address | Public Ip Address as used by a TFGrid user | $IP_USD_MONTH/month | $IP_USD_MONTH_DISCOUNT/month | + + +> Please check pricing calculator on http://pricing.threefold.me + +### Dedicated Servers + +Starting April 2022, the TFGrid 3.0/a5 has support for dedicated servers. You can reserve a full server and the server is only usable for you, a minimum of 70% discount is given for this usecase. + +- Dedicated Node, 192 GB mem, 24 cores, 1000 GB SSD = 75 USD per month (max discount, 3Y staking) +- Dedicated Node, 32 GB mem, 8 cores, 1000 GB SSD = 31 USD per month (max discount, 3Y staking) + +Above example was with generous 5TB of bandwidth used per node per month, which is huge. + +These nodes are ideal to deploy blockchain nodes, or other high demanding workloads. Dedicated nodes leads to amazing pricing. + +To use a dedicated node, you will have to reserve a 3node for yourself in your admin portal of TFGrid, only you can then deploy on this node and there is no additional cost. + +> Please check pricing calculator on http://pricing.threefold.me + + +### How to buy and use capacity + +- More info about [how to use the grid see here](grid_use) +- See our manual how to get started. +- [TFT's can be bought on multiple locations](how_to_buy). + +### More Info + +- See [here for more info about planet positive certification](certified_farming) +- Pricing is done based on cloud units, see [cloudunits](cloudunits) + +!!!include:staking_discount_levels + +!!!def alias:tfpricing,cloudunit_pricing,threefold_pricing + +!!!tfpriceinfo diff --git a/collections/tfmanual/knowledge_base/cloud/pricing/img/cloudorado.jpg b/collections/tfmanual/knowledge_base/cloud/pricing/img/cloudorado.jpg new file mode 100644 index 0000000..1cf6e01 Binary files /dev/null and b/collections/tfmanual/knowledge_base/cloud/pricing/img/cloudorado.jpg differ diff --git a/collections/tfmanual/knowledge_base/cloud/pricing/img/cloudorado_compute_1.jpg b/collections/tfmanual/knowledge_base/cloud/pricing/img/cloudorado_compute_1.jpg new file mode 100644 index 0000000..0f261ff Binary files /dev/null and b/collections/tfmanual/knowledge_base/cloud/pricing/img/cloudorado_compute_1.jpg differ diff --git a/collections/tfmanual/knowledge_base/cloud/pricing/img/cloudorado_compute_2.jpg b/collections/tfmanual/knowledge_base/cloud/pricing/img/cloudorado_compute_2.jpg new file mode 100644 index 0000000..1284fa9 Binary files /dev/null and b/collections/tfmanual/knowledge_base/cloud/pricing/img/cloudorado_compute_2.jpg differ diff --git a/collections/tfmanual/knowledge_base/cloud/pricing/img/cloudorado_compute_choices.jpg b/collections/tfmanual/knowledge_base/cloud/pricing/img/cloudorado_compute_choices.jpg new file mode 100644 index 0000000..7074de6 Binary files /dev/null and b/collections/tfmanual/knowledge_base/cloud/pricing/img/cloudorado_compute_choices.jpg differ diff --git a/collections/tfmanual/knowledge_base/cloud/pricing/img/cloudorado_storage_1.jpg b/collections/tfmanual/knowledge_base/cloud/pricing/img/cloudorado_storage_1.jpg new file mode 100644 index 0000000..022c737 Binary files /dev/null and b/collections/tfmanual/knowledge_base/cloud/pricing/img/cloudorado_storage_1.jpg differ diff --git a/collections/tfmanual/knowledge_base/cloud/pricing/img/cloudorado_storage_choices.jpg b/collections/tfmanual/knowledge_base/cloud/pricing/img/cloudorado_storage_choices.jpg new file mode 100644 index 0000000..d18a2a3 Binary files /dev/null and b/collections/tfmanual/knowledge_base/cloud/pricing/img/cloudorado_storage_choices.jpg differ diff --git a/collections/tfmanual/knowledge_base/cloud/pricing/img/tfgrid_pricing.jpg b/collections/tfmanual/knowledge_base/cloud/pricing/img/tfgrid_pricing.jpg new file mode 100644 index 0000000..5775ded Binary files /dev/null and b/collections/tfmanual/knowledge_base/cloud/pricing/img/tfgrid_pricing.jpg differ diff --git a/collections/tfmanual/knowledge_base/cloud/pricing/pricing.md b/collections/tfmanual/knowledge_base/cloud/pricing/pricing.md new file mode 100644 index 0000000..8854e3d --- /dev/null +++ b/collections/tfmanual/knowledge_base/cloud/pricing/pricing.md @@ -0,0 +1,98 @@ +

Cloud Unit Pricing

+ +

Table of Contents

+ +- [Pricing Policy](#pricing-policy) +- [Pricing Expressed Per Month](#pricing-expressed-per-month) +- [Operation Fees](#operation-fees) +- [Certified Capacity](#certified-capacity) +- [Dedicated Nodes](#dedicated-nodes) +- [Staking Discount](#staking-discount) + - [Example for 40% discount (Silver)](#example-for-40-discount-silver) + +*** + +## Pricing Policy + +- The current prices are for resources usage on mainnet (testnet get 50% discount) +- A month is considered as 30 days (720 hours) + +| Cloud Units | Description | mUSD | mTFT | +| ----------------- | ------------------------------------------------ | ------------------ | ------------------ | +| Compute Unit (CU) | typically 2 vcpu, 4 GB mem, 50 GB storage | {{#include ../../../values/CU_MUSD_HOUR.md}}/hour | {{#include ../../../values/CU_MTFT_HOUR.md}}/hour | +| Storage Unit (SU) | typically 1 TB of netto usable storage (*) | {{#include ../../../values/SU_MUSD_HOUR.md}}/hour | {{#include ../../../values/SU_MTFT_HOUR.md}}/hour | +| Network Unit (NU) | 1 GB transfer, bandwidth as used by TFGrid users | {{#include ../../../values/NU_MUSD_HOUR.md}}/hour | {{#include ../../../values/NU_MTFT_HOUR.md}}/hour | + +
+ +| Network Addressing | Description | mUSD | mTFT | +| ------------------ | ------------------------------------------ | --------------------- | --------------------- | +| IPv4 Address | Public Ip Address as used by a TFGrid user | {{#include ../../../values/IP_MUSD_HOUR.md}}/hour | {{#include ../../../values/IP_MTFT_HOUR.md}}/hour | +| Unique Name | Usable as name on webgateways | {{#include ../../../values/NAME_MUSD_HOUR.md}} | {{#include ../../../values/NAME_MTFT_HOUR.md}}/hour | +| Unique Domain Name | Usable as dns name on webgateways | {{#include ../../../values/DNAME_MUSD_HOUR.md}}/hour | {{#include ../../../values/DNAME_MTFT_HOUR.md}}/hour | + +- mUSD = 1/1000 of USD, mTFT = 1/1000 of TFT +- TFT pricing pegged to USD (pricing changes in line with TFT/USD rate) +- The current TFT to USD price is {{#include ../../../values/tft_value.md}} USD +- pricing is calculated per hour for the TFGrid 3.0 + +> Please check our [Cloud Pricing for utilization sheet](https://docs.google.com/spreadsheets/d/1E6MpGs15h1_flyT5AtyKp1TixH1ILuGo5tzHdmjeYdQ/edit#gid=2014089775) for more details. + +## Pricing Expressed Per Month + +| Cloud Units | description | USD NO DISCOUNT | USD 60% DISCOUNT | +| ----------------- | ------------------------------------------------ | ------------------- | ---------------------------- | +| Compute Unit (CU) | typically 2 vcpu, 4 GB mem, 50 GB storage | 22.00/month | 8.80/month | +| Storage Unit (SU) | typically 1 TB of netto usable storage | 14.00/month | 5.60/month | +| Network Unit (NU) | 1 GB transfer, bandwidth as used by TFGrid users | 0.05/GB | 0.03/GB | +| IPv4 Address | Public Ip Address as used by a TFGrid user | 5.00/month | 3.00/month | + +## Operation Fees + +Operations on TFChain have a base fee of 0.001 TFT. Creating and destroying deployments usually includes several operations. + +## Certified Capacity + +Renting capacity on certified nodes is charged 25% extra (x 1.25). + +## Dedicated Nodes + +Since April 2022, TFGrid has introduced dedicated server support. With dedicated servers, you can reserve a full server exclusively for your use. This comes with 50% discount, making it a cost-effective option. + +Here are two examples of dedicated nodes and their prices, with maximum staking discount level (Gold => -60%) for 18 months staking: + +- Dedicated Node 1: 192 GB memory, 24 cores, 1000 GB SSD = $75 per month +- Dedicated Node 2: 32 GB memory, 8 cores, 1000 GB SSD = $31 per month + +> Please check our [Cloud Pricing for utilization sheet](https://docs.google.com/spreadsheets/d/1E6MpGs15h1_flyT5AtyKp1TixH1ILuGo5tzHdmjeYdQ/edit#gid=2014089775) for more details. + +These dedicated nodes come with a generous 5TB bandwidth usage per node per month. They are well-suited for deploying blockchain nodes or other resource-intensive workloads. Using a dedicated node requires reserving a 3node in your TFGrid admin portal. Once reserved, you have exclusive deployment rights for that node, and there are no additional costs. + +When renting a dedicated node, you receive a 50% discount for the entire node. However, it's important to note that you will still be required to pay for the entire node, even with the discount applied. This means that while you enjoy the discount, the cost of the dedicated node is not prorated based on the resources you utilize. + +## Staking Discount + +| Type | Pricing Level | Nr months of TFT linked to account | +| ---------- | ------------- | ---------------------------------- | +| No staking | - 0% | 0 | +| Default | - 20% | 1.5 months | +| Bronze | - 30% | 3 months | +| Silver | - 40% | 6 months | +| Gold | - 60% | 18 months | + +TFChain charges users for proof of utilization on an hourly basis. The discount applied is determined by the amount of TFT (ThreeFold Token) available in the user's TFChain account. It's important to note that the discount is calculated based on the TFT balance in the TFChain account, not on other supported blockchains like Stellar. + +This discount mechanism operates automatically, and users don't need to take any specific actions to avail themselves of this benefit. However, it's worth mentioning that the maximum discount for network-related services is 40%. + +### Example for 40% discount (Silver) + +Let's break down the example for a 40% discount on Internet Capacity consumption: + +- Suppose your consumption on the ThreeFold Grid is worth 10 TFT per hour. +- To be eligible for a 40% discount, you need to have a minimum of 43,200 TFT in your account, calculated as 10 TFT * 24 hours * 30 days * 6 months. +- Similarly, to be eligible for a 60% discount, you would need a minimum of 129,600 TFT in your account, calculated as 10 TFT * 24 hours * 30 days * 18 months. +- If you have 60,000 TFT in your TFChain account, you would receive a 40% discount. +- However, since you don't have enough tokens to qualify for the 60% discount, it won't be applicable. +- With the 40% discount, your effective payment for the consumption would be 6 TFT per hour, as long as the amount of TFT in your account falls within the range of 43,200 to 129,600 (as calculated above). + +Keep in mind that these calculations are based on the example provided and the specific discount levels mentioned. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/cloud/pricing/pricing_toc.md b/collections/tfmanual/knowledge_base/cloud/pricing/pricing_toc.md new file mode 100644 index 0000000..8e7a128 --- /dev/null +++ b/collections/tfmanual/knowledge_base/cloud/pricing/pricing_toc.md @@ -0,0 +1,8 @@ +# Pricing + +

Table of Contents

+ +- [Pricing Overview](./pricing.md) +- [Staking Discounts](./staking_discount_levels.md) +- [Cloud Pricing Compare](./cloud_pricing_compare.md) +- [Grid Billing](../grid_billing/grid_billing.md) \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/cloud/pricing/sidebar.md b/collections/tfmanual/knowledge_base/cloud/pricing/sidebar.md new file mode 100644 index 0000000..71e6615 --- /dev/null +++ b/collections/tfmanual/knowledge_base/cloud/pricing/sidebar.md @@ -0,0 +1,5 @@ +- [**Home**](@threefold_home) +----- +**Pricing** +- [Cloud Pricing](@pricing) +- [Cloud Pricing Compare](@cloud_pricing_compare) diff --git a/collections/tfmanual/knowledge_base/cloud/pricing/staking_discount_levels.md b/collections/tfmanual/knowledge_base/cloud/pricing/staking_discount_levels.md new file mode 100644 index 0000000..0c4f62e --- /dev/null +++ b/collections/tfmanual/knowledge_base/cloud/pricing/staking_discount_levels.md @@ -0,0 +1,34 @@ +

Staking Discount Levels

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Table of Discounts](#table-of-discounts) +- [Example for 40% discount](#example-for-40-discount) + +*** + +## Introduction + +By staking TFT on their TFChain wallet, TFGrid users can benefit to discounts up to 60%. + +## Table of Discounts + +| type | pricing level | nr months of TFT linked to account | +| ---------- | ------------- | ---------------------------------- | +| no staking | - 0% | 0 | +| default | - 20% | 3 months | +| bronze | - 30% | 6 months | +| silver | - 40% | 12 months | +| gold | - 60% | 36 months | + +TFChain charges the user for proof_of_utilization every hour. TFChain will calculate the discount based on amount of TFT available in the account of the user on TFChain (not on Stellar or any of the other blockchains we also support). This is an automatic form of staking, the user does not have to do anything to have this benefit. For network related services its max 40% discount. + +## Example for 40% discount + +- I've used 10 TFT worth of Internet Capacity on tf_grid for the last hour. +- 10TFT * 24 * 30 * 12 = I would need 86,400 TFT for one year +- 10TFT * 24 * 30 * 36 = I would need 259,200 TFT for 3 year +- I have 120,000 TFT in my account on TF_Chain, this means that I will get 40% discount. +- I don't have enough tokens to get to 60% discount. + diff --git a/collections/tfmanual/knowledge_base/cloud/pricing/staking_discount_levels0.md b/collections/tfmanual/knowledge_base/cloud/pricing/staking_discount_levels0.md new file mode 100644 index 0000000..75db027 --- /dev/null +++ b/collections/tfmanual/knowledge_base/cloud/pricing/staking_discount_levels0.md @@ -0,0 +1,18 @@ +| type | pricing level | nr months of TFT linked to account | +| ---------- | ------------- | ---------------------------------- | +| no staking | - 0% | 0 | +| default | - 20% | 3 months | +| bronze | - 30% | 6 months | +| silver | - 40% | 12 months | +| gold | - 60% | 36 months | + +TFChain charges the user for proof_of_utilization every hour. TFChain will calculate the discount based on amount of TFT available in the account of the user on TFChain (not on Stellar or any of the other blockchains we also support). This is an automatic form of staking, the user does not have to do anything to have this benefit. For network related services its max 40% discount. + +### Example for 40% discount + +- I've used 10 TFT worth of Internet Capacity on tf_grid for the last hour. +- 10TFT * 24 * 30 * 12 = I would need 86,400 TFT for one year +- 10TFT * 24 * 30 * 36 = I would need 259,200 TFT for 3 year +- I have 120,000 TFT in my account on TF_Chain, this means that I will get 40% discount. +- I don't have enough tokens to get to 60% discount. + diff --git a/collections/tfmanual/knowledge_base/cloud/resource_units_calc_cloudunits.md b/collections/tfmanual/knowledge_base/cloud/resource_units_calc_cloudunits.md new file mode 100644 index 0000000..87a2b99 --- /dev/null +++ b/collections/tfmanual/knowledge_base/cloud/resource_units_calc_cloudunits.md @@ -0,0 +1,89 @@ + +

Resource Units

+ +

Table of Contents

+ +- [Resource Units Overview](#resource-units-overview) + - [Compute](#compute) + - [Storage](#storage) + - [Storage cost price verification Dec 2021](#storage-cost-price-verification-dec-2021) +- [Change Log](#change-log) +- [Remarks](#remarks) + +*** + +## Resource Units Overview + +The threefold Zero-OS and TFChain software translates resource units (CRU, MRU, HRU, SRU) into cloud units (CU, SU) for farming reward purposes. + +Resource units are used to measure and convert capacity on the hardware level into cloud units: CU & SU. + + +| Unit Type | Description | Code | +| ------------ | ------------------------------------ | ---- | +| Core Unit | 1 Logical Core (Hyperthreaded Core) | CRU | +| Mem Unit | 1 GB mem | MRU | +| HD Unit | 1 GB | HRU | +| SSD Unit | 1 GB | SRU | +| Network Unit | 1 GB of bandwidth transmitted in/out | NRU | + +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) + +### Compute + +For farming, 1 CU equals: + +- 2 virtual CPUs with a maximum over subscription of 4 CPUs and minimum required memory of 4GB. +- An over subscription of 4 CPUs remains still gentle as we understand many other providers use more. +- There needs to be at least 50GB SSD per CU, if not there is penalty for nr of CU, reasoning is that otherwise people cannot deploy their VM's or Containers if there would not be minimal SSD. + +```python +cu = min((mru - 1) / 4, cru * 4 / 2, sru / 50) +``` + +- 1 GB of memory is subtracted for the operating system to function. +- please note minimal passmark per CU (with 4GB mem), needs to be 1000 passmark at farming side, this is not being checked today but might be done in future. If your chosen CPU has less than 1000 passmark per CU (of 4 GB mem), it could be your final CU's will be lower once that feature is introduced. + + + + + +### Storage + +For farming, 1 SU equals to: +- 1.2 TB of HD capacity (which can deliver 1 TB of net usable storage) +- 200 GB of SSD capacity with a buffer of 20% + +```python +su = hru / 1200 + sru * 0.8 / 200 +``` + +#### Storage cost price verification Dec 2021 + +- price for 16 TB HDD = 300 USD + - 16000 / 1200 = 13.3 SU + - 1 SU costs = 300 / 13.3 = 22.5 for HDD +- price for 2 TB SSD = 200 USD + - 2000 * 0.8 / 200 = 8 SU + - 1 SU costs 200 / 8 = 25 for SSD + + + + +## Change Log + +- original non final specs from Summer 2021, was mentioned its not final. +- Dec 2021 update for launch v3.x + - there need to be at least 50 GB SSD capacity per CU + - was in the specs of farming reward but formula above did not take it into consideration, in others nonconsistenty between specs & formula. + - sru division to 200, was 300, to be more in line with HDD vs SSD pricing, this check needs to be done +- every 6 months, results in slightly more SU, which is good for farmers. +- Jan 2022 update for launch v3.x + - reverted change done in Dec, sru does not have to be deducted from cpu, results in increase of farming rewards, in other words good for farmers. Also good formula more easy. + - Introduced warning about minimum CPU requirements in relation to passmark. + +## Remarks + +- There seems to be issue in simulator play.grid.tf, will check asap (17-jan) +- We are checking all numbers & the DAO is coming life in Jan/Feb 2022, once we have the DAO every change of the specs needs to be approved by DAO voting members. For now we use the forum to notify and ask feedback and make sure farming reward goes up for the changes if possible. There ia already a minimal DAO life, the blockchain TFChain validators (L1) need to find consensus to upgrade code. diff --git a/collections/tfmanual/knowledge_base/cloud/resourceunits.md b/collections/tfmanual/knowledge_base/cloud/resourceunits.md new file mode 100644 index 0000000..7265f41 --- /dev/null +++ b/collections/tfmanual/knowledge_base/cloud/resourceunits.md @@ -0,0 +1,16 @@ +## Resource Units + +Resource units are used to measure and convert capacity on the hardware level into cloud units: CU & SU. + + +| Unit Type | Description | Code | +| ------------ | ------------------------------------ | ---- | +| Core Unit | 1 Logical Core (Hyperthreaded Core) | CRU | +| Mem Unit | 1 GB mem | MRU | +| HD Unit | 1 GB | HRU | +| SSD Unit | 1 GB | SRU | +| Network Unit | 1 GB of bandwidth transmitted in/out | NRU | + +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 diff --git a/collections/tfmanual/knowledge_base/cloud/resourceunits_advanced.md b/collections/tfmanual/knowledge_base/cloud/resourceunits_advanced.md new file mode 100644 index 0000000..674afb1 --- /dev/null +++ b/collections/tfmanual/knowledge_base/cloud/resourceunits_advanced.md @@ -0,0 +1,62 @@ +

Resource Units Calculation

+ +

Table of Contents

+ +- [Calculation from resource units to CU/SU for farming purposes](#calculation-from-resource-units-to-cusu-for-farming-purposes) +- [Compute](#compute) +- [Storage](#storage) + - [Storage cost price verification Dec 2021](#storage-cost-price-verification-dec-2021) + +*** + +## Calculation from resource units to CU/SU for farming purposes + +The threefold Zero-OS and TFChain software translates resource units (CRU, MRU, HRU, SRU) into cloud units (CU, SU) for farming reward purposes. + +## Compute + +For farming, 1 CU equals: + +- 2 virtual CPUs with a maximum over subscription of 4 CPUs and minimum required memory of 4GB. +- An over subscription of 4 CPUs remains still gentle as we understand many other providers use more. +- There needs to be at least 50GB SSD per CU, if not there is penalty for nr of CU, reasoning is that otherwise people cannot deploy their VM's or Containers if there would not be minimal SSD. + +```python +cu = min((mru - 1) / 4, cru * 4 / 2, sru / 50) +``` + +- 1 GB of memory is subtracted for the operating system to function. +- please note minimal passmark per CU (with 4GB mem), needs to be 1000 passmark at farming side, this is not being checked today but might be done in future. If your chosen CPU has less than 1000 passmark per CU (of 4 GB mem), it could be your final CU's will be lower once that feature is introduced. + + +## Storage + +For farming, 1 SU equals to: +- 1.2 TB of HD capacity (which can deliver 1 TB of net usable storage) +- 200 GB of SSD capacity with a buffer of 20% + +```python +su = hru / 1200 + sru * 0.8 / 200 +``` + +### Storage cost price verification Dec 2021 + +- price for 16 TB HDD = 300 USD + - 16000 / 1200 = 13.3 SU + - 1 SU costs = 300 / 13.3 = 22.5 for HDD +- price for 2 TB SSD = 200 USD + - 2000 * 0.8 / 200 = 8 SU + - 1 SU costs 200 / 8 = 25 for SSD + + + \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/collaboration/PULL_REQUEST_TEMPLATE.md b/collections/tfmanual/knowledge_base/collaboration/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..c41fc2e --- /dev/null +++ b/collections/tfmanual/knowledge_base/collaboration/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,18 @@ +### Description + +Describe the changes introduced by this PR and what does it affect + +### Changes + +List of changes this PR includes + +### Related Issues + +List of related issues + +### Checklist + +- [ ] Tests included +- [ ] Build pass +- [ ] Documentation +- [ ] Code format and docstring \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/collaboration/bug_report.md b/collections/tfmanual/knowledge_base/collaboration/bug_report.md new file mode 100644 index 0000000..db75a12 --- /dev/null +++ b/collections/tfmanual/knowledge_base/collaboration/bug_report.md @@ -0,0 +1,29 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +## Describe the bug + +A clear and concise description of what the bug is. + +## To Reproduce + +Steps to reproduce the behavior: + + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + +## Expected behavior + +A clear and concise description of what you expected to happen. + +## Screenshots + +If applicable, add screenshots to help explain your problem. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/collaboration/code_conduct.md b/collections/tfmanual/knowledge_base/collaboration/code_conduct.md new file mode 100644 index 0000000..2c8ffd6 --- /dev/null +++ b/collections/tfmanual/knowledge_base/collaboration/code_conduct.md @@ -0,0 +1,318 @@ +

Code of Conduct

+ +

Table of Contents

+ +- [Introduction: Collaboration Manifest](#introduction-collaboration-manifest) +- [Code of Conduct](#code-of-conduct) + - [Forum \& Chat Rules](#forum--chat-rules) + - [Moderation Rights](#moderation-rights) + - [Contribution](#contribution) + - [Keep It Simple and Relevant](#keep-it-simple-and-relevant) + - [Content Verification Guidelines](#content-verification-guidelines) + - [Freedom of Speech.](#freedom-of-speech) +- [Contribution Guidelines](#contribution-guidelines) + - [This is a Civilized Place for Public Discussion](#this-is-a-civilized-place-for-public-discussion) + - [Improve the Discussion](#improve-the-discussion) + - [Be Agreeable, Even When You Disagree](#be-agreeable-even-when-you-disagree) + - [Your Participation Counts](#your-participation-counts) + - [If You See a Problem, Flag It](#if-you-see-a-problem-flag-it) + - [Always Be Civil](#always-be-civil) + - [Keep It Tidy](#keep-it-tidy) + - [Post Only Your Own Stuff](#post-only-your-own-stuff) + - [Powered by You](#powered-by-you) + - [Terms of Service](#terms-of-service) +- [Terms of Service (TOS)](#terms-of-service-tos) + - [Important Terms](#important-terms) + - [Your Permission to Use the Forum)](#your-permission-to-use-the-forum) + - [Conditions for Use of the Forum](#conditions-for-use-of-the-forum) + - [Acceptable Use](#acceptable-use) + - [Content Standards](#content-standards) + - [Enforcement](#enforcement) + - [Your Account](#your-account) + - [Your Content](#your-content) + - [Your Responsibility](#your-responsibility) + - [Disclaimers](#disclaimers) + - [Limits on Liability](#limits-on-liability) + - [Feedback](#feedback) + - [Termination](#termination) + - [Disputes](#disputes) + - [General Terms](#general-terms) + - [Contact](#contact) + - [Changes](#changes) + +*** + +# Introduction: Collaboration Manifest + +FreeFlow nation created this collaboration manifest which can be freely used by any organization who finds them useful. If you would like to see any changes to this document please email to **info@freeflownation.org**. +We at ThreeFold want to follow these guidelines. + +This document has been created honoring the [FreeFlow Nation Manifesto](https://www.freeflownation.org/manifesto.html). + +# Code of Conduct + +## Forum & Chat Rules + +We are committed to making participation a harassment-free experience for everyone, regardless of level of experience, gender, gender identity or expression, sexual orientation, disability, personal appearance, race, ethnicity, age, religion, or nationality. + +Examples of unacceptable behavior include, but are not limited to: + +* Use of sexualized language or imagery +* Personal attacks +* Trolling or insulting/derogatory comments +* Public or private harassment +* Publishing private information without explicit permission (e.g. physical or electronic address) + +## Moderation Rights + +Content moderators have the right and responsibility to remove, edit, or reject all posts, comments, and other contributions that are not aligned to this Code of Conduct. They may also suspend or ban any forum member for behaviors that they deem inappropriate, threatening, offensive, or harmful. + +By adopting this Code of Conduct, moderators commit themselves to fairly and consistently applying these principles to every aspect of managing this community. Moderators who do not follow or enforce the Code of Conduct may be permanently removed from the moderation team. + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by flagging the post or comment in question. All complaints will be reviewed and investigated and will result in a response deemed both necessary and appropriate to the circumstances. Moderators are obligated to maintain confidentiality regarding the identity of the reporting party. + +The forum is a place where we bring people together that share the same values and want to make the world a better place. Positive feedback is well appreciated but must always stay respectful and helpful. Moderators thus have the right to remove any posts spreading negativity and/or attacking the project and its founders. + +## Contribution + +We welcome everyone to contribute and thank you for your content contribution. + +Content can be chat, questions, answers, blogs, articles, knowledge base information, tutorials, … + +The more people collaborate the more relevant set of information will be created. + +Creating content constitutes your agreement to release submitted content as public domain ([CC0 10 4](https://creativecommons.org/publicdomain/zero/1.0/)). + +## Keep It Simple and Relevant + +Overload of information is maybe even worse as not enough information. + +Please keep your discussions and contributions information-rich. If your signal-to-noise ratio gets too low, you will be muted or banned from the forum or relevant chat. This is up to the discretion of ThreeFold moderators. + +## Content Verification Guidelines + +We believe it’s in the best interest of our community to know the origin and authenticity of any information contributed. We want to do everything possible to verify the authenticity of the content created (e.g. messages, knowledge-base, chats, etc.). As such it’s our right to block a contributor from creating any content if identity cannot be verified. + +## Freedom of Speech. + +We believe in freedom of speech as long as it’s not in contradiction with our Content Verification Guidelines. + +# Contribution Guidelines + +## This is a Civilized Place for Public Discussion + +Please treat this discussion forum with the same respect you would a public park. We, too, are a shared community resource — a place to share skills, knowledge and interests through ongoing conversation. + +These are not hard and fast rules, merely guidelines to aid the human judgment of our community and keep this a clean and well-lighted place for civilized public discourse. + +## Improve the Discussion + +Help us make this a great place for discussion by always working to improve the discussion in some way, however small. If you are not sure your post adds to the conversation, think over what you want to say and try again later. + +The topics discussed here matter to us, and we want you to act as if they matter to you, too. Be respectful of the topics and the people discussing them, even if you disagree with some of what is being said. + +One way to improve the discussion is by discovering ones that are already happening. Spend time browsing the topics here before replying or starting your own, and you’ll have a better chance of meeting others who share your interests. + +## Be Agreeable, Even When You Disagree + +You may wish to respond to something by disagreeing with it. That’s fine. But remember to criticize ideas, not people. Please avoid any of the following: + +* Name-calling +* Ad hominem attacks +* Responding to a post’s tone instead of its actual content +* Knee-jerk contradiction + +Instead, provide reasoned counter-arguments that improve the conversation. + +## Your Participation Counts + +The conversations we have here set the tone for every new arrival. Help us influence the future of this community by choosing to engage in discussions that make this forum an interesting place to be — and avoiding those that do not. + +The forum we use (Discourse) provides tools that enable the community to collectively identify the best (and worst) contributions: bookmarks, likes, flags, replies, edits, and so forth. Use these tools to improve your own experience, and everyone else’s, too. + +Let’s leave our community better than we found it. + +## If You See a Problem, Flag It + +Moderators have special authority: they are responsible for this forum, but so are you. With your help, moderators can be community facilitators, not just janitors or police. + +When you see bad behavior, don’t reply. It encourages bad behavior by acknowledging it, consumes your energy, and wastes everyone’s time. Just flag it. If enough flags accrue, action will be taken, either automatically or by moderator intervention. + +In order to maintain our community, moderators reserve the right to remove any content and any user account for any reason at any time. Moderators do not preview new posts: the moderators and site operators take no responsibility for any content posted by the community. + +## Always Be Civil + +Nothing sabotages a healthy conversation like rudeness: + +* Be civil. Don’t post anything that a reasonable person would consider offensive, abusive, or hate speech. +* Keep it clean. Don’t post anything obscene or sexually explicit. +* Respect each other. Don’t harass or grief anyone, impersonate people, or expose their private information. +* Respect our forum. Don’t post spam or otherwise vandalize the forum. + +These are not concrete terms with precise definitions — avoid even the appearance of any of these things. If you’re unsure, ask yourself how you would feel if your post was featured on the front page of the New York Times. + +This is a public forum, and search engines index these discussions. Keep the language, links, and images safe for family and friends. + +## Keep It Tidy + +Make the effort to put things in the right place, so that we can spend more time discussing and less time cleaning up. + +In brief: + +* Don’t start a topic in the wrong category. +* Don’t cross-post the same thing in multiple topics. +* Don’t post no-content replies. +* Don’t divert a topic by changing it midstream. +* Don’t sign your posts — every post has your profile information attached to it. +* Rather than posting “+1” or “Agreed”, use the Like button. Rather than taking an existing topic in a radically different direction, use Reply as a Linked Topic. + +## Post Only Your Own Stuff + +You may not post anything digital that belongs to someone else without permission. You may not post descriptions of, links to, or methods for stealing someone’s intellectual property (e.g. software, video, audio, images, etc.), or for breaking any other law. + +## Powered by You + +This site is operated by your friendly local staff and you, the community. If you have any further questions about how things should work here, open a new topic in the site feedback category and let’s discuss! If there’s a critical or urgent issue that can’t be handled by a meta topic or flag, contact us via the support live chat. + +## Terms of Service + +Yes, legalese is boring, but we must protect ourselves – and by extension, you and your data – against unfriendly folks. We have a Terms of Service describing your (and our) behavior and rights related to content, privacy, and laws. To use this service, you must agree to abide by our TOS. See below for more information on this. + +# Terms of Service (TOS) + +These terms include a number of important provisions that affect your rights and responsibilities, such as the disclaimers in Disclaimers, limits on the company’s liability to you in Limits on Liability, your agreement to cover the company for damages caused by your misuse of the forum in Responsibility for Your Use, and an agreement to arbitrate disputes in Disputes. + +Please read: + +To use this forum, or any other collaboration/communication tool of ThreeFold you must agree to these terms with threefold, the company that runs the forum or any other tool (FreeFlow Pages and others). + +The company may offer other products and services, under different terms. These terms apply only to use of the forum. + +## Important Terms + +These terms include a number of important provisions that affect your rights and responsibilities, such as the disclaimers in [Disclaimers](#disclaimers), limits on the company’s liability to you in [Limits on Liability](#limits-on-liability), your agreement to cover the company for damages caused by your misuse of the forum in [Responsibility for Your Use](#your-responsibility), and an agreement to arbitrate disputes in [Disputes](#disputes). + +## Your Permission to Use the Forum) + +Subject to these terms, the company gives you permission to use the forum. Everyone needs to agree to these terms to use the forum. + +## Conditions for Use of the Forum + +Your permission to use the forum is subject to the following conditions: + +1. You must be at least thirteen years old. +2. You may no longer use the forum if the company contacts you directly to say that you may not. +3. You must use the forum in accordance with [Acceptable Use](#acceptable-use) and [Content Standards](#content-standards). + +## Acceptable Use + +1. You may not break the law using the forum. +2. You may not use or try to use another’s account on the forum without their specific permission. +3. You may not buy, sell, or otherwise trade in user names or other unique identifiers on the forum. +4. You may not send advertisements, chain letters, or other solicitations through the forum, or use the forum to gather addresses or other personal data for commercial mailing lists or databases. +5. You may not automate access to the forum, or monitor the forum, such as with a web crawler, browser plug-in or add-on, or other computer program that is not a web browser. You may crawl the forum to index it for a publicly available search engine, if you run one. +6. You may not use the forum to send e-mail to distribution lists, newsgroups, or group mail aliases. +7. You may not falsely imply that you’re affiliated with or endorsed by the company. +8. You may not hyperlink to images or other non-hypertext content on the forum on other webpages. +9. You may not remove any marks showing proprietary ownership from materials you download from the forum. +10. You may not show any part of the forum on other websites with \. +11. You may not disable, avoid, or circumvent any security or access restrictions of the forum. +12. You may not strain infrastructure of the forum with an unreasonable volume of requests, or requests designed to impose an unreasonable load on information systems underlying the forum. +13. You may not impersonate others through the forum. +14. You may not encourage or help anyone in violation of these terms. + +## Content Standards + +1. You may not submit content to the forum that is illegal, offensive, or otherwise harmful to others. This includes content that is harassing, inappropriate, or abusive. +2. You may not submit content to the forum that violates the law, infringes anyone’s intellectual property rights, violates anyone’s privacy, or breaches agreements you have with others. +3. You may not submit content to the forum containing malicious computer code, such as computer viruses or spyware. +4. You may not submit content to the forum as a mere placeholder, to hold a particular address, user name, or other unique identifier. +5. You may not use the forum to disclose information that you don’t have the right to disclose, like others’ confidential or personal information. + +## Enforcement + +The company may investigate and prosecute violations of these terms to the fullest legal extent. The company may notify and cooperate with law enforcement authorities in prosecuting violations of the law and these terms. + +The company reserves the right to change, redact, and delete content on the forum for any reason. If you believe someone has submitted content to the forum in violation of these terms, [contact us immediately](#contact). + +## Your Account + +You must create and log into an account to use some features of the forum. + +To create an account, you must provide some information about yourself. If you create an account, you agree to provide, at a minimum, a valid e-mail address, and to keep that address up-to-date. You may close your account at any time by e-mailing **info@threefold.io**. + +You agree to be responsible for all action taken using your account, whether authorized by you or not, until you either close your account or notify the company that your account has been compromised. You agree to notify the company immediately if you suspect your account has been compromised. You agree to select a secure password for your account, and keep it secret. + +The company may restrict, suspend, or close your account on the forum according to its policy for handling copyright-related takedown requests, or if the company reasonably believes that you’ve broken any rule in these terms. + +## Your Content + +Nothing in these terms gives the company any ownership rights in intellectual property that you share with the forum, such as your account information, posts, or other content you submit to the forum. Nothing in these terms gives you any ownership rights in the company’s intellectual property, either. + +Between you and the company, you remain solely responsible for content you submit to the forum. You agree not to wrongly imply that content you submit to the forum is sponsored or approved by the company. These terms do not obligate the company to store, maintain, or provide copies of content you submit, and to change it, according to these terms. + +Content you submit to the forum belongs to you, and you decide what permission to give others for it. But at a minimum, you license the company to provide content that you submit to the forum to other users of the forum. That special license allows the company to copy, publish, and analyze content you submit to the forum. + +When content you submit is removed from the forum, whether by you or by the company, the company’s special license ends when the last copy disappears from the company’s backups, caches, and other systems. Other licenses you apply to content you submit, such as [Creative Commons](https://creativecommons.org/) licenses, may continue after your content is removed. Those licenses may give others, or the company itself, the right to share your content through the forum again. + +Others who receive content you submit to the forum may violate the terms on which you license your content. You agree that the company will not be liable to you for those violations or their consequences. + +## Your Responsibility + +You agree to indemnify the company from legal claims by others related to your breach of these terms, or breach of these terms by others using your account on the forum. Both you and the company agree to notify the other side of any legal claims for which you might have to indemnify the company as soon as possible. If the company fails to notify you of a legal claim promptly, you won’t have to indemnify the company for damages that you could have defended against or mitigated with prompt notice. You agree to allow the company to control investigation, defense, and settlement of legal claims for which you would have to indemnify the company, and to cooperate with those efforts. The company agrees not to agree to any settlement that admits fault for you or imposes obligations on you without your prior agreement. + +## Disclaimers + +You accept all risks of using the forum and content on the forum. As far as the law allows, the company and its suppliers provide the forum as is, without any warranty whatsoever. + +The forum may hyperlink to and integrate forums and services run by others. The company does not make any warranty about services run by others, or content they may provide. Use of services run by others may be governed by other terms between you and the one running service. + +## Limits on Liability + +Neither the company nor its suppliers will be liable to you for breach-of-contract damages their personnel could not have reasonably foreseen when you agreed to these terms. + +As far as the law allows, the total liability to you for claims of any kind that are related to the forum or content on the forum will be limited to $50. + +## Feedback + +The company welcomes your feedback and suggestions for the forum. See the [Contact](#contact) section below for ways to get in touch with us. + +You agree that the company will be free to act on feedback and suggestions you provide, and that the company won’t have to notify you that your feedback was used, get your permission to use it, or pay you. You agree not to submit feedback or suggestions that you believe might be confidential or proprietary, to you or others. + +## Termination + +Either you or the company may end the agreement written out in these terms at any time. When our agreement ends, your permission to use the forum also ends. + +The following provisions survive the end of our agreement: [Your Content](#your-content), [Feedback](#feedback), [Your Responsibility](#your-responsibility), [Disclaimers](#disclaimers), [Limits on Liability](#limits-on-liability), and [General Terms](#general-terms). + +## Disputes + +The governing law will govern any dispute related to these terms or your use of the forum. + +You and the company agree to seek injunctions related to these terms only in state or federal court in the city for disputes. Neither you nor the company will object to jurisdiction, forum, or venue in those courts. + +Other than to seek an injunction or for claims under the Computer Fraud and Abuse Act, you and the company will resolve any dispute by binding American Arbitration Association arbitration. Arbitration will follow the AAA’s Commercial Arbitration Rules and Supplementary Procedures for Consumer Related Disputes. Arbitration will happen in the city for disputes. You will settle any dispute as an individual, and not as part of a class action or other representative proceeding, whether as the plaintiff or a class member. No arbitrator will consolidate any dispute with any other arbitration without the company’s permission. + +Any arbitration award will include costs of the arbitration, reasonable attorneys’ fees, and reasonable costs for witnesses. You and the company may enter arbitration awards in any court with jurisdiction. + +## General Terms + +If a provision of these terms is unenforceable as written, but could be changed to make it enforceable, that provision should be modified to the minimum extent necessary to make it enforceable. Otherwise, that provision should be removed. + +You may not assign your agreement with the company. The company may assign your agreement to any affiliate of the company, any other company that obtains control of the company, or any other company that buys assets of the company related to the forum. Any attempted assignment against these terms has no legal effect. + +Neither the exercise of any right under this Agreement, nor waiver of any breach of this Agreement, waives any other breach of this Agreement. + +These terms embody all the terms of agreement between you and the company about use of the forum. These terms entirely replace any other agreements about your use of the forum, written or not. + +## Contact + +You may notify the company under these terms, and send questions to the company, at **info@threefold.io**. + +The company may notify you under these terms using the e-mail address you provide for your account on the forum, or by posting a message to the homepage of the forum or your account page. + +## Changes + +The company last updated these terms on Aug, 2020, and may update these terms again. For updates that contain substantial changes, the company agrees to e-mail you, if you’ve created an account and provided a valid e-mail address. The company may also announce updates with special messages or alerts on the forum. + +Once you get notice of an update to these terms, you must agree to the new terms in order to keep using the forum. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_toc.md b/collections/tfmanual/knowledge_base/collaboration/collaboration_toc.md new file mode 100644 index 0000000..3a6bc41 --- /dev/null +++ b/collections/tfmanual/knowledge_base/collaboration/collaboration_toc.md @@ -0,0 +1,13 @@ +

Collaboration

+ +ThreeFold strongly believes in the power of open-source projects and community-driven collaboration. The following documentation is ideal for anyone who wants to know ways to collaborate to the ThreeFold ecosystem. + +To become a farmer, a developer or a sysadmin on the ThreeFold, read the [documentation](../../documentation/documentation.md). + +

Table of Contents

ThreeFold Circle Tool + +

Table of Contents

+ +- [Introduction](#introduction) +- [Overview](#overview) +- [Prerequisites](#prerequisites) +- [How to Use the Circle Tool](#how-to-use-the-circle-tool) +- [Circle Tool Overview](#circle-tool-overview) +- [Dashboard View](#dashboard-view) +- [Profile view](#profile-view) +- [Projects](#projects) +- [Scrum Module on Project](#scrum-module-on-project) + - [Scrum Backlog](#scrum-backlog) + - [Scrum Sprints](#scrum-sprints) +- [More Info](#more-info) + +*** + +## Introduction + +The [__ThreeFold Circle Tool__](https://circles.threefold.me ) is our own self-hosted (desktop only) project management tool based on [Taiga](https://www.taiga.io/), an open-source project management tool for cross-functional agile. It offers a lot of different project management kits and features such as the scrum board, kanban board, issues management, and many more. + +Our teams at ThreeFold use the Circle Tool to self-manage our tasks, thus it is deemed necessary for the new onboarded team members to learn how to use the tool. Unfortunately we only provide the desktop version of the tool at this moment since we normally manage our projects on the computer. + +This manual will be a beneficial thing to read for anyone: our team members, as well as our community members who are interested in using Circle Tool for their projects. + +## Overview + +Here is an overview of the tool. + +![ ](./img/taiga.png) + +## Prerequisites + +You would need to install and create an account on the [TF Connect App](../../../documentation/threefold_token/storing_tft/tf_connect_app.md) before being able to register and use the Circle Tool. + +## How to Use the Circle Tool + +* Go to [Circle Tool's desktop homepage](https://circles.threefold.me) on your computer as shown below. Click on '__Login__' button on the very top right corner of your screen. + +![ ](./img/circlehome.png) + +* Click on "TF Connect" button to log into the Circle Tool by using your TF Connect Account. + +![ ](./img/tfconnect.png) + +* Fill in your TF Connect usernames (without adding the '@' sign) on the provided box, and click on the 'Sign in' button. + +![ ](./img/signin.png) + +* Circle Tool will ask you to verify your login by clicking the right emoji that is sent to your TF Connect App. + +![ ](./img/emoji.png) + +* Verify your sign in process by loggin in to your TF Connect App on your mobile phone. Click on the same emoji that you see on your circle tool (desktop). + +![ ](./img/matchemoji.png) + +* Congratulations, you are now officially logged in on the circle tool. The Dashboard view will be the first thing you will see once you are logged in to the tool. + +![ ](./img/dashboard.png) + +*** + +## Circle Tool Overview + +The Circle Tool always try to make things easy and intuitive for new users but it’s good to have a nice & quick overview for your first couple of days. + +## Dashboard View + +![ ](./img/dashboard.png) + +Upon login or if you just go to your Circle Tool, you’re confronted with your dashboard with quick access to your working on items, a list of watched items and shortcuts to your projects. You can always go back to your dashboard by clicking on the Taiga +icon on the top bar. + +## Profile view + +![ ](./img/profile.png) + +Circle Tool has an additional section to get a multiproject view where you can find and list everything that is accessible to you. Simply click on your avatar and you access your personal profile section where you can check from what your personal bio looks like for people that might have access to it to all sorts of information on your activities and relevant content. + +## Projects + +![ ](./img/project.png) + +You can access your assigned projects by clicking on Projects link at the top left of your screen. You can hover and get an interactive shortlist or click on the link and go to a dedicated page where you can access them as well as rearrange them. Once you have clicked on a project, you access your default view for that project, which is always the Project’s Timeline if you haven’t changed that. + + +## Scrum Module on Project + +![ ](./img/homeproject.png) + +Every circle project can activate the Scrum module. This also happens automatically if you chose the Scrum template upon project creation. You can find the scrum module on the sidebar of your project page. + +Scrum is an agile framework for developing, delivering, and sustaining complex products. Although it had an initial emphasis on software development, it has been used in other fields including research, sales, marketing and advanced technologies. + +### Scrum Backlog + +![ ](./img/backlog.png) + +There are various so called artifacts in Scrum. The top three are the Backlog, the User Stories and the Sprints. They respectively represent what is to be done ordered by priority and readyness, the pieces of work themselves and the fixed time periods in which we put selected User Stories to be worked upon and finished. + +### Scrum Sprints + +![ ](./img/sprints.png) + +The Scrum Backlog view will always show a summary view of ongoing or closed Sprints but teams generally stick to the Sprint Taskboard view when they are focused on getting things done for that Sprint. Click on either the Sprint name or the “Sprint Taskboard” button so you can access the very important Sprint Taskboard. Open Sprints appear as shortcuts through the left navigation pane’s Scrum icon. + + +## More Info + +You can read more about the Circle Tool (Taiga), scrum, sprints, and other documentations on Taiga's project management features on Taiga's official documentation [here](https://community.taiga.io/). Happy Project Managing! \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/collaboration_tools.md b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/collaboration_tools.md new file mode 100644 index 0000000..2060d09 --- /dev/null +++ b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/collaboration_tools.md @@ -0,0 +1,18 @@ +

ThreeFold's Collaboration Tools

+ +In this section, we will introduce powerful collaboration tools utilized by ThreeFold, such as the Circle Tool and the Website Deployer. + +These tools play a crucial role in enhancing as well as simplifying collaboration and communication at ThreeFold. The tools we use at ThreeFold are chosen for their open-source design and their focus on ease of comprehension and use. + +

Table of Contents

+ +- [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) + - 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) + - 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/tfmanual/knowledge_base/collaboration/collaboration_tools/img/backlog.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/backlog.png new file mode 100644 index 0000000..2cc0f41 Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/backlog.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/circlehome.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/circlehome.png new file mode 100644 index 0000000..a1ca18b Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/circlehome.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/clone.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/clone.png new file mode 100644 index 0000000..083e4ad Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/clone.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/codeexample.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/codeexample.png new file mode 100644 index 0000000..de6f82d Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/codeexample.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/column.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/column.png new file mode 100644 index 0000000..6f33e41 Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/column.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/config.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/config.png new file mode 100644 index 0000000..c615104 Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/config.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/dashboard.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/dashboard.png new file mode 100644 index 0000000..b0c8ce2 Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/dashboard.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/done.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/done.png new file mode 100644 index 0000000..43f760c Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/done.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/emoji.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/emoji.png new file mode 100644 index 0000000..a710876 Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/emoji.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/folderdetail.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/folderdetail.png new file mode 100644 index 0000000..019b1ee Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/folderdetail.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/fork.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/fork.png new file mode 100644 index 0000000..9fadc1e Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/fork.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/gitpages.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/gitpages.png new file mode 100644 index 0000000..7b49f85 Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/gitpages.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/homeproject.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/homeproject.png new file mode 100644 index 0000000..70f0ca0 Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/homeproject.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/indexmd.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/indexmd.png new file mode 100644 index 0000000..0a746b0 Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/indexmd.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/logo.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/logo.png new file mode 100644 index 0000000..b945b27 Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/logo.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/mastodon.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/mastodon.png new file mode 100644 index 0000000..cb24871 Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/mastodon.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/mastodonmd.jpeg b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/mastodonmd.jpeg new file mode 100644 index 0000000..e34b84a Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/mastodonmd.jpeg differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/matchemoji.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/matchemoji.png new file mode 100644 index 0000000..24cad6c Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/matchemoji.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/navbar.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/navbar.png new file mode 100644 index 0000000..d322317 Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/navbar.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/navigate.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/navigate.png new file mode 100644 index 0000000..5294595 Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/navigate.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/placeholder.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/placeholder.png new file mode 100644 index 0000000..b39dbfd Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/placeholder.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/preview.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/preview.png new file mode 100644 index 0000000..803dddc Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/preview.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/profile.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/profile.png new file mode 100644 index 0000000..ee4a3bb Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/profile.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/project.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/project.png new file mode 100644 index 0000000..96285b5 Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/project.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/publishtools.jpeg b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/publishtools.jpeg new file mode 100644 index 0000000..cffcdfe Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/publishtools.jpeg differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/scoopsuccess.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/scoopsuccess.png new file mode 100644 index 0000000..16e7eea Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/scoopsuccess.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/signin.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/signin.png new file mode 100644 index 0000000..fedebec Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/signin.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/sprints.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/sprints.png new file mode 100644 index 0000000..9fc2747 Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/sprints.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/success.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/success.png new file mode 100644 index 0000000..9818dd1 Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/success.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/taiga.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/taiga.png new file mode 100644 index 0000000..834927a Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/taiga.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/tfconnect.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/tfconnect.png new file mode 100644 index 0000000..0479e95 Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/tfconnect.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/threecolumns.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/threecolumns.png new file mode 100644 index 0000000..e6ff5e8 Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/threecolumns.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/threecolumnsdone.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/threecolumnsdone.png new file mode 100644 index 0000000..72b7a54 Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/threecolumnsdone.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/threefolders.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/threefolders.png new file mode 100644 index 0000000..ba9aa74 Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/threefolders.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/twocolumns.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/twocolumns.png new file mode 100644 index 0000000..45ea049 Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/twocolumns.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/twocolumnsdone.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/twocolumnsdone.png new file mode 100644 index 0000000..eb49df2 Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/twocolumnsdone.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/vscode.png b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/vscode.png new file mode 100644 index 0000000..c9cda3a Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/vscode.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/websitetool.jpeg b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/websitetool.jpeg new file mode 100644 index 0000000..bc4315e Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/img/websitetool.jpeg differ diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/website_link_checker.md b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/website_link_checker.md new file mode 100644 index 0000000..788c5e0 --- /dev/null +++ b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/website_link_checker.md @@ -0,0 +1,87 @@ +

Website Link Checker

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [How the Program Exits](#how-the-program-exits) +- [Program Arguments](#program-arguments) +- [How to Use the Program](#how-to-use-the-program) + - [With Python](#with-python) + - [With Docker](#with-docker) + - [With Github Action](#with-github-action) + +*** + +## Introduction + +This is a Python program that calls muffet on a whole website and then filters and displays the HTTP errors. + +> Note: It can take a couple of minutes to run if the website has a lot of URLs. + +## How the Program Exits + +Exits with error code 1 if at least one error is found, as specified with --errors +flag. Otherwise exits with code 0. Note that errors set as --warnings will always exit with code 0. + +## Program Arguments + +* url + * The URL to scan. Please include https:// or http://. (e.g. https://google.com) +* -h, --help + * show this help message and exit +* -e ERRORS [ERRORS ...], --errors ERRORS [ERRORS ...] + * Specify one, many or all error codes to be filtered (e.g. -e 404, -e 403 404, -e all). Use -e all to show all errors. +* -w WARNINGS [WARNINGS ...], --warnings WARNINGS [WARNINGS ...] + * Specify one, many or all error codes to be filtered as warnings (e.g. -w 404, -w 403 404, -w all). Use -w all to show all warnings. + +## How to Use the Program + +### With Python + +* Clone the repository + * ``` + git clone https://github.com/threefoldfoundation/website-link-checker + ``` +* Change directory + * ``` + cd website-link-checker + ``` +* Run the program + * ``` + python website-link-checker.py https://example.com -e 404 -w all + ``` + +### With Docker + +You can use the following command to run the website link checker with Docker: + +``` +docker run ghcr.io/threefoldfoundation/website-link-checker https://example.com -e 404 -w all +``` + +### With Github Action + +The website link checker can be run as an action (e.g. `action.yml`) set in `.github/workflows` of a Github repository. + +The following action example runs everytime there is a push on the development branch and also every Monday at 6:00AM as set by the cron job. + +``` +name: link-checker-example +on: + push: + branches: [ development ] + schedule: + - cron: '0 6 * * 1' # e.g. 6:00 AM each Monday + +jobs: + job_one: + name: Check for Broken Links + runs-on: ubuntu-latest + steps: + - name: Check for Broken Links + id: link-report + uses: docker://ghcr.io/threefoldfoundation/website-link-checker:latest + with: + args: 'https://example.com -e 404 -w all' +``` + diff --git a/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/website_tool.md b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/website_tool.md new file mode 100644 index 0000000..c3b997f --- /dev/null +++ b/collections/tfmanual/knowledge_base/collaboration/collaboration_tools/website_tool.md @@ -0,0 +1,338 @@ +

Zola Website Deployer

+ +

Table of Contents

+ +- [Overview](#overview) + - [What is Zola Framework?](#what-is-zola-framework) +- [Prerequisites](#prerequisites) + - [Important Links](#important-links) +- [Installing Zola Onto Your Machine](#installing-zola-onto-your-machine) + - [Important Links](#important-links-1) +- [Get Started](#get-started) + - [Fork ThreeFold's Website Template to Your Github Account](#fork-threefolds-website-template-to-your-github-account) + - [Clone the Forked Repository Locally](#clone-the-forked-repository-locally) + - [Open and Edit Your Cloned Zola Template with a Code Editor](#open-and-edit-your-cloned-zola-template-with-a-code-editor) + - [Template Guide](#template-guide) + - [Navigating the Template](#navigating-the-template) + - [Top Navbar Made Easy](#top-navbar-made-easy) + - [Replace Logo with your Own logo](#replace-logo-with-your-own-logo) + - [Important Links](#important-links-2) +- [Customization](#customization) + - [Some Tutorials on Markdown](#some-tutorials-on-markdown) + - [Creating A Single-Column Page Section](#creating-a-single-column-page-section) + - [Adding Image](#adding-image) + - [Creating Page Section with Multiple Columns](#creating-page-section-with-multiple-columns) + - [Important Links](#important-links-3) + - [Build and Preview Your Website Locally](#build-and-preview-your-website-locally) + - [Check the Website Links](#check-the-website-links) + - [Important Links](#important-links-4) +- [Publish Your Website (Via Github Pages)](#publish-your-website-via-github-pages) + - [Publish your Github page](#publish-your-github-page) +- [Important Links](#important-links-5) +- [Questions and Feedback](#questions-and-feedback) + +*** + +## Overview + +**ThreeFold Website Tool** is a customized open-source Zola-based web deployment framework and static website template repository that is available for anyone to use. + +At ThreeFold, we utilized Website Tool to deploy all of our web presences. For example, [**www.threefold.io**](https://threefold.io). + +### What is Zola Framework? +[**Zola**](https://www.getzola.org/) is a static site generator (SSG), similar to Hugo, Pelican, and Jekyll (for a comprehensive list of SSGs, please see Jamstack). It is written in Rust and uses the Tera template engine, which is similar to Jinja2, Django templates, Liquid, and Twig. Content is written in CommonMark, a strongly defined, highly compatible specification of Markdown. + +While you can also publish a static website using Zola alone, we at ThreeFold have customized the framework and created a static website template that makes it even easier for anyone to build a website by simply cloning template and fill it with their own website content. + + + +## Prerequisites + +- Github Account +- Zola Framework +- VS Code, or any code editor of choice +- Markdown language knowledge +- Basic Command Line (Terminal) Knowledge + +In order to deploy and publish a website using ThreeFold Website Tool, you would need to have an account on github (to store your website data in a github repository), as well as to have Zola framework installed on your machine. + +### Important Links + +> - [How to Sign Up for a Github Account](https://docs.github.com/en/get-started/signing-up-for-github/signing-up-for-a-new-github-account) +> - [Download VS Code](https://code.visualstudio.com/download) +> - [Learn Markdown Language](https://www.markdownguide.org/) +> - [Command Line Cheat Sheet](https://cs.colby.edu/maxwell/courses/tutorials/terminal/) + + + +## Installing Zola Onto Your Machine + +To install Zola on your machine, simply go to your terminal and run the following command: + +**MacOS (brew)**: + +``` +$ brew install zola +``` +Please make sure you have [Brew](https://brew.sh/) installed on your MacOS machine before installing Zola. + +Windows (scoop): + +``` +$ scoop install zola +``` +Please make sure you have [Scoop](https://scoop.sh/) installed on your Windows machine before installing Zola. + +You should see a similar screen as below when successful: + +![](./img/scoopsuccess.png) + +For more details on Zola Installation, and installation guidelines for other operating systems, please read: [**Zola Installation Manual**](https://www.getzola.org/documentation/getting-started/installation/). + + +### Important Links +> - [How to Install Brew (MacOS)](https://brew.sh/) +> - [How to Install Scoop (Windows)](https://github.com/ScoopInstaller/Scoop#readme) +> - [Zola Installation for other OS](https://www.getzola.org/documentation/getting-started/installation/) +> - [Command Line Cheat Sheet](https://cs.colby.edu/maxwell/courses/tutorials/terminal/) + +> Next Step: [Template Guide: How to use the TF Web Template](#template-guide) + + + +## Get Started + +Now that you have successfully installed Zola on your machine. You are ready to create and build your own website using ThreeFold Website Tool. + +In order to do that you would need to clone [**ThreeFold's Website Template**](https://github.com/threefoldfoundation/www_examplezola) to your own github account, and open it locally on your computer by using VS Code or your code editing program of choice. + +### Fork ThreeFold's Website Template to Your Github Account + +Our Team has especially created an html/css/markdown based template repository on github, free for anyone to use. To start working on your project, simply fork [this repository](https://github.com/threefoldfoundation/www_examplezola) to your own github account by clicking the 'fork' account on the repository, and rename it with your website's name. + +![](./img/fork.png) + +### Clone the Forked Repository Locally +After you forked the template, now you can [clone the repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) to your local computer so we can start working on it. Please remember the directory / folder of where you cloned the repository in your computer to make it easier for you to locate and edit it. + + +![](./img/clone.png) + +### Open and Edit Your Cloned Zola Template with a Code Editor + +Once the template is forked and cloned, open your code editor and start working on your website. I will explain a little more about the content editing process and procedure on the next pages... + +![](./img/vscode.png) + +### Template Guide + +On this page you will find an introduction on [TF Web Template](https://github.com/threefoldfoundation/www_examplezola) and how to navigate the different template component that enable you to edit the template with your own content. + +### Navigating the Template + +All editable content of your website would be found under **‘content’** folder. +Each page of your website is a **markdown (.md) file.** + +Each page and all the images on the page will be put into its own folder under content/ folder. +![](./img/folderdetail.png) +
+For example, here, my homepage (index.md) is put into **content/home** folder. +![](./img/indexmd.png) + +If I want to edit the homepage of my website, I would go to the following: +bb +``` +content/home/index.md +``` + and start editing. + + ![](./img/vscode.png) + + ### Top Navbar Made Easy + +![](./img/navbar.png) + +Every time you make a new page folder, we have designed it in a way that the website would automatically generate a new navbar item using the name of each folder you created. + + based on the navbar picture above, it means that I have created 3 separate content subfolders, each with an index.md file on it called Home, ThreeFoldFeed and GetServer. + +### Replace Logo with your Own logo +![](./img/logo.png) + +To replace the logo, **add your own logo image to ‘home’ folder.** + +And then go to **_index.md** file and replace the **logo_path**: images/yourlogoimagename.jpg + +![](./img/placeholder.png) + +### Important Links + +> - [TF Web Template](https://github.com/threefoldfoundation/www_examplezola) + + + +## Customization + +We have designed the template in certain ways that it would accommodate different indentation web page style, such as placeholders, footer, header, left-indentation, right-indentation. + +All you need to do is just replace the texts and images using markdown language, and use the indentation style you would like to use for your page. Don’t know how to markdown? Here’s a [**complete markdown syntax guide**](https://www.markdownguide.org/basic-syntax/) for you to begin with. + + Happy experimenting! + +### Some Tutorials on Markdown + +### Creating A Single-Column Page Section + +Since we only have one column, Every one column section begins only with row indentation syntax (style, margin, padding). + + +``` + + +{% row(style="" margin="" padding="t") %} +``` + +for example: + +``` + + +{% row(style="center" margin="narrow" padding="top") %} +``` + +and ends with + +``` +{% end %} +``` + +### Adding Image + +To add image to your page please use + +``` +![alt_text](yourimagename.png) +``` + +The Result: + +![](./img/mastodon.png) + + +### Creating Page Section with Multiple Columns + +For more than one column section, we need to configure the row and column syntax. +For example: +Sometimes you would like to have a page where you place your texts and buttons on left column and an image on the right column, like: + +What you need to do is add: + +``` +||| +``` +in between your text and images for every column you want to create. + +For example, this page consist of two columns (left and right): + +![](./img/twocolumns.png) + +The Result: + +![](./img/twocolumnsdone.png) + +You can add more than two column like this one, a page section consist of 3 columns. + +The code: + +![](./img/threecolumns.png) + +The Result: + +![](./img/threecolumnsdone.png) + + +### Important Links +> - [Learn Markdown Language](https://www.markdownguide.org/) + +### Build and Preview Your Website Locally + +After customizing your website, you might want to review and build your website locally before publishing it online. On this page you will find tutorials on how to preview and deploy your website. + +To preview your website locally, simply open the terminal via your code editor and type in: + +``` +./build.sh +``` + +So that the framework starts building your website. + +Then + +``` +./start.sh +``` + +So that the framework starts serving your website preview locally. Please make sure you are on located on the right website folder, for example: *$ user/doc/mywebsitename* before typing the command above. + + The preview won't successfuly be built if you run the command in the wrong folder. + +When successful, it will give you a link to a local preview of your website. Go ahead and copy paste the url onto your web browser to preview your website locally. + +![](./img/success.png) + +And, Congratulations! You just built your website locally! + +![](./img/preview.png) + +### Check the Website Links + +When you are in the main directory of your Zola website, you can check the following command to check the links of the complete website locally: + +``` +zola check +``` + +Once your website is online, you can also use the [Website Link Checker](./website_link_checker.md). + +### Important Links + +> - [Command Line Cheat Sheet](https://cs.colby.edu/maxwell/courses/tutorials/terminal/) + + + +## Publish Your Website (Via Github Pages) + +Since we're using github repository to save our website content, the easiest way to publish our website is also through github pages and by using our own domain. + +Once all commits have been pushed back to your github repository online, you can start publishing your website. + +The first thing you need to do is to go back to your code editor, and find **config.toml** file on your website repo. +Edit the **base_url** on the **config.toml** file on your repo to your own domain. + +![](./img/config.png) + +Save all your changes and push all your commits to its origin again. + +### Publish your Github page + +Later on, go to your github repo **settings**, go to **Pages** on the left navigation sidebar. Add your own custom domain to start publishing your website. + +![](./img/gitpages.png) + + +And you are done! Your website will be published, and it will take only a minute or so to complete the process. Refresh page, and you will see a link to your newly published website. + +![](./img/done.png) + + + +## Important Links +> - [Pushing Changes to Github](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/pushing-changes-to-github) +> - [Github Pages How-to](https://docs.github.com/en/pages) +> - [Adding Custom Domain to my Github Page](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages) + + + +## Questions and Feedback + +If you have any question or feedback, you can write a post on the [ThreeFold Forum](http://forum.threefold.io/). \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/collaboration/contribute.md b/collections/tfmanual/knowledge_base/collaboration/contribute.md new file mode 100644 index 0000000..698a477 --- /dev/null +++ b/collections/tfmanual/knowledge_base/collaboration/contribute.md @@ -0,0 +1,119 @@ +

How to Contribute to the Threefold Manual

+ +

Table of Contents

+ +- [Quick Method: Create an Issue](#quick-method-create-an-issue) +- [Advanced Method: Create a Pull Request](#advanced-method-create-a-pull-request) + - [Main Steps to Add Content](#main-steps-to-add-content) + - [How to View the mdbook Locally](#how-to-view-the-mdbook-locally) + - [How to Install git and mdbook](#how-to-install-git-and-mdbook) + - [Markdown File Template (Optional)](#markdown-file-template-optional) +- [Questions and Feedback](#questions-and-feedback) + +*** + +## Quick Method: Create an Issue + +If you've found some issues or typos in the ThreeFold Manual, feel free to [create an issue on the ThreeFold Manual repository](https://github.com/threefoldtech/info_grid/issues) to let us know. We will then be able to fix it as soon as possible. + +The steps are simple: + +* Go to the [issues section of ThreeFold Manual](https://github.com/threefoldtech/info_grid/issues) repository on GitHub +* Click on `New Issue` +* Choose an appropriate title +* Explain briefly the issue you found +* Click `Submit New Issue` + + + +## Advanced Method: Create a Pull Request + +If you found an issue in the manual and you wish to fix the issue yourself, you can always fork the repository and propose the changes in a pull request. We present the main steps in this section as well as further details on how to proceed efficiently. + + + +### Main Steps to Add Content + + + +We present here the main steps to add content to the Threefold Manual by forking the repository [`threefoldtech/info_grid`](https://github.com/threefoldtech/info_grid) to your own Github account. + +* Go to the Threefold Manual repository: [https://github.com/threefoldtech/info_grid](https://github.com/threefoldtech/info_grid) +* Fork the Development branch + * On the top right corner, click `Fork -> Create a new fork` +* 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). + * To modify an existing section: + * Make the changes directly in the Markdown file +* Ask for a pull request + * In the forked repository, click `Contribute -> Open pull request` +* Once the pull request is accepted, the changes of the Development branch will be available here: [https://www2.manual.grid.tf](https://www2.manual.grid.tf) +* The Threefold team will regularly update the [Development branch](https://github.com/threefoldtech/info_grid) to the [Master branch](https://github.com/threefoldtech/info_grid/tree/master) + * The new content will thus be available here: [https://www.manual.grid.tf](https://www.manual.grid.tf) + +Note: You can update your forked repository by clicking `Sync fork -> Update branch`. + + + +### How to View the mdbook Locally + + + +Once you've forked the TF Manual repository to your Github account, you might want to see the changes you've made before asking for a pull request. This will ensure that the final output is exactly what you have in mind. + +To do so, you simply need to clone the forked repository on your local computer and serve the mdbook on a given port. + +The steps are the following: + +* In the terminal, write the following line to clone the forked `info_grid` repository: + * ``` + git clone https://github.com/YOUR_GIT_ACCOUNT/info_grid + ``` + * make sure to write your own Github account in the URL +* To deploy the mdbook locally, first go to the **info_grid** directory: + * ``` + cd info_grid + ``` +* Then write the following line. It will open the manual automatically. + * ``` + mdbook serve -o + ``` + * Note that, by default, the URL is the following, using port `3000`, `http://localhost:3000/` +* You should now be able to see your changes. + + + +### How to Install git and mdbook + + + +To install git, follow the steps provided [here](https://github.com/git-guides/install-git). + +To install mdbook, you can download the executable binaries available on the [GitHub Releases Page](https://github.com/rust-lang/mdBook/releases). Simply download the binary for your platform (Windows, macOS, or Linux) and extract the archive. The archive contains an mdbook executable which you can run to build your books. To make it easier to run, you can put the path to the binary into your PATH. + +For more information, read the [mdbook Documentation](https://rust-lang.github.io/mdBook/guide/installation.html). + + + +### Markdown File Template (Optional) + + + +Here are some suggestions on how to organize a Markdown file (`.md`) when you submit contents to the ThreeFold Manual. This is not necessary, but it will ease the whole process. + +* Title: Heading 1 (`#` in Markdown syntax) +* Main sections: Heading 2 (`##` in Markdown syntax) +* For Markdown files that contain a *Table of Contents*: + * Use `

` instead of `#` for the _Title_ , and `

` instead of `##` for the _Table of Contents_. + * This quickens editing when creating and updating the ToC ([read this for more details](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one#table-of-contents)). + * Other heading labels should use standard Markdown headings (`##`, etc.). +* If your text reaches heading level 4, you might want to separate your file into two or more files. + * A long article can be spread in many subsections. + + + +## Questions and Feedback + +If you have any questions or if you would like to share some feedback, let us know in this [Threefold forum post](https://forum.threefold.io/t/new-grid-manual/3783). \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/collaboration/development_cycle.md b/collections/tfmanual/knowledge_base/collaboration/development_cycle.md new file mode 100644 index 0000000..c321367 --- /dev/null +++ b/collections/tfmanual/knowledge_base/collaboration/development_cycle.md @@ -0,0 +1,36 @@ +The development cycle is explained below: + +![Untitled presentation (1)](https://user-images.githubusercontent.com/8425762/170034170-7247a737-9d99-481d-9289-88d361275043.png) + + + +Devnet: + - continuous development for active version + - can be reset + - should be against a branch named with the version being developed (example: 10.2.3) + +Nextnet: + - for parallel version development + - oftentimes, the next major version while development has bugfixes + - should be against a branch named with the version being developed (example: 10.3.1) + +QAnet: + - once development is complete, each component is tagged with an rc (example: 10.2.3-rc1) and the new version to be tested is deployed on QAnet + - this net is for INTERNAL QA + - Here, we expect most bugs to be reported + - Once QA signs off, it moves to testnet + +Testnet: + - tag as beta release (example: 10.2.3-rc3-beta) + - This is for the community and stability testing + - should be almost completely stable + +Mainnet: + - if testnet has no blockers for 2 weeks, community votes to move to mainnet + - everything is merged to main + - final release is tagged (example: 10.2.3) + + + +## GOAL: +moving away from that model to be able to use ephermal environments instead of maintaining such environments, but now they're available for simplicity \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/collaboration/development_process.md b/collections/tfmanual/knowledge_base/collaboration/development_process.md new file mode 100644 index 0000000..ae6d64b --- /dev/null +++ b/collections/tfmanual/knowledge_base/collaboration/development_process.md @@ -0,0 +1,422 @@ +

Development Process

+ +Our project development process is characterized by agility, collaboration, and, most importantly, respect. We firmly believe in harnessing the collective ingenuity of our team, recognizing that each individual contributes invaluable insights to our codebase, our development process is completely managed on Github, using Github based projects. + +

Table of Contents

+ +- [Quality Assurance (QA) Process](#quality-assurance-qa-process) + - [QA Responsibilities](#qa-responsibilities) + - [Daily Standups](#daily-standups) + - [Provide Test Plans](#provide-test-plans) + - [Test Execution](#test-execution) + - [Test Documentation](#test-documentation) + - [Verification and Closure](#verification-and-closure) + - [Cross-Environment Testing](#cross-environment-testing) + - [Bug Assessment Meetings (BAM)](#bug-assessment-meetings-bam) + - [Additional Testing Types](#additional-testing-types) + - [Expectations for QA Leads](#expectations-for-qa-leads) + - [Test Planning](#test-planning) + - [Test Strategy](#test-strategy) + - [Review and Closure](#review-and-closure) + - [Communication](#communication) + - [QA Verification and Testing](#qa-verification-and-testing) + - [Testplan](#testplan) + - [Verification Process](#verification-process) + +*** + +## Product Definition on Home + + +`Home` repo serves a special role in the organization, it's the starting point of all development. + +- It links to all products & components +- Put only stories, identified with tag `type_story` in the home repo + + +To streamline our development workflow, we have adopted the GitHub-style projects framework, with all repositories linked to the ThreeFold Grid (tfgrid) product (e.g., version 3.6.0). + +- Various views, such as StoryCards for a high-level overview, repository-specific views, and prioritized views, enhance project visibility. +- All repositories are managed within a centralized project, ensuring unified control and coordination. +- Milestones, aligned with semantic versioning, serve as a means to categorize and organize issues, providing versioning per component. +- Each product is clearly outlined in a dedicated project section within the "home" repository. +- The home page in the home repository serves as a hub linking to individual product pages. +- Products are associated with relevant components slated for the upcoming release. +- Product release milestones are clearly marked on the product page. +- Release notes, accessible through each product, offer a historical overview with links to specific components used in each release. +- Interlinked relationships between products and components, as well as links to third-party products with specified version numbers, provide comprehensive tracking. +- Components are meticulously monitored within the same product project. +- A commitment to [semantic versioning](https://semver.org) is mandated for all components. + +## Github Project + +When creating a new project, please use the grid template project (private repository) available at `https://github.com/orgs/threefoldtech/projects/205`. + + +### Github project columns + +- `No Status` + - Stakeholder or project owner suggests a feature/story/bug to be resolved in this release +- `Accepted` + - The project owner accepts the item, the issue will be worked on and he commits to solve within the release + - Once accepted = then escalation is needed if it can not be done in time +- `In progress` + - The issue is being worked on +- `Blocked` + - We are using the Kanban way of thinking - something in this swimlane needs to be resolved asap, can be e.g. a question + - Means issue cannot be completed, attention from e.g. stakeholders is needed +- `Verification` : work is being verified + - The team delivered the feature/bug/story + - Stakeholders need to agree that the issue has been resolved appropriately + - Project owner can never go from 'Verification' to 'Done' without approval from stakeholders (often represented by QA team) +- `Done` + - Everyone agreed (project owner and stakeholders) agreed that the issue was done ok + + +##### Project Special Columns + +Some projects require special columns like the following + +- `Pending Review`: Work is done, waiting for review; no need for daily progress updates. +- `Pending Deployment`: If deployment is needed for QA testing on the staging instance. + + +### Repository + +Creating a repository involves establishing a foundation for collaborative development. Follow these guidelines to ensure consistency and best practices in repository creation. + +#### Naming + +- Choose a clear and descriptive name for the repository. +- Use lowercase letters and hyphens for improved readability. + +#### README + +- Include a comprehensive README.md file. +- Provide essential information about the project, including setup instructions, dependencies, and usage guidelines. + +#### License + +- Include a LICENSE file specifying the project's licensing terms, threefoldtech is using [Apache2 License](https://github.com/threefoldtech/info_grid/blob/master/LICENSE). + +#### 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) + +#### Expected Workflows + +- Set up a continuous integration (CI) pipeline using a tool like GitHub Actions. +- Include linting, tests and code quality checks in the CI process. +- Set up automation to deployment on staging, and production server +- Building docker images +- Building flists +- Pushing to the hub +- Publishing packages + + +### Issues + +Consider the following for Effective Issue Reporting + +1. **Title:** + - Provide a clear and concise title that summarizes the issue. + +2. **Description:** + - Offer a detailed description of the issue, including what you expected to happen and what actually occurred. + - Provide steps to reproduce the issue, if possible. + - Include any error messages received. + +3. **Environment:** + - Specify the environment in which the issue occurred (e.g., operating system, browser, version). + +4. **Attachments:** + - Attach relevant files or screenshots to help visualize the problem. + +5. **Issue Type:** + - Label the issue with an appropriate type (e.g., bug, feature request, question). + +6. **Priority:** + - If applicable, assign a priority level to indicate the urgency of the issue. + +7. **Version Information:** + - Include information about the version of the software or application where the issue was encountered. + +8. **Labels:** + - Apply relevant labels to categorize the issue (e.g., priority levels, type of issue). + +9. **Reproducibility:** + - Clearly state whether the issue is reproducible and under what conditions. + +10. **Additional Context:** + - Provide any additional context that might help in understanding and addressing the issue. + +11. **Assigned:** + - If known, assign the issue to the responsible team member or developer. + +12. **Discussion:** + - Engage in discussions with the development team and other stakeholders to gather insights and potential solutions. + +By following these guidelines, you contribute to a more efficient issue resolution process, enabling developers and the team to address concerns promptly and effectively. + +#### Issue Labels + +See [issue labels](issue_labels.md) + + +#### Branch Names in Issue titles + +Each issue has the name of a branch in the title as [development_something], the name 'development' can be skipped and its the default or previous could also be written as [something] but don't forget branch is development_... +If not specified, it is to be fixed/developed on development. + +#### Milestones for Issues + +We use milestones for version numbers e.g `1.4.2` means this issue is going to be part of the release of `1.4.2` of the component. + +> It's very important that nobody works on any issue in milestones not part of the global project plan + +- No milestone means need to be sorted +- Number e.g `1.4.2` means + +So issues with no milestones can only be in 1 condition: new and not sorted out yet where (repo) it belongs + +### Branching + +We encourage collaborative branching. Meaning any group of people working within the same scope are highly encouraged to work on the same branch, trusting and communicating with one another. + +Our branching strategy is: + +- `master` is the last stable release +- `master_$hotfix` is only for solving BLOCKING issues which are in the field on the last release + - short living +- `development` is where all stories branch from, and the one that has hotfixes if needed +- `development_$storyname` + - branch for a story + - always updated from development(_hotfixes) +- `development_$storyname_$reviewname` + - short living branch for when reviews are needed for a story +- `development_hotfixes` short living hotfix(es) to allow people to review and then put on development + - now everyone should update from or development or development_hotfixes + - development_hotfixes is always newer than development +- `integration` is a branch used to integrate development branches + - never develop on it, its for verifying & doing tests + +We have branches for new features/disruptive changes. These have a prefix of `development_` + +Each project and story should define which branches to use & the branching strategy. + +There should never be any branch on the system which can not be found back by looking at the stories in the `home` repo. +Title of the story : in between [] + + +### Pull Requests + +When developers or a group initiate work on a separate branch and seek input from their peers, it is recommended to promptly open a `draft pull request` for seamless communication. Upon completion of the work, opening a pull request signals that the work is: + +- Complete as Defined in the Project: The work aligns with the predefined goals and specifications outlined in the project. +- Well Tested: Thorough testing has been conducted to ensure the reliability and functionality of the code. +- Well Documented: Comprehensive documentation accompanies the code, aiding in understanding and future maintenance. + +#### Pull Requests Best Practices + +When creating pull requests (PRs), adhere to the following best practices for effective collaboration: + +- Early Draft PRs: Open a draft pull request as soon as work begins on a different branch. This allows for ongoing communication and collaboration with peers throughout the development process. +- Timely Updates: Regularly update the PR as new changes are made to keep reviewers informed of progress. +- Clear and Concise Title: Use a clear and concise title that summarizes the purpose or goal of the pull request. +- Detailed Description: Provide a comprehensive description of the changes made, the problem solved, and any relevant context. This aids reviewers in understanding the purpose and impact of the changes. +- Link to Issues: If the pull request addresses specific issues, link them to provide additional context and traceability. +- Reviewers and Assignees: Assign the appropriate reviewers and, if applicable, assignees to ensure that the right people are involved in the review process. +- Complete Work: Ensure that the work is complete as defined in the project requirements. Address any outstanding issues before marking the PR as ready for review. +- Thorough Testing: Verify that the code has undergone thorough testing. Include details about the testing strategy and results in the PR description. +- Documentation: Confirm that the changes are well-documented. Documentation should not only explain how the code works but also guide future developers on its usage and maintenance. +- Address Feedback: Be responsive to feedback from reviewers. Address comments and concerns promptly to facilitate a smooth review process. +- Code Style and Standards: Ensure that the code follows established style guidelines and coding standards. Consistent formatting contributes to maintainability. +- Status Checks: Ensure that automated status checks, such as continuous integration (CI) tests, pass successfully before merging. +By adhering to these best practices, you contribute to a collaborative and efficient development process, fostering a culture of high-quality code and effective communication within the team. + +### Commits + +Clear and informative commit messages are essential for understanding the history of a project. Follow these guidelines to create meaningful commit messages. + +## Message Structure + +### Header + +- Start with a concise one-line summary +- Use present-tense verbs (e.g., "Add," "Fix," "Update") to describe the action. + +### Body + +- Optionally, provide a more detailed explanation. +- Break long explanations into bullet points if needed. + +## Be Descriptive + +- Clearly describe the purpose of the commit. +- Include information about why the change is necessary. + +## Reference Issues + +- If the commit is related to an issue, reference it in the message. +- Use keywords like "Fixes," "Closes," or "Resolves." + +## Consistency + +- Be consistent with your writing style and formatting. +- Use the imperative mood consistently throughout. + +## Examples + +### Good Example + +Here's a good example of a commit message +``` +Add user authentication feature + +- Implement user login functionality +- Enhance user registration form +- Fixes #123 +``` + +### Bad Example + +``` +Changes +- Bug fix +- Update +- Important changes +``` + +### Merge or Rebase + +If you're the sole developer on the branch, you can use rebase, if more people are collaborating together, use merge + +### Merge or Squash merge + +Squash only when it makes the history cleaner. Feature branch is a good example, because it is often short-lived, small, and authored by 1 developer. + +On the other hand, use regular merge for big feature co-authored by multiple developers eg. long-lived branches, please be aware of the [Disadvantages of squash merges](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/about-merge-methods-on-github#squashing-your-merge-commits) + +### Releasing Process + +Before tagging a release, open a branch named with the intended version e.g 10.5.x with the quality level + - alpha: doesn't have all the features, but you can use the features in there + - beta: no major, or blocking bugs. All features working for the customer as promised, no blocking bugs + - production: no major, no blocking, no minor bugs and the documentation is ready + +check the [release process document](release_process.md) for more information + +#### Blocking + +Issues categorized as blockers include: + +- Inability of the customer to access the functionality as described in the manual. +- Stability concerns that impede progress, particularly instances where the system crashes. +- Security issues that act as barriers to further development. +- Stability issues that hinder smooth operation. +- Performance concerns labeled as blockers when they prevent continuation. +- Performance issues classified as major when they allow for continued work. + +#### Progress Reporting + +In teams operating remotely, complete transparency is of utmost importance. + +Visibility into development progress is crucial and is best achieved through the use of storycards and issues. + +To facilitate clear communication, commenting daily is a critical aspect of our process. We advocate for the following format, which aids in asynchronous communication: + +``` + +## Work Completed: +Summarize the tasks successfully finished in relation to the issue. Provide specific details to ensure clarity. + +## Work in Progress (WIP): +Detail ongoing efforts and remaining tasks related to this issue. Clearly outline items currently being worked on and those still needing attention. + +## Investigation and Solution: +If no work has been completed or is in progress, elaborate on the investigative work undertaken to address the issue. Provide insights into the problem, and if a solution was reached, include it. +``` + +For issues or stories labeled with `priority_critical`, continuous updates should be at least two updates per day to keep stakeholders informed. + +Including an Estimated Time of Arrival (ETA) in the comments is essential. While it serves as an estimation subject to change with new findings, it provides a valuable projection of completion. + + + +# Quality Assurance (QA) Process + +QA plays a crucial role in delivering high-quality software. This document outlines responsibilities, expectations, and best practices. + +## QA Responsibilities + +### Daily Standups + +- Attend daily standups for progress updates, issue discussions, and coordination. + +### Provide Test Plans + +- Collaborate on test plans for each sprint. + +### Test Execution + +- Execute test plans manually and through automated testing. +- Log and prioritize defects. +- Track nightly tests. + +### Test Documentation + +- Maintain updated test documentation. + +### Verification and Closure + +- Verify issues and user stories before closure. + +### Cross-Environment Testing + +- Conduct test runs across different environments. + +### Bug Assessment Meetings (BAM) + +- Conduct BAM sessions twice weekly to address community feedback, covering both `test_feedback` repository and active projects. + +### Additional Testing Types + +- Expand responsibilities to include various testing types such as: + - Performance testing + - Security testing + - Compatibility testing + - Usability testing + - Regression testing + +## Expectations for QA Leads + +### Test Planning + +- Lead the creation of detailed test plans. + +### Test Strategy + +- Define a testing strategy, emphasizing automation. + +### Review and Closure + +- Review and close issues, ensuring alignment with the test plan. + +### Communication + +- Facilitate communication between QA and development teams. + +## QA Verification and Testing + +### Testplan + +- Provide a comprehensive test plan, authored exclusively by the QA lead that serves as the source of truth for the verification process + +### Verification Process + +- Verify stories in a two-step process + - As soon as the story is moved to In Verification column, QA team can pickup the issue, they need to log their scenarios, executions and link to the testcase in the testplan. + - QA lead can then verify it's aligned to the original requirements and it was properly verified before closing +- QA leads need to test the main features by themselves. +- Automate regression testing through github workflows, and any other means needed. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/collaboration/feature_request.md b/collections/tfmanual/knowledge_base/collaboration/feature_request.md new file mode 100644 index 0000000..3390fde --- /dev/null +++ b/collections/tfmanual/knowledge_base/collaboration/feature_request.md @@ -0,0 +1,16 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +## Is your feature request related to a problem? Please describe + +A clear and concise description of what the problem is. Ex. I'm always frustrated when \[...] + +## Describe the solution you'd like + +A clear and concise description of what you want to happen. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/collaboration/issue_labels.md b/collections/tfmanual/knowledge_base/collaboration/issue_labels.md new file mode 100644 index 0000000..e771c03 --- /dev/null +++ b/collections/tfmanual/knowledge_base/collaboration/issue_labels.md @@ -0,0 +1,24 @@ +# Issue Labels Usage Guidelines + +Kindly refrain from using labels other than the specified ones. + +## Priority-based Labels + +- `priority_critical`: This label indicates that the issue requires immediate attention, with a maximum resolution timeframe of the same day. + - If the assigned developer deems this timeline unachievable, they must escalate the issue immediately. + - The term "critical" implies that the resolution is of utmost urgency, and everyone involved should prioritize it until it is resolved. + +- `priority_major`: This label designates issues that are very urgent and should be addressed within a minimal timeframe, typically within 1-2 days but no more than 3 days. + - If the developer anticipates challenges in meeting this timeframe, they are required to escalate the issue promptly. +- `priority_minor`: Issues labeled as such are given a lower priority and are typically positioned towards the end of the sprint cycle. + +## Types Labels + +- `type_bug` +- `type_feature` +- `type_question` +- `type_story`: This label is used to distinguish story cards, providing an overview of a use case the team aims to achieve. + +### For monorepos + +Repository owners are free to create labels per component in the monorepo for easier repo management \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/collaboration/release_process.md b/collections/tfmanual/knowledge_base/collaboration/release_process.md new file mode 100644 index 0000000..a931a1b --- /dev/null +++ b/collections/tfmanual/knowledge_base/collaboration/release_process.md @@ -0,0 +1,53 @@ +

Release Process

+ +

Table of Contents

+ +- [Github projects](#github-projects) +- [Releasing the Grid](#releasing-the-grid) + - [Environments](#environments) + - [Versions](#versions) + - [Branching/Tagging](#branchingtagging) + - [Blocking Bugfixes for Mainnet](#blocking-bugfixes-for-mainnet) + +*** + +## Github projects + +- We are going to use new github style projects to manage the development process, all repos are linked against tfgrid product e.g 3.6.0 +- You can have different views e.g StoryCards only view for Highlever overview, a view by repositories, priorities +- We will drive all repos from that one project +- We should use milestones (semantic version to sort out the issues) + +## Releasing the Grid + + +### Environments + +- Grid releases are no longer linked to an environment in a pipeline, while this makes sense in lots of scenarios, it won't scale +- An environment hosts a specific grid version based on the components it has +- In the future, we should be able to create ephermal environments e.g deploy this grid version on these X number of nodes + +### Versions + +- Releasing should follow [semantic versioning](https://semver.org/) +- Every grid release is linked to X number of components. For example, TFGrid 3.6.1 is linked to terraform 1.0.0, portal 2.0.1, .. etc + + +### Branching/Tagging + +- As mentioned above, releases should should follow semantic versioning. The tag itself is prefixed with a `v`. so vx.y.z or vx.y.z-rc1 +- Devnet(s) should host development branches and once it reaches a specific quality they get verified on that branch + - THIS IS NOT TRUE: it can be that on a dev net you have production components +- Once verification happens and everything goes ok, we should tag a release of a component +- Once all components are ready a grid release is complete and we can host that release on whatever environment +- Container image tags must not contain the `v`-prefix + +### Blocking Bugfixes for Mainnet + +- In case of a blocking bug happening only on mainnet, we branch out of the tag on the affected component repository +- do the fix on that branch +- host a new grid release on a testing environment to verify +- tag the new component +- merge to trunk +- create a new grid release +- host that grid release (its components) on mainnet diff --git a/collections/tfmanual/knowledge_base/collaboration/testing/img/add_test.png b/collections/tfmanual/knowledge_base/collaboration/testing/img/add_test.png new file mode 100644 index 0000000..1a8983d Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/testing/img/add_test.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/testing/img/deploy_evdc.png b/collections/tfmanual/knowledge_base/collaboration/testing/img/deploy_evdc.png new file mode 100644 index 0000000..a662b35 Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/testing/img/deploy_evdc.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/testing/img/evdc_home_.jpg b/collections/tfmanual/knowledge_base/collaboration/testing/img/evdc_home_.jpg new file mode 100644 index 0000000..b05af42 Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/testing/img/evdc_home_.jpg differ diff --git a/collections/tfmanual/knowledge_base/collaboration/testing/img/evdc_test.png b/collections/tfmanual/knowledge_base/collaboration/testing/img/evdc_test.png new file mode 100644 index 0000000..c8baa69 Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/testing/img/evdc_test.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/testing/img/help_us_test_.jpg b/collections/tfmanual/knowledge_base/collaboration/testing/img/help_us_test_.jpg new file mode 100644 index 0000000..a94fa94 Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/testing/img/help_us_test_.jpg differ diff --git a/collections/tfmanual/knowledge_base/collaboration/testing/img/my_test.png b/collections/tfmanual/knowledge_base/collaboration/testing/img/my_test.png new file mode 100644 index 0000000..125fea8 Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/testing/img/my_test.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/testing/img/project_overview.png b/collections/tfmanual/knowledge_base/collaboration/testing/img/project_overview.png new file mode 100644 index 0000000..5a4263e Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/testing/img/project_overview.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/testing/img/report_test.png b/collections/tfmanual/knowledge_base/collaboration/testing/img/report_test.png new file mode 100644 index 0000000..998f5e4 Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/testing/img/report_test.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/testing/img/run_test.png b/collections/tfmanual/knowledge_base/collaboration/testing/img/run_test.png new file mode 100644 index 0000000..00ebda3 Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/testing/img/run_test.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/testing/img/test_finish.png b/collections/tfmanual/knowledge_base/collaboration/testing/img/test_finish.png new file mode 100644 index 0000000..4f9d5c4 Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/testing/img/test_finish.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/testing/img/test_home.png b/collections/tfmanual/knowledge_base/collaboration/testing/img/test_home.png new file mode 100644 index 0000000..2fa3f7a Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/testing/img/test_home.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/testing/img/test_list.png b/collections/tfmanual/knowledge_base/collaboration/testing/img/test_list.png new file mode 100644 index 0000000..8071301 Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/testing/img/test_list.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/testing/img/test_run.png b/collections/tfmanual/knowledge_base/collaboration/testing/img/test_run.png new file mode 100644 index 0000000..e90517e Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/testing/img/test_run.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/testing/img/testlodge_invitation.png b/collections/tfmanual/knowledge_base/collaboration/testing/img/testlodge_invitation.png new file mode 100644 index 0000000..f6bb9da Binary files /dev/null and b/collections/tfmanual/knowledge_base/collaboration/testing/img/testlodge_invitation.png differ diff --git a/collections/tfmanual/knowledge_base/collaboration/testing/testing_readme.md b/collections/tfmanual/knowledge_base/collaboration/testing/testing_readme.md new file mode 100644 index 0000000..aebf6db --- /dev/null +++ b/collections/tfmanual/knowledge_base/collaboration/testing/testing_readme.md @@ -0,0 +1,52 @@ +

Testing the ThreeFold Grid: Ensuring Reliability and User Feedback

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Automation Testing](#automation-testing) +- [Manual Testing](#manual-testing) +- [Covered Tests](#covered-tests) + +*** + +## Introduction + +With each release of a newer version of the ThreeFold Grid, the ThreeFold Community plays a vital role in testing the product components and providing constructive feedback to the engineering team. This article explores the testing strategy employed by ThreeFold, which includes both automation and manual testing, and highlights the covered functionality tested by the procedures. + +## Automation Testing +The internal QA team conducts automation testing, where they automate various test scenarios and run them in nightly builds. This approach helps identify the status of the code and allows for the early detection of functionality and regression issues. + +## Manual Testing +The QA team, along with the grid testing community, performs manual testing. [TestLodge](./testlodge.html) is the chosen platform for managing test plans, test cases, and test runs. By joining TestLodge as a user, individuals can actively participate in running test use cases and reporting any issues encountered during product deployment. Issues can be reported by creating an issue on [ThreeFold's Test Feedback repository](https://github.com/threefoldtech/test_feedback/issues) on Github. + +## Covered Tests +The ThreeFold Grid 3 encompasses a wide range of functionalities that are thoroughly tested to ensure their reliability and performance. Some of the covered functionalities include: + +- Compute + - Virtual machine + - Caprover + - Kubernetes + +- Network + - WebGateway + - Planetary Network + +- Storage + - Quantum Safe Storage System (Quantum Safe Filesystem) + - 0-DB + - S3 minio + +- TFChain + - Portal + - IPFS + +- Farming + - Create Farm + - Farm Management + +- TwinServer v2 +- TerraForm Deployments + +Testing is a crucial aspect of the ThreeFold Grid's development process. By actively involving the ThreeFold Community in testing the product components and leveraging automation and manual testing approaches, the engineering team ensures the reliability and quality of the Grid3. + +With TestLodge as the testing platform, users can contribute to the testing efforts by running test use cases and reporting any issues encountered. Through collaborative testing, the ThreeFold Grid continues to evolve and deliver a robust and efficient infrastructure for users worldwide. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/collaboration/testing/testlodge.md b/collections/tfmanual/knowledge_base/collaboration/testing/testlodge.md new file mode 100644 index 0000000..fe5abf6 --- /dev/null +++ b/collections/tfmanual/knowledge_base/collaboration/testing/testlodge.md @@ -0,0 +1,95 @@ +

How to Use TestLodge for Testing the ThreeFold Grid

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Getting Started on TestLodge](#getting-started-on-testlodge) + - [Joining the TF GRID Project on TestLodge by Invitation](#joining-the-tf-grid-project-on-testlodge-by-invitation) +- [Accessing the TF GRID 3.x Projects](#accessing-the-tf-grid-3x-projects) + - [Project Overview](#project-overview) + - [Creating Your Own Personal Test Run](#creating-your-own-personal-test-run) + +*** + +## Introduction + +After each release of a newer version of the ThreeFold Grid, we encourage the ThreeFold Community to participate in testing the grid's product components and provide valuable feedback to our engineering team. To facilitate this process, we have adopted TestLodge as our QA and testing platform. TestLodge allows us to efficiently manage test plans, test cases, and test runs for our products. By joining TestLodge as a user, you can assist us in running test cases and reporting any issues encountered during our product deployment processes. + +## Getting Started on TestLodge + +### Joining the TF GRID Project on TestLodge by Invitation + +To become one of our testers on TestLodge, please request an invitation by joining our official [TF Grid Tester +Telegram Group](https://t.me/joinchat/R75FxI_6J6tgn1jK) and sending a personal message to the group's moderator, providing your email address. + +Once you receive an invitation, check your email for further instructions and create an account on TestLodge. This will grant you access to the TF GRID Project on TestLodge. + +## Accessing the TF GRID 3.x Projects + +After successfully creating your account, you can access the TF GRID 3.x Project from your Testlodge dashboard. Simply click on the project to begin the testing process. + +### Project Overview + +Inside the project, you will find an overview that displays the project's testing environment. Here's a brief description of the project's content: + +- Total Test Plans: +Indicates the number of test plans or products being tested in this project. + +- Total Requirement Docs: +Represents the amount of testing documentation provided for each test within the project. + +- Total Test Suites: +Displays the number of individual test use cases for each product being tested. These test suites are the procedures you will follow as a user/tester. + +- Total Test Runs: +Reflects the total number of testing rounds conducted by users within the project. Each tester has their own Test Run, which serves as a testing dashboard for reporting test results. To get started with testing the TF Grid Test Suites, you need to create your own Test Run by using your name as the title. + +### Creating Your Own Personal Test Run +To create your personal Test Run, follow these steps: + +1. Click on the "Test Runs" tab in the top navigation bar and select "New Test Run." + +![](./img/test_run.png) + +2. Provide your name as the test name and select "eVDC Deployer" as your test suite since it is a test run for eVDC Deployer. Click on "Select Test Suites and Cases" to view the details of the use cases you want to test. + +![](./img/evdc_test.png) + + +3. On the "Select Test Suites and Cases" page, choose the "Deploy a new eVDC" test suite as your Test Suite. This suite includes the different use cases required to deploy an eVDC. + +![](./img/deploy_evdc.png) + +4. Click "Add Test Run" to complete the registration of your new test run. + +![](./img/add_test.png) + + +5. You will see a list of all created test runs, including your own. Click on the test run you just created to access your test run profile. + +![](./img/my_test.png) + + +6. In your test run profile, you will find a summary and a list of the test suites you need to run. + +![](./img/test_list.png) + +7. Click on the "Deploy eVDC" test suite from the list and select "Run Test" to begin testing. + +![](./img/run_test.png) + +8. Proceed to the eVDC Deployer and commence your test. + +![](./img/evdc_home_.jpg) + +9. Provide your remarks in the provided comment box and click "Pass," "Fail," or "Skip" based on the result of your test run to provide feedback to the ThreeFold QA Team. + +![](./img/report_test.png) + +10. Repeat the previous step to complete all + +11. Go back to the ‘test runs’ page to see the overview of all test runs, and make sure that you completed your own test runs as shown below. + +![](./img/test_finish.png) + +12. Thank you for completing test runs for ThreeFold Grid Project! You can now create an issue on [ThreeFold's Test Feedback repository](https://github.com/threefoldtech/test_feedback/issues) on Github, and report to our development teams about your test findings and feedback. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/farming/_beta/planet_positive_farming.md b/collections/tfmanual/knowledge_base/farming/_beta/planet_positive_farming.md new file mode 100644 index 0000000..b7736e1 --- /dev/null +++ b/collections/tfmanual/knowledge_base/farming/_beta/planet_positive_farming.md @@ -0,0 +1,18 @@ +# Planet Positive Farming + +The ThreeFold Grid (“Grid”) has the aim to become a carbon_negative grid by the end of 2022. ThreeFold Farmers (“Farmers”) will be offsetting their carbon emissions three times and through their Farming process, will be directly involved in initiatives with the goal of regenerating the earth and enhancing the life of local communities. ThreeFold will therefore partner with an organization specialized in climate education and involving students and teachers in their quest to fight against climate change. Users of the ThreeFold Grid will therefore purchase carbon-negative internet capacity with ThreeFold Tokens ("TFT"). + +Part of the ThreeFold Token from the farming reward will be allocated for energy compensation and sent onto a pool dedicated for the above project. + +The amount will depend on: +- The types of 3Node run by the Farmer as each type of server varies in terms of power utilization +- The location of the 3Node as each country has a different electricity production structure. + +More variables will be taken into account to ensure the reliability of this voluntary carbon offset. + +> More information will be communicated to the community soon. Stay tune. + + + + + diff --git a/collections/tfmanual/knowledge_base/farming/certified/certified_farming.md b/collections/tfmanual/knowledge_base/farming/certified/certified_farming.md new file mode 100644 index 0000000..94a3127 --- /dev/null +++ b/collections/tfmanual/knowledge_base/farming/certified/certified_farming.md @@ -0,0 +1,5 @@ +# Certified Farming + +!!!include:farming_certification_benefits + +!!!def alias:certified_farming \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/farming/certified/certified_node.md b/collections/tfmanual/knowledge_base/farming/certified/certified_node.md new file mode 100644 index 0000000..8536d20 --- /dev/null +++ b/collections/tfmanual/knowledge_base/farming/certified/certified_node.md @@ -0,0 +1,33 @@ +![](img/farming_solutions.jpg) + +## Certified Node + +A Certified Node is a node which comes BIOS locked and does not allow the owner change how the node boots. + +This makes it impossible for the node owner to make changes to the operating system and secure that the node will run the right certified version of Zero-OS. + +The Titan V2.1 node is a certified node. Certified nodes are eligible for more [farming rewards](farming_reward). + +### Requirements + +- Node delivered by a certified hardware vendor or through the ThreeFold website. +- The farmer who owns a certified node will have to sign specifically created terms and conditions + - not done yet, will be part of tfgrid 3.0 launch, see [here](farming_certification_terms_conditions). +- For 2.0 Farmers who started in 2020 or before: agreement about vesting see [vesting_overview](vesting_overview). + +### More Info + +- [Certified Farming](certified_farming) + +### More Technical Details + +- The BIOS gets locked. +- The BIOS gets configured to use TPM2 + - more info about tpm2 [here](https://www.usenix.org/system/files/conference/usenixsecurity16/sec16_paper_raj.pdf). +- TPM2 is a security implementation on the motherboard which allows Zero-OS to securely store private keys, this mechanism is used to identify Zero-OS nodes and make sure they are registered as certified node. +- If a user would reset the BIOS then the TPM private keys are gone as well. +- Starting with our TFGrid 3.0 we will use this TPM feature to verify and validate some checks done from tfchain. +- A certified farmer is required to use certified_nodes. + + +!!!def alias:certified_node diff --git a/collections/tfmanual/knowledge_base/farming/certified/farming_certification_benefits.md b/collections/tfmanual/knowledge_base/farming/certified/farming_certification_benefits.md new file mode 100644 index 0000000..bf29f18 --- /dev/null +++ b/collections/tfmanual/knowledge_base/farming/certified/farming_certification_benefits.md @@ -0,0 +1,17 @@ +## Certified Farming Benefits + +This certification program has many benefits for the TFGrid user, for the world and the farmer itself. + +| For The Planet | For The Cloud User | For The Farmer | +| ------------------------------------------------------ | ---------------------------------------------------- | ------------------------------------------------------ | +| More Green | More Secure | Faster Adoption (easier to get to 30% treshold) | +| **certified carbon neutral** | More Defined Legal Framework | More Farming Rewards (income) | +| Better Global Distribution | More Uptime (SLA) | Lower Operational Cost | +| Sovereignity (legal framework) | Better Performance | Higher Credibility | +| More protection for user | Possiblity For Support | Custom Pricing CU/SU/NU is possible (*) | +| **[more info](farming_certification_benefits_planet)** | **[more info](farming_certification_benefits_user)** | **[more info](farming_certification_benefits_farmer)** | + +(*) in collaboration with TFTech, and planned for earliest H1 2022. + +- [farming certification requirements](farming_certified_requirements) +- [certified nodes](certified_node) \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/farming/certified/farming_certification_benefits_farmer.md b/collections/tfmanual/knowledge_base/farming/certified/farming_certification_benefits_farmer.md new file mode 100644 index 0000000..5629d3f --- /dev/null +++ b/collections/tfmanual/knowledge_base/farming/certified/farming_certification_benefits_farmer.md @@ -0,0 +1,63 @@ +![](img/grid_banner.jpg) + +## For The Farmer + +### Higher Cloud Unit Reward reward = more income + +A certified farmer gets more farming_rewards because a certified farmer need to adhere to higher service level agreements and buy certified farming solutions or certifiy their existing 3nodes. + +### TF Tech Support + +Direct defect and certified build support for Zero-OS from the software creators for the tfgrid_primitives on TFGrid. + +### Lower Operational Cost + +Certified farms can use the TFTech power management solution which makes sure that 3Nodes are only powered on when there is a need for it. This can save huge amounts of electricity. + +### Easier to get to minimal required 30% utilization + +The tokens farmed for a 3Node are locked up in a staking pool untill the 3Node gets to 30% utilization. + +This is to make sure that people cannot put hardware to the grid which cannot be used and as such get farming rewards. + +ThreeFold needs to make sure that there is no abuse and also that 3Nodes are not brought life for just farming which would burn energy for no reason. + +ThreeFold & ThreeFold Tech will do a lot of promotion and find channel_partners to get the TFGrid to grow as fast as possible and get capacity used. + +Its up to ThreeFold to make sure that certified capacity gets deployed where it is needed first. + +All of this leads to much faster utilization of the TF_Farm IT capacity which results in the TF_Farmer getting access to their farmed tokens faster. + +### Higher Credibility Because Of Certification + +Security advantage as farm, location and nodes have been thoroughly checked and documented (secure boot process guarantees the most stable (best) Zero OS version). This information gets checked by ThreeFold which means the TFGrid user will more likey chose a certified farmer. + +### Custom Network (\*): + +Ability to implement custom networking based on VxLAN or many other networking technologies. + +This is needed for deployments in hybrid or even full private mode where customers have very specific requirements around networking. + +### Farmer Bot (\*) + +A farmer bot will be made available which makes it easier for a certified farmer to manage their farm in relation to + +- power management +- management farmed tokens +- network management tools +- lockout bad actors (e.g. deny access for hackers or other bad actors) +- ... + +### Monitoring Integration (\*) + +Possibility to integrate custom monitoring solutions. + +### Reputation System (\*) + +Farmers and TFGrid users are rated by a reputation system. +These reputation scores will be visible on the TF_Chain + +This allows a farmer to see that the TFGrid users on the TF_Farm can be trusted. + +> (\*): planned easliest Q4 2021 + diff --git a/collections/tfmanual/knowledge_base/farming/certified/farming_certification_benefits_planet.md b/collections/tfmanual/knowledge_base/farming/certified/farming_certification_benefits_planet.md new file mode 100644 index 0000000..3d28c69 --- /dev/null +++ b/collections/tfmanual/knowledge_base/farming/certified/farming_certification_benefits_planet.md @@ -0,0 +1,20 @@ +![](img/grid_banner.jpg) + +## For The Planet + +### Green + +Certified farming capacity will become carbon neutral by end 2021. +This happens because if using less energy and offsetting remainder of energy usage with buying carbon credits from a climate change action program called TAG = Take Action Global. + +### Inclusive + +Everyone gets access to this network of capacity everywhere. + +Thanks to certification its easier to make sure that the TF_Farmer complies with all requirements. + +### Sovereignity + +Its important to deliver sovereign solutions to the user and to countries. +Certification allows ThreeFold to guarantee more requirements and have more visibility in the sovereignty requirements. + diff --git a/collections/tfmanual/knowledge_base/farming/certified/farming_certification_benefits_user.md b/collections/tfmanual/knowledge_base/farming/certified/farming_certification_benefits_user.md new file mode 100644 index 0000000..980d57c --- /dev/null +++ b/collections/tfmanual/knowledge_base/farming/certified/farming_certification_benefits_user.md @@ -0,0 +1,52 @@ +![](img/grid_banner.jpg) + +## For The ThreeFold Grid User. + +Users of the ThreeFold Grid have an advantage to use a farmer who is certified. + +### More information about the farm + +Whoever wants to use capacity from the grid gets more information about + +- connection capabilities to the internet +- quality of hardware used +- service level agreements +- location of the TF_Farm (country,...) +- protection mechanisms around fire, water, ... + +This information is important for the TFGrid user to make selection where to host their IT workloads. + +TFTech will validate this information. + +### More uptime + +Being certified means that the farmer likely will have more uptime compared to a non certified farmer. + +### More security + +As part of the certification process, TFTech will make sure that the 3Node has secure boot procedures to allow for more security. The Farmer needs to sign an agreement with ThreeFold Foundation where they commit to a set of standards and security requirements. + +### More legal protection + +Each certified farmer has to adhere to a set of terms & conditions which protect the TFGrid User. + +The terms & conditions describe + +- privacy & security protections +- compliance to legal requirements +- protection against abuse + +### Continuation protection. + +The TF_Farmer has to promise to keep the farm operational till the end as specified on farming certificate which gets registered on the TFChain. + +- [more info about requirements see here](farming_certified_requirements) + +### TFGrid User Can Have Support + +All support inquiries will be handled through blocks of 15 minutes which are paid for in ThreeFold Support Tokens(TFTS). + +Any TFGrid user can ask for support but only for certified farms. + + + diff --git a/collections/tfmanual/knowledge_base/farming/certified/farming_certification_terms_conditions.md b/collections/tfmanual/knowledge_base/farming/certified/farming_certification_terms_conditions.md new file mode 100644 index 0000000..4ddf2f4 --- /dev/null +++ b/collections/tfmanual/knowledge_base/farming/certified/farming_certification_terms_conditions.md @@ -0,0 +1,11 @@ +- sign terms and conditions document with threefold_dubai + - we are in the process of formalizing this, this will be done at least before the end 2022. +- farmer agrees and acknowledges following info: + - TFGrid operates as a DAO with the help of human councils. This means that no organization manages the operations of the TFGrid. + - TFTech as subcontractor for threefold_dubai delivers software support for the tfgrid_primitives (only defect support and certified builds). + - All information required to be a farmer can be found on our knowledgebase: https://library.threefold.me/ + - TFT rewards (farming) is the result of the blockchain as operated by consensus3 concept. If SLA is not achieved TFT will NOT be rewarded that month. + - TFT rewards are done in line with [farming reward document](farming_reward). + - Measurement of SLA (see below) done by consensus3 engine. + + diff --git a/collections/tfmanual/knowledge_base/farming/certified/farming_certified_requirements.md b/collections/tfmanual/knowledge_base/farming/certified/farming_certified_requirements.md new file mode 100644 index 0000000..887f0e7 --- /dev/null +++ b/collections/tfmanual/knowledge_base/farming/certified/farming_certified_requirements.md @@ -0,0 +1,69 @@ +![](img/grid_banner.jpg) + +## Certified Farming Requirements + +### Individual Certified Farmer + +- Certified Farms are made up of certified_nodes +- up to 4 certified nodes +- home or office location + +#### Uptime and Network Requirements + +- 97% uptime is accepted in home farming situations +- 1 IP feed (consumer provider) +- 1 public IP address and NAT allowed +- enough bandwidth to allow the utilization of the storage/archive (see below) +- good enough latency (low latency = performance of network) + +### Professional Certified Farmer + +- Certified Farms are made up of certified_nodes +- more than 4 certified nodes +- datacenter location + +#### Uptime and Network Requirements + +- 99.5% uptime +- minimal bandwidth as required for the workloads as hosted on the farm +- maximum network latency +- more than 1 internet connection (multiple IP feeds) +- enough IPv4 addresses +- at least 1 class C ipv4 addr for network farmers. +- enough bandwidth to allow the utilization of the storage/archive (see below) +- good enough latency (low latency = performance of network) +- [install your network in line with Threefold Requirements](tfgrid_networking) + +(*) = in case of datacenter or commercial deployment + +#### Redundancy Requirements + +- protection for fire & water damage +- enough access to power +- redundant power systems + +#### Terms and Conditions need to be signed + +!!!include:farming_certification_terms_conditions + + +### Bandwidth Requirement for archive/storage usecase example. + +A storage usecase needs a lot of bandwidth to allow the storage nodes to be filled and also to allow its customers to download the information. + +It’s the obligation of the farmer to make sure that enough bandwidth is available. We will measure this by doing random upload & download tests to the storage systems. + +It should always be possible to have at least 1 mbit/sec per Zero_DB (which is a storage container running on 1 harddisk or ssd). + +### Reputation & Monitoring Engine + +The TFGrid has a reputation engine and a monitoring engine to measure uptime & other SLA requirements, see consensus3. + +Factors the TFGrid Reputation_engine will look at (Q4 2021, latest Q1 2022) + +- Available Bandwidth +- Latency +- Utilization +- Uptime (nodes & network) + +The monitoring engine could require farmers to execute on certain actions. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/farming/certified/farming_types.md b/collections/tfmanual/knowledge_base/farming/certified/farming_types.md new file mode 100644 index 0000000..c35b1f6 --- /dev/null +++ b/collections/tfmanual/knowledge_base/farming/certified/farming_types.md @@ -0,0 +1,20 @@ +![](img/farming_solutions.jpg) + +# Farming Types + +## DIY (Do It Yourself) Farming + +- Self made or bought bare metal server (compute/storage) capacity (and AMD or Intel system) +- No license on the software with TF Tech (Company responsible for the ThreeFold Software components). +- No Support possibility from ThreeFold / TF Tech. + +### Certified + +- Certified Secured server hardware +- Comes plug and play +- Highest Uptime Requirements +- Certification report given by TFTech or partners to describe farming situation (H2 2021). +- see [farming certified requirements](farming_certified_requirements) + +!!!include:farming_certification_benefits + diff --git a/collections/tfmanual/knowledge_base/farming/certified/img/farming_solutions.jpg b/collections/tfmanual/knowledge_base/farming/certified/img/farming_solutions.jpg new file mode 100644 index 0000000..dfc81d8 Binary files /dev/null and b/collections/tfmanual/knowledge_base/farming/certified/img/farming_solutions.jpg differ diff --git a/collections/tfmanual/knowledge_base/farming/diy/diy_guide.md b/collections/tfmanual/knowledge_base/farming/diy/diy_guide.md new file mode 100644 index 0000000..87255c5 --- /dev/null +++ b/collections/tfmanual/knowledge_base/farming/diy/diy_guide.md @@ -0,0 +1,44 @@ +# Do-it-Yourself Farming Guide + +Any standard computer can become a 3Node on the ThreeFold Grid. This section covers the compatible systems and setup optimization for anyone who wants to purchase or build their own nodes. + +## What kind of hardware is supported? + +Any 64-bit hardware with an Intel or AMD processor chip can run Zero-OS and become a 3Node. The following configurations provide guidelines on compatible and recommended setups: + +- Servers, desktops and mini computers type hardware are compatible. +- A minimum of 500 GB of SSD and a bare minimum of 2 GB of RAM is required. +- A ratio of 1:4 between vCPU and RAM (e.g. 8vCPU and 32 GB of RAM) is recommended. +- The recommended upper limit is 8 GB of RAM per vCPU as farming rewards do not increase beyond that ratio. +- A minimum of 500 GB of SSD and a bare minimum of 2 GB of RAM is required. +- A wired ethernet connection is highly recommended to maximize reliability and the ability to farm TFT. + +> Note: The team successfully tested ARM based devices, but they are not yet supported. + +The follwoing configurations are not advised or not supported: + +- Laptops are not advised and USB based external drives are not supported due to reliability concerns. +- No graphics or display is required, although it may be helpful during the boot configuration or troubleshooting if necessary. +- GPU is not yet supported. + +## How much power does a node consume? + +Power efficiency is important for farmers to spend less on electricity and therefore increase earnings. A small form factor server may be much more power efficient than a gaming PC with similar specs (GPUs are not supported yet). + +> Note: Knowing exactly how much power a system will draw can be complicated, but some manufacturers provide more detailed estimates than the watt rating of a power supply. + +## What kind of internet connection is needed? + +- A wired network connection should be considered essential to maximize a node's reliability. Any domestic high speed internet plan is adequate for a basic node. +- If the node connects more than a few terrabytes of storage, a gigabit or faster connection may be necessary to support the traffic. +- The Grid is designed with IPv6 in mind, but IPv4 is sufficient for now. + +> A node only needs bandwidth when it is being utilized. That means you could scale up your connectivity as utilization of your node grows. + +## How to boot a node with Zero-OS? + +Zero OS can be booted either from a USB stick (the boot image is tiny, so any size drive will do) or over a network via PXE. In either case, the latest software will be downloaded and cryptographically verified before boot. After the first boot, Zero OS will update itself automatically and requires virtually no maintenance. + +When you’re ready to start farming, follow [these instructions](https://library.threefold.me/info/manual/#/manual__farming) to bring your 3Node online. + +> Note: Occasionally, updates to the boot medium may be required. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/farming/farming_circular.md b/collections/tfmanual/knowledge_base/farming/farming_circular.md new file mode 100644 index 0000000..eedc2e5 --- /dev/null +++ b/collections/tfmanual/knowledge_base/farming/farming_circular.md @@ -0,0 +1,19 @@ + +Farming is the process of adding Internet capacity (compute, storage and network) to the ThreeFold Grid. + +ThreeFold uses a proof-of-blockstake consensus mechanism. By running Zero-OS on their hardware, Farmers dedicate the computation power and storage capacity of their node to the network, enabling anyone to host data and run IT workloads on a decentralized Internet infrastructure. + +![](img/circular_tft3_.jpg ':size=500') + +> TODO: we have better one (note: image? could not find) + +In decentralized systems like ThreeFold, we need to ensure that everyone is able to provide Internet capacity to the world. Farmers help this happen by connecting hardware that run Zero-OS. Once booted, the hardware is locked to generate Internet capacity for the network. The capacity is registered on TFChain, securing access to a decentralized Internet for users and rewarding farmers with TFT. + + + diff --git a/collections/tfmanual/knowledge_base/farming/farming_intro.md b/collections/tfmanual/knowledge_base/farming/farming_intro.md new file mode 100644 index 0000000..9ba490e --- /dev/null +++ b/collections/tfmanual/knowledge_base/farming/farming_intro.md @@ -0,0 +1,64 @@ + +# ThreeFold Farming + +![](img/farming_intro0.jpeg) + +ThreeFold Farming ("Farming") is the process of connecting Internet capacity to the ThreeFold Grid. This process is undertaken by independent people or organization called ThreeFold Farmers ("Farmers"). + +## What is Farming? + +{{#include farming_circular.md}} + +## Who can become a farmer on ThreeFold? + +![](img/farming_.png) + +Technically, anyone can farm on the ThreeFold Grid using any server-type hardware. By using [Proof-of-Capacity](proof_of_capacity), farming was designed to reward all nodes equally according to the Internt capacity they provide to the ThreeFold Grid. + +## Cost of farming + +Anyone can become a Farmer, and there is no technical knowledge required. ThreeFold's autonomous system does all the heavy lifting, making it easy for anyone to join. + +- Potential costs of the hardware necessary to provide Internet capacity and maintain a farming setup. +- Electrical costs to power the farm. +- Potential cost of equipment to support larger farming setups such as data centers (ventilation, monitoring, electrical wiring, etc). + +To further explore farming rewards, click [here](@farming_reward). + +## How ThreeFold Internet capacity is farmed? + +1. A farmer provides Internet capacity by booting compatible hardware with Zero-OS. +2. Once installed, Zero-OS locks the hardware and registers the Internet capacity in TFChain. +3. Once verified by the [Proof-of-Capacity](proof_of_capacity) algorythm, the Internet capacity is made available to the network via the explorer. + +> Note: All the compute and storage data remains off-chain in order to protect the privacy of users. Once Zero-OS is booted, the device is locked in such a way that it no longer has any state or remote access, preventing farmers to access user data on a hardware level as well. + +## What kind of hardware can become a 3Node? + +Any Intel or AMD server type hardware that contains compute and/ or storage can be connected to the ThreeFold Grid. Farmers need to download Zero-OS and boot their hardware. + +Learn more [here](@farming_hardware_overview) + +Once booted by Zero OS, the hardware becomes a 3Node, and its total capacity will automatically be detected and registered on the blockchain database. We call this Proof-of-Capacity. + +Learn more about Proof-of-Capacity [here](@proof_of_capacity) + + + +!!!alias become_a_farmer \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/farming/farming_reward.md b/collections/tfmanual/knowledge_base/farming/farming_reward.md new file mode 100644 index 0000000..8eba865 --- /dev/null +++ b/collections/tfmanual/knowledge_base/farming/farming_reward.md @@ -0,0 +1,63 @@ +

Farming Reward

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [How do farmers earn TFT?](#how-do-farmers-earn-tft) +- [Proof-of-Capacity](#proof-of-capacity) +- [What is proof-of-capacity?](#what-is-proof-of-capacity) +- [Why proof-of-capacity?](#why-proof-of-capacity) +- [How does Proof-of-Capacity work?](#how-does-proof-of-capacity-work) + +*** + +> Note: Farming rewards will be updated for the next 3.14 grid release. Stay tuned. + +## Introduction + +The amount of TFT earned by farmers is relative to the amount of compute, storage or network capacity they provide to the ThreeFold Grid as recorded by the proof-of-capacity algorythm. This section covers some farming and token reward basics. + +## How do farmers earn TFT? + +ThreeFold Blockchain (TFChain) rewards farmers for providing Internet capacity and expanding the ThreeFold Grid. They earn TFT. When successfully verified by proof-of-capacity, farmers earn TFT according to the amount of Internet capacity registered in TFChain. + +## Proof-of-Capacity + +The Proof-of-Capacity records Internet resources from the 3Node: + +The ThreeFold Blockchain (TFChain) uses work algorythm called "Proof-of-Capacity" to verify the Internet capacity provided by 3Nodes. Put simply, PoC verifies, on an ongoing basis, that farms are honestly representing the Internet capacity they provide to the network. + +**See Proof-of-Capacity in action** by visiting the [ThreeFold Grid Node Finder](https://dashboard.grid.tf/#/deploy/node-finder/) which represents the best resource to view POC-related data. + +## What is proof-of-capacity? + +POC allows ThreeFold Farmers to earn reward according to their contribution. Farming is the "work" itself, the act of providing Internet capacity to the network and making it accessible via our TFDAO and TFChain. + +The PoC algorythm records four different types of Internet capacity: + +- Compute Capacity (CPU) +- Memory Capacity (RAM) +- Storage Capacity (SSD/HDD) +- Network Capacity (Bandwidth, IP Addresses) + +## Why proof-of-capacity? + +PoC comes with a number of benefits, including: + +- Energy efficiency: earning reward in form of TFT does not waste energy, farming TFT is a carbon_negative operation. +- Lower barriers to entry with reduced hardware requirements: no need for elite hardware to stand a chance for earning rewards. +- Decentralized: allows anyone to connect a 3node to the network. TFGrid runs as a DAO. + +The main advantage of PoC to farmers it makes it really easy to run a 3Node. It doesn't require huge investments in hardware or energy and everyone earns a fair reward for their contribution. It is more decentralized, allowing for increased participation, and more 3Nodes doesn't mean increased returns, like in mining. + +## How does Proof-of-Capacity work? + +1. A farmer boots hardware with Zero-OS (multiple boot methods available) +2. Zero-OS is a low level OS, with no shell, farmers cannot access Zero-OS +3. Zero-OS reports used IT capacity towards TFChain +4. TFChain and TFDAO will calculate rewards as required for the farmer (TFGrid 3.1.x) +5. TFChain will mint the required TFT and send them to account on TFChain of TFFarmer. +6. Everyone can use the [ThreeFold Node Finder](https://dashboard.grid.tf/#/deploy/node-finder/) to see where capacity is available. This info comes from the TFChain. + + +{{#include farming_reward_disclaimer.md}} diff --git a/collections/tfmanual/knowledge_base/farming/farming_reward_calculation.md b/collections/tfmanual/knowledge_base/farming/farming_reward_calculation.md new file mode 100644 index 0000000..a56a9f1 --- /dev/null +++ b/collections/tfmanual/knowledge_base/farming/farming_reward_calculation.md @@ -0,0 +1,53 @@ +## Farming Reward Calculation + +Each 3Node has certain amount of compute, storage and network resources: + +- Compute Capacity (CPU) +- Memory Capacity (RAM) +- Storage Capacity (SSD/HDD) +- Network Capacity (Bandwidth, IP Addresses) + +For making this Internet Capacity available, Farmers are rewarded with TFT. + +The amount of resources availabe in a 3Node are translated into compute units (CU), storage units (SU), Network units (NU) and IP addresses (IPAddr) to calculate farming rewards. See also [Cloud Units Calculation For Farming](../../cloudunits/resource_units_calc_cloudunits.md). + +> **Unless explicitly specified otherwise, calculations of "gigabytes" use base +> 1024. That is, 1 GB is equal to 1073741824 bytes.** + +The formula to calculate farming rewards is the following: + +```python +TFT earned per month = + CU farmed * CU farming rewards + + SU farmed * SU farming rewards + + NU used * NU farming rewards + + IPAddr used * IPAddr farming rewards + +``` + +The below table expands on CU, SU, NU and IPAddr and their farming rewards: + +| Unit | description | v3 farming rewards in TFT | +| ------------------- | ----------------------------------------------------------------- | ------------------------- | +| Compute Unit (CU) | typically 2 vcpu, 4 GB mem, 50 GB storage | $REWARD_CU_TFT TFT/month | +| Storage Unit (SU) | typically 1 TB of netto usable storage | $REWARD_SU_TFT TFT/month | +| Network Unit (NU) | 1 GB of data transfered as used by TFGrid user for Public IP Addr | $REWARD_NU_TFT TFT/GB | +| Public IPv4 Address | Public IP Address as used by a TFGrid user | $REWARD_IP_TFT TFT/hour | + + +The reward for above items are linked (pegged) to the USD + +| Unit | USD | Unit | +| ------------------- | ----- | ------------------------------------- | +| Compute Unit (CU) | 2.4 | per month | +| Storage Unit (SU) | 1 | per month | +| Network Unit (NU) | 0.03 | per GB transfer (as customers use it) | +| Public IPv4 Address | 0.005 | per IP address, calculated per hour | + +> IMPORTANT: MORE INFO ABOUT DAO RULES IN RELATION TO PROOF OF CAPACITY, SEE BELOW + +> **The rewards above are calculated according to the current TFT to USD price in TFChain of $TFTFARMING** ($NOW). TFDAO is responsible to change this price in accordance to current marketsituation and liquidity. + +See below for more info about USD price which will be used to calculate your farming reward as well as any other specifics in relation to farming calculations. + +The above farming rewards apply for 3Nodes registered in TFChain for ThreeFold Grid v3. Anyone can calculate their potential rewards using the [Farming Reward Calculator](https://dashboard.grid.tf/calculator/simulator). The same CU, SU, NU and IPAddr principles apply to the sales of Internet capacity in the form [cloud units](../../cloudunits/cloudunits.md). diff --git a/collections/tfmanual/knowledge_base/farming/farming_reward_disclaimer.md b/collections/tfmanual/knowledge_base/farming/farming_reward_disclaimer.md new file mode 100644 index 0000000..5485865 --- /dev/null +++ b/collections/tfmanual/knowledge_base/farming/farming_reward_disclaimer.md @@ -0,0 +1,8 @@ +> DISCLAIMER: ThreeFold Foundation organizes this process. This process is the result of the execution of code written by open source developers (Zero-OS and minting code) and a group of people who checks this process voluntarily. No claims can be made or damages asked for to any person or group related to ThreeFold Foundation like, but not limited to, the different councils. This process changes for TFGrid 3.X once the TFDAO is fully active. + +> 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) + + + diff --git a/collections/tfmanual/knowledge_base/farming/farming_toc.md b/collections/tfmanual/knowledge_base/farming/farming_toc.md new file mode 100644 index 0000000..547b71e --- /dev/null +++ b/collections/tfmanual/knowledge_base/farming/farming_toc.md @@ -0,0 +1,12 @@ +# Farming + +This section covers the essential information concerning ThreeFold Farming. + +To farm on the ThreeFold Grid, refer to the [Farmers](../../documentation/farmers/farmers.md) 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 diff --git a/collections/tfmanual/knowledge_base/farming/img/circular_tft3_.jpg b/collections/tfmanual/knowledge_base/farming/img/circular_tft3_.jpg new file mode 100644 index 0000000..0c54072 Binary files /dev/null and b/collections/tfmanual/knowledge_base/farming/img/circular_tft3_.jpg differ diff --git a/collections/tfmanual/knowledge_base/farming/img/farming_.png b/collections/tfmanual/knowledge_base/farming/img/farming_.png new file mode 100644 index 0000000..f7a6ff6 Binary files /dev/null and b/collections/tfmanual/knowledge_base/farming/img/farming_.png differ diff --git a/collections/tfmanual/knowledge_base/farming/img/farming_intro0.jpeg b/collections/tfmanual/knowledge_base/farming/img/farming_intro0.jpeg new file mode 100644 index 0000000..c60445f Binary files /dev/null and b/collections/tfmanual/knowledge_base/farming/img/farming_intro0.jpeg differ diff --git a/collections/tfmanual/knowledge_base/farming/img/farming_rewards_.png b/collections/tfmanual/knowledge_base/farming/img/farming_rewards_.png new file mode 100644 index 0000000..d67d68b Binary files /dev/null and b/collections/tfmanual/knowledge_base/farming/img/farming_rewards_.png differ diff --git a/collections/tfmanual/knowledge_base/farming/img/grid_new_.png b/collections/tfmanual/knowledge_base/farming/img/grid_new_.png new file mode 100644 index 0000000..5f85f72 Binary files /dev/null and b/collections/tfmanual/knowledge_base/farming/img/grid_new_.png differ diff --git a/collections/tfmanual/knowledge_base/farming/img/token_time_to_get_involved_now_.jpg b/collections/tfmanual/knowledge_base/farming/img/token_time_to_get_involved_now_.jpg new file mode 100644 index 0000000..2022990 Binary files /dev/null and b/collections/tfmanual/knowledge_base/farming/img/token_time_to_get_involved_now_.jpg differ diff --git a/collections/tfmanual/knowledge_base/farming/img/utilization_process.png b/collections/tfmanual/knowledge_base/farming/img/utilization_process.png new file mode 100644 index 0000000..0016ff6 Binary files /dev/null and b/collections/tfmanual/knowledge_base/farming/img/utilization_process.png differ diff --git a/collections/tfmanual/knowledge_base/farming/own_farm_utilization.md b/collections/tfmanual/knowledge_base/farming/own_farm_utilization.md new file mode 100644 index 0000000..724553d --- /dev/null +++ b/collections/tfmanual/knowledge_base/farming/own_farm_utilization.md @@ -0,0 +1,10 @@ +# Cost of Utilization of Capacity for a Famer their own farm. + +We would like to make sure that a farmer can use their provided capacity super cost effective. +The ThreeFold Dao will take care of this situation. + +The idea is that the farmer will pay only for the burning & validator nodes. + +> see [Proof of Capacity DAO rules](poc_dao_rules). + + diff --git a/collections/tfmanual/knowledge_base/farming/poc_dao_rules.md b/collections/tfmanual/knowledge_base/farming/poc_dao_rules.md new file mode 100644 index 0000000..0b0475c --- /dev/null +++ b/collections/tfmanual/knowledge_base/farming/poc_dao_rules.md @@ -0,0 +1,60 @@ +

ThreeFold DAO Rules for Proof-of-Capacity

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Technical Farming Requirements](#technical-farming-requirements) +- [Suggested: improvements to proof-of-capacity](#suggested-improvements-to-proof-of-capacity) +- [TFGrid is a DAO](#tfgrid-is-a-dao) +- [Grid Enhancement Proposal](#grid-enhancement-proposal) + +*** + +> Note: The proof-of-capacity DAO rules will be updated for the next 3.14 grid release. Stay tuned. + +## Introduction + +- The CU/SU reward gets expressed in TFT and registered in TFChain at 3Node registration time + - For certified Nodes, the CU/SU reward was specified at sales/promotion time, this process is managed by ThreeFold Tech. +- CU/SU rewards are calculated from Resource Units + - Certified Node gets 25% more farming rewards + - TFT pricing is pegged to USD (pricing changes in line with TFT/USD rate) +- Rewards for NU and IP Addresses are dynamic + - The TFChain tracks capacity utilization and as such the reward can be calculated for the Farmer +- All Internet capacity farmed is rewarded on a monthly basis according to minimum service level agreements + - Minimum SLA = Service Level Agreement (see special section about SLA) needs to be achieved before TFT can be rewarded + +## Technical Farming Requirements + +- Make sure you have 50GB SSD capacity min available per logical core (physical core times number of threads it can run), if not your calculated CU will be lower. +- Make sure your network connection is good enough, in future it will be measured and part of the Service Level Agreement. + +{{#include tfgrid_min_sla.md}} + +**Important Information around TFT USD Price Used at Registration** + +This is for mainnet TFGrid 3.0: + +- The TFT USD price used at 3Node registration at launch of mainnet is hardcoded in TFChain 3.0 at 0.08 USD per TFT (TFChain 3.0 as used in Jan 2022). +- Once the DAO is life, a new price will be approved by the DAO voters. Idea is to have this price re-visited more or less once a month, if needed faster. +- The TFT USD price used at 3Node registration is defined by the TFDAO at least once a month by means of GEP. + +## Suggested: improvements to proof-of-capacity + +Suggestions will be made to improve PoC, the DAO will have to come to consensus before changes can be made. + +- How to deal with a situation where a 3node adds or removes compute or storage capacity. +- ThreeFold is developing a way of how to detect possible fraud on PoC using TPM chip and dynamic generated code to execute random PoC checks. +- If PoC finds fraud e.g. trying to fake Internet capacity provided, the 3Node will be disabled automatically by Zero-OS and flagged as fraudulant. The Farmer will then have to re-register with a lower reputation for transparancy to the ecosystem. If TFTs are staked at that time, they will be locked permanently. +- How to improve the calculation of CU rewards to mitigate the difference in power provided between new and old hardware. + + +## TFGrid is a DAO + +- All of above information is public and can be see by everone of the community as per 3Node and Farmer (part of TFChain). +- Farming rewards methodology can and probably will get revised if the community wants this, DAO consensus needs to be achieved before changes can happen, this happens by means of a GEP. + +## Grid Enhancement Proposal + +- Changes to above described mechanism or any other change request for the TFGrid is managed by grid enhancement proposals (GEP). +- Because we are a DAO, everything is open for change as long as consensus of community in accordance of TFDAO has been achieved. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/farming/proof_of_capacity.md b/collections/tfmanual/knowledge_base/farming/proof_of_capacity.md new file mode 100644 index 0000000..ae0f9fe --- /dev/null +++ b/collections/tfmanual/knowledge_base/farming/proof_of_capacity.md @@ -0,0 +1,93 @@ +

Proof-of-Capacity

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [What is proof-of-capacity?](#what-is-proof-of-capacity) +- [Why proof-of-capacity?](#why-proof-of-capacity) +- [How does Proof-of-Capacity work?](#how-does-proof-of-capacity-work) +- [PoC Rewards](#poc-rewards) +- [Farming Reward Calculation](#farming-reward-calculation) + +*** + +> Note: The proof-of-capacity parameters will be updated for the next 3.14 grid release. Stay tuned. + +## Introduction + +The ThreeFold Blockchain (TFChain) uses work algorythm called "Proof-of-Capacity" to verify the Internet capacity provided by 3Nodes. Put simply, PoC verifies, on an ongoing basis, that farms are honestly representing the Internet capacity they provide to the network. + +## What is proof-of-capacity? + +POC allows ThreeFold Farmers to earn reward according to their contribution. Farming is the "work" itself, the act of providing Internet capacity to the network and making it accessible via our TFDAO and TFChain. + +The PoC algorythm records four different types of Internet capacity: + +- Compute Capacity (CPU) +- Memory Capacity (RAM) +- Storage Capacity (SSD/HDD) +- Network Capacity (Bandwidth, IP Addresses) + +## Why proof-of-capacity? + +PoC comes with a number of benefits, including: + +- Energy efficiency: earning reward in form of TFT does not waste energy. +- Lower barriers to entry with reduced hardware requirements: no need for elite hardware to stand a chance for earning rewards. +- Decentralized: allows anyone to connect a 3node to the network. TFGrid runs as a DAO. + +The main advantage of PoC to farmers it makes it really easy to run a 3Node. It doesn't require huge investments in hardware or energy and everyone earns a fair reward for their contribution. It is more decentralized, allowing for increased participation, and more 3Nodes doesn't mean increased returns, like in mining. + +## How does Proof-of-Capacity work? + +1. A farmer boots hardware with Zero-OS (multiple boot methods available) +2. Zero-OS is a low level OS, with no shell, farmers cannot access Zero-OS +3. Zero-OS reports used IT capacity towards TFChain +4. TFChain and TFDAO will calculate rewards as required for the farmer (TFGrid 3.1.x) +5. TFChain will mint the required TFT and send them to account on TFChain of the farmer. +6. Everyone can use the [ThreeFold Node Finder](https://dashboard.grid.tf/#/deploy/node-finder/) to see where capacity is available. This info comes from the TFChain. + + +## PoC Rewards + +100% of specified [farming rewards](./farming_reward.md) goes to the farmer. + +## Farming Reward Calculation + +Each 3Node has certain amount of compute, storage and network resources: + +- Compute Capacity (CPU) +- Memory Capacity (RAM) +- Storage Capacity (SSD/HDD) +- Network Capacity (Bandwidth, IP Addresses) + +For making this Internet Capacity available, Farmers are rewarded with TFT. + +The amount of resources availabe in a 3Node are translated into compute units (CU), storage units (SU), Network units (NU) and IP addresses (IPAddr) to calculate farming rewards. See also [Cloud Units Calculation For Farming](../cloud/resource_units_calc_cloudunits.md). + +> **Unless explicitly specified otherwise, calculations of "gigabytes" use base +> 1024. That is, 1 GB is equal to 1073741824 bytes.** + +The formula to calculate farming rewards is the following: + +```python +TFT earned per month = + CU farmed * CU farming rewards + + SU farmed * SU farming rewards + + NU used * NU farming rewards + + IPAddr used * IPAddr farming rewards + +``` + +The below table expands on CU, SU, NU and IPAddr and their farming rewards: + +| Unit | description | v3 farming rewards in TFT | +| ------------------- | ----------------------------------------------------------------- | ------------------------- | +| Compute Unit (CU) | typically 2 vcpu, 4 GB mem, 50 GB storage | 30.00 TFT/month | +| Storage Unit (SU) | typically 1 TB of netto usable storage | 12.50 TFT/month | +| Network Unit (NU) | 1 GB of data transfered as used by TFGrid user for Public IP Addr | 0.38 TFT/GB | +| Public IPv4 Address | Public IP Address as used by a TFGrid user | 0.06 TFT/hour | + +> **The rewards above are calculated according to the current TFT to USD price in TFChain of 0.08. TFDAO is responsible to change this price in accordance to the current market and liquidity.** + +The above farming rewards apply for 3Nodes registered in TFChain for ThreeFold Grid v3. Anyone can calculate their potential rewards using the [Farming Reward Simulator](https://dashboard.grid.tf/#/farms/simulator/). The same CU, SU, NU and IPAddr principles apply to the sales of Internet capacity in the form of [cloud units](../cloud/cloudunits.md). diff --git a/collections/tfmanual/knowledge_base/farming/proof_of_utilization.md b/collections/tfmanual/knowledge_base/farming/proof_of_utilization.md new file mode 100644 index 0000000..e92536e --- /dev/null +++ b/collections/tfmanual/knowledge_base/farming/proof_of_utilization.md @@ -0,0 +1,58 @@ +

Proof-of-Utilization

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [What is Proof-of-Utilization?](#what-is-proof-of-utilization) +- [How does Proof-of-Utilization work?](#how-does-proof-of-utilization-work) +- [ThreeFold DAO rules in Relation To Proof-of-Utilization](#threefold-dao-rules-in-relation-to-proof-of-utilization) + - [TFGrid Capacity Utilization](#tfgrid-capacity-utilization) + - [Other Ways TFT are Required](#other-ways-tft-are-required) + +*** + +> Note: The proof-of-utilization parameters will be updated for the next 3.14 grid release. Stay tuned. + +## 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. + +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. + +## What is Proof-of-Utilization? + +Proof-of-utilization is the underlying mechanisms that verifies the utilization of Internet capacity on the ThreeFold Grid. + +Every hour, the utilization is recorded in TFChain and the user is charged for the Internet capacity used on the ThreeFold Grid. Discount calculated in line with the amount of TFT users have in their accounts on TFChain. Learn more about the discount [here](../cloud/pricing/staking_discount_levels.md). + +## How does Proof-of-Utilization work? + +1. A user reserves Internet capacity on a given set of 3Nodes. +2. Zero-OS records the reserved and used CU, SU, NU and IPAddresses in correlation with TFChain records. +3. The TFChain DAO will charge the costs to the user in line with [discount mechanism](../cloud/pricing/staking_discount_levels.md). +4. TFT from the user account are burned/distributed in line to table below. + +| Percentage | Description | Remark | +| ---------- | -------------------------------------- | ------------------------------------------------------------------------ | +| 35% | TFT burning | A mechanism used to maintain scarcity in the TFT economy. | +| 10% | ThreeFold Foundation | Funds allocated to promote and grow the ThreeFold Grid. | +| 5% | Validator Staking Pool | Rewards farmers that run TFChain 3.0 validator nodes. | +| 50% | Solution providers & sales channel | managed by [ThreeFold DAO](../about/dao/dao.md). | + +> Note: While the solution provider program is still active, the plan is to discontinue the program in the near future. We will update the manual as we get more information. We currently do not accept new solution providers. + +## ThreeFold DAO rules in Relation To Proof-of-Utilization + +### TFGrid Capacity Utilization + +- Each solution provider and sales channel gets registered in TFChain and as such the distribution can be defined and calculated at billing time. +- For billing purposes, ThreeFold DAO will check if it is from a known sales channel or solution provider. If yes, then the billing smart contract code will know how to distribute the TFTs. If the channel of solution provider is not known, then the 50% will go to the ThreeFold Foundation. +- For Certified Farming, [ThreeFold Tech](../about/threefold_tech.md) can define the solution & sales channel parameters, these are channels as provided by ThreeFold Tech. +- Burning can be lowered to 25% if too many tokens would be burned, ThreeFold DAO consensus needs to be achieved. + +### Other Ways TFT are Required + +- Anyone building solutions on top of the TFGrid can use TFT as a currency to charge for the added value they provide, this gives an extra huge requirement for TFT. +- Some will use TFT as a store or exchange of value, like money, because TFT is a valuable commodity. The hoarding of TFT means that TFT are not available to be used on the TFGrid. + + diff --git a/collections/tfmanual/knowledge_base/farming/tfgrid_min_sla.md b/collections/tfmanual/knowledge_base/farming/tfgrid_min_sla.md new file mode 100644 index 0000000..5659485 --- /dev/null +++ b/collections/tfmanual/knowledge_base/farming/tfgrid_min_sla.md @@ -0,0 +1,18 @@ +## Minimum requirement Service Level Agreement (SLA) + +Minimal SLA's need to be achieved before the farming reward can be earned (uptime, bandwidth, latency, ...). This is not yet fully implemented. + +More service levels agreements will be required, the DAO will decide on those changes. +Requests can be made by everyone by means of GEP. + +Some Ideas + +- minimal uptime +- minimal bandwidth requirement +- minimal network latency requirement +- minimal distance between Certified Nodes for the super node concept +- different uptime requirement for Certified vs DIY nodes + + +If SLA (Service Level Agreement) was not achieved for 3 consecutive months, then the 3Node will have to re-register which means the CU/SU reward will be recalculated at that time and re-registered in TFChain for that node, just like a new one. + diff --git a/collections/tfmanual/knowledge_base/farming/utility_token_model.md b/collections/tfmanual/knowledge_base/farming/utility_token_model.md new file mode 100644 index 0000000..56e4346 --- /dev/null +++ b/collections/tfmanual/knowledge_base/farming/utility_token_model.md @@ -0,0 +1,4 @@ +| Utility Token model | | +| -------------------------------------------- | ------------------------------------------ | +| [Proof Of Capacity](proof_of_capacity) | Farming (creation) of TFT | +| [Proof Of Utilization](proof_of_utilization) | Utilization (burning, distribution) of TFT | \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/farming/why_farming.md b/collections/tfmanual/knowledge_base/farming/why_farming.md new file mode 100644 index 0000000..be389a5 --- /dev/null +++ b/collections/tfmanual/knowledge_base/farming/why_farming.md @@ -0,0 +1,18 @@ + +## Why becoming a Farmer? + +### Internet and Its Global Demand + +The Internet represents the largest economy in the world and is growing at a rapid pace. + +![](img/token_time_to_get_involved_now_.jpg) + +The ThreeFold Grid offers the most scaleable, secure and sustainable infrastructure to supply the increasing Internet demand. + +Learn more about the ThreeFold Grid [here](grid_intro). + +### Sovereign and Recurrent Wealth + +By participating in the expansion of the ThreeFold Grid, Farmers earn [TFT](threefold_token) on a monthly basis. ThreeFold Token has value - it represents a unit of reservation of Internet Capacity on the ThreeFold Grid. With the infinite expansion of the ThreeFold Grid and the scarcity of mechanism of the [TFT](threefold_token), there will be a constant increase in demand while a decrease in supply, thus providing value of its holders/Farmers. + +Learn more about Farming Rewards [here](farming_reward). \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/knowledge_base.md b/collections/tfmanual/knowledge_base/knowledge_base.md new file mode 100644 index 0000000..2aebbdb --- /dev/null +++ b/collections/tfmanual/knowledge_base/knowledge_base.md @@ -0,0 +1,14 @@ +

ThreeFold Knowledge Base

+ +The section contains information about the ThreeFold ecosystem, its technology and its history. + +For practical information for farmers, developers and system administrators, refer to the [ThreeFold Documentation](../documentation/documentation.md). + +

Table of Contents

+ +- [About](./about/about.md) +- [Technology](./technology/technology_toc.md) +- [Farming](./farming/farming_toc.md) +- [Cloud](./cloud/cloud_toc.md) +- [Collaboration](./collaboration/collaboration_toc.md) +- [Legal](./legal/terms_conditions_all3.md) \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/definitions_legal.md b/collections/tfmanual/knowledge_base/legal/definitions_legal.md new file mode 100644 index 0000000..5afe811 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/definitions_legal.md @@ -0,0 +1,297 @@ +# Definitions + +## ThreeFold (TF) + +AN INTERNET BUILT FOR EVERYONE, BY EVERYONE. + +Threefold is a peer-to-peer network of network, storage an compute capacity for an upgraded internet, laying the foundation for a more sustainable, smart, and sovereign digital world where everyone can participate and prosper. + +All the ideas and content created for this concept are opensource and stored in github +A group of volunteers and the ThreeFold Foundation maintain these repositories. + +> See [https://github.com/threefoldfoundation](https://github.com/threefoldfoundation) + +## ThreeFold Foundation (TFF) + +The ThreeFold Foundation (ThreeFold_Dubai) is a participant in the bigger ThreeFold movement, the purpose of the movement is to bring the world a truly peer-to-peer internet. + +We acknowledge and support the many people and organizations around the world who bring crucial support to the growth and adoption of the ThreeFold_Grid. + +See [ThreeFold Dubai](../about/threefold_dubai.md) + +> Work is ongoing to make the Foundation a global distributed concept with probably more than 1 legal entity. + +## ThreeFold Tech (TFTech, TFTECH) + +TF TECH NV, a Belgian limited liability company, having its registered office at Antwerpse Steenweg 19, B-9080 Lochristi, Belgium, registered with the Belgian Crossroads Bank of Enterprises under company number 0712.845.674 (RLP Gent, district Gent) + +TF Tech is a software tech company and is a major contributor to the software as used on the TFGrid. + +See [TFTech](../about/threefold_tech.md) + +## Non For Profit + +Non-for-profit organizations are types of organizations that do not earn profits for its owners. All of the money earned by or donated to a non-for-profit organization is used in pursuing the organization's objectives and keeping it running. Employees or contributors can be paid for the services provided. + +In the case of TFF following remarks might be useful + +- Many non for profits get a legal status by the government to not have to pay tax, in our case the foundation is in Dubai, there is no Tax implication in Dubai as such we didn't need this status or certification. +- TFF has been funded by its original founders by means of loans or investment in kind or tokens, this money can be returned to the founders whenever cashflow allows (which is not the case yet). +- TFF directors/shareholders do everything they can to only operate out of the best interests of the ThreeFold Project. +- A project is under way to officialize the structure with strict governance e.g. a company called ThreeFold VZW has been created in Belgium with official governance around non for profit structure. This company is not used yet. Other alternatives are being researched at this moment (Aug 2020). +- ThreeFold_Dubai has farmed tokens which can be used as gifts towards contributors or employees. + +## ThreeFold_Grid (TFG) + +The ThreeFold_Grid is a new, global neutral and sustainable network of IT infrastructure. On this Grid, IT capacity is indexed registered on the TFChain for easy discovery by purchasers. + +This Internet capacity is produced and allocated locally - similar to the way electricity and other utilities are purchased today. This allows any digital service or application provider to host their services and applications in proximity to the end user leading to significantly greater performance, a lower price point and better margins. This is both more cost effective and green. + +## IT Capacity + +- IT = Information Technology. +- IT Capacity is resource availability for running any IT Workloads +- Examples of IT Workloads which can run on the TFG are + - web applications + - archiving of data + - generic storage (e.g. using the S3 storage interface) + - container workloads (e.g. using the Kubernetes interface) + - artificial intelligence workloads + - big data workloads (processing of data) + - gaming servers + - content delivery + - test workloads for developers + +## ThreeFold_Token (TFT) + +The ThreeFold_Token is a digital Token which allows anyone to buy and sell IT Capacity on the TF Grid. This token only gets issued by the TFChain if a TF Pool gets connected to the TF Grid. + +The TFChain can issue a maximum of 4 billion tokens (gen 2). + +## TFChain + +Group of blockchain related technologies as used by ThreeFold to accomplish the following: + +- store & trade your TFTs: uses Stellar Public Blockchain platform +- buy/sell capacity on the TFG: TFExplorer +- register capacity of the TFG: TFExplorer +- provision IT workloads on the TFG: TFExplorer +- ... + +> See the following [github repos](https://github.com/threefoldtech) and [https://github.com/threefoldfoundation/tft-stellar](https://github.com/threefoldfoundation/tft-stellar) + +## Zero-OS (ZOS) or Capacity Layer + +The Zero-OS is the software which makes it possible to convert any pool of hardware to become a pool of resource for the ThreeFold_Grid. + +> See [Zero-OS](https://github.com/threefoldtech/zos) = Ultra Efficient Stateless Operating System + +## Zero-People or Autonomous Layer + +- [Jumpscale](https://github.com/threefoldtech/js-ng) = Automation Framework (self healing, ...) + +## User + +- is the person/organization/company who buys capacity from the TF Grid +- capacity can only be bought by means of TFTs + +## TF Distributed exchange (TFExchange) + +Since March 2020 based on Stellar integrated Decentralized exchange and before Atomic Swaps. +Mechanism for people to exchange TFT to other digital currencies in a decentralized way. +Atomic Swaps were difficult to use, this got resolved by switching to Stellar blockchain. + +# ThreeFold Farming + +## TFNode + +- is a compute/storage server which provides IT Capacity as source for the Cloud Units +- a TFNode is part of a Farming Pool +- 3Nodes are owned by TF Farmers. +- The TFNode runs the TF Operating System and TFChain (TFC). + +## Cloud Units + +Units of IT capacity as sold from the TF Grid to Users. +More info see [here](../cloud/cloudunits.md) + +## ThreeFold Farming Pool (FP) + +A Pool of storage & compute hardware which allows to provision IT Capacity. + +Each Farming Pool consists out of 3Nodes which run the TF Operating System and TF Blockchain Software (TFChain) which allows anyone in the world to use this IT capacity to host their IT workloads (storage apps, archive capacity, web applications, artificial intelligence, iOT, docker containers, etc). To use this IT Capacity, through the TF Grid, people need to own ThreeFold_Tokens (“TFTs”) as they are the only possible mechanism to purchase this capacity on the TF Grid. As such, TFTs represent a true utility. + +## ThreeFold Farmer + +A ThreeFold Farmer is any organization or person who invests in a ThreeFold Farming Pool and connects this capacity to the ThreeFold_Grid. + +As a result of Farming, i.e. creating additional capacity, ThreeFold_Tokens are automatically created by the ThreeFold Chain. + +Farmers can cultivate both managed and/or unmanaged capacity. + +Farmers receive TFTs + +- as part of owning the TF Farming Pool (tf_farming) +- as part of selling capacity from the TF Farming Pool (cultivating) + +Most TF Farmers use a ThreeFold Cooperative to become active because it hugely simplifies the process and gives them often better pricing to purchase the Farming Pool as well as connecting the Farming Pool to the internet. + +The ThreeFold Farmer is the only party who owns the TF Farming Pool. + +## ThreeFold Cooperative + +Any organization who helps a TF Farmer to become active on the TF Grid. + +A Cooperative can supply any or all of following services. + +- Selling required hardware kit for the Farming Pool (compute, storage, networking) to the TF Farmer (and logistics around it). +- Installing & testing the TF Operating System on the chosen hardware. +- Burn in testing of the chosen hardware: make sure the hardware is reliable and works following expectations. +- Configuration & Installation of the ThreeFold Farming Pool. +- Registration & Initialization of the ThreeFold Farming Pool. +- Delivering & Executing of hardware Warranty as specified on contract. +- Creation and Delivery of the ThreeFold Mobile App for the TF Farmer (allow people worldwide to order capacity using TFTs for the Farming Pool. +- Software support for the Farming Pool +- Training of the TF Farmer about TF Concepts + - how to use the TF Wallet + - how to safely store the TFT's + - how to go from TFT's to fiat currency like USD/EUR (and visa versa) + - how to register pricing info on the TF Grid + - how to integrate a fiat currency payment gateway into existing ecommerce website for the sales of TFT's or TF IT Capacity (e.g. integration with Stripe or other payment mechanism) + - how to consult/register information on the TFChain +- Hosting Services + - all services related to connectivity to the internet (routing, denial of service, firewalling, ...) + - rackspace & other datacenter services + - monitoring of the infrastructure (hardware and software). + +## Do It Yourself Capacity + +Unmanaged IT Capacity can exist everywhere; in people’s home, in mobile telephone masts, in utility cabinets, next to railways or motorways, anywhere where internet lines meet electrical outlets, any IT Hosting or Datacenter Facility. This capacity is deployed to the TF Grid and has no people involved to manage its operations (apart from the physical and network aspects). Farmers have no access to the 3Nodes purchased. They can only use the capacity produced in the exact same way as any other user, i.e. through the TFChain, in a secure private and neutral way, equally applicable to all. + +Unmanaged capacity provides the following 3 basic services + +- Storage Capacity = backend storage services which can be used as backend for more high level storage services like S3 +- Compute Capacity = backend compute capacity which can be used as backend for more high level compute services like Kubernetes. +- Network Gateway Services: integration with ZeroTier network, HTTP(s) reverse proxy, DNS services, TCP Portforwarding. + +These basic services are ordered through the TFChain only. +SLA's (service level agreements) cannot be be guaranteed on Unmanaged Capacity and as such not registered in the TFChain. + +## Certified Capacity + +Capacity which received certification as organized by ThreeFold Tech. + +## Managed Capacity + +Managed capacity is capacity that sits in a datacenter or other controlled environment where people operate and maintain supervision of the capacity connected to the TF Grid and published in the TF Directory. SLA (Service Level Agreements) are provided on this capacity like uptime, guaranteed bandwidth, response times, ... + +TF Farmers have access to the 3Nodes. + +Features Only Available In A Managed Capacity Farming Pool + +- Published & Tracked (monitored) Service Level Agreements + +# Legal + +## The Company + +The Company has been defined on the contract who refers to this document but can be any of the following: + +- The company or organization who is selling a service on the ThreeFold_Grid. +- The company who is selling/buying ThreeFold_Tokens (TFTs) as capacity on the ThreeFold_Grid. +- The company who is helping a Farmer to become active on the ThreeFold_Grid = a TF Cooperative. +- The company who is selling the hardware and software required for a Farming Pool + +## The Product + +The Product is the ThreeFold_Token or any service related to the ThreeFold_Grid which can be bought by The Purchaser. +The Product has been defined on the contract who refers to this document. + +## The Purchaser + +Is the person or company or organization who buys The Product from The Company + +## ThreeFold Tech (TFTech) + +Software Technology company in Belgium. + +Has no direct relationship with the TFGrid or TFTokens. TFTech does not farm and ThreeFold_Tokens and has no impact or does not give any direction to anything happening on the ThreeFold_Grid or in relation to TFTokens. + +TFTech is the company who creates a lot of the opensource software as is used in the TFGrid. TFTech is also a contributor to the TF Foundation in the form of content or promotion, there is no legal connection in place. + +TFTech business model is to sell licenses and certify TFGrid farmers if that is what they require. + +# Miscellaneous + +## TF Wallet + +A software application which allows anyone to consult how many TFTs they own and to make transfers of TFTs to other parties. +The TF Wallet works together with Stellar and is nothing but a javascript UI. +TF Wallet is part of the ThreeFold Connect app on mobile. + +# Sales Related Definitions + +### “Acceptance” + +means that any Deliverable has successfully completed the Acceptance process set forth in Section 4. Such Acceptance may be either explicit or implicit, i.e. in the absence of an explicit Rejection. + +### “Acceptance Period” + +means fifteen (15) days as from the Delivery Date, unless otherwise agreed to in the Sales Order or as provided under statutory law. + +### “Customer” + +means you or the customer entity identified in the Sales Order, as the case may be. + +### “Deliverables” + +means the Hardware, Software, Services (if any), or any deliverable specified in a Sales Order. + +### “Delivery” + +means the act of making the Deliverables available for reception by the Customer in accordance with Section 4.1. + +### “Delivery Date” + +means the ultimate date on which the Delivery may take place, as determined in the Sales Order. + +### “Documentation” + +means all manuals, instructions and other documents (whether in hard copy, soft copy or web-based form) relating to, or necessary for, the use, operation or maintenance of the Deliverables, together with all enhancements, corrections, modifications and amendments to such documents that are furnished to Customer under this Agreement. + +### “Effective Date” + +means the date when the Agreement starts to operate, corresponding to the issuance date of the Sales Order. + +### “Hardware” + +means any hardware to be provided by Company as specified in a Sales Order or Specific Agreement. + +### “Party” + +means any party to this Agreement; + +### “Rejection” + +means the explicit rejection of Deliverables by Customer, provided that the following cumulative conditions have all been completed: +the Rejection has been notified by Customer to Company within the Acceptance Period (i.e. at the latest on the last day of the Acceptance Period); +Customer has returned to Company all rejected Deliverables immediately after the Rejection notice; +Any rejection that does not meet both aforementioned cumulative conditions shall not qualify as a Rejection and shall be deemed an implicit Acceptance. + +### “Sales Order” + +means any Sales Order generated electronically by Company to allow the Customer to order, including the details specified by Customer in the checkout of the Company website, or any document that the Parties mutually agree upon as the vehicle for procuring Hardware, Software and/or Services pursuant to this Agreement. + +### “Services” + +means any services to be provided by Company to Customer as stipulated in the Sales Order. + +### “Software” + +means the open source software connecting the Hardware to the ThreeFold network, all in machine readable, object code form, together with all enhancements, modifications, corrections and amendments thereto. + +### “Specifications” + +means the technical requirements for, and performance standards of, the Deliverables as set forth in the Sales Order or Documentation provided to Customer. + +{{#include ./terms_conditions/sub/the_single_source_truth.md}} \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/disclaimer.md b/collections/tfmanual/knowledge_base/legal/disclaimer.md new file mode 100644 index 0000000..37be9e9 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/disclaimer.md @@ -0,0 +1,36 @@ +# General Warning And Disclaimer + +Your use of the TFGrid and/or TFTs, as well as the IT capacity made available from the TFGrid to the Internet, as well as any tools provided to work with TFGrid or TFTokens (hereinafter collectively also referred to as the "Services") will be subject to the warnings, limitations, acknowledgements and disclaimers set out hereinafter. These statements and disclaimers are made by and on behalf of (1) the TF Foundation (ThreeFold_Dubai), (2) each individual or entity acting as a ThreeFold Farmer (3) , TFTech NV (4) any of the companies or individuals related to these entities, and (5) any person contributing or otherwise assisting in developing, marketing or distributing the Services (hereinafter collectively referred to as “ThreeFold”). + +### Disclaimer + +TO THE FULLEST EXTENT PERMITTED BY APPLICABLE LAW THE SERVICES ARE PROVIDED ON AN "AS IS" AND “AS AVAILABLE” BASIS WITHOUT WARRANTIES OF ANY KIND, AND THREEFOLD EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES AS TO THE SERVICES, INCLUDING, WITHOUT LIMITATION, IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT; (B) THREEFOLD DOES NOT REPRESENT OR WARRANT THAT THE SERVICES ARE ACCURATE, COMPLETE, RELIABLE, CURRENT OR ERROR-FREE, MEET YOUR REQUIREMENTS, OR THAT DEFECTS IN THE SERVICES WILL BE CORRECTED; AND (C) THREEFOLD CANNOT AND DOES NOT REPRESENT OR WARRANT THAT THE SERVICES, OR THE SERVERS USED TO PROVIDE SUCH SERVICES, ARE FREE OF VIRUSES OR OTHER HARMFUL COMPONENTS. + +By using the Services, you acknowledge that: + +- you have access to all relevant and required information to do with the tokens and the grid on https://library.threefold.me + - e.g. way how tokens are created/minted on: token_creation + - all this information is being provided on best effort basis and does not imply any promise or guarantee +- you have sufficient knowledge and experience in financial and business matters and are capable of evaluating the merits and risks of using or acquiring TFTs, and that you are able to bear the economic risk of such acquisition for an indefinite period of time. +- the Services (including the TFTs) involve risks, all of which you fully and completely assume, including, but not limited to, the risk relating to the possibility of limited or absent liquidity for the TFTs on the secondary markets (including the relevant online exchanges), the risk relating to price fluctuations of the TFTs on such secondary markets (including the relevant online exchanges), etc. +- the Services (including the TFTs) have or will be created and delivered to you at your sole risk on an "AS IS" basis. +- you have not relied on any representations or warranties made by ThreeFold outside this document, including, but not limited to, conversations of any kind, whether through oral or electronic communication, or any white paper. Without limiting the generality of the foregoing, you assume all risk and liability for the results obtained by the use of any tokens (including TFTs) and regardless of any oral or written statements made by ThreeFold, by way of technical advice or otherwise, related to the use of the tokens. +- you bear sole responsibility for any taxes as a result of the use or acquisition of the Services (including the TFTs), and any future acquisition, ownership, use, sale or other disposition of TFTs held by you. To the extent permitted by law, you agree to indemnify, defend and hold ThreeFold harmless for any claim, liability, assessment or penalty with respect to any taxes (other than any net income taxes of ThreeFold that result from the sale of TFTs) associated with or arising from your purchase, use or ownership of TFTs. + +### Release + +To the fullest extent permitted by applicable law, you hereby explicitly release ThreeFold from responsibility, liability, claims, demands and/or damages (actual and consequential) of every kind and nature, known and unknown (including, but not limited to, claims of negligence), arising out of or related to: + +(1) disputes between users of the Services and/or the acts or omissions of third parties; and +(2) your purchase of tokens (if any) from ThreeFold_Dubai (formerly known as ‘GreenITGlobe’) or Bettertoken BV identified in the relevant contracts as ‘Internal ThreeFold_Tokens’ or ‘iTFTs’. + +If and to the extend you have purchased or otherwise acquired tokens from ThreeFold_Dubai (formerly known as ‘GreenITGlobe’) or Bettertoken BV that were identified in the relevant contracts as ‘Internal ThreeFold_Tokens’ or ‘iTFTs’, your use of the Services (including your subsequent receipt or acceptance of TFTs) implies your confirmation that such purchase or acquisition has been duly completed as a result of your receipt of a corresponding amount of TFTs, that all deliverables under the relevant contracts (known as ‘iTFT Purchase Agreement’, ‘TFT Purchase Agreement’ or ‘ITO investment agreement’) have been duly delivered and that there are no further obligations from one of the above-mentioned companies to you in relation to such contracts. + +### Limitation of Liability + +- Exclusion of indirect damages. To the fullest extent permissible under applicable law, ThreeFold shall not have any liability with respect to any claims for consequential, exemplary, special, indirect and/or punitive damages (such as –but not limited to – loss of goodwill, loss of actual or anticipated business or contracts, work stoppage, loss as a result of a third party claim, data loss or corruption of data, computer failure or lost profit), arising out or in any way related to the access or use of the Services or otherwise related to ThreeFold, regardless of the form of action, whether based in contract, or otherwise, even if ThreeFold has been advised of the possibility of such damages. +- Cap on damages. To the extent permissible under the applicable law the contractual and/or extra-contractual liability of ThreeFold arising out or related to the use of, or inability to use, the Services, shall be limited to (1) any compensation you paid to ThreeFold for the Services, or (2) 1,000 US Dollars, whichever is greater. This limitation is cumulative and not per incident. It applies to all causes of action and obligations in the aggregate, including without limitations, any claim of breach of contract and/or negligence. +- Prescription. No action in any form arising out of or in connection with this Agreement may be brought by the Purchaser more than one (1) year after the cause of action has accrued. +- No limitations for own intent. Nothing in this Agreement shall (or shall be deemed to, or construed to) exclude or restrict any liability either Party may incur as a result of fraud, willful intent or for any death or personal injury resulting from its gross negligence or that of its employees, agents or subcontractors. + +{{#include ./terms_conditions/sub/the_single_source_truth.md}} \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/legal.md b/collections/tfmanual/knowledge_base/legal/legal.md new file mode 100644 index 0000000..d925da2 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/legal.md @@ -0,0 +1,17 @@ +

ThreeFold Legal Wiki

+ +As part of ThreeFold's commitment to transparency and providing a secure and reliable platform, we have a dedicated [ThreeFold's Legal Wiki](https://legal.threefold.io) where users can access essential legal articles and documentation. + +At [**legal.threefold.io**](https://legal.threefold.io), users can find important legal resources such as Terms and Conditions (T&C) and disclaimers that govern the usage of the ThreeFold Grid and related services. + +These legal documents outline the rights, responsibilities, and obligations of both ThreeFold and its users, ensuring a clear understanding of the legal framework within which the platform operates. By visiting the legal section, users can familiarize themselves with the legal aspects of engaging with the ThreeFold ecosystem, promoting a trustworthy and accountable environment. + +You're invited to explore the ThreeFold Legal Wiki by visiting [this link](https://library.threefold.me/info/legal/#/). + +- [Disclaimer](../wiki/disclaimer.md) +- [Definitions](../wiki/definitions_legal.md) +- [Privacy Policy](../wiki/privacypolicy.md) +- [Terms & Conditions ThreeFold Related Websites](../wiki/terms_conditions_websites.md) +- [Terms & Conditions TFGrid Users TFGrid 3](../wiki/terms_conditions_griduser.md) + - [TFTA to TFT](../wiki/tfta_to_tft.md) +- [Terms & Conditions TFGrid Farmers TFGrid 3](../wiki/terms_conditions_farmer3.md) \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/privacypolicy.md b/collections/tfmanual/knowledge_base/legal/privacypolicy.md new file mode 100644 index 0000000..1d0c4a8 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/privacypolicy.md @@ -0,0 +1,120 @@ +# Privacy Policy + +*This privacy policy will explain how ThreeFold Movement ("companies", “we”, or “us”) uses the personal data we collect from you when you use any of our:* + +{{#include ./terms_conditions/sub/websites.md}} + +### What data do we collect? + +All websites using the ThreeFold Movement Privacy Policy do not collect any data on a personal level by default. All data being processed is anonymized. When signing up for our newsletter we collect your: *email address* + +**How do we collect your data?** + +Browsing data: +We automatically collect data and process data when you use or view our website via your browser's cookies. + +Newsletter Signups: +Collected only with your permission through our sign-up form that uses a double opt-in mechanism for you to explicitly accept. + +### How will we use your data? + +We use this information to monitor and analyze your use of our website and for the website's technical administration, to increase our website's functionality and user-friendliness, and to better tailor it to our visitors needs. + +If you agree, our companies will share your data with the following partner companies so that they may offer you or us their products and services: + +* Matomo: offers us services relating to monitoring and measuring website traffic and access, creating user navigation reports, etc. All information processed here is anonymized. We run this service within our own environments. The data being processed does not leave our servers and is not shared with any thrid parties. + +* Mailerlite: offers us services relating newsletter sending and monitoring. + +**We do not track individual IP's or any other personal data.** + +The aforementioned processors operate independently from us and have their own privacy policy, which we strongly suggest you review. These processors may use the information collected through their services to evaluate visitors’ activity, as set out in their respective privacy policies. + +### How do we store your data? + +We store the anonmyzed data in Matomo for us to research usage and improve user experience on our websites. +We store email addresses in Mailerlite's system. + +### Marketing + +We will not use your information for any (re)marketing reasons, nor send you information about products and/or services of ours or any partner companies unless you explicitly agreed to signing up for our newsletter. + +### What are your data protection rights? + +We would like to make sure you are fully aware of all of your data protection rights. Every user is entitled to the following: + +#### The right to access + +You have the right to request from us copies of your personal data. We may charge you a small fee for this service. + +#### The right to rectification + +You have the right to request that we correct any information you believe is inaccurate. You also have the right to request us to complete information you believe is incomplete. + +#### The right to erasure + +You have the right to request that we erase your personal data, under certain conditions. + +#### The right to restrict processing + +You have the right to request that we restrict the processing of your personal data, under certain conditions. + +#### The right to object to processing + +You have the right to object to our companies' processing of your personal data, under certain conditions. + +#### The right to data portability + +You have the right to request that we transfer the data that we have collected to another organization, or directly to you, under certain conditions. + +If you make a request, we have one month to respond to you. If you would like to exercise any of these rights, please contact us: + +* email: dataprivacy@threefold.io + +* post address: +{{#include ./threefold_fzc_address.md}} + + +### What are cookies? + +Cookies are text files placed on your computer to collect standard Internet log information and visitor behavior information. When you visit our websites, we may collect information from you automatically through cookies or similar technology. + +For further information, visit: http://allaboutcookies.org/ + +### How do we use cookies? + +We use cookies in a range of ways to improve your experience on our website, including: + +* understanding how you use our website + +* for the websites technical administration + +### What types of cookies do we use? + +There are a number of different types of cookies, however, our websites use: + +* Functionality - Our companies use these cookies so that we recognize you on our website and remember your previously selected preferences. These could include what language you prefer and the location you are in. A mix of first-party and third-party cookies are used. + +* No Advertising - Our companies use these cookies to collect information about your visit to our website, the content you viewed, the links you followed and information about your browser, device, and your IP address. However, we will not share this data with third parties for advertising purposes. + +* Analytics cookies - Our companies use these to monitor how users reached the Site, and how they interact with and move around once on the Site. These cookies let us know what features on the Site are working the best and what features on the Site can be improved. + +### How to manage cookies + +You can set your browser to not accept cookies, and the above website tells you how to remove cookies from your browser. However, in a few cases, some of our website features may not function as a result. + +### Privacy policies of other websites + +Our website contains links to other websites. Our privacy policy applies only to our website, so if you click on a link to another website, you should read their privacy policy. + +### Changes to our privacy policy + +We keep our privacy policy under regular review and places any updates on this web page. This privacy policy was last updated on 16 May 2019. + +### How to contact us + +If you have any questions about our privacy policy, the data we hold on you, or you would like to exercise one of your data protection rights, please do not hesitate to contact us. + +Email us at: dataprivacy@threefold.io + +{{#include ./terms_conditions/sub/the_single_source_truth.md}} \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/sub/parties_threefold.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/sub/parties_threefold.md new file mode 100644 index 0000000..1ea6f8f --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/sub/parties_threefold.md @@ -0,0 +1 @@ +These Terms and Conditions (the "**Agreement**") constitute a legal agreement between you (“**user**," “**you**", or “**yours**”) and [THREEFOLD RELATED COMPANIES](../../about/threefold_companies.md) (“**Threefold**”, “**Company**,” “**us**,” “**we**” or “**our**”) \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/sub/the_company.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/sub/the_company.md new file mode 100644 index 0000000..1897d8d --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/sub/the_company.md @@ -0,0 +1,8 @@ +## The Company + +The Company has been defined on the contract who refers to this document but can be any of the following: + +- The company or organization who is selling a service on the ThreeFold_Grid. +- The company who is selling/buying ThreeFold_Tokens (TFTs) as capacity on the ThreeFold_Grid. +- The company who is helping a Farmer to become active on the ThreeFold_Grid = a TF Cooperative +- The company who is selling the hardware and software required for a Farming Pool diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/sub/the_product.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/sub/the_product.md new file mode 100644 index 0000000..d10fc8f --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/sub/the_product.md @@ -0,0 +1,4 @@ +## The Product + +The Product is the ThreeFold_Token or any service related to the ThreeFold_Grid which can be bought by The Purchaser. +The Product has been defined on the contract who refers to this document. diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/sub/the_purchaser.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/sub/the_purchaser.md new file mode 100644 index 0000000..f13c063 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/sub/the_purchaser.md @@ -0,0 +1,3 @@ +## The Purchaser + +The Purchaser is the person or company or organization who buys The Product from The Company. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/sub/the_single_source_truth.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/sub/the_single_source_truth.md new file mode 100644 index 0000000..db24c10 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/sub/the_single_source_truth.md @@ -0,0 +1,5 @@ +## SINGLE SOURCE OF TRUTH + +Our single source of truth for our legal docs is stored on [Github: https://github.com/threefoldfoundation/info_legal/tree/master/](https://github.com/threefoldfoundation/info_legal) + +> You can see the history of each file on github, useful to see the right version of the file in relation to the date when you signed a document or contract which linked into one of the above documents. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/sub/websites.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/sub/websites.md new file mode 100644 index 0000000..7557344 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/sub/websites.md @@ -0,0 +1 @@ +websites/wikis/forums ending with threefold.io, threefold.me, grid.tf, threefold.tech, ThreeFold_Token.com, freeflownation.org, 3bot.org, incubaid.com or consciousinternet.org or any other website as used/promoted by the ThreeFold Foundation or any other site as originating from our opensource git repository on https://github.com/threefoldfoundation. diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions.md new file mode 100644 index 0000000..6f8d82b --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions.md @@ -0,0 +1,9 @@ +

Terms & Conditions

+ +

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 diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer3.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer3.md new file mode 100644 index 0000000..0c6ec94 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer3.md @@ -0,0 +1,24 @@ +{{#include ./terms_conditions_farmer_parts/part_0_introduction_tcs.md}} +{{#include ./terms_conditions_farmer_parts/part_1_definitions.md}} +{{#include ./terms_conditions_farmer_parts/part_2_farmer_services.md}} +{{#include ./terms_conditions_farmer_parts/part_3_farmer_grant.md}} +{{#include ./terms_conditions_farmer_parts/part_4_certified_vs_diy.md}} +{{#include ./terms_conditions_farmer_parts/part_5_farmer_responsibilities.md}} +{{#include ./terms_conditions_farmer_parts/part_6_restrictions.md}} +{{#include ./terms_conditions_farmer_parts/part_7_representations_and_warranties.md}} +{{#include ./terms_conditions_farmer_parts/part_8_capacity_measurement_minting3.md}} +{{#include ./terms_conditions_farmer_parts/part_9_capacity_utilization3.md}} +{{#include ./terms_conditions_farmer_parts/part_10_term_termination.md}} +{{#include ./terms_conditions_farmer_parts/part_11_intellectual_property.md}} +{{#include ./terms_conditions_farmer_parts/part_12_indemnification.md}} +{{#include ./terms_conditions_farmer_parts/part_13_disclaimer_limitation_liability.md}} +{{#include ./terms_conditions_farmer_parts/part_14_export_compliance.md}} +{{#include ./terms_conditions_farmer_parts/part_15_agreement_severability_waiver.md}} +{{#include ./terms_conditions_farmer_parts/part_16_governing_law_venue.md}} + + +## APPENDIX + +{{#include threefold_companies0.md}} + +{{#include ./sub/the_single_source_truth.md}} \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/img/farmer_tcs_minting_equation.jpg b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/img/farmer_tcs_minting_equation.jpg new file mode 100644 index 0000000..8b13676 Binary files /dev/null and b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/img/farmer_tcs_minting_equation.jpg differ diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_0_introduction_tcs.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_0_introduction_tcs.md new file mode 100644 index 0000000..bc27086 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_0_introduction_tcs.md @@ -0,0 +1,4 @@ +**FARMER TERMS AND CONDITIONS** + +THESE TERMS AND CONDITIONS (THE "**AGREEMENT**") CONSTITUTE A LEGAL AGREEMENT BETWEEN YOU (“**FARMER**," “**YOU**", OR “**YOURS**”) AND OF THE THREEFOLD COMPANIES (“**THREEFOLD**”, “**COMPANY**,” “**US**,” “**WE**” OR “**OUR**”), GOVERNING THE TERMS OF YOUR PARTICIPATION AS A FARMER IN THE THREEFOLD GRID. YOU UNDERSTAND AND AGREE THAT BY ACCEPTING THE TERMS OF THIS AGREEMENT, EITHER BY CLICKING TO SIGNIFY ACCEPTANCE, OR BY TAKING ANY ONE OR MORE OF THE FOLLOWING ACTIONS DOWNLOADING, INSTALLING, RUNNING,/AND OR USING THE APPLICABLE SOFTWARE, YOU AGREE TO BE BOUND BY THE TERMS OF THIS AGREEMENT EFFECTIVE AS OF THE DATE THAT YOU TAKE THE EARLIEST OF ONE OF THE FOREGOING ACTIONS. YOU REPRESENT AND WARRANT THAT YOU ARE 18 YEARS OLD OR OLDER AND HAVE THE RIGHT AND AUTHORITY TO ENTER INTO AND COMPLY WITH THE TERMS OF THIS AGREEMENT. + diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_10_term_termination.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_10_term_termination.md new file mode 100644 index 0000000..df594c0 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_10_term_termination.md @@ -0,0 +1,7 @@ +### 10. TERM AND TERMINATION + +This Agreement shall be effective as of the date that you take the earliest of the following actions: your acceptance of this Agreement, either by clicking to signify acceptance, or by taking any one or more of the following actions: downloading, installing, running and/or using the Software. It will continue until terminated per the terms below. + +Either party may terminate this Agreement immediately at any time without notice to the other party. + +In case of termination, the Farmer shall immediately cease using the Software. Any portion of Farmed or Cultivated ThreeFold_Tokens that have not been transferred to the Farmer’s wallet on the date of termination will be irrevocably forfeited. diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_11_intellectual_property.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_11_intellectual_property.md new file mode 100644 index 0000000..1eb7a4a --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_11_intellectual_property.md @@ -0,0 +1,7 @@ +### 11. INTELLECTUAL PROPERTY + +No rights are granted to the Farmer hereunder other than as expressly set forth in this Agreement. Except for Software subject to the Open Source Licenses, and except for any rights expressly granted under this Agreement, Company and its licensors own and shall retain all right, title, and interest in and to the ThreeFold_Grid and all related software (including any improvements, enhancements, customizations, and modifications thereto), the Documentation, and the Related Data, including, without limitation, all related intellectual property rights therein. For purposes hereof, the term "**Related Data**" means data derived from operation of the 3Node and of the ThreeFold_Grid via the 3Node, and any data that is aggregated by Company (including aggregations with data sourced from other Farmers and other third party data sources), and data and information regarding the Farmer’s access to and participation in the ThreeFold_Grid, including, without limitation, statistical usage data derived from the operation of the 3Node and ThreeFold_Grid and configurations, log data and the performance results related thereto. For the avoidance of doubt, nothing herein shall be construed as prohibiting Company from utilizing Related Data to optimize and improve the ThreeFold_Grid or otherwise operate Company’s business; provided that if Company provides Related Data to third parties, such Related Data shall be de-identified and presented in the aggregate so that it will not disclose the identity of Farmers to any third party. + +The ThreeFold_Grid may include access to various confidential and proprietary third party data that is utilized along with the IT Capacity, and all such data is owned by the applicable third party source or vendor. Farmer may only use such data as part of the ThreeFold_Grid and may not extract or otherwise utilize any such data except as included in and in connection with the ThreeFold_Grid. This data may be compiled from third party sources, including but not limited to, public records, user submissions, and other commercially available data sources. These sources may not be accurate or complete, or up-to-date and is subject to ongoing and continual change without notice. Neither Company nor its third party data sources make any representations or warranties regarding the data and assume no responsibility for the accuracy, completeness, or currency of the data. + +Company shall have a royalty-free, worldwide, transferable, sublicensable, irrevocable, perpetual license to use or incorporate into the Software and/or the ThreeFold_Grid any suggestions, ideas, enhancement requests, feedback, recommendations or other information provided by Farmers relating to the features, functionality, or operation thereof ("**Feedback**"). Company shall have no obligation to use Feedback, and Farmer shall have no obligation to provide Feedback. diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_12_indemnification.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_12_indemnification.md new file mode 100644 index 0000000..69fc66c --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_12_indemnification.md @@ -0,0 +1,7 @@ +### 12. INDEMNIFICATION + +To the fullest extent permitted by applicable law, you will defend, indemnify and hold harmless Company and our respective past, present, and future employees, officers, directors, contractors, consultants, equity holders, suppliers, vendors, service providers, parent companies, subsidiaries, affiliates, agents, representatives, predecessors, successors and assigns (the "**Indemnified Parties**") from and against all claims, damages, costs and expenses (including attorneys’ fees) that arise from or relate to: (i) your use of the Software; (ii) your participation in the ThreeFold_Grid; (iii) any Feedback you provide; or (iv) your breach of this Agreement. + +Company reserves the right to exercise sole control over the defense of any claim subject to indemnification under the paragraph above, at your expense. This indemnity is in addition to, and not in lieu of, any other indemnities set forth in a written agreement between you and Company. + +If the Software becomes, or in Company’s reasonable judgment is likely to become, the subject of a claim of infringement, then Company may in its sole discretion: (a) obtain the right, for Farmer to continue using the Software; (b) provide a non-infringing functionally equivalent replacement; or (c) modify the Software so that it is no longer infringing. If Company, in its sole and reasonable judgment, determines that none of the above options are commercially reasonable, then Company may, without liability, suspend or terminate Farmer’s use of the Software. This Section 12 states Company’s sole liability and Farmer’s exclusive remedy for infringement claims. diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_13_disclaimer_limitation_liability.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_13_disclaimer_limitation_liability.md new file mode 100644 index 0000000..c03c6ed --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_13_disclaimer_limitation_liability.md @@ -0,0 +1,17 @@ +### 13. DISCLAIMER AND LIMITATION OF LIABILITY + +The Farmer hereby acknowledges the fact that he/she has been advised that TFTs may qualify as a security and that the offers and sales of TFTs have not been registered under any country’s securities laws and, therefore, cannot be resold except in compliance with the applicable country’s laws. + +The Farmer understands that the use of TFTs, the Software and/or the ThreeFold_Grid involves risks, all of which the Farmer fully and completely assumes, including, but not limited to, the risk that (i) the technology associated with the ThreeFold_Grid, 3Node and/or related Threefold products will not function as intended; (ii) the Threefold project will not be completed; (iii) Threefold will fail to attract sufficient interest from key stakeholders; and (iv) ThreeFold or any related parties may be subject to investigation and punitive actions from governmental authorities. + +Except as explicitly set forth herein, Company makes no representations that the Software is appropriate for use in any jurisdictions. Farmers engaging with the ThreeFold_Grid from any jurisdictions do so at their own risk and are responsible for compliance with local laws. + +The Farmer understands and expressly accepts that the TFTs, the Software and the ThreeFold_Grid were created and delivered to the Farmer at the sole risk of the Farmer on an "AS IS" and “UNDER DEVELOPMENT” basis. + +COMPANY DISCLAIMS ALL REPRESENTATIONS AND WARRANTIES, EXPRESS AND IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT. COMPANY MAKES NO WARRANTY THAT THE SOFTWARE, THREEFOLD GRID, OR DOCUMENTATION WILL BE UNINTERRUPTED, ACCURATE, COMPLETE, RELIABLE, CURRENT, ERROR-FREE, VIRUS FREE, OR FREE OF MALICIOUS CODE OR HARMFUL COMPONENTS, OR THAT DEFECTS WILL BE CORRECTED. COMPANY DOES NOT CONTROL, ENDORSE, SPONSOR, OR ADOPT ANY CONTENT AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND REGARDING THE CONTENT STORED ON THE THREEFOLD GRID. COMPANY HAS NO OBLIGATION TO SCREEN, MONITOR, OR EDIT CONTENT AND IS NOT RESPONSIBLE OR LIABLE FOR ANY CONTENT. YOU ACKNOWLEDGE AND AGREE THAT COMPANY HAS NO INDEMNITY, SUPPORT, SERVICE LEVEL, OR OTHER OBLIGATIONS HEREUNDER. + +The Undersigned understands and expressly acknowledges that it has not relied on any representations or warranties made by the Company, TF Tech NV, Bettertoken NV, Kristof De Spiegeleer, any person or entity involved in the development or promotion of the Software and/or the ThreeFold project, or any related parties, including, but not limited to, conversations of any kind, whether through oral or electronic communication or otherwise, or any whitepapers or other documentation. + +WITHOUT LIMITING THE GENERALITY OF THE FOREGOING, THE FARMER ASSUMES ALL RISK AND LIABILITY FOR THE RESULTS OBTAINED BY THE USE OF THE SOFTWARE, THE THREEFOLD GRID AND/OR THE THREEFOLD TOKENS AND REGARDLESS OF ANY ORAL OR WRITTEN STATEMENTS MADE BY THREEFOLD, BY WAY OF TECHNICAL ADVICE OR OTHERWISE, RELATED TO THE USE THEREOF. + +COMPANY SHALL NOT BE LIABLE FOR ANY INCIDENTAL, CONSEQUENTIAL, PUNITIVE, SPECIAL, INDIRECT, OR EXEMPLARY DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS, REVENUE, DATA, OR DATA USE, OR DAMAGE TO BUSINESS) HOWEVER CAUSED, WHETHER BY BREACH OF WARRANTY, BREACH OF CONTRACT, IN TORT (INCLUDING NEGLIGENCE) OR ANY OTHER LEGAL OR EQUITABLE CAUSE OF ACTION EVEN PREVIOUSLY ADVISED OF SUCH DAMAGES IN ADVANCE OR IF SUCH DAMAGES WERE FORESEEABLE, AND COMPANY SHALL ONLY BE LIABLE FOR DIRECT DAMAGES CAUSED BY ITS GROSS NEGLIGENCE. IN NO EVENT WILL COMPANY’S TOTAL AGGREGATE LIABILITY ARISING FROM OR RELATING TO THIS AGREEMENT EXCEED ONE HUNDRED EURO (€ 100.00). diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_14_export_compliance.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_14_export_compliance.md new file mode 100644 index 0000000..b580805 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_14_export_compliance.md @@ -0,0 +1,3 @@ +### 14. EXPORT COMPLIANCE + +The Software may be subject to export laws and regulations of the European Union, the United States and other jurisdictions. Farmer represents that it is not named on any E.U. or U.S. government denied-party list. Farmer shall not access or use the Software or the ThreeFold_Grid in a E.U. or U.S.-embargoed or any sanctioned country or region or in violation of any E.U. or U.S. export law or regulation. Farmer shall not use the ThreeFold_Grid to export, re-export, transfer, or make available, whether directly or indirectly, any regulated item or information to anyone outside the E.U. or U.S. in connection with this Agreement without first complying with all export control laws and regulations that may be imposed by the European Union, any EU country or the U.S. Government and any country or organization of nations within whose jurisdiction Farmer operates or does business. diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_15_agreement_severability_waiver.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_15_agreement_severability_waiver.md new file mode 100644 index 0000000..d0e2be8 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_15_agreement_severability_waiver.md @@ -0,0 +1,7 @@ +### 15. ENTIRE AGREEMENT,SEVERABILITY, WAIVER + +1. This Agreement sets forth the complete and final agreement of the parties concerning the subject matter hereof, and supersedes, replaces all prior agreements, written and oral, between them concerning the subject matter hereof. If a term of this Agreement to be invalid or unenforceable, the remaining provisions will continue in full force and effect. A party’s consent to, or waiver of, enforcement of this Agreement on one occasion will not be deemed a waiver of any other provision or such provision on any other occasion. +2. We reserve the right to change this Agreement from time to time in our sole discretion. If we make material changes to this Agreement, we will provide notice of such changes, such as by posting the revised Farmer Terms and Conditions to the Software and on our Websites. By continuing to access or use the Software or otherwise participate in the ThreeFold_Grid after the posted effective date of modifications to this Agreement, you agree to be bound by the revised version of this Agreement. If you do not agree to the modified Agreement, you must stop interacting with the ThreeFold_Grid and disconnect all your 3Node. +3. The parties are independent contractors. No agency, partnership, franchise, joint venture, or employment relationship is intended or created by this Agreement. Neither party has the power or authority to create or assume any obligation, or make any representations or warranties, on behalf of the other party. +4. The Farmer agrees that the Company may transfer and assign the Agreement in its sole discretion, provided a notice of such assignment is sent to the Farmer within fifteen days of such assignment. +5. Notices to Company made under this Agreement shall be made by email to legal@threefold.io AND in writing and delivered by registered mail (return receipt requested) or nationally-recognized overnight courier service to ThreeFold_Dubai, with registered office at BA1120 DMCC BUSINESS CENTRE, LEVEL NO 1, JEWELLERY & GEMPLEX 3, DUBAI, UNITED EMIRATES ARAB, attention Legal Department. You agree to receive electronically all communications, agreements, documents, notices, and disclosures that we provide in connection with the Software and/or the ThreeFold_Grid ("**Communications**"). We may provide Communications in a variety of ways, including by e-mail, text, in-app notifications, or by posting them on our websites. You agree that all Communications that we provide to you electronically satisfy any legal requirement that such communications be in writing. diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_16_governing_law_venue.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_16_governing_law_venue.md new file mode 100644 index 0000000..d9178c9 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_16_governing_law_venue.md @@ -0,0 +1,3 @@ +### 16. GOVERNING LAW AND VENUE + +This Agreement will be governed by Luxembourg law. Any disputes shall be subject to the jurisdiction of the courts of Luxembourg, Grand Duchy of Luxembourg. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_1_definitions.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_1_definitions.md new file mode 100644 index 0000000..e135276 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_1_definitions.md @@ -0,0 +1,39 @@ +### 1. DEFINITIONS + +Unless defined otherwise in this Agreement below, capitalized terms in this Agreement shall have the meaning ascribed to them in the following links for [Definitions](../definitions_legal.md). + +SPECIAL DEFINITIONS + +- THREEFOLD COMPANIES noted as (“**THREEFOLD**”, “**COMPANY**,” “**US**,” “**WE**” OR “**OUR**”) mean any of the companies as mentioned below: + - DUBAI & BVI + - THREEFOLD DMCC, TF Hub Limited + - THREEFOLD FZC (the original ThreeFold in UAE, no longer active) + - THREEFOLD LABS IT + - MAZRAA IS BRANDNAME OF THREEFOLD LABS IT + - EUROPE + - THREEFOLD VZW + - TFTECH NV BELGIUM + - BETTERTOKEN NV BELGIUM + - THREEFOLD AG +- TFCHAIN ("**TFCHAIN**") + - ThreeFold Blockchain manages the ThreeFold Grid and the 3Nodes as an autonomous piece of software. + - A DAO has been created (decentralized autonomous organization) which manages the behaviour of this Blockchain Software (upgrades & functionalities) + - Is a piece of opensource software as used by all of us together. + - TFChain has been introduces since TFGrid 3.x +- Change Request + - Change Requests can be registered on the TFChain. They are a proposal for any request for change. + - Change Requests can be used to trigger change in protocol, software update, changes in software or TFGrid specifications. + - Change Requests need to be approved by majority of Validators + - Change Requests are being introduced from TFGrid 3.x (x to be defined) +- TFChain Validators ("**VALIDATOR**") + - A Validator is a piece of software running a TFChain Blockchain Function to protect the security and sovereignity of the Blockchain. + - Each Validator has a vote to agree on changes in protocol, software updates, changes in software or TFGrid specifications. + - Each Owner / Maintainer of a Validator has to stake a certain to be defined amount of TFT before voting can happen. + - Validators are being introduced from TFGrid 3.x (x to be defined) + - Majority of Validators have to vote positively on each Change Request suggested before change can happen. + - Validators are required to let the DAO function. +- DAO + - Decentralizes Autonomous Organization + - Implemented on multiple levels, but for release 3.0.x only on level 1 which is on Substrate TFChain level. + - The DAO is the set of rules under which the decentralized organization functions. + - The DAO specifications will or are available on https://library.threefold.me (our knowledgebase) diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_2_farmer_services.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_2_farmer_services.md new file mode 100644 index 0000000..8c1f0a7 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_2_farmer_services.md @@ -0,0 +1,10 @@ +### 2. FARMER SERVICES + +The Farmer may provide IT Capacity on the ThreeFold_Grid (the "**Farmer Services**") pursuant to the terms hereof during the Term of this Agreement. The Farmer Services include the features and functionality applicable to the version of the TF Operating System (Zero OS) installed by the Farmer and TF Blockchain Software (together also referred to as the “**Software**”). Company may update the content, functionality, and user interface of the Farmer Services from time to time in its sole discretion. + +By entering into this Agreement you receive a non-exclusive, non-sublicensable, non-transferable right to provide the Farmer Services pursuant to this Agreement during the Term hereof solely for your internal business purposes subject to the limitations set forth herein. + +The Software consists of open source code and is made available to you pursuant to the terms of the open-source license agreement(s) as located on https://github.com/threefoldtech and https://github.com/threefoldfoundation (the "**Open Source License(s)**"). Your use of the Software or any other Content (Information) is conditioned upon your compliance at all times with the terms of all applicable Open Source License(s). [Example license for Zero-OS can be found here](https://github.com/threefoldtech/zos/blob/main/LICENSE). + +Including without limitation all provisions governing access to source code, modification, and/or reverse engineering. You are responsible for complying with any applicable documentation, meaning any information that describes the ThreeFold_Grid, provides instructions or recommendations related to the configuration and/or use of the ThreeFold_Grid, or otherwise informs Users of the intended use of the ThreeFold_Grid, including, but not limited to content provided directly to User or published at [https://library.threefold.me](https://library.threefold.me), [https://library.threefold.me](https://library.threefold.me), [https://forum.threefold.io](https://forum.threefold.io) or otherwise made available in conjunction with the ThreeFold_Grid, the ThreeFold_Token or the Software (“**Documentation**”) and for satisfying all technical requirements of the Software, including any requirements set forth in the Documentation for ensuring that the Software performs properly. + diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_3_farmer_grant.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_3_farmer_grant.md new file mode 100644 index 0000000..0a4a093 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_3_farmer_grant.md @@ -0,0 +1,9 @@ +### 3. FARMER GRANT OF RIGHT TO IT CAPACITY + +By making available one or more computers, network or storage devices ("**3Nodes**") and connecting such 3Nodes to the TF Grid via the Software, you hereby grant to Company, TFChain and Users the irrevocable right to access and use the 3Nodes as follows: + +- to use storage, compute and network services as delivered by your 3Node(s) +- to store data and materials by Users on your 3Node(s) (the "**Content**") and to access such Content from your 3Node(s) at any time + +in accordance with the capabilities of the software installed on the 3Nodes; + diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_4_certified_vs_diy.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_4_certified_vs_diy.md new file mode 100644 index 0000000..30cac6c --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_4_certified_vs_diy.md @@ -0,0 +1,19 @@ +### 4. CERTIFIED VS. DIY-FARMERS + +There are two types of ThreeFold Farmers: + +1. Certified Farmer: Uses hardware from certified sources and signs a contract with TF Tech NV for support and additional benefits +2. Do It Yourself (DIY) Farmer: Uses any hardware and in case of support uses online material only. + +Farmers can opt in for certification ("**Certification**"). Certification can be withdrawn in case the relevant 3Node does no longer comply with the applicable certification requirements. + +The following criteria or requirements are checked (timing of implementation, see roadmap on wiki): + +- Bandwidth: 24 times a day random non local nodes are used to upload a 2MB file to a 3Node. The bandwidth will be measured in mbit/sec +- Utilization: Through the ThreeFold Explorer the true utilization of the 3Node will be checked. It will be displayed in % of the 3Node total capacity. +- Uptime: The uptime per month will be created in the ThreeFold Explorer and is presented as a percentage of 3Node availability. + +ThreeFold Foundation or TFTech may give free certification to 3Nodes that benefit the distribution of capacity on the ThreeFold_Grid. + +ThreeFold Foundation or TFTech may also certify certain hardware partners (i.e. certified hardware vendors) as part of this certification process. + diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_5_farmer_responsibilities.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_5_farmer_responsibilities.md new file mode 100644 index 0000000..7d081a2 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_5_farmer_responsibilities.md @@ -0,0 +1,15 @@ +### 5. FARMER RESPONSIBILITIES + +At all times during the Term of this Agreement or the period when Content is maintained in your 3Node, whichever is longer: + +1. You will comply with the terms of this Agreement, the [Generic Disclaimer](../disclaimer.md), [ThreeFold Website Terms](./terms_conditions_websites.md) and [Privacy Policy](../privacypolicy.md) and any other terms and conditions required by in connection herewith, the Open Source Licenses, and the terms of all other agreements to which you are a party in connection with your performance under this Agreement including, without limitation, any agreement you have with a third-party Internet service provider. +2. You will operate the 3Node in strict compliance with terms of this Agreement and any applicable laws or regulations, and will not take any action not expressly authorized hereunder. +3. Without prejudice to your rights under any applicable Open Source license, you will not modify or attempt to modify the Software for any purpose including but not limited to attempting to circumvent the audit, bypass security, manipulate the performance of, or otherwise disrupt the ThreeFold_Grid for any reason, including but not limited to attempting to increase the amount of data stored or bandwidth utilized or the amount of Farmed TFTs, as defined herein, and you will not otherwise interfere with the operation of the ThreeFold_Grid. +4. You will provide and maintain the 3Node so that, at all times, it will meet the minimum requirements set out for either pre configured servers (‘certified hardware’) or ‘do-it-yourself’ servers. [Read more here](../../../documentation/farmers/farmers.md). +5. You will implement and maintain adequate administrative, organizational, physical and technical safeguards to ensure the protection, confidentiality, security, and integrity of the 3Node and Content and shall take all reasonable steps to ensure that Content are not disclosed, accessed, used, modified, or distributed except as expressly authorized under this Agreement. +6. You acknowledge and agree that by running the Software on your hardware device and allowing IT Capacity to be made available on the TF Grid to the Users and TFCHAIN, you may act as a cloud service provider under certain circumstances and as such qualify as a processor or sub-processor under the General Data Processing Directive (Regulation (EU) 2016/679 of the European Parliament and of the Council of 27 April 2016 on the protection of natural persons with regard to the processing of personal data and on the free movement of such data, and repealing Directive 95/46/EC) (‘GDPR’). You undertake to comply with any legal obligations which may possibly be applicable to you as a data processor under the GDPR and/or any other applicable data privacy regulations. +7. You acknowledge and agree that by running the Software on your hardware device and allowing IT Capacity to be made available on the TF Grid to the Users, your 3Node may be impacted due to additional constraints being placed on it by the Software and the processing of Content. In particular, but without limiting the generality of the foregoing, your 3Node may not operate as quickly as it would without running the Software and making IT Capacity available for use by Users. +8. In connection with your use of the Software and/or operation of a 3Node hereunder, Company may, provide updates to the software which will be automatically provided and installed. You acknowledge that these updates are done automatically on your 3node or any other web site or portal and you don't have the ability to confirm such an update. This update mechanism might be revisited at the end of 2020 and will be communicated accordingly. These updates need to be done automatically for now, because ThreeFold_Grid consists out of many components which are depending on each other and need the right version to be installed. +9. In connection with your use of the Software and/or operation of a 3Node hereunder, Company may, from time to time, require you to affirm and/or reaffirm your agreement to the terms of this Agreement, and in such case, your continued use of the Software is contingent upon your promptly providing such affirmation as requested by Company. +10. You, as the Famer, acknowledge that you retain administrative and/or physical control over to whom you grant access to the applicable 3Node. You are responsible for maintaining the physical security of the 3Node +11. Company may suspend Famer’s participation in the ThreeFold_Grid if Company believes the Farmer to be: (a) violating any term of this Agreement; or (b) using the ThreeFold_Grid in a manner that Company reasonably believes may cause a security risk, a disruption to the ThreeFold_Grid, or liability for Company or any persons involved in the ThreeFold Open Source project. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_6_restrictions.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_6_restrictions.md new file mode 100644 index 0000000..d37d47b --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_6_restrictions.md @@ -0,0 +1,13 @@ +### 6. RESTRICTIONS + +You will operate the 3Node in strict accordance with the terms of this Agreement and in no other manner. Without limiting the generality of the foregoing, you will not: + +1. access or use the ThreeFold_Grid: (i) in violation of applicable laws; or (ii) in a manner that interferes with or disrupts the integrity or performance of the ThreeFold_Grid (or the data contained therein). +2. with respect to Content (i) reverse engineer any aspect of the Content or do anything that might discover the contents or origin of the Content, (ii) attempt to bypass or circumvent measures employed to prevent or limit access to the Content, including by attempting to defeat any encryption, or (iii) attempt to interfere with the storage or transmission of Content or with our audits of your 3Node(s); +3. manipulate or otherwise attempt to bypass, change, or update any values related to uptime detection outside the programmatic operation of the Software; +4. deliberately or actively limit or otherwise negatively impact download speed such that insufficient bandwidth is available for required audit traffic; +5. manipulate or alter the default behavior of the ThreeFold_Grid to artificially increase or decrease the value of any reputation factor of any 3Node; +6. manipulate network responses to any request with unauthorized intent to change the cryptographic signatures, NodeID, or TFT wallet address; +7. attempt to manipulate or falsify the identification of the 3Node by the Software or otherwise bypass the proof of capacity process; +8. retain any Content after the earlier of termination of this Agreement or de-certification of the applicable 3Node at any time; or +9. in any other way attempt to interfere, impede, alter, or otherwise interact in any manner not expressly authorized hereunder with the ThreeFold_Grid or the operation of any other 3Node(s). diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_7_representations_and_warranties.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_7_representations_and_warranties.md new file mode 100644 index 0000000..bff2d65 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_7_representations_and_warranties.md @@ -0,0 +1,9 @@ +### 7. REPRESENTATIONS AND WARRANTIES + +You hereby represent, warrant, and covenant that: + +1. You own or control your 3Node(s), and have the right to install the Software on your 3Node(s) and share IT Capacity pursuant to this Agreement, and otherwise comply with all of your obligations under this Agreement and/or applicable laws; +2. You represent and warrant that you are authorized to receive ThreeFold_Tokens (TFT) as a remuneration from Users for the usage of your IT Capacity on the ThreeFold_Grid as set forth in this Agreement; +3. You have full power and authority to enter into this Agreement and comply with all terms hereof, and that doing so will not conflict with any obligation you may owe to any third party; +4. You have the qualifications, skill, and ability to perform your obligations hereunder without the advice, control, or supervision of Company; and +5. You will at all times comply with all applicable foreign, federal, state, and local laws, orders, rules, and regulations currently in effect or that may come into effect during the term of this Agreement, including but not limited to those regarding data privacy and protection. diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_8_capacity_measurement_minting.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_8_capacity_measurement_minting.md new file mode 100644 index 0000000..a61d2f6 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_8_capacity_measurement_minting.md @@ -0,0 +1,52 @@ +### 8. TFT Minting (Token Creation ‘FARMING of capacity’) TFGrid 2.x + +#### 8.1 General Principle + +Farmers who connect 3Nodes on an ongoing basis to the ThreeFold_Grid by running the Software and making IT Capacity available to the Users, get rewarded by receiving ThreeFold_Tokens (TFTs) which are generated by the Software. TFTs are exclusively issued (created) by the TF Chain for each active Capacity Pool which gets and remains connected to the ThreeFold_Grid. Such issuance of TFTs that results from connecting a 3Node to the ThreeFold_Grid and making IT Capacity available on a global scale to Users is called "**Farming**". + +#### 8.2 Calculation of Farmed TFTs + +The details of farming (minting of TFT’s) are described on our farming logic TFGrid 2 and this location serves as master for the TFT Reward Process. + +The wiki is version controlled (on github), so all changes can be followed.All connected IT Capacity gets registered on the TF Chain, i.e. ThreeFolds blockchain software. Each month the TF Chain issues new TFTs and transfers them to Farmers in respect of each 3Node that remained connected to the ThreeFold_Grid during the preceding month, using the following calculation in respect of each 3Node: + +![farmer_tcs_minting_equation](img/farmer_tcs_minting_equation.jpg) + +The concepts of CPR, CPR Price and Difficulty Level are determined in the aforementioned wiki and are incorporated into this Agreement by reference. + +The amount of TFTs that are Farmed hence depends on three variables: + +_1. Proof-of-Capacity_ + +The specs of the Farmer’s relevant 3Node: + +- Compute Capacity (CPU) = CRU +- Memory Capacity (RAM) = MRU +- Storage Capacity (SSD/HDD) = SRU/HRU + +The performance/capability of this hardware is attributed with Cloud Units that then summarized to a Cloud Production Rate (CPR) (as further described in the abovementioned wiki) for the relevant 3Node. The higher the CPR, the more TFTs are Farmed. + +_2. Difficulty Level_ + +The amount of ThreeFold_Tokens (TFTs) that Farmers receive for Farming also depends on the amount of TFTs that are already in circulation. The more TFTs already exist, the lower the rewards. This follows the principle of diminishing returns. We call this Farming limitation to reward the "**Difficulty Level**". + +When the amount of existing TFT nears 4 billion, the amount of TFTs received by Farmers will decrease progressively. Once the aggregate amount of "Farmed" TFTs reaches four billion ThreeFold_Tokens (4,000,000,000 TFTs), there won’t be any rewards for Farming anymore and no new TFTs will be generated by the Software. + +The Difficulty Level is the same for all Farmers at a certain point in time. + +_3. Certification_ + +When connecting reliable hardware the Farmer can request a certification from TF Tech NV which leads to increased earnings in TFT for such ‘Certified Farmers’. We automatically measure uptime, bandwidth and the utilization of the node for this certification. The details of this certification have to be further defined and will be set out on our wiki. + +#### 8.3 Uptime + +In addition thereto, the Company will determine in its sole discretion the reasonable uptime that each 3Node of the Farmer needs to to achieve when they register their 3Node(s) in the TF Chain. ThreeFold expects most 3Nodes to achieve an uptime of more than 98%, commercial providers can go as high as 99.9%. The TF Chain will only issue TFTs if the IT Capacity was connected to the internet and was usable during the last month at least up to the specified uptime guarantee. + +#### 8.4 Taxes + +You will be solely responsible for payment of all applicable taxes (if any) associated with your Farming of ThreeFold_Tokens (TFTA, TFT), including but not limited to value added taxes, taxes on gross receipts and income, Social Security taxes, business license fees and other payment obligations applicable to your business. + +#### 8.5 Modification + +The Company reserves the right to modify the terms of this section 8 (‘_Capacity Measurement and Minting - ‘Farming’_) at any time, including but not limited to the determination of the Difficulty Level. Such amendments will be subject to the approval of a majority of the members of the Company’s ‘Grid Counsel’ and a majority of the Farmers (whereby majority is measured based on nr of 3Nodes a Farmer has, each 3Node entitles the Farmer to one vote, Farmers who do not vote have no say in the decision process) who participate in an online poll organized by the Company In case of modification to these terms, the Company shall inform the Farmer at least one month in advance. In case the Farmer would not agree to such modifications, the Farmer shall have the right to immediately and unilaterally terminate this Agreement by disconnecting the Farming Pool from the ThreeFold_Grid. + diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_8_capacity_measurement_minting3.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_8_capacity_measurement_minting3.md new file mode 100644 index 0000000..b4bc8b9 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_8_capacity_measurement_minting3.md @@ -0,0 +1,55 @@ +### 8. TFT Minting (Token Creation ‘FARMING of capacity’) For TFGrid 3.x + +#### 8.1 General Principle + +Farmers who connect 3Nodes on an ongoing basis to the ThreeFold_Grid by running the Software and making IT Capacity available to the Users, get rewarded by receiving ThreeFold tokens (TFTs) which are generated by the Software. TFTs are exclusively issued (created) by the TFChain for each active Capacity Pool which gets and remains connected to the ThreeFold_Grid. Such issuance of TFTs that results from connecting a 3Node to the ThreeFold_Grid and making IT Capacity available on a global scale to Users is called "**Farming**". + +#### 8.2 Calculation of Farmed TFTs + +The details of farming (minting of TFT’s) are described on our [farming logic](../../farming/farming_reward.md) and this location serves as master for the TFT Reward Process. The wiki is version controlled (on github), so all changes can be followed.All connected IT Capacity gets registered on the TFChain, i.e. ThreeFolds blockchain software. Each month the TFChain issues new TFTs and transfers them to Farmers in respect of each 3Node that remained connected to the ThreeFold_Grid during the preceding month, using the following calculation in respect of each 3Node: + + +The amount of TFTs that are Farmed hence depends on three variables: + +_1. Proof-of-Capacity_ + +The specs of the Farmer’s relevant 3Node: + +- Compute Capacity (CPU) = CRU +- Memory Capacity (RAM) = MRU +- Storage Capacity (SSD/HDD) = SRU/HRU + +_2. PRICE OF TFT = THREEFOLD TOKEN_ + +The Price of TFT is registered at point of connection or an averaged out period. + +Each farmer needs to register their TFT farming account in the TF Explorer through the TF Chain (see manual). + +_3. Certification_ + +When connecting reliable hardware the Farmer can request a certification from TF Tech NV which leads to increased earnings in TFT for such ‘Certified Farmers’. We automatically measure uptime, bandwidth and the utilization of the node for this certification. The details of this certification have to be further defined and will be set out on our wiki. + +The specific way how farming rewards are calculated is specified on: + +- [Farming Reward](../../farming/farming_reward.md) +- [Proof-of-Capacity](../../farming/proof_of_capacity.md) + + +#### 8.3 Uptime + +In addition thereto, the Company will determine in its sole discretion the reasonable uptime that each 3Node of the Farmer needs to to achieve when they register their 3Node(s) in the TFChain. ThreeFold expects most 3Nodes to achieve an uptime of more than 98%, commercial providers can go as high as 99.9%. The TFChain will only issue TFTs if the IT Capacity was connected to the internet and was usable during the last month at least up to the specified uptime guarantee. + +#### 8.4 Taxes + +You will be solely responsible for payment of all applicable taxes (if any) associated with your Farming of ThreeFold tokens (TFTA, TFT), including but not limited to value added taxes, taxes on gross receipts and income, Social Security taxes, business license fees and other payment obligations applicable to your business. + +#### 8.5 Modification + +The Company reserves the right to modify the terms of this section 8 (‘_Capacity Measurement and Minting - ‘Farming’_) at any time. Such amendments will be subject to the approval of the majority of the Farmers (whereby majority is measured based on nr of 3Nodes a Farmer has, each 3Node entitles the Farmer to one vote, Farmers who do not vote have no say in the decision process) who participate in an online poll organized by the Company or the DAO. + +In case of modification to these terms, the Company or DAO shall inform the Farmer at least one month in advance. In case the Farmer would not agree to such modifications, the Farmer shall have the right to immediately and unilaterally terminate this Agreement by disconnecting the Farming Pool from the ThreeFold_Grid. + +The TFChain and TFGrid capabilities & specifications can change over time after getting consensus from the DAO . +The specific requirements and workings of the DAO are or will be publised on our wikisystem: [https://library.threefold.me](https://library.threefold.me). + +If the DAO (by means of X nr of members of the Community) agree on a change of the protocol used or specifications for the Software or TFGrid then the Validators can allow and execute an upgrade of the system (TFChain as well as ZERO-OS software). Farmers and Users accept changes introduced this way, they accept that any of above mentioned variables can be changed that way. diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_9_capacity_utilization.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_9_capacity_utilization.md new file mode 100644 index 0000000..1a2373c --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_9_capacity_utilization.md @@ -0,0 +1,60 @@ +### 9. CAPACITY SALES (‘UTILIZATION’) = TFGrid 2.X + +#### 9.1 General Principles + +Users (such as developers or other persons requiring IT Capacity) can rent IT Capacity from the ThreeFold_Grid in exchange for ThreeFold_Tokens (TFTs), which creates a natural economic demand. We call this process of selling IT Capacity on the ThreeFold_Grid "**Utilization**". + +ThreeFold_Tokens (TFTs) are used to buy or sell IT Capacity as delivered by the Capacity Pools on the ThreeFold_Grid. In order to do so, the Farmer shall sell the IT Capacity produced on the ThreeFold_Grid via the "**ThreeFold Directory**" (or “TF Directory”). The TF Directory acts like a ‘marketplace’ for selling IT Capacity generated by the Farmer’s 3Nodes. The TF Directory has been implmented by a tool called TF Explorer see http://explorer.grid.tf + +In order to access the TF Directory and sell IT Capacity on the ThreeFold_Grid, the TF Grid user or Solution Provider offering services on the TFGrid must deploy a virtual system administrator, called the "**3Bot**". This 3bot is used, amongst others, to sell and buy IT Capacity (raw storage and compute resources) on the ThreeFold_Grid. + +The reservation and use of the Farmer’s IT Capacity by the User is effected through "Smart Contracts for IT". The Smart Contract for IT will then be executed automatically by the software code and the requested IT workload will be deployed. The TF Explorer calculates the required TFT Token price and makes sure that the TF Farmer receives their cultivated tokens. + +#### 9.2 Utilization Mechanism + +IT capacity is expressed in compute & storage units. + +- CU = [Compute Units](../../cloud/cloudunits.md) +- SU = [Storage Units](../../cloud/cloudunits.md) + +The pricing is expressed as follows: + +- CP = Compute Unit price - expressed in USD +- SP = Storage Unit price - expressed in USD + +- T = Token price in USD at time of capacity reservation + +Certified Farmers are free to determine the pricing of their IT Capacity. DIY (Do It Yourself) farmers have to rely on the TF Foundation to set the price of the CU and SU. +TF Foundation will do this with all best intentions in mind. + +The IT capacity is sold through the TF Explorer using the smart contract for IT concept. TF Explorer is the inventory of all IT capacity available for consumption on the ThreeFold_Grid. See http://explorer.grid.tf/ + +Each farmer needs to register their TFT wallet in the TF Explorer and the certified farmers can register the price for the CU/SU on the TF Exlorer as well by using their farming 3bot. + +> Utilization in TFT = (CU _ CP + SU _ SP) / T \* 0.9 + +Utilization in TFT are the TFT (Tokens) the Farmer receives when capacity has been sold as result of provisioning the IT workload by means of the IT smart contract concept. + +As a result of executing the IT smart contract, 90% of the proceeds (in TFT) of the capacity sold is send to the wallet of the Farmer, 10% is send to the TF Foundation Wallet, this is an automatic action. + +#### 9.3 TF Foundation Fee and License Fees TFTech + +The Company (the "**Foundation Fee**") receives 10% of sales done of Cloud Units on the TF Explorer (as described above). The Company will use the revenues from the Foundation Fees to fund its projects and objectives, including, amongst others, to promote, maintain and expand the ThreeFold_Grid. The Company might also decide to burn part of those tokens (TFT) to lower the total amount of tokens in the field (burning means, destroy tokens). + +In case the Farmer chooses to purchase a license from TF Tech NV in order to qualify as a Certified Farmer and provide Certified Capacity on the ThreeFold_Grid, the Farmer shall pay the relevant fee (as agreed between the Farmer and TF Tech NV directly) to TF Tech NV (the "**Certification License Fee**"). + +#### 9.4 Taxes + +You (The Farmer) will be responsible for payment of all applicable taxes (if any) associated with your Utilization of ThreeFold_Tokens (i.e. sale of IT Capacity), including but not limited to value added taxes, sales taxes, custom taxes, and taxes on gross receipts and income. + +The Farmer shall seek all necessary tax advice in order to comply with any applicable tax regulations when providing IT Capacity to Users on the ThreeFold_Grid. By way of example, the Farmer acknowledges that within the European Union, as from 1 January 2015, telecommunications, broadcasting and electronically supplied services are always taxed in the country of the customer (i.e. the tax residence of the User) – regardless of whether the User is a business or a consumer. + +In view thereof, the Farmer will determine the applicable Farmer’s Compute Unit Price and Storage unit Price (as referred to in section 9.2 above) taking into account any aforementioned taxes that may apply. ThreeFold will not be held liable for the Farmer’s failure to comply with its legal obligations, including but not limited to its obligation to pay any applicable taxes, and the Farmer will indemnify and hold harmless the Company for claims against the Company from any tax authorities in respect of such non-compliance by the Farmer. + +#### 9.5 Modification + +The Company reserves the right to modify the terms of this section 9 (‘_Capacity Sales - ‘Utilization’_’) at any time, including but not limited to the determination of the Foundation Fee. In case of modification to these terms, the Company shall inform the Farmer at least one month in advance. In case the Farmer would not agree to such modifications, the Farmer shall have the right to immediately and unilaterally terminate this Agreement by disconnecting the Farming Pool from the ThreeFold_Grid. + +#### 9.6 Breach + +In addition to its other rights and remedies under this Agreement, the Farmer forfeit any right to compensation under this Agreement if Farmer breaches any terms thereof. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_9_capacity_utilization3.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_9_capacity_utilization3.md new file mode 100644 index 0000000..2c209f3 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_farmer_parts/part_9_capacity_utilization3.md @@ -0,0 +1,53 @@ +### 9. CAPACITY UTILIZATION (‘UTILIZATION’) FOR TFGRID 3.X + +#### 9.1 General Principles + +Users (such as developers or other persons requiring IT Capacity) can use IT Capacity from the ThreeFold_Grid in exchange for ThreeFold_Tokens (TFTs), which creates a natural economic demand. We call this process of using IT Capacity on the ThreeFold_Grid "**Utilization**". + +ThreeFold_Tokens (TFTs) are used to buy IT Capacity as delivered by the 3Nodes (by a process called Farming) on the ThreeFold_Grid. The capacity can be consulted by means of a tool called TF Explorer see http://explorer.grid.tf. + +#### 9.2 Utilization Mechanism + +IT capacity is expressed in [network, compute & storage units](../../cloud/cloudunits.md). + +- CU = Compute Units +- SU = Storage Units +- NU = Network Units + +TF Explorer is the inventory of all IT capacity available for consumption on the ThreeFold_Grid. See http://explorer.grid.tf/ + +TFT received for people using capacity is disributed as follows: + +| Percentage | Description | Remark | +| ---------- | -------------------------------------- | ------------------------------------------------------------------------ | +| 35% | needs to be burned | results in more TFT burned compared to generated once grid more mature. | +| 10% | to TF Foundation | used to promote the manage the project. | +| 5% | to Staking Pool for TF Validators | used to reward the people who run the TFChain 3.0 blockchain validators. | +| 50% | for solution providers & sales channel | managed by [ThreeFold DAO](../../about/dao/dao.md). | + +The single source of truth for Utilization specifications is available [here](../../farming/proof_of_utilization.md). + + +#### 9.4 Taxes + +You (The Farmer) will be responsible for payment of all applicable taxes (if any) associated with your Utilization of ThreeFold_Tokens (i.e. sale of IT Capacity), including but not limited to value added taxes, sales taxes, custom taxes, and taxes on gross receipts and income. + +The Farmer shall seek all necessary tax advice in order to comply with any applicable tax regulations when providing IT Capacity to Users on the ThreeFold_Grid. By way of example, the Farmer acknowledges that within the European Union, as from 1 January 2015, telecommunications, broadcasting and electronically supplied services are always taxed in the country of the customer (i.e. the tax residence of the User) – regardless of whether the User is a business or a consumer. + +In view thereof, the Farmer will determine the applicable Farmer’s Compute Unit Price and Storage unit Price (as referred to in section 9.2 above) taking into account any aforementioned taxes that may apply. ThreeFold will not be held liable for the Farmer’s failure to comply with its legal obligations, including but not limited to its obligation to pay any applicable taxes, and the Farmer will indemnify and hold harmless the Company for claims against the Company from any tax authorities in respect of such non-compliance by the Farmer. + +#### 9.5 Modification + +The Company reserves the right to modify the terms of this section 9 (‘_CAPACITY UTILIZATION (‘UTILIZATION’)_) at any time. Such amendments will be subject to the approval of the TFChain Validators who protect the TFChain (Substrate based chain on Level 1) through our DAO. + +In case of modification to these terms, the Company or DAO shall inform the Farmers and Community at least one month in advance by means of forum or chat or other mechanism. In case the Farmer would not agree to such modifications, the Farmer shall have the right to immediately and unilaterally terminate this Agreement by disconnecting the Farming Pool from the ThreeFold_Grid. + +The TFChain and TFGrid capabilities & specifications can change over time after getting consensus from the DAO . +The specific requirements and workings of the DAO are or will be publised on our wikisystem: https://library.threefold.me + +If the DAO (by means of X nr of members of the Community or Validators) agree on a change of the protocol used or specifications for the Software or TFGrid then the Validators can allow and execute an upgrade of the system (TFChain as well as ZERO-OS software). Farmers and Users accept changes introduced this way, they accept that any of above mentioned variables can be changed that way. + + +#### 9.6 Breach + +In addition to its other rights and remedies under this Agreement, the Farmer forfeit any right to compensation under this Agreement if Farmer breaches any terms thereof. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_griduser.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_griduser.md new file mode 100644 index 0000000..3de562f --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_griduser.md @@ -0,0 +1,240 @@ +**USER TERMS AND CONDITIONS** + +{{#include ./sub/parties_threefold.md}} +, governing your usage of the ThreeFold software and related products (the “**TF Products**”), including but not limited to: + +- The ThreeFold software and technologies (the "**Software**"), including: + - "**Zero OS**", a stateless operating system which enables distributed hardware to form the ThreeFold_Grid which generates IT Capacity (storage and compute capacity) + - "**Zero Chain**", the blockchain framework + - and any other related software components which are referenced in github under [https://github.com/threefoldtech](https://github.com/threefoldtech) and [https://github.com/threefoldfoundation](https://github.com/threefoldfoundation) +- Threefold applications (including the ThreeFold Connect app) +- ThreeFold Tokens (TFTs) +- The TFGrid and any related products. + +The terms of your interaction with the websites, social networks or online communication channels maintained by the Company (including but not limited to the posting or publishing of content, information or promotional materials) shall be governed by the ‘Terms of Service’ referred to on [www.threefold.io](https://www.threefold.io), which are incorporated herein by reference. + +The IT Capacity services provided by Farmers on the ThreeFold_Grid are governed by the present Agreement, but may be supplemented by additional terms agreed between the relevant Farmer and the User governing their delivery, access and use of the IT Capacity through the ThreeFold_Grid. This supplementation shall not extend the liability of ThreeFold. + +You understand and agree that by accepting the terms of this Agreement, either by clicking to signify acceptance, or by taking any one or more of the following actions downloading, installing, running,/and or using the applicable TF Products, you agree to be bound by the terms of this Agreement effective as of the date that you take the earliest of one of the foregoing actions. You represent and warrant that you are 18 years old or older and have the right and authority to enter into and comply with the terms of this Agreement. + +{{#include ./terms_conditions_farmer_parts/part_1_definitions.md}} + +### 2. USE OF TF PRODUCTS + +By entering into this Agreement you receive a non-exclusive, non-sublicenseable, non-transferable right to use the TF Products pursuant to this Agreement during the Term hereof solely for your internal business purposes subject to the limitations set forth herein. + +You acknowledge that the Software consists of open source code which is made available to you pursuant to the terms of the relevant open-source license agreement(s) as specified in github under [https://github.com/threefoldtech](https://github.com/threefoldtech) and [https://github.com/threefoldfoundation](https://github.com/threefoldfoundation) (the "**Open Source License(s)**"). Your use of the Software and the TF Products is conditioned upon your compliance at all times with the terms of all applicable Open Source License(s), including without limitation all provisions governing access to source code, modification, and/or reverse engineering. You are responsible for complying with any applicable documentation, meaning any information that describes the TF Products, provides instructions or recommendations related to the configuration and/or use of the TF Products, or otherwise informs Users of their intended use, including, but not limited to content provided directly to User or published at or otherwise made available in conjunction with the ThreeFold_Grid, the ThreeFold_Token or the Software (“**Documentation**”) and for satisfying all technical requirements of the TF Products, including any requirements set forth in the Documentation for ensuring that the TF Products perform properly. + +### 3. FARMER GRANT OF RIGHT TO FARMING POOL + +By making available one or more computers, network or storage devices ("**3Nodes**") and connecting such 3Nodes to the TF Grid (as part of a Farming Pool) via the Software, you hereby grant to Company and Users the irrevocable right to access and use the 3Nodes as follows: + +- to use storage, compute and network services as delivered by your 3Node(s) +- to store data and materials by Users on your 3Node(s) (the "**Content**") and to access such Content from your 3Node(s) at any time + +in accordance with the capabilities of the software installed on the 3Nodes; + +### 4. REGISTRATION TO THE THREEFOLD CONNECT (FORMERLY 3BOT CONNECT) APPLICATION + +In order to access certain TF Products you will be required to install the ThreeFold Connect application on your device and register your account in this ThreeFold Connect application by creating a username and password. You agree to provide us with accurate, complete, and current registration information about yourself. It is your responsibility to ensure that your password remains confidential and secure. By registering, you agree that you are fully responsible for all activities that occur under your user name and password. We may assume that any communications we receive under your account have been made by you. If you are a billing owner, an administrator, or if you have confirmed in writing that you have the authority to make decisions on behalf of a User ("**3Bot Administrator**"), you represent and warrant that you are authorized to make decisions on behalf of the User and agree that ThreeFold is entitled to rely on your instructions. + +You are responsible for notifying us at legal@threefold.io if you become aware of any unauthorized use of or access to your 3Bot account. You understand and agree that we may require you to provide information that may be used to confirm your identity and help ensure the security of your account. ThreeFold will not be liable for any loss, damages, liability, expenses or attorneys’ fees that you may incur as a result of someone else using your password or account, either with or without your knowledge and/or authorization, and regardless of whether you have or have not advised us of such unauthorized use. You will be liable for losses, damages, liability, expenses and attorneys’ fees incurred by ThreeFold or a third party due to someone else using your account. In the event that the 3Bot Administrator or User loses access to an account or otherwise requests information about an account, ThreeFold reserves the right to request from the 3Bot Administrator or User any verification it deems necessary before restoring access to or providing information about such account in its sole discretion. + +### 5. USE OF THREEFOLD TOKENS + +ThreeFold_Tokens (TFTs) are a digital token used to buy autonomous and decentralized IT Capacity (compute, storage, network, IT services, applications) on the ThreeFold_Grid. TFTs have a specific commercial utility, since ThreeFold_Tokens were conceived as the designated currency for buying and selling IT Capacity on the ThreeFold_Grid. + +TFTs are exclusively generated through a process called Farming, which means that TFTs are created only when new IT Capacity is added to the ThreeFold_Grid. TFTs are registered on a blockchain which is part of the Stellar Network ([https://stellar.org](https://stellar.org/)), Binance Smart Chain, a Cosmos Chain or our own TFChain. + +The first batch of TFTs that got registered in the blockchain consists of the ‘Genesis Block’ of 685 million TFTs that were Farmed by or on behalf of the Company using an initial Farming Pool, also known as the Genesis Pool. + +Two versions of ThreeFold_Tokens have been issued: + +- A first version of the ThreeFold_Token was issued as from March 2018 on ThreeFolds initial blockchain called Rivine. These TFTs are also referred to as "TFTv1" or “TFTA”. These tokens have now been migrated to the Stellar blockchain. +- A second version of the ThreeFold_Token was issued as from May 2020 on the Stellar blockchain. These TFTs are also referred to as "TFTv2". This token is available on multiple blockchains, the total amount of tokens farmed is the same independent of blockchain used, TFBridges are used to migrate TFTs between blockchain technology. + +While the original TFTv1 kept all same properties and benefits, they are now called TFTA on the Stellar blockchain. Since the creation of the TFTv2, TFTA’s have become ThreeFolds voluntary staking pool of Tokens, which means these TFTs can only be used to buy IT Capacity and cannot be traded otherwise. However any User can convert TFTA’s into TFTs (i.e. TFTv2) by implementing a few simple migration steps which can be found [here](./tfta_to_tft.md). Once converted, any TFT’s can be traded or transferred by various means as the User deems fit, as further explain [here](../../../documentation/threefold_token/buy_sell_tft/buy_sell_tft.md). + +The TF Foundation has chosen to use multiple blockchain technology for storing and managing the TFT. You can use any wallet that supports the chosen blockchain, including but not limited to the wallet included in the ThreeFold Connect app. + +Your use of the TF Products and/or TFTs constitutes your acknowledgement of the aforementioned general principles relating to the ThreeFold_Tokens. As a User you furthermore acknowledge that: + +- each TFT constitutes a value of exchange on the ThreeFold_Grid; +- you have been advised that the ThreeFold_Tokens are the result of farming which means a Farmer connects IT Capacity to the ThreeFold_Grid; +- as such the TFTs have not been registered under any country’s securities laws; +- TFTs are neither securities nor an investment instrument; and +- the purchase, creation or use of TFTs involve risks, all of which the User fully and completely assumes by entering into this Agreement. + +### 6. MODIFICATIONS TO THE TF PRODUCTS + +We reserve the right, in our sole discretion, to modify or discontinue, temporarily or permanently, any TF Products (or any features or functionality thereof) at any time without notice and without obligation or liability to you. You agree that ThreeFold shall not be liable to you or any third party for any modification, suspension, or discontinuance of the TF Products or related services. + +### 7. USER RESPONSIBILITIES + +At all times during the Term of this Agreement or the period when you use any TF Products, your Content is maintained in a 3Node or TFTs are maintained in a wallet address of which you hold the private keys, whichever is longer: + +1. You will comply with the terms of this Agreement and the [Privacy Policy](../privacypolicy.md) and any other terms and conditions required by in connection herewith, the Open Source Licenses, and the terms of all other agreements to which you are a party in connection with your performance under this Agreement including, without limitation, any agreement you have with a third-party service provider. +2. You will use and operate the TF Products in strict compliance with terms of this Agreement and any applicable laws or regulations, and you will not take any action not expressly authorized hereunder. +3. Without prejudice to your rights under any applicable Open Source license, you will not modify or attempt to modify the TF Products for any purpose including but not limited to attempting to circumvent the audit, bypass security, manipulate the performance of, or otherwise disrupt the TF Products for any reason, including but not limited to attempting to increase the amount of data stored or bandwidth utilized, as defined herein, and you will not otherwise interfere with the operation of the ThreeFold_Grid. +4. You acknowledge and agree that the Company has no practical access to your data or knowledge of the nature of the data stored on your 3Bot or the 3Nodes (including but not limited to Content) and that it does not retain any Content or other data that you process using the ThreeFold_Grid. The Company has no control in the management of such Content or data, nor any influence in the specific processing procedures. The Company will never pursue changes to TF Products that could make User data accessible to Company or third parties. We are a neutral intermediary and do not act on behalf of a Farmer, User or any other party to process Content or User data and thus you acknowledge and agree that we should not be qualified as data processors or sub-processor under the General Data Processing Directive (Regulation (EU) 2016/679 of the European Parliament and of the Council of 27 April 2016 on the protection of natural persons with regard to the processing of personal data and on the free movement of such data, and repealing Directive 95/46/EC) (‘GDPR’). +5. Company may suspend User’s use of the TF Products if Company believes the User to be: (a) violating any term of this Agreement; or (b) using the TF Products in a manner that Company reasonably believes may cause a security risk, a disruption to the TF Products (including the ThreeFold_Grid), or liability for Company or any persons involved in the ThreeFold Open Source project. + +### 8. USAGE RESTRICTIONS (ACCEPTABLE USE) + +You will use the TF Products in strict accordance with the terms of this Agreement and in no other manner. Without limiting the generality of the foregoing, you will not: + +1. access or use the TF Products: (i) in violation of applicable laws; (ii) to send or store material knowingly or intentionally containing software viruses, worms, Trojan horses or other harmful computer code, files, or scripts; (iii) in a manner that interferes with or disrupts the integrity or performance of the ThreeFold_Grid (or the data contained therein); or (iv) in any manner that could interfere with, disrupt, negatively affect or inhibit other Users from fully enjoying their use of the TF Products or that could damage, disable, overburden or impair the functioning of the TF Products in any manner. +2. delete or otherwise render Content unavailable for recovery independent of the programmatic functionality of the relevant software; +3. violate, infringe or misappropriate any intellectual property or other third-party right or commit a tort; +4. modify, copy (other than standard page caching), publicly perform, publicly display, sell, rent, lease, timeshare or otherwise distribute the TF Products, in whole or in part. This restriction does not apply to open source software we release, which you can use subject to the applicable open source software license terms; +5. attempt to bypass or circumvent measures employed to prevent or limit access to any content, area or functionality on the TF Products, without providing prior notice to Company of the method used to bypass or circumvent; +6. in any other way attempt to interfere, impede, alter, or otherwise interact with the TF Products in any manner not expressly authorized hereunder; +7. use any of the TF Products other than for its intended purposes; or +8. use the TF Products to engage in or promote any activity that violates these User Terms and Conditions. + +### 9. CONTENT RESTRICTIONS + +The IT Capacity that is made available on the ThreeFold_Grid can be used by any Users to create, post, upload, share or store Content, such as text, graphics, photos, videos, sound, data or other information and materials submitted or provided by Users. + +We have no access to, nor do we control, own, or endorse any Content that you transmit, store or process via the ThreeFold_Grid or any other TF Products. You are solely responsible for any Content stored using the ThreeFold_Grid or any TF Products, and for any data that you have entered using the ThreeFold Connect application. You hereby represent and warrant that (1) you own all intellectual property rights (or have obtained all necessary permissions) to provide your Content and other data; (2) such Content and other data will not violate any agreements or confidentiality obligations; and (3) such Content and data will not violate, infringe or misappropriate any intellectual property right or other proprietary rights of any person or third party. + +You will not create, post, share or store Content or other data that: + +1. is unlawful, libelous, defamatory, harassing, threatening, invasive of privacy or publicity rights, abusive, inflammatory, fraudulent or otherwise objectionable; +2. would constitute, encourage or provide instructions for a criminal offense, violate the rights of any party, otherwise create liability or violate any local, state, national or international law; +3. intentionally misleads by containing or depicting any statements, remarks or claims that do not reflect your honest views and experiences; +4. impersonates, or misrepresents your affiliation with, any person or entity (including Company); +5. references or depicts Company, our TF Products or any related services but fails to disclose any material connection to us that may exist; +6. contains any unsolicited promotions, political campaigning, advertising or solicitations; +7. contains any viruses, corrupted data or other harmful, disruptive or destructive files or content; or +8. in our sole judgment, is objectionable or that restricts or inhibits any other person from using or enjoying the TF Products, or that may expose Company or others to any harm or liability of any type; + +### 10. REPRESENTATIONS AND WARRANTIES + +You hereby represent, warrant, and covenant that: + +1. You have full legal capacity, power and authority to execute and deliver this Agreement and to perform its obligations hereunder. This Agreement constitutes valid and binding obligations of the User, enforceable in accordance with its terms. + +2. You are NOT a target person or entity under any restrictive measures in the framework of the EU Common Foreign and Security Policy and you are NOT named on any E.U. or U.S. government denied-party list. + +3. You are, and have at all times been, in compliance in all material respects with each legal requirement that is are applicable to you, or the ownership of your assets, relating to money laundering (including but not limited to applicable anti-money laundering regulations). + +4. You have been advised and acknowledge that the ThreeFold_Tokens or TFTs are NOT issued by any company or organization and are only registered in the TF BlockChain as an automatic action when a Farmer connects IT Capacity to the ThreeFold_Grid, as such they have not been registered under any country’s securities laws. + +5. You understand that the TFTs involve risks, all of which you fully and completely assume. You understand and expressly accept that the TFTs will be created and delivered to you at your sole risk on an "AS IS" basis. You understand and expressly accept that you have not relied on any representations or warranties made by the Company outside this Agreement, including, but not limited to, conversations of any kind, whether through oral or electronic communication, or any white paper. Without limiting the generality of the foregoing, you assume all risk and liability for the results obtained by any use of TFTs and regardless of any oral or written statements made by or on behalf of the Company, by way of technical advice or otherwise, related to the use of the TFTs. + +6. You have such knowledge and experience in technology, financial and business matters that you are capable of evaluating the merits and risks of such purchase of TFTs and corresponding IT Capacity and are able to bear the economic risk of such acquisition for an indefinite period of time. + +7. You are executing this Agreement for your own account, not as a nominee or agent. + +8. You understand that you have no right against the Company or any other person related to the ThreeFold project except in the event of the Company’s breach of this agreement or intentional fraud. + +9. You understand that you bear sole responsibility for any taxes as a result of the matters and transactions the subject of this Agreement, and any future acquisition, ownership, use, sale or other disposition of TFTs. To the extent permitted by law, you agree to indemnify, defend and hold the Company or any of its affiliates, employees or agents (including developers, auditors, contractors or founders) harmless for any claim, liability, assessment or penalty with respect to any taxes (other than any net income taxes of the Company) associated with or arising from your acquisition, use or ownership of TFTs hereunder. + +### 11. TERM AND TERMINATION + +This Agreement shall be effective as of the date that you take the earliest of the following actions: your acceptance of this Agreement, either by clicking to signify acceptance, or by taking any one or more of the following actions: downloading, installing, running and/or using any TF Product. It will continue until terminated per the terms below. + +Either party may terminate this Agreement immediately at any time without notice to the other party. + +In case of termination, the User shall immediately cease using the TF Products. + +### 12. FEEDBACK + +Company shall have a royalty-free, worldwide, transferable, sublicensable, irrevocable, perpetual license to use or incorporate into the TF Products any suggestions, ideas, enhancement requests, feedback, recommendations or other information provided by Users relating to the features, functionality, or operation thereof ("**Feedback**"). Company shall have no obligation to use Feedback, and User shall have no obligation to provide Feedback. + +### 13. INDEMNIFICATION + +To the fullest extent permitted by applicable law, you will defend, indemnify and hold harmless Company and our respective past, present, and future employees, officers, directors, contractors, consultants, equity holders, suppliers, vendors, service providers, parent companies, subsidiaries, affiliates, agents, representatives, predecessors, successors and assigns (the "**Indemnified Parties**") from and against all claims, damages, costs and expenses (including attorneys’ fees) that arise from or relate to: (i) your use of the TF Products; (ii) any Feedback you provide; or (iii) your breach of this Agreement. + +Company reserves the right to exercise sole control over the defense of any claim subject to indemnification under the paragraph above, at your expense. This indemnity is in addition to, and not in lieu of, any other indemnities set forth in a written agreement between you and Company. + +If any TF Product becomes, or in Company’s reasonable judgment is likely to become, the subject of a claim of infringement, then Company may in its sole discretion: (a) obtain the right, for User to continue using such TF Product; (b) provide a non-infringing functionally equivalent replacement; or (c) modify such TF Product so that it is no longer infringing. If Company, in its sole and reasonable judgment, determines that none of the above options are commercially reasonable, then Company may, without liability, suspend or terminate User’s use of the relevant TF Product. This Section 12 states Company’s sole liability and User’s exclusive remedy for infringement claims. + +### 14. DISCLAIMER AND LIMITATION OF LIABILITY + +The User hereby acknowledges the fact that he/she has been advised that TFTs may qualify as a security and that the offers and sales of TFTs have not been registered under any country’s securities laws and, therefore, cannot be resold except in compliance with the applicable country’s laws. + +The User understands that the use of TFTs, the other TF Products and/or the ThreeFold_Grid involves risks, all of which the User fully and completely assumes, including, but not limited to, the risk that (i) the technology associated with the ThreeFold_Grid, 3Nodes, 3Bot and/or related TF Products will not function as intended; (ii) the Threefold project will not be completed; (iii) Threefold will fail to attract sufficient interest from key stakeholders; and (iv) ThreeFold or any related parties may be subject to investigation and punitive actions from governmental authorities. + +Except as explicitly set forth herein, Company makes no representations that the TF Products are appropriate for use in any jurisdictions. Users engaging with the TF Products from any jurisdictions do so at their own risk and are responsible for compliance with local laws. + +The User understands and expressly accepts that the TFTs, ThreeFold Connect App, the ThreeFold_Grid and other TF Products were created and made available to the User at its sole risk on an "AS IS" and “UNDER DEVELOPMENT” basis. + +COMPANY DISCLAIMS ALL REPRESENTATIONS AND WARRANTIES, EXPRESS AND IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT. COMPANY MAKES NO WARRANTY THAT THE TF PRODUCTS OR DOCUMENTATION WILL BE UNINTERRUPTED, ACCURATE, COMPLETE, RELIABLE, CURRENT, ERROR-FREE, VIRUS FREE, OR FREE OF MALICIOUS CODE OR HARMFUL COMPONENTS, OR THAT DEFECTS WILL BE CORRECTED. COMPANY DOES NOT CONTROL, ENDORSE, SPONSOR, OR ADOPT ANY CONTENT AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND REGARDING THE CONTENT STORED ON THE THREEFOLD GRID. COMPANY HAS NO OBLIGATION TO SCREEN, MONITOR, OR EDIT CONTENT AND IS NOT RESPONSIBLE OR LIABLE FOR ANY CONTENT. YOU ACKNOWLEDGE AND AGREE THAT COMPANY HAS NO INDEMNITY, SUPPORT, SERVICE LEVEL, OR OTHER OBLIGATIONS HEREUNDER. + +User understands and expressly acknowledges that it has not relied on any representations or warranties made by the Company, TF Tech NV, Bettertoken NV, Kristof De Spiegeleer, any person or entity involved in the development or promotion of the TF Products and/or the ThreeFold project, or any related parties, including, but not limited to, conversations of any kind, whether through oral or electronic communication or otherwise, or any whitepapers or other documentation. + +WITHOUT LIMITING THE GENERALITY OF THE FOREGOING, THE USER ASSUMES ALL RISK AND LIABILITY FOR THE RESULTS OBTAINED BY THE USE OF THE TF PRODUCTS (INCLUDING THE THREEFOLD TOKENS) AND REGARDLESS OF ANY ORAL OR WRITTEN STATEMENTS MADE BY THREEFOLD, BY WAY OF TECHNICAL ADVICE OR OTHERWISE, RELATED TO THE USE THEREOF. + +COMPANY SHALL NOT BE LIABLE FOR ANY INCIDENTAL, CONSEQUENTIAL, PUNITIVE, SPECIAL, INDIRECT, OR EXEMPLARY DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS, REVENUE, DATA, OR DATA USE, OR DAMAGE TO BUSINESS) HOWEVER CAUSED, WHETHER BY BREACH OF WARRANTY, BREACH OF CONTRACT, IN TORT (INCLUDING NEGLIGENCE) OR ANY OTHER LEGAL OR EQUITABLE CAUSE OF ACTION EVEN PREVIOUSLY ADVISED OF SUCH DAMAGES IN ADVANCE OR IF SUCH DAMAGES WERE FORESEEABLE, AND COMPANY SHALL ONLY BE LIABLE FOR DIRECT DAMAGES CAUSED BY ITS GROSS NEGLIGENCE. IN NO EVENT WILL COMPANY’S TOTAL AGGREGATE LIABILITY ARISING FROM OR RELATING TO THIS AGREEMENT EXCEED ONE HUNDRED EURO (€ 100.00). + +### 15. RELEASE + +To the fullest extent permitted by applicable law, you hereby explicitly release (1) the TF Foundation (ThreeFold_Dubai), (2) each individual or entity acting as a Farmer, (3) TF Tech NV, (4) any of the companies or individuals related to these entities, and (5) any person contributing or otherwise assisting in developing, marketing or distributing the TF Products (hereinafter collectively referred to as "**ThreeFold Relatives**") from responsibility, liability, claims, demands and/or damages (actual and consequential) of every kind and nature, known and unknown (including, but not limited to, claims of negligence), arising out of or related to: + +- the acts or omissions of third parties; and + +- your purchase of TFTs (if any) from ThreeFold Relatives, regardless of the names or former names under which such TFTs may have been identified in the relevant contracts (e.g. ‘Internal ThreeFold_Tokens’, ‘iTFTs’, TFTs, etc.). + +If and to the extend you have purchased or otherwise acquired TFTs from ThreeFold Relatives that were identified in the relevant contracts as ‘Internal ThreeFold_Tokens’ or ‘iTFTs’, your use of the TF Products (including your subsequent receipt or acceptance of TFTs) implies your confirmation that such purchase or acquisition has been duly completed as a result of your receipt of a corresponding amount of TFTs, and that all deliverables under the relevant contracts (known as ‘iTFT Purchase Agreement’, ‘TFT Purchase Agreement’ or ‘ITO investment agreement’) have been duly delivered and that there are no further obligations from any ThreeFold Relatives to you in relation to such contracts. + +### 16. EXPORT COMPLIANCE + +The TF Products may be subject to export laws and regulations of the European Union, the United States and other jurisdictions. The User represents that it is not named on any E.U. or U.S. government denied-party list. The User shall not access or use the TF Products in a E.U. or U.S.-embargoed or any sanctioned country or region or in violation of any E.U. or U.S. export law or regulation. User shall not use the TF Products to export, re-export, transfer, or make available, whether directly or indirectly, any regulated item or information to anyone outside the E.U. or U.S. in connection with this Agreement without first complying with all export control laws and regulations that may be imposed by the European Union, any EU country or the U.S. Government and any country or organization of nations within whose jurisdiction the User operates or does business. + +### 17. ENTIRE AGREEMENT,SEVERABILITY, WAIVER + +1. This Agreement sets forth the complete and final agreement of the parties concerning the subject matter hereof, and supersedes, replaces all prior agreements, written and oral, between them concerning the subject matter hereof. If a term of this Agreement to be invalid or unenforceable, the remaining provisions will continue in full force and effect. A party’s consent to, or waiver of, enforcement of this Agreement on one occasion will not be deemed a waiver of any other provision or such provision on any other occasion. + +2. We reserve the right to change this Agreement from time to time in our sole discretion. If we make material changes to this Agreement, we will provide notice of such changes, such as by posting the revised User Terms and Conditions on our websites or in the ThreeFold Connect application. By continuing to access or use the TF Products or otherwise participate in the ThreeFold_Grid after the posted effective date of modifications to this Agreement, you agree to be bound by the revised version of this Agreement. If you do not agree to the modified Agreement, you must stop using and interacting with the TF Products. + +3. The parties are independent contractors. No agency, partnership, franchise, joint venture, or employment relationship is intended or created by this Agreement. Neither party has the power or authority to create or assume any obligation, or make any representations or warranties, on behalf of the other party. + +4. The User agrees that the Company may transfer and assign the Agreement in its sole discretion, provided a notice of such assignment is sent to the User within fifteen days of such assignment. + +5. Notices to Company made under this Agreement shall be made by email to legal@threefold.io AND in writing and delivered by registered mail (return receipt requested) or nationally-recognized overnight courier service to ThreeFold_Dubai, United Arab Emirates, attention Legal Department. You agree to receive electronically all communications, agreements, documents, notices, and disclosures that we provide in connection with the Software and/or the ThreeFold_Grid ("**Communications**"). We may provide Communications in a variety of ways, including by e-mail, text, in-app notifications, or by posting them on our websites. You agree that all Communications that we provide to you electronically satisfy any legal requirement that such communications be in writing. + +### 18. OPERATIONS OF THIRD-PARTY'S DIGITAL ASSET PROTOCOLS AND SERVICES + +1. TF Tech NV (“TF Tech) does not provide (investment) advice regarding cryptocurrencies. You acknowledge that any information provided as part of TF Tech’s ThreeFold Connect App and/or ThreeFold Wallet (the “Platforms”) is not intended as a (personal) recommendation to buy, sell or hold (cryptocurrency) assets. All trading services offered on or through TF Tech’s Platforms are offered on the basis of "execution only". Your orders are executed automatically by our systems. + +2. You hereby confirm to be aware of and accept the risks associated with the purchase, sale and holding of cryptocurrencies and agree not to enter into transactions that can lead to losses that you cannot bear. + +3. TF Tech does not have control over the delivery, quality, legality, safety or any other aspects of any digital assets or services provided to you by third parties. + +4. TF Tech assumes no responsibility for the operation of the underlying software protocols which govern the operation of the cryptocurrencies other than the ThreeFold Token (‘TFT’) which may be displayed or referred to on its ‘software’ and services, including but not limited to, its Platforms. + +5. TF Tech NV does not own or control the underlying software protocols which govern the operation of third party’s digital assets supported on Platforms. Generally, the underlying protocols are controlled by third-party services. TF Tech NV assumes no responsibility for the operation of the underlying protocols and is not able to guarantee the functionality, availability, or security of network operations. In particular, the underlying protocols may be subject to sudden changes in operating rules (including “forks”). Any such material operating changes may materially affect the availability, value, functionality, and/or the name of the third party’s digital asset you store in TF Tech’s Platforms. + +6. TF Tech does not control the timing and features of these material operating changes. It is your responsibility to make yourself aware of upcoming operating changes and you must carefully consider publicly available information and information that may be provided by TF Tech NV in determining whether to continue to use the ThreeFold Connect App account or “Platforms” for the affected third-party’s digital asset. In the event of any such operational change, TF Tech NV reserves the right to take such steps as may be necessary to protect the security and safety of assets held on ThreeFold’s “Platforms”, including temporarily suspending operations, and other necessary steps. TF Tech NV will use its best efforts to provide you notice of its response to any material operating change; however, such changes are outside of TF Tech’s control and may occur without notice to TF Tech NV. TF Tech NV’s response to any material operating change is subject to its sole discretion and includes deciding not to support a third-party’s digital asset fork, or other actions. + +7. You acknowledge and accept the risks of operating changes to third-party’s digital asset protocols and agree that TF Tech NV is not responsible for such operating changes and not liable for any loss of value you may experience as a result of such changes in operating rules. You acknowledge and accept that TF Tech NV has sole discretion to determine its response to any operating change and that we have no responsibility to assist you with third-party’s digital assets, operational changes, unsupported currencies, or protocols. + +### 19. TAXES + +1. You shall be solely responsible for and shall pay (and shall indemnify TF Tech against any liability with respect to any failure by you to pay) all income taxes, value added taxes, goods and services taxes and any and all other taxes or sums due to national, federal, state or local governments (as the case may be) as a result of your use of the Platforms.. + +2. You acknowledge that only you are responsible for the provision of information to tax authorities where such is required. Notwithstanding the above, upon request from a tax authority, TF Tech will provide information relating to you to the tax authorities. + +### 20. EXCLUSION OF LIABILITY + +1. For the avoidance of doubt and notwithstanding the generality of the liability limitations set out in the applicable terms and conditions governing your use of the Platforms and/or other software or services provided by TF Tech, no liability shall exist in any manner whatsoever for: + - differences in prices resulting from delayed processing of buy- or sell orders; + - cancellation of orders by reason of clearly misquoted prices; + - any damage incurred relating to the ThreeFold Wallet feature; + - any losses resulting from hacks, system failures and/or regulatory actions; and + - any indirect loss (including consequential loss, loss of income and profit, loss of data and non-material loss). + +2. Except in case of intentional misconduct by TF Tech, the liability of TF Tech in respect of the Platforms shall in all cases be limited to the amount paid by you for the Platforms during the month prior to the moment the cause of the damage occurred. + +### 21. GOVERNING LAW AND VENUE + +This Agreement will be governed by Luxembourg law. Any disputes shall be subject to the jurisdiction of the courts of Luxembourg, Grand Duchy of Luxembourg. + + +## APPENDIX + +{{#include threefold_companies0.md}} + +{{#include ./sub/the_single_source_truth.md}} \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_sales.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_sales.md new file mode 100644 index 0000000..643aa46 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_sales.md @@ -0,0 +1,92 @@ +# Terms Conditions Sales + +These terms and conditions (the “Agreement") constitute a legal agreement between you (“farmer,”, "customer", “you", or “yours”) and TF Tech NV, with registered office at Antwerpse Steenweg 19, B-9080 Lochristi, Belgium, (company number KBO 0712.845.674) ("we" "our" or the "Company") regarding our the sales of a service or product to you. + +## DEFINITIONS AND RELATED TERMS + +The definitions which apply to this Agreement, unless stated otherwise herein, can be found [here](../definitions_legal.md), and are incorporated herein by reference. + + +## TF TECH GENERAL TERMS AND CONDITIONS OF SALE + +Unless explicitly stated otherwise in a specific agreement, these General Terms and Conditions of Sale, together with the Sales Order, represent the entire agreement (“Agreement”) between you or the entity you represent, and TF Tech NV, a Belgian limited liability company with registered office at Antwerpsesteenweg 19, B-9080 Lochristi, Belgium, registered with the Crossroads Bank of Enterprises under company number 0712.845.674 (RPR Gent, district Gent) (the “Company”). + +### 1. SALES ORDERS + +Company will issue a Sales Order (either electronically or otherwise in writing), and such Sales Order must be explicitly accepted by the Customer. In order to qualify as a Sales Order, the relevant document shall specify, without limitation, at least: + +- The identity of the Customer; +- The Deliverables; +- The Effective Date; +- The Acceptance Period; and +- The prices and fees to be paid in respect of the Deliverables. + +In addition, each Sales Order issued may set forth (i) the applicable quantities, (ii) the unit prices, (iii) the bill-to address, (iv) the site(s) where any Services are to be performed (if applicable), and (v) any additional special terms or instructions. + +### 2. PRICING AND PAYMENT + +The prices and fees for Deliverables shall be as set forth in the Sales Order. All prices will be displayed in the Customer’s local currency where they have chosen that option. In such case prices are displayed in the Customer’s local currency for information purposes only. The final contracted price shall be in EUR and may be subject to bank charges and/or currency exchange fees which will be borne by Customer. + +Company shall issue an invoice against each accepted Sales Order (the “Invoice”). The Invoice shall be made available either electronically, in writing or online through the Company’s electronic invoicing system (if any). + +Each Invoice shall automatically become due and payable on the date of issuance of the Sales Order. + +In the event that Customer fails to make any payment of undisputed amounts on or prior to the applicable invoice due date (as determined in accordance with this Section 3), then those undisputed amounts shall accrue interest from the due date at a rate of eight percent (8%) per annum (or such lesser rate as may be the maximum permissible rate allowed under applicable law), calculated from the first day when such amount became due and owing until the date on which such amount is paid. The Company’s right to claim additional damages shall remain unaffected. + +Customer shall pay all federal, state or local sales or use taxes and any other government taxes, fees, duties or charges that are imposed upon the fees and charges paid by Customer to Company pursuant to this Agreement. Company will be responsible for all other taxes arising from the transactions contemplated by this Agreement, including, without limitation, any taxes based upon Company’s property, net income or gross receipts. Customer shall pay all such amounts directly to the taxing authority unless the taxing authority requires that Company collect and remit payment, in which event Customer shall pay such amounts to Company and Company shall remit such amounts to the authority and provide Customer with a certificate stating that such amounts were so remitted. Customer and Company shall reasonably cooperate in order to take actions to minimize, or to qualify for exemptions from, any applicable taxes, duties or tariffs. Such cooperation shall include, without limitation, the furnishing of certifications that purchases by Customer are for purposes of resale, if applicable, and must be used in accordance with any local and international laws. Customer and Company shall each have the right to protest or appeal any tax or charge assessed against it by any taxing authority with respect to the subject matter of this Agreement. + +### 3. DELIVERY AND ACCEPTANCE + +Delivery. Unless otherwise agreed, prices and delivery are ExWorks (INCOTERMS 2010) from the production premises of the Company in Lochristi (Belgium) or the third party designated in the Sales Order. Any charges Company may be required to pay or collect on the sale, purchase, delivery, storage, use or transportation of the goods shall be paid by Customer. + + +Export regulations. Customer is responsible for complying with all applicable export and/or re-export restrictions and regulations. + +Title; Risk of Loss. Unless otherwise agreed, the risk of loss passes to Customer on the date when the goods are delivered to the carrier, as described in INCOTERMS 2010 (the “Delivery Date”). Where the risk of loss has passed to Customer, Customer must obtain redress for freight losses, shortages or damages from the carrier or its insurer. Company is not responsible for any such losses. Notwithstanding any provision of INCOTERMS 2010 or contained herein, equitable title and accession to the goods shall, where permitted by law, remain with Company until Customer has paid in full. This shall be the case even if legal title to the goods shall be deemed by law to have passed to Customer at the time of delivery and prior to performance of all of Company’s obligations. Customer shall grant and by acceptance of the goods is deemed to have granted to Company a first security interest in all goods to secure payment of amounts owed by Customer. In certain circumstances for instance for very large orders Customer agrees to execute a financing statement at Company's request. Company may reclaim any goods delivered or in transit if Customer fails to make payment when due. + +Inspection and Acceptance. Customer will evaluate any Deliverable that has been delivered to Customer or performed in accordance with this Agreement to determine whether it complies with all applicable Specifications. Customer shall give Company written notice of Acceptance or Rejection within the Acceptance Period. +Upon notice of Rejection, Customer may: +immediately return to Company the relevant Deliverables, provided such Deliverables are in good working condition and without damage, in which case the Invoice will be cancelled through a credit note; +direct Company to correct the nonconformity, in which case Company (at no cost to Customer) shall correct the nonconformity within thirty (30) days of Customer’s request; or +upon mutual agreement of the Parties, pay Company a reduced amount for the nonconforming item (in which case the Invoice will be partially cancelled accordingly through a credit note). +Deliverables provided to Customer will be deemed accepted: +in the absence of any notice of Rejection within or at the expiration of the Acceptance Period; or +in the absence of any return of the Deliverables within the Acceptance Period. + +### 4. USAGE RESTRICTIONS + +Customer acknowledges that any use or purchase of the Hardware or Services for fraudulent or illegal purposes or purchases Hardware or Services in a fraudulent manner will irrevocably invalidate any Agreement between the Customer and Company and may lead to prosecution. + +### 5.WARRANTIES + +Hardware Warranty by Company to Customer. The Hardware supplied by Company pursuant to this Agreement is manufactured and/or developed by third party vendors and will carry the warranties specified by the applicable third party vendor, which warranties Company shall extend to Customer to the full extent permissible under such warranties or as provided under statutory law. + +Services Warranties. Company warrants that all Services performed hereunder shall be performed in a timely, professional and workmanlike manner, in conformance with industry practices, and Company warrants the workmanship of such Services for a period of ninety (90) days from the date on which the applicable Services are provided. + +Eligibility. Any warranties shall be invalid and the company shall have no responsibility or liability whatsoever for any Hardware or Software, or part thereof, that (a) has had the Serial Number, Model Number, or other identification markings altered, removed or rendered illegible; (b) has been damaged by or subject to improper installation or operation, misuse, accident or neglect; (c) has become defective or inoperative due to its integration or assembly with any equipment or products not supplied by Company; (d) has been repaired, modified or otherwise altered by anyone other than Company and/or has been subject to the opening of the Hardware without Company’s prior written consent; (e) has had any item removed from the Hardware including any storage device including USB drives. If any warranty claim by Customer falls within any of the foregoing exceptions, Customer shall pay Company its then current rates and charges for such services. + +Termination. Cancellation or termination of this Agreement by either Company or Customer shall void this warranty. + +Remedies and repair. Company’s liability and responsibility under this warranty is limited to the obligation, at Company’s option, to either repair or replace the relevant Deliverables. In the event that after repeated efforts Company is unable to repair or replace a defective Deliverable, then Customer’s exclusive remedy and Company’s entire liability in contract, tort, or otherwise shall be the payment by Company of Customer's actual damages after mitigation, but shall not exceed the purchase price or fee actually paid by Customer for the relevant defective Deliverable. +The Company shall have no obligation to repair, replace, or refund the relevant Deliverable until the Customer returns the defective Deliverable to the Company. Before returning any Deliverable to the Company, the Customer must contact the Company for a return authorization and other appropriate instructions. +The Company warrants a repaired Deliverable only for the unexpired term of the original warranty for the defective Deliverable. The Company warrants parts exchanged in connection with a repair, only for the unexpired term of the original warranty for the defective Deliverable. + +Warranty Procedure. The Customer shall notify the Company immediately in writing of any obvious or potential defects in the Deliverables, following the acceptance thereof, as soon as such defects have been discovered in the ordinary course of business within the aforementioned warranty terms. Company shall only remedy defective Deliverables under these Warranty provisions provided the defects are notified to Company within the relevant Warranty period. + +Disclaimer. THE ABOVE WARRANTY IS IN LIEU OF ALL OTHER WARRANTIES, EXPRESS OR IMPLIED, INCLUDING THOSE OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, ALL OF WHICH ARE EXPRESSLY DISCLAIMED. COMPANY SHALL NOT BE LIABLE FOR ANY CONSEQUENTIAL, INCIDENTAL, SPECIAL, OR EXEMPLARY DAMAGES (WHETHER FOR LOSS OF PROFIT, LOSS OF BUSINESS, LOSS OF OPPORTUNITY, MISSED SAVINGS, DEPLETION OF GOODWILL, RECALL, DISMANTLING OR OTHERWISE); EVEN IF IT HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +Limitations. To the fullest extent permitted by law, Company’s total and aggregate liability in respect to direct damages, whether in contract or tort (including negligence or breach of statutory duty), for each respective breach or series of related breaches or any and all losses, shall not exceed in the aggregate (i) the actual amount paid for the specific Deliverables giving rise to the claim; or (ii) EUR 10,000, whichever amount is lower. The existence of one or more claims under this Agreement shall not enlarge the limit. +The limitations and exclusions referred to in this clause will not apply in the event the liability results from the Company’s deliberate intent (or that of its subordinates or assistants). +The limitations and exclusions of liability, as well as indemnity stipulated for Company itself in the above paragraphs are also stipulated for and on behalf of its directors, employees, agents and other intermediaries and/or any other person employed by it or delivering services to it within the framework of the Agreement. + +### 6. MISCELLANEOUS + +Severability. If any provision of this Agreement will be held to be invalid or unenforceable for any reason, the remaining provisions will continue to be valid and enforceable. If a court finds that any provision of this Agreement is invalid or unenforceable, but that by limiting such provision, it would become valid and enforceable, then such provision will be deemed to be written, construed, and enforced as so limited. + +Governing Law. All disputes will be governed by the laws of Belgium. The venue for litigation will be the appropriate courts of Ghent, Belgium. Choice of law rules of any jurisdiction and the United Nations Convention on Contracts for the International Sale of Goods will not apply to any dispute. + +Changes. TF Tech NV reserves the right to vary these T&Cs at any time. TF Tech NV will inform customers by email if the T&Cs change using the contact email provided at the time of purchase, or using any email subsequently provided by the customer as their main email. The customer agrees that they will always ensure such emails are up to date and monitored. Any variations to the T&Cs will be deemed to have been accepted unless TF Tech NV is informed to the contrary. + +## APPENDIX + +{{#include ./sub/the_single_source_truth.md}} \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_toc.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_toc.md new file mode 100644 index 0000000..de9638f --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_toc.md @@ -0,0 +1,9 @@ +# Terms & Conditions + +

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 diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites.md new file mode 100644 index 0000000..7eaa7c7 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites.md @@ -0,0 +1,28 @@ +**TERMS OF USE** + +{{#include ./terms_conditions_websites/part_0_agreement_terms.md}} +{{#include ./terms_conditions_websites/part_1_ip_rights.md}} +{{#include ./terms_conditions_websites/part_2_user_representations.md}} +{{#include ./terms_conditions_websites/part_3_user_registration.md}} +{{#include ./terms_conditions_websites/part_4_prohibited_activities.md}} +{{#include ./terms_conditions_websites/part_5_user_generated_contributions.md}} +{{#include ./terms_conditions_websites/part_6_contribution_license.md}} +{{#include ./terms_conditions_websites/part_7_social_media.md}} +{{#include ./terms_conditions_websites/part_8_submission.md}} +{{#include ./terms_conditions_websites/part_9_thirdparty_websites_content.md}} +{{#include ./terms_conditions_websites/part_10_site_management.md}} +{{#include ./terms_conditions_websites/part_11_privacy_policy.md}} +{{#include ./terms_conditions_websites/part_12_dispute_resolution.md}} +{{#include ./terms_conditions_websites/part_13_disclaimer.md}} +{{#include ./terms_conditions_websites/part_14_limitations_liability.md}} +{{#include ./terms_conditions_websites/part_15_indemnification.md}} +{{#include ./terms_conditions_websites/part_16_user_data.md}} +{{#include ./terms_conditions_websites/part_17_electronic_comms_transactions_signatures.md}} +{{#include ./terms_conditions_websites/part_18_miscellaneous.md}} +{{#include ./terms_conditions_websites/part_19_contact_us.md}} + +## APPENDIX + +{{#include threefold_companies0.md}} + +{{#include ./sub/the_single_source_truth.md}} \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_0_agreement_terms.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_0_agreement_terms.md new file mode 100644 index 0000000..93cf2e5 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_0_agreement_terms.md @@ -0,0 +1,15 @@ +**AGREEMENT TO TERMS** + + These Terms of Use constitute a legally binding agreement made between you, whether personally or on behalf of an entity ("you") and ThreeFold, doing business as ThreeFold ("**ThreeFold**", “**we**”, “**us**”, or “**our**”), concerning your access to and use of the threefold related websites: + +{{#include ../sub/websites.md}} + +as well as any other media form, media channel, forum, mobile website or mobile application related, linked, or otherwise connected thereto (collectively, the “Site”). + +You agree that by accessing the Site, you have read, understood, and agreed to be bound by all of these Terms of Use. IF YOU DO NOT AGREE WITH ALL OF THESE TERMS OF USE, THEN YOU ARE EXPRESSLY PROHIBITED FROM USING THE SITE AND YOU MUST DISCONTINUE USE IMMEDIATELY. + +Supplemental terms and conditions or documents that may be posted on the Site from time to time are hereby expressly incorporated herein by reference. We reserve the right, in our sole discretion, to make changes or modifications to these Terms of Use at any time and for any reason. We will alert you about any changes by updating the "Last updated" date of these Terms of Use, and you waive any right to receive specific notice of each such change. It is your responsibility to periodically review these Terms of Use to stay informed of updates. You will be subject to, and will be deemed to have been made aware of and to have accepted, the changes in any revised Terms of Use by your continued use of the Site after the date such revised Terms of Use are posted. + +The information provided on the Site is not intended for distribution to or use by any person or entity in any jurisdiction or country where such distribution or use would be contrary to law or regulation or which would subject us to any registration requirement within such jurisdiction or country. Accordingly, those persons who choose to access the Site from other locations do so on their own initiative and are solely responsible for compliance with local laws, if and to the extent local laws are applicable. + +The Site is intended for users who are at least 18 years old. Persons under the age of 18 are not permitted to use or register for the Site. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_10_site_management.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_10_site_management.md new file mode 100644 index 0000000..1b12bf6 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_10_site_management.md @@ -0,0 +1,3 @@ +**SITE MANAGEMENT** + +We reserve the right, but not the obligation, to: (1) monitor the Site for violations of these Terms of Use; (2) take appropriate legal action against anyone who, in our sole discretion, violates the law or these Terms of Use, including without limitation, reporting such user to law enforcement authorities; (3) in our sole discretion and without limitation, refuse, restrict access to, limit the availability of, or disable (to the extent technologically feasible) any of your Contributions or any portion thereof; (4) in our sole discretion and without limitation, notice, or liability, to remove from the Site or otherwise disable all files and content that are excessive in size or are in any way burdensome to our systems; and (5) otherwise manage the Site in a manner designed to protect our rights and property and to facilitate the proper functioning of the Site. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_11_privacy_policy.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_11_privacy_policy.md new file mode 100644 index 0000000..5db0439 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_11_privacy_policy.md @@ -0,0 +1,22 @@ +**PRIVACY POLICY** + +We care about data privacy and security. Please review our Privacy Policy: privacypolicy . + +By using the Site, you agree to be bound by our Privacy Policy, which is incorporated into these Terms of Use. Please be advised the Site is hosted in the United States. If you access the Site from the European Union, Asia, or any other region of the world with laws or other requirements governing personal data collection, use, or disclosure that differ from applicable laws in the United States, then through your continued use of the Site, you are transferring your data to the United States, and you expressly consent to have your data transferred to and processed in the United States. Further, we do not knowingly accept, request, or solicit information from children or knowingly market to children. Therefore, in accordance with the U.S. Children’s Online Privacy Protection Act, if we receive actual knowledge that anyone under the age of 13 has provided personal information to us without the requisite and verifiable parental consent, we will delete that information from the Site as quickly as is reasonably practical. + +**TERM AND TERMINATION** + +These Terms of Use shall remain in full force and effect while you use the Site. WITHOUT LIMITING ANY OTHER PROVISION OF THESE TERMS OF USE, WE RESERVE THE RIGHT TO, IN OUR SOLE DISCRETION AND WITHOUT NOTICE OR LIABILITY, DENY ACCESS TO AND USE OF THE SITE (INCLUDING BLOCKING CERTAIN IP ADDRESSES), TO ANY PERSON FOR ANY REASON OR FOR NO REASON, INCLUDING WITHOUT LIMITATION FOR BREACH OF ANY REPRESENTATION, WARRANTY, OR COVENANT CONTAINED IN THESE TERMS OF USE OR OF ANY APPLICABLE LAW OR REGULATION. WE MAY TERMINATE YOUR USE OR PARTICIPATION IN THE SITE OR DELETE YOUR ACCOUNT AND ANY CONTENT OR INFORMATION THAT YOU POSTED AT ANY TIME, WITHOUT WARNING, IN OUR SOLE DISCRETION. + + If we terminate or suspend your account for any reason, you are prohibited from registering and creating a new account under your name, a fake or borrowed name, or the name of any third party, even if you may be acting on behalf of the third party. In addition to terminating or suspending your account, we reserve the right to take appropriate legal action, including without limitation pursuing civil, criminal, and injunctive redress. + +**MODIFICATIONS AND INTERRUPTIONS** + + We reserve the right to change, modify, or remove the contents of the Site at any time or for any reason at our sole discretion without notice. However, we have no obligation to update any information on our Site. We also reserve the right to modify or discontinue all or part of the Site without notice at any time. We will not be liable to you or any third party for any modification, price change, suspension, or discontinuance of the Site. + + +We cannot guarantee the Site will be available at all times. We may experience hardware, software, or other problems or need to perform maintenance related to the Site, resulting in interruptions, delays, or errors. We reserve the right to change, revise, update, suspend, discontinue, or otherwise modify the Site at any time or for any reason without notice to you. You agree that we have no liability whatsoever for any loss, damage, or inconvenience caused by your inability to access or use the Site during any downtime or discontinuance of the Site. Nothing in these Terms of Use will be construed to obligate us to maintain and support the Site or to supply any corrections, updates, or releases in connection therewith. + +**GOVERNING LAW** + +These Terms of Use and your use of the Site are governed by and construed in accordance with the laws of Belgium, without regard to its conflict of law principles. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_12_dispute_resolution.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_12_dispute_resolution.md new file mode 100644 index 0000000..0483b50 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_12_dispute_resolution.md @@ -0,0 +1,7 @@ +**DISPUTE RESOLUTION** + +Any legal action of whatever nature brought by either you or us (collectively, the "Parties" and individually, a “Party”) shall be commenced or prosecuted in courts located in Belgium, Ghent, and the Parties hereby consent to, and waive all defenses of lack of personal jurisdiction and forum non conveniens with respect to venue and jurisdiction in such state and federal courts. Application of the United Nations Convention on Contracts for the International Sale of Goods and the Uniform Computer Information Transaction Act (UCITA) are excluded from these Terms of Use. In no event shall any claim, action, or proceeding brought by either Party related in any way to the Site be commenced more than one (1) years after the cause of action arose. + +**CORRECTIONS** + +There may be information on the Site that contains typographical errors, inaccuracies, or omissions, including descriptions, pricing, availability, and various other information. We reserve the right to correct any errors, inaccuracies, or omissions and to change or update the information on the Site at any time, without prior notice. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_13_disclaimer.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_13_disclaimer.md new file mode 100644 index 0000000..19472d0 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_13_disclaimer.md @@ -0,0 +1,3 @@ +**DISCLAIMER** + +THE SITE IS PROVIDED ON AN AS-IS AND AS-AVAILABLE BASIS. YOU AGREE THAT YOUR USE OF THE SITE AND OUR SERVICES WILL BE AT YOUR SOLE RISK. TO THE FULLEST EXTENT PERMITTED BY LAW, WE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, IN CONNECTION WITH THE SITE AND YOUR USE THEREOF, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. WE MAKE NO WARRANTIES OR REPRESENTATIONS ABOUT THE ACCURACY OR COMPLETENESS OF THE SITE’S CONTENT OR THE CONTENT OF ANY WEBSITES LINKED TO THE SITE AND WE WILL ASSUME NO LIABILITY OR RESPONSIBILITY FOR ANY (1) ERRORS, MISTAKES, OR INACCURACIES OF CONTENT AND MATERIALS, (2) PERSONAL INJURY OR PROPERTY DAMAGE, OF ANY NATURE WHATSOEVER, RESULTING FROM YOUR ACCESS TO AND USE OF THE SITE, (3) ANY UNAUTHORIZED ACCESS TO OR USE OF OUR SECURE SERVERS AND/OR ANY AND ALL PERSONAL INFORMATION AND/OR FINANCIAL INFORMATION STORED THEREIN, (4) ANY INTERRUPTION OR CESSATION OF TRANSMISSION TO OR FROM THE SITE, (5) ANY BUGS, VIRUSES, TROJAN HORSES, OR THE LIKE WHICH MAY BE TRANSMITTED TO OR THROUGH THE SITE BY ANY THIRD PARTY, AND/OR (6) ANY ERRORS OR OMISSIONS IN ANY CONTENT AND MATERIALS OR FOR ANY LOSS OR DAMAGE OF ANY KIND INCURRED AS A RESULT OF THE USE OF ANY CONTENT POSTED, TRANSMITTED, OR OTHERWISE MADE AVAILABLE VIA THE SITE. WE DO NOT WARRANT, ENDORSE, GUARANTEE, OR ASSUME RESPONSIBILITY FOR ANY PRODUCT OR SERVICE ADVERTISED OR OFFERED BY A THIRD PARTY THROUGH THE SITE, ANY HYPERLINKED WEBSITE, OR ANY WEBSITE OR MOBILE APPLICATION FEATURED IN ANY BANNER OR OTHER ADVERTISING, AND WE WILL NOT BE A PARTY TO OR IN ANY WAY BE RESPONSIBLE FOR MONITORING ANY TRANSACTION BETWEEN YOU AND ANY THIRD-PARTY PROVIDERS OF PRODUCTS OR SERVICES. AS WITH THE PURCHASE OF A PRODUCT OR SERVICE THROUGH ANY MEDIUM OR IN ANY ENVIRONMENT, YOU SHOULD USE YOUR BEST JUDGMENT AND EXERCISE CAUTION WHERE APPROPRIATE. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_14_limitations_liability.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_14_limitations_liability.md new file mode 100644 index 0000000..9adccbf --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_14_limitations_liability.md @@ -0,0 +1,3 @@ +**LIMITATIONS OF LIABILITY** + + IN NO EVENT WILL WE OR OUR DIRECTORS, EMPLOYEES, OR AGENTS BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL, EXEMPLARY, INCIDENTAL, SPECIAL, OR PUNITIVE DAMAGES, INCLUDING LOST PROFIT, LOST REVENUE, LOSS OF DATA, OR OTHER DAMAGES ARISING FROM YOUR USE OF THE SITE, EVEN IF WE HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. NOTWITHSTANDING ANYTHING TO THE CONTRARY CONTAINED HEREIN, OUR LIABILITY TO YOU FOR ANY CAUSE WHATSOEVER AND REGARDLESS OF THE FORM OF THE ACTION, WILL AT ALL TIMES BE LIMITED TO $1.00 USD. CERTAIN STATE LAWS DO NOT ALLOW LIMITATIONS ON IMPLIED WARRANTIES OR THE EXCLUSION OR LIMITATION OF CERTAIN DAMAGES. IF THESE LAWS APPLY TO YOU, SOME OR ALL OF THE ABOVE DISCLAIMERS OR LIMITATIONS MAY NOT APPLY TO YOU, AND YOU MAY HAVE ADDITIONAL RIGHTS. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_15_indemnification.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_15_indemnification.md new file mode 100644 index 0000000..447c022 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_15_indemnification.md @@ -0,0 +1,3 @@ +**INDEMNIFICATION** + +You agree to defend, indemnify, and hold us harmless, including our subsidiaries, affiliates, and all of our respective officers, agents, partners, and employees, from and against any loss, damage, liability, claim, or demand, including reasonable attorneys’ fees and expenses, made by any third party due to or arising out of: (1) your Contributions; (2) use of the Site; (3) breach of these Terms of Use; (4) any breach of your representations and warranties set forth in these Terms of Use; (5) your violation of the rights of a third party, including but not limited to intellectual property rights; or (6) any overt harmful act toward any other user of the Site with whom you connected via the Site. Notwithstanding the foregoing, we reserve the right, at your expense, to assume the exclusive defense and control of any matter for which you are required to indemnify us, and you agree to cooperate, at your expense, with our defense of such claims. We will use reasonable efforts to notify you of any such claim, action, or proceeding which is subject to this indemnification upon becoming aware of it. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_16_user_data.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_16_user_data.md new file mode 100644 index 0000000..80ecde7 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_16_user_data.md @@ -0,0 +1,3 @@ +**USER DATA** + +We will maintain certain data that you transmit to the Site for the purpose of managing the performance of the Site, as well as data relating to your use of the Site. Although we perform regular routine backups of data, you are solely responsible for all data that you transmit or that relates to any activity you have undertaken using the Site. You agree that we shall have no liability to you for any loss or corruption of any such data, and you hereby waive any right of action against us arising from any such loss or corruption of such data. diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_17_electronic_comms_transactions_signatures.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_17_electronic_comms_transactions_signatures.md new file mode 100644 index 0000000..da54ef8 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_17_electronic_comms_transactions_signatures.md @@ -0,0 +1,3 @@ +**ELECTRONIC COMMUNICATIONS, TRANSACTIONS, AND SIGNATURES** + +Visiting the Site, sending us emails, and completing online forms constitute electronic communications. You consent to receive electronic communications, and you agree that all agreements, notices, disclosures, and other communications we provide to you electronically, via email and on the Site, satisfy any legal requirement that such communication be in writing. YOU HEREBY AGREE TO THE USE OF ELECTRONIC SIGNATURES, CONTRACTS, ORDERS, AND OTHER RECORDS, AND TO ELECTRONIC DELIVERY OF NOTICES, POLICIES, AND RECORDS OF TRANSACTIONS INITIATED OR COMPLETED BY US OR VIA THE SITE. You hereby waive any rights or requirements under any statutes, regulations, rules, ordinances, or other laws in any jurisdiction which require an original signature or delivery or retention of non-electronic records, or to payments or the granting of credits by any means other than electronic means. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_18_miscellaneous.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_18_miscellaneous.md new file mode 100644 index 0000000..633bbe3 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_18_miscellaneous.md @@ -0,0 +1,3 @@ +**MISCELLANEOUS** + + These Terms of Use and any policies or operating rules posted by us on the Site or in respect to the Site constitute the entire agreement and understanding between you and us. Our failure to exercise or enforce any right or provision of these Terms of Use shall not operate as a waiver of such right or provision. These Terms of Use operate to the fullest extent permissible by law. We may assign any or all of our rights and obligations to others at any time. We shall not be responsible or liable for any loss, damage, delay, or failure to act caused by any cause beyond our reasonable control. If any provision or part of a provision of these Terms of Use is determined to be unlawful, void, or unenforceable, that provision or part of the provision is deemed severable from these Terms of Use and does not affect the validity and enforceability of any remaining provisions. There is no joint venture, partnership, employment or agency relationship created between you and us as a result of these Terms of Use or use of the Site. You agree that these Terms of Use will not be construed against us by virtue of having drafted them. You hereby waive any and all defenses you may have based on the electronic form of these Terms of Use and the lack of signing by the parties hereto to execute these Terms of Use. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_19_contact_us.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_19_contact_us.md new file mode 100644 index 0000000..82f7d36 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_19_contact_us.md @@ -0,0 +1,9 @@ +**CONTACT US** + + In order to resolve a complaint regarding the Site or to receive further information regarding use of the Site, please contact us at: + + **ThreeFold FCZ** + +BA1120 DMCC BUSINESS CENTRE, LEVEL NO 1, JEWELLERY & GEMPLEX 3, DUBAI, UNITED EMIRATES ARAB + +info@threefold.io \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_1_ip_rights.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_1_ip_rights.md new file mode 100644 index 0000000..4a56c39 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_1_ip_rights.md @@ -0,0 +1,5 @@ +**INTELLECTUAL PROPERTY RIGHTS** + + Unless otherwise indicated, the Site is our proprietary property and all source code, databases, functionality, software, website designs, audio, video, text, photographs, and graphics on the Site (collectively, the "Content") and the trademarks, service marks, and logos contained therein (the “Marks”) are owned or controlled by us or licensed to us, and are protected by copyright and trademark laws and various other intellectual property rights and EU competition laws, foreign jurisdictions, and international conventions. The Content and the Marks are provided on the Site “AS IS” for your information and personal use only. Except as expressly provided in these Terms of Use, no part of the Site and no Content or Marks may be copied, reproduced, aggregated, republished, uploaded, posted, publicly displayed, encoded, translated, transmitted, distributed, sold, licensed, or otherwise exploited for any commercial purpose whatsoever, without our express prior written permission. + +Provided that you are eligible to use the Site, you are granted a limited license to access and use the Site and to download or print a copy of any portion of the Content to which you have properly gained access solely for your personal, non-commercial use. We reserve all rights not expressly granted to you in and to the Site, the Content and the Marks. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_2_user_representations.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_2_user_representations.md new file mode 100644 index 0000000..281bcc0 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_2_user_representations.md @@ -0,0 +1,5 @@ +**USER REPRESENTATIONS** + + By using the Site, you represent and warrant that: (1) all registration information you submit will be true, accurate, current, and complete; (2) you will maintain the accuracy of such information and promptly update such registration information as necessary; (3) you have the legal capacity and you agree to comply with these Terms of Use; (4) you are not a minor in the jurisdiction in which you reside; (5) you will not access the Site through automated or non-human means, whether through a bot, script, or otherwise; (6) you will not use the Site for any illegal or unauthorized purpose; and (7) your use of the Site will not violate any applicable law or regulation. + +If you provide any information that is untrue, inaccurate, not current, or incomplete, we have the right to suspend or terminate your account and refuse any and all current or future use of the Site (or any portion thereof). \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_3_user_registration.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_3_user_registration.md new file mode 100644 index 0000000..24f5115 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_3_user_registration.md @@ -0,0 +1,3 @@ +**USER REGISTRATION** + +You may be required to register with the Site. You agree to keep your password confidential and will be responsible for all use of your account and password. We reserve the right to remove, reclaim, or change a username you select if we determine, in our sole discretion, that such username is inappropriate, obscene, or otherwise objectionable. diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_4_prohibited_activities.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_4_prohibited_activities.md new file mode 100644 index 0000000..dc86d3f --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_4_prohibited_activities.md @@ -0,0 +1,18 @@ +**PROHIBITED ACTIVITIES** + +You may not access or use the Site for any purpose other than that for which we make the Site available. The Site may not be used in connection with any commercial endeavors except those that are specifically endorsed or approved by us. + + As a user of the Site, you agree not to: + +1. Systematically retrieve data or other content from the Site to create or compile, directly or indirectly, a collection, compilation, database, or directory without written permission from us. +2. Circumvent, disable, or otherwise interfere with security-related features of the Site, including features that prevent or restrict the use or copying of any Content or enforce limitations on the use of the Site and/or the Content contained therein. +3. Engage in unauthorized framing of or linking to the Site. +4. Trick, defraud, or mislead us and other users, especially in any attempt to learn sensitive account information such as user passwords. +5. Engage in any automated use of the system, such as using scripts to send comments or messages, or using any data mining, robots, or similar data gathering and extraction tools. +6. Interfere with, disrupt, or create an undue burden on the Site or the networks or services connected to the Site. +7. Use the Site as part of any effort to compete with us or otherwise use the Site and/or the Content for any revenue-generating endeavor or commercial enterprise. +8. Decipher, decompile, disassemble, or reverse engineer any of the software comprising or in any way making up a part of the Site. +9. Upload or transmit (or attempt to upload or to transmit) viruses, Trojan horses, or other material, including excessive use of capital letters and spamming (continuous posting of repetitive text), that interferes with any party’s uninterrupted use and enjoyment of the Site or modifies, impairs, disrupts, alters, or interferes with the use, features, functions, operation, or maintenance of the Site. +10. Upload or transmit (or attempt to upload or to transmit) any material that acts as a passive or active information collection or transmission mechanism, including without limitation, clear graphics interchange formats ("gifs"), 1×1 pixels, web bugs, cookies, or other similar devices (sometimes referred to as “spyware” or “passive collection mechanisms” or “pcms”). +11. Except as may be the result of standard search engine or Internet browser usage, use, launch, develop, or distribute any automated system, including without limitation, any spider, robot, cheat utility, scraper, or offline reader that accesses the Site, or using or launching any unauthorized script or other software. +12. Use the Site in a manner inconsistent with any applicable laws or regulations. diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_5_user_generated_contributions.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_5_user_generated_contributions.md new file mode 100644 index 0000000..15b00c4 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_5_user_generated_contributions.md @@ -0,0 +1,22 @@ +**USER GENERATED CONTRIBUTIONS** + +The Site may invite you to chat, contribute to, or participate in blogs, message boards, online forums, and other functionality, and may provide you with the opportunity to create, submit, post, display, transmit, perform, publish, distribute, or broadcast content and materials to us or on the Site, including but not limited to text, writings, video, audio, photographs, graphics, comments, suggestions, or personal information or other material (collectively, "Contributions"). Contributions may be viewable by other users of the Site and through third-party websites. As such, any Contributions you transmit may be treated as non-confidential and non-proprietary. When you create or make available any Contributions, you thereby represent and warrant that: + + + +1. The creation, distribution, transmission, public display, or performance, and the accessing, downloading, or copying of your Contributions do not and will not infringe the proprietary rights, including but not limited to the copyright, patent, trademark, trade secret, or moral rights of any third party. +2. You are the creator and owner of or have the necessary licenses, rights, consents, releases, and permissions to use and to authorize us, the Site, and other users of the Site to use your Contributions in any manner contemplated by the Site and these Terms of Use. +3. You have the written consent, release, and/or permission of each and every identifiable individual person in your Contributions to use the name or likeness of each and every such identifiable individual person to enable inclusion and use of your Contributions in any manner contemplated by the Site and these Terms of Use. +4. Your Contributions are not false, inaccurate, or misleading. +5. Your Contributions are not unsolicited or unauthorized advertising, promotional materials, pyramid schemes, chain letters, spam, mass mailings, or other forms of solicitation. +6. Your Contributions are not obscene, lewd, lascivious, filthy, violent, harassing, libelous, slanderous, or otherwise objectionable (as determined by us). +7. Your Contributions do not ridicule, mock, disparage, intimidate, or abuse anyone. +98 Your Contributions do not advocate the violent overthrow of any government or incite, encourage, or threaten physical harm against another. +9. Your Contributions do not violate any applicable law, regulation, or rule. +10. Your Contributions do not violate the privacy or publicity rights of any third party. +11. Your Contributions do not contain any material that solicits personal information from anyone under the age of 18 or exploits people under the age of 18 in a sexual or violent manner. +12. Your Contributions do not violate any federal or state law concerning child pornography, or otherwise intended to protect the health or well-being of minors; +13. Your Contributions do not include any offensive comments that are connected to race, national origin, gender, sexual preference, or physical handicap. +14. Your Contributions do not otherwise violate, or link to material that violates, any provision of these Terms of Use, or any applicable law or regulation. + +Any use of the Site in violation of the foregoing violates these Terms of Use and may result in, among other things, termination or suspension of your rights to use the Site. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_6_contribution_license.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_6_contribution_license.md new file mode 100644 index 0000000..689ec3d --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_6_contribution_license.md @@ -0,0 +1,9 @@ +**CONTRIBUTION LICENSE** + +By posting your Contributions to any part of the Site or making Contributions accessible to the Site by linking your account from the Site to any of your social networking accounts, you automatically grant, and you represent and warrant that you have the right to grant, to us an unrestricted, unlimited, irrevocable, perpetual, non-exclusive, transferable, royalty-free, fully-paid, worldwide right, and license to host, use, copy, reproduce, disclose, sell, resell, publish, broadcast, retitle, archive, store, cache, publicly perform, publicly display, reformat, translate, transmit, excerpt (in whole or in part), and distribute such Contributions (including, without limitation, your image and voice) for any purpose, commercial, advertising, or otherwise, and to prepare derivative works of, or incorporate into other works, such Contributions, and grant and authorize sublicenses of the foregoing. The use and distribution may occur in any media formats and through any media channels. + +This license will apply to any form, media, or technology now known or hereafter developed, and includes our use of your name, company name, and franchise name, as applicable, and any of the trademarks, service marks, trade names, logos, and personal and commercial images you provide. You waive all moral rights in your Contributions, and you warrant that moral rights have not otherwise been asserted in your Contributions. + +We do not assert any ownership over your Contributions. You retain full ownership of all of your Contributions and any intellectual property rights or other proprietary rights associated with your Contributions. We are not liable for any statements or representations in your Contributions provided by you in any area on the Site. You are solely responsible for your Contributions to the Site and you expressly agree to exonerate us from any and all responsibility and to refrain from any legal action against us regarding your Contributions. + +We have the right, in our sole and absolute discretion, (1) to edit, redact, or otherwise change any Contributions; (2) to re-categorize any Contributions to place them in more appropriate locations on the Site; and (3) to pre-screen or delete any Contributions at any time and for any reason, without notice. We have no obligation to monitor your Contributions. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_7_social_media.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_7_social_media.md new file mode 100644 index 0000000..56d92b7 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_7_social_media.md @@ -0,0 +1,5 @@ +**SOCIAL MEDIA** + +As part of the functionality of the Site, you may link your account with online accounts you have with third-party service providers (each such account, a "Third-Party Account") by either: (1) providing your Third-Party Account login information through the Site; or (2) allowing us to access your Third-Party Account, as is permitted under the applicable terms and conditions that govern your use of each Third-Party Account. You represent and warrant that you are entitled to disclose your Third-Party Account login information to us and/or grant us access to your Third-Party Account, without breach by you of any of the terms and conditions that govern your use of the applicable Third-Party Account, and without obligating us to pay any fees or making us subject to any usage limitations imposed by the third-party service provider of the Third-Party Account. By granting us access to any Third-Party Accounts, you understand that (1) we may access, make available, and store (if applicable) any content that you have provided to and stored in your Third-Party Account (the “Social Network Content”) so that it is available on and through the Site via your account, including without limitation any friend lists and (2) we may submit to and receive from your Third-Party Account additional information to the extent you are notified when you link your account with the Third-Party Account. Depending on the Third-Party Accounts you choose and subject to the privacy settings that you have set in such Third-Party Accounts, personally identifiable information that you post to your Third-Party Accounts may be available on and through your account on the Site. Please note that if a Third-Party Account or associated service becomes unavailable or our access to such Third Party Account is terminated by the third-party service provider, then Social Network Content may no longer be available on and through the Site. You will have the ability to disable the connection between your account on the Site and your Third-Party Accounts at any time. PLEASE NOTE THAT YOUR RELATIONSHIP WITH THE THIRD- + +PARTY SERVICE PROVIDERS ASSOCIATED WITH YOUR THIRD-PARTY ACCOUNTS IS GOVERNED SOLELY BY YOUR AGREEMENT(S) WITH SUCH THIRD-PARTY SERVICE PROVIDERS. We make no effort to review any Social Network Content for any purpose, including but not limited to, for accuracy, legality, or non-infringement, and we are not responsible for any Social Network Content. You acknowledge and agree that we may access your email address book associated with a Third-Party Account and your contacts list stored on your mobile device or tablet computer solely for purposes of identifying and informing you of those contacts who have also registered to use the Site. You can deactivate the connection between the Site and your Third-Party Account by contacting us using the contact information below or through your account settings (if applicable). We will attempt to delete any information stored on our servers that was obtained through such Third-Party Account, except the username and profile picture that become associated with your account. diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_8_submission.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_8_submission.md new file mode 100644 index 0000000..d390911 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_8_submission.md @@ -0,0 +1,3 @@ +**SUBMISSIONS** + +You acknowledge and agree that any questions, comments, suggestions, ideas, feedback, or other information regarding the Site ("Submissions") provided by you to us are non-confidential and shall become our sole property. We shall own exclusive rights, including all intellectual property rights, and shall be entitled to the unrestricted use and dissemination of these Submissions for any lawful purpose, commercial or otherwise, without acknowledgment or compensation to you. You hereby waive all moral rights to any such Submissions, and you hereby warrant that any such Submissions are original with you or that you have the right to submit such Submissions. You agree there shall be no recourse against us for any alleged or actual infringement or misappropriation of any proprietary right in your Submissions. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_9_thirdparty_websites_content.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_9_thirdparty_websites_content.md new file mode 100644 index 0000000..7f69b25 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/terms_conditions_websites/part_9_thirdparty_websites_content.md @@ -0,0 +1,3 @@ +**THIRD-PARTY WEBSITES AND CONTENT** + +The Site may contain (or you may be sent via the Site) links to other websites ("Third-Party Websites") as well as articles, photographs, text, graphics, pictures, designs, music, sound, video, information, applications, software, and other content or items belonging to or originating from third parties ("Third-Party Content"). Such Third-Party Websites and Third-Party Content are not investigated, monitored, or checked for accuracy, appropriateness, or completeness by us, and we are not responsible for any Third-Party Websites accessed through the Site or any Third-Party Content posted on, available through, or installed from the Site, including the content, accuracy, offensiveness, opinions, reliability, privacy practices, or other policies of or contained in the Third-Party Websites or the Third-Party Content. Inclusion of, linking to, or permitting the use or installation of any Third-Party Websites or any Third-Party Content does not imply approval or endorsement thereof by us. If you decide to leave the Site and access the Third-Party Websites or to use or install any Third-Party Content, you do so at your own risk, and you should be aware these Terms of Use no longer govern. You should review the applicable terms and policies, including privacy and data gathering practices, of any website to which you navigate from the Site or relating to any applications you use or install from the Site. Any purchases you make through Third-Party Websites will be through other websites and from other companies, and we take no responsibility whatsoever in relation to such purchases which are exclusively between you and the applicable third party. You agree and acknowledge that we do not endorse the products or services offered on Third-Party Websites and you shall hold us harmless from any harm caused by your purchase of such products or services. Additionally, you shall hold us harmless from any losses sustained by you or harm caused to you relating to or resulting in any way from any Third-Party Content or any contact with Third-Party Websites. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/tfta_to_tft.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/tfta_to_tft.md new file mode 100644 index 0000000..33a89ce --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/tfta_to_tft.md @@ -0,0 +1,9 @@ +## Convert TFTA to TFT + +TFTA is a voluntary staking pool for people to show that they have no intent to sell in near time. + +If you would like migrate TFTA to TFT, it's super easy, just send your TFTA to the following address: + +> GBUT4GP5GJ6B3XW5PXENHQA7TXJI5GOPW3NF4W3ZIW6OOO4ISY6WNLN2 + +and it will return as TFT. We suggest that you try with 1 TFT first! \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions/threefold_companies0.md b/collections/tfmanual/knowledge_base/legal/terms_conditions/threefold_companies0.md new file mode 100644 index 0000000..a626914 --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions/threefold_companies0.md @@ -0,0 +1,29 @@ +

ThreeFold Related Companies

+ +The following companies are related parties to ThreeFold. Our terms and conditions apply. + +| THREEFOLD RELATED COMPANIES | Description | +| --------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| [ThreeFold Dubai or ThreeFold Cloud](../../about/threefold_dubai.md) | Promotion of TFGrid + Delivery of ThreeFold Cloud | +| [Threefold_Tech](../../about/threefold_tech.md) | Belgium-based tech company owns IP (Intellectual Property) of tech, is open source | +| [ThreeFold_VZW](../../about/threefold_vzw.md) | Non for profit organization in BE, intented to be used for grants work. | +| [ThreeFold_AG](../../about/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](../../about/mazraa.md) | A farmer in Middle East who is part of ThreeFold_Dubai | +| [BetterToken](../../about/bettertoken.md) | BetterToken is the very first ThreeFold Farming Cooperative in Europe | + + +| SOME LARGER FARMERS | | +| ------------------- | ---------------------------------------------------------------- | +| Green Edge | Early ThreeFold Farmer providing decentralized compute & storage | +| Bancadati | Large ThreeFold Farmer in Switzerland | +| Moresi | A neutral, technologically advanced data center in Switzerland | +| there are many more | ... | + +> Please note, ThreeFold Grid 3.x operates as a [DAO](../../about/dao/dao.md) every party who wants to participate with the ThreeFold Grid uses the [TFChain](../../about/tfchain.md) and our Forums. +> [Click here for more info about our DAO](../../about/dao/tfdao.md) \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/terms_conditions_all3.md b/collections/tfmanual/knowledge_base/legal/terms_conditions_all3.md new file mode 100644 index 0000000..07fb1ec --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/terms_conditions_all3.md @@ -0,0 +1,15 @@ +# Legal + +## TFGRID USER and/or FARMER TERMS AND CONDITIONS TFGRID 3.X + +THESE TERMS AND CONDITIONS (THE "**AGREEMENTS**") CONSTITUTE A LEGAL AGREEMENT BETWEEN YOU (“TFGRID **USER**,"“TFGRID **FARMER**," “**YOU**", OR “**YOURS**”) AND TRC (“**THREEFOLD**”, “**COMPANY**,” “**US**,” “**WE**” OR “**OUR**”), GOVERNING THE TERMS OF YOUR PARTICIPATION AS A PARTNER, CUSTOMER, FARMER OR USER IN THE THREEFOLD GRID. YOU UNDERSTAND AND AGREE THAT BY ACCEPTING THE TERMS OF THIS AGREEMENT, EITHER BY CLICKING TO SIGNIFY ACCEPTANCE, OR BY TAKING ANY ONE OR MORE OF THE FOLLOWING ACTIONS DOWNLOADING, INSTALLING, RUNNING,/AND OR USING THE APPLICABLE SOFTWARE, YOU AGREE TO BE BOUND BY THE TERMS OF THIS AGREEMENT EFFECTIVE AS OF THE DATE THAT YOU TAKE THE EARLIEST OF ONE OF THE FOREGOING ACTIONS. YOU REPRESENT AND WARRANT THAT YOU ARE 18 YEARS OLD OR OLDER AND HAVE THE RIGHT AND AUTHORITY TO ENTER INTO AND COMPLY WITH THE TERMS OF THIS AGREEMENT. + +> BY USING THE TFGRID OR ANY OF THE THREEFOLD PROVIDED SOFTWARE OR SERVICES YOU ACCEPT THE FOLLOWING AGREEMENTS: + +- [X] [Disclaimer](./disclaimer.md) +- [X] [Definitions](./definitions_legal.md) +- [X] [Privacy Policy](./privacypolicy.md) +- [X] [Terms & Conditions ThreeFold Related Websites](./terms_conditions/terms_conditions_websites.md) +- [X] [Terms & Conditions TFGrid Users TFGrid 3](./terms_conditions/terms_conditions_griduser.md) +- [X] [Terms & Conditions TFGrid Farmers TFGrid 3](./terms_conditions/terms_conditions_farmer3.md) +- [X] [Terms & Conditions TFGrid Sales](./terms_conditions/terms_conditions_sales.md) \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/legal/threefold_fzc_address.md b/collections/tfmanual/knowledge_base/legal/threefold_fzc_address.md new file mode 100644 index 0000000..7ae3c9e --- /dev/null +++ b/collections/tfmanual/knowledge_base/legal/threefold_fzc_address.md @@ -0,0 +1,2 @@ +Q1-07-038/B SAIF Zone, Sharjah +United Arab Emirates \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/architecture/cloud_architecture_.md b/collections/tfmanual/knowledge_base/technology/architecture/cloud_architecture_.md new file mode 100644 index 0000000..accb833 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/architecture/cloud_architecture_.md @@ -0,0 +1,20 @@ +![](img/architecture_why_us.jpg) + +## Architecture Overview + +**More info:** + +- QSSS + - QSFS +- [Quantum Safe Network Concept](sdk:archi_qsnetwork) + - [Zero-OS Network](sdk:capacity_network) + - [ThreeFold Network = Planetary Network](sdk:archi_psnw) + - [Web Gateway](sdk:archi_webgateway) +- TFGrid + - [3Node](3node) + - [ThreeFold Connect](tfconnect) + + diff --git a/collections/tfmanual/knowledge_base/technology/architecture/cloud_wallet_.md b/collections/tfmanual/knowledge_base/technology/architecture/cloud_wallet_.md new file mode 100644 index 0000000..ceff391 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/architecture/cloud_wallet_.md @@ -0,0 +1,43 @@ +# Wallet on Stellar Network + +![](img/3bot_wallet_detail.jpg) + +### Prepaid Wallets + +The VDC has a built-in __prepaid wallet__, which is the wallet used for paying the capacity requested in the VDC. This wallet expresses in TFT the remaining balance available for ensuring the operational continuity of the reserved capacity. + +This wallet is registered on the Stellar network, and is exclusively used for capacity reservation aligned with the chosen VDC size. +Both the TFGrid testnet and mainnet are connected to the Stellar mainnet, so TFTs used are the same. Testnet prices are substantially lower than mainnet prices, though there's no guarantee about continuity of operation: testnet is reset at regular times, and available capacity is also lower than on mainnet. + +### A public key and a shared private key + +The wallet is characterized by 2 strings: +- A public address, starting with a 'G', is the address that can be shared with anyone, as it the address to be mentioned when transferring tokens TO the wallet. +- A private key, starting with an 'S', is the secret that gives control over the wallet, and which is needed to generate outgoing transfers. + +### Payment for Capacity Process + +The Prepaid Wallet which is setup within your VDC is exclusively used for this purpose. The private key of this wallet is shared between you and the VDC provider : +- The VDC provider needs the private key to pay the farmer on a rolling basis : every hour an amount is transferred to the farmer(s) that owns the reserved hardware capacity, so it stays reserved for the next 2 weeks. These 2 weeks are meant as a 'grace period' : when the balance of the prepaid wallet becomes zero, you have 2 weeks to top up the wallet. You will get notified for this, while the workload remains operational. +In case after these 2 weeks grace period the wallet hasn't been topped up again, the workload will be removed and the capacity will be made available again for new reservations. + +## Top-up a Wallet + +Please read the [Top-up](evdc_wallet_topup) page for instructions. + +## Viewing Your Balance + +Simply click on one of your existing wallet see the details of the wallet. + +![](img/3bot_wallet_detail.jpg) + +## Withdraw TFTs from the wallet + +The private key is available to transfer tokens from the prepaid wallet to your personal TFT wallet. Evidently, transferring tokens has a direct impact on the expiration date of your VDC. + +### Your VDC Wallet Details + +- The Network is the Stellar mainnet network (indicated with `STD` on the wallet information) +- [Trustlines](https://www.stellar.org/developers/guides/concepts/assets.html) are specific to the Stellar network to indicate that a user is 'trusting' the asset / crypto issuer, in our case trusting ThreeFold Dubai as issuer of TFT. +Trustlines are specific to the network, so it needs to be established both on testnet and mainnet and for all the tokens that someone intends to hold. Without a trustline, a wallet address can't be fed with tokens. +In order to make it easier for the user, trustlines are being established automatically when creating a wallet for TFT in the admin panel as well as in ThreeFold Connect app. However, if you use a third party Stellar wallet for your tokens, you need to create the trustlines yourself. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/architecture/evdc_qsfs_get_started_.md b/collections/tfmanual/knowledge_base/technology/architecture/evdc_qsfs_get_started_.md new file mode 100644 index 0000000..50d7ab1 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/architecture/evdc_qsfs_get_started_.md @@ -0,0 +1,79 @@ +## Getting started + +Any Quantum-Safe File System has 4 storage layers : +- An etcd metadata storage layer +- Local storage +- ZDB-FS fuse layer +- ZSTOR for the dispersed storage + +Now, there are 2 ways to run the zstor filesystem: +- In self-management mode for the metadata; +- A 'Quantum Storage Enabled' mode. + +The first mode combines the local storage, ZDB-FS and ZSTOR, but requires an etcd metadata layer to be manually run and managed. +The second mode is enabled by the `ENABLE QUANTUM STORAGE` button and provisions etcd to manage the metadata. Here the 4 layers are available (hence it will consume slightly more storage from your VDC). + +### Manually Managed Metadata Mode + +This Planetary Secure File System uses a ThreeFold VDC's storage nodes to back data up to the ThreeFold Grid. Below you'll find instructions for using an executable bootstrap file that runs on Linux or in a Linux Docker container to set up the complete environment necessary to use the file system. + +Please note that this solution is currently for testing only, and some important features are still under development. + +#### VDC and Z-Stor Config + +If you haven't already, go ahead and [deploy a VDC](evdc_deploy). Then download the Z-Stor config file, found in the upper right corner of the `VDC Storage Nodes` screen. Unless you know that IPv6 works on your machine and within Docker, choose the IPv4 version of the file. + +![](img/planetaryfs_zstor_config.jpg) + +As described in [Manage Storage Nodes](evdc_storage), this file contains the necessary information to connect with the 0-DBs running on the storage nodes in your VDC. It also includes an encryption key used to encrypt data that's uploaded and a field to specify your etcd endpoints. Using the defaults here is fine. + +#### Bootstrap Executable + +Download now the zstor filesystem bootstrap, available [here](https://github.com/threefoldtech/quantum-storage/releases/download/v0.0.1/planetaryfs-bootstrap-linux-amd64). + + +> __Remark__: +For now, the bootstrap executable is only available for Linux. We'll cover how to use it within an Ubuntu container in Docker, which will also work on MacOS. +First, we'll start an Ubuntu container with Docker, enabling fuse file system capabilities. In a terminal window, + +`docker run -it --name zdbfs --cap-add SYS_ADMIN --device /dev/fuse ubuntu:20.04` + +Next, we'll copy the Z-Stor config file and the bootstrap executable into the running container. In a separate terminal window, navigate to where you downloaded the files and run: + +`docker cp planetaryfs-bootstrap-linux-amd64 zdbfs:/root/` +`docker cp zdbfs:/root/` + +Back in the container's terminal window, `cd /root` and confirm that the two files are there with `ls`. Then run the bootstrap executable, specifying your config file: + +`chmod u+x planetaryfs-bootstrap-linux-amd64` +`./planetaryfs-bootstrap-linux-amd64 ` + +This bootstrap's execution will start up all necessary components and show you that the back-end is ready for dispersing the data. + +![](img/planetaryfs_bootstrap_ready.jpg ':size=600') + +After that, your Planetary Secure File System will be mounted at `/root/.threefold/mnt/zdbfs`. Files copied there will automatically be stored on the grid incrementally as fragments of a certain size are filled, by default 32Mb. In a future release, this will no longer be a limitation. + +### Provisioned Metadata Mode + +Users that intend to have also the metadata out-of-the-box available, and have it used in the Kubernetes cluster, need to push the `ENABLE QUANTUM STORAGE` button. This will allow to use etcd key-value stores in the VDC, and can be used within a Kubernetes cluster. + +![](img/planetaryfs_enable_qs.jpg) + +Once Quantum Storage mode is enabled, you get an etcd for free. + +**Remark**: this action can't be undone in your VDC : the etcd stores can be filled immediately, and deletion of them could result in data loss. This is why the 'Disable Quantum Storage' is considered as too risky and is not available. + +### Add node + +Adding storage nodes manually is simple: press the `+ ADD NODE` button. + +![](img/planetaryfs_add_node.jpg) + +You'll be asked to deploy this storage node either on the same farm or on another one. The choice is a balance between security (have the data in multiple locations makes it more resilient against disaster). + +![](img/planetaryfs_farm.jpg ':size=600') + +If you choose `Yes`, select the farm of your choice, and then pay for the extra capacity. + +![](img/planetaryfs_pay.jpg ':size=600') \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/architecture/img/3bot_wallet_detail.jpg b/collections/tfmanual/knowledge_base/technology/architecture/img/3bot_wallet_detail.jpg new file mode 100644 index 0000000..ab79ec2 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/architecture/img/3bot_wallet_detail.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/architecture/img/3layers_tf_.jpg b/collections/tfmanual/knowledge_base/technology/architecture/img/3layers_tf_.jpg new file mode 100644 index 0000000..1f244d7 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/architecture/img/3layers_tf_.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/architecture/img/architecture_why_us.jpg b/collections/tfmanual/knowledge_base/technology/architecture/img/architecture_why_us.jpg new file mode 100644 index 0000000..0c144df Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/architecture/img/architecture_why_us.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/architecture/img/planet_fs.jpg b/collections/tfmanual/knowledge_base/technology/architecture/img/planet_fs.jpg new file mode 100644 index 0000000..7d2d814 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/architecture/img/planet_fs.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/architecture/img/planetaryfs_add_node.jpg b/collections/tfmanual/knowledge_base/technology/architecture/img/planetaryfs_add_node.jpg new file mode 100644 index 0000000..89f259c Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/architecture/img/planetaryfs_add_node.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/architecture/img/planetaryfs_bootstrap_ready.jpg b/collections/tfmanual/knowledge_base/technology/architecture/img/planetaryfs_bootstrap_ready.jpg new file mode 100644 index 0000000..c59c889 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/architecture/img/planetaryfs_bootstrap_ready.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/architecture/img/planetaryfs_enable_qs.jpg b/collections/tfmanual/knowledge_base/technology/architecture/img/planetaryfs_enable_qs.jpg new file mode 100644 index 0000000..166edad Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/architecture/img/planetaryfs_enable_qs.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/architecture/img/planetaryfs_farm.jpg b/collections/tfmanual/knowledge_base/technology/architecture/img/planetaryfs_farm.jpg new file mode 100644 index 0000000..45fca5b Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/architecture/img/planetaryfs_farm.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/architecture/img/planetaryfs_pay.jpg b/collections/tfmanual/knowledge_base/technology/architecture/img/planetaryfs_pay.jpg new file mode 100644 index 0000000..0dfc38d Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/architecture/img/planetaryfs_pay.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/architecture/img/planetaryfs_zstor_config.jpg b/collections/tfmanual/knowledge_base/technology/architecture/img/planetaryfs_zstor_config.jpg new file mode 100644 index 0000000..4467329 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/architecture/img/planetaryfs_zstor_config.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/architecture/img/quantum_safe_storage.jpg b/collections/tfmanual/knowledge_base/technology/architecture/img/quantum_safe_storage.jpg new file mode 100644 index 0000000..4d99c48 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/architecture/img/quantum_safe_storage.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/architecture/img/quantum_safe_storage_scale.jpg b/collections/tfmanual/knowledge_base/technology/architecture/img/quantum_safe_storage_scale.jpg new file mode 100644 index 0000000..b785a79 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/architecture/img/quantum_safe_storage_scale.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/architecture/threefold_filesystem.md b/collections/tfmanual/knowledge_base/technology/architecture/threefold_filesystem.md new file mode 100644 index 0000000..45b12fe --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/architecture/threefold_filesystem.md @@ -0,0 +1,34 @@ +![](img/planet_fs.jpg) + +# ThreeFold zstor filesystem (zstor) + +Part of the eVDC is a set of Storage Nodes, which can be used as a storage infrastructure for files in any format. + +## Mount Any Files in your Storage Infrastructure + +The QSFS is a mechanism to mount any file system (in any format) on the grid, in a quantum-secure way. + +This storage layer relies on relies on 3 primitives of the ThreeFold technology : + +- [0-db](https://github.com/threefoldtech/0-db) is the storage engine. +It is an always append database, which stores objects in an immutable format. It allows keeping the history out-of-the-box, good performance on disk, low overhead, easy data structure and easy backup (linear copy and immutable files). + +- [0-stor-v2](https://github.com/threefoldtech/0-stor_v2) is used to disperse the data into chunks by performing 'forward-looking error-correcting code' (FLECC) on it and send the fragments to safe locations. +It takes files in any format as input, encrypts this file with AES based on a user-defined key, then FLECC-encodes the file and spreads out the result +to multiple 0-DBs. The number of generated chunks is configurable to make it more or less robust against data loss through unavailable fragments. Even if some 0-DBs are unreachable, you can still retrieve the original data, and missing 0-DBs can even be rebuilt to have full consistency. It's an essential element of the operational backup. + +- [0-db-fs](https://github.com/threefoldtech/0-db-fs) is the filesystem driver which uses 0-DB as a primary storage engine. It manages the storage of directories and metadata in a dedicated namespace and file payloads in another dedicated namespace. + +Together they form a storage layer that is quantum secure: even the most powerful computer can't hack the system because no single node contains all of the information needed to reconstruct the data. + +![](img/quantum_safe_storage.jpg) + +This concept scales forever, and you can bring any file system on top of it: +- S3 storage +- any backup system +- an ftp-server +- IPFS and Hypercore distributed file sharing protocols +- ... + +![](img/quantum_safe_storage_scale.jpg) + diff --git a/collections/tfmanual/knowledge_base/technology/concepts/buying_storing_tft.md b/collections/tfmanual/knowledge_base/technology/concepts/buying_storing_tft.md new file mode 100644 index 0000000..8019cb7 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/concepts/buying_storing_tft.md @@ -0,0 +1,32 @@ +![](./img/tft.png) + +# Buying and Storing TFTs + +If you're looking to navigate the [TFT Ecosystem](https://library.threefold.me/info/manual/#/tokens/threefold__tft_ecosystem), this collection of tutorials and manuals is here to help. Learn how to purchase, trade, and securely store your TFTs with ease. + +For a comprehensive introduction to TFT, we recommend exploring the [TFT Home Section in the ThreeFold Library](https://library.threefold.me/info/threefold#/tokens/threefold__tokens_home). + +## Manuals on How to Buy TFT +Discover step-by-step instructions on buying and storing TFTs across different platforms. Our manuals cover: + +- [BSC - Pancake Swap](https://library.threefold.me/info/manual/#/tokens/threefold__tft_binance_defi) +- [BSC - 1inch.io](https://library.threefold.me/info/manual/#/tokens/threefold__tft_1inch) +- [GetTFT.com](https://gettft.com/gettft/#how-it-works) +- [Albedo Wallet](https://library.threefold.me/info/manual/#/tokens/threefold__albedo) +- [Solar Wallet](https://library.threefold.me/info/manual/#/tokens/threefold__solar_wallet) +- [Lobstr Wallet](https://library.threefold.me/info/manual/#/tokens/threefold__lobstr_wallet) +- [StellarTerm](https://library.threefold.me/info/manual/#/tokens/threefold__tft_stellarterm) +- [Interstellar](https://library.threefold.me/info/manual/#/tokens/threefold__tft_interstellar) +- [BTC-Alpha Exchange](https://library.threefold.me/info/manual/#/tokens/threefold__tft_btc_alpha) +- [StellarX Exchange](https://library.threefold.me/info/manual/#/tokens/threefold__tft_stellarx) +- [TF Live Desk (OTC)](https://library.threefold.me/info/manual/#/tokens/threefold__tft_otc) +- [Mazraa (Farmers)](https://library.threefold.me/info/manual/#/tokens/threefold__tft_mazraa) +- [Bettertoken (Farmers)](https://library.threefold.me/info/manual/#/tokens/threefold__tft_bettertoken) + +## Other Related Manuals on TFT +- [Store TFTs on Hardware Wallets](../threefold_token/storing_tft/hardware_wallet.md) +- [Storing TFTs on TF Connect App](../threefold_token/storing_tft/tf_connect_app.md) +- [TFT Bridges](../threefold_token/tft_bridges/tft_bridges.md) + - [TFChain-Stellar Bridge](../threefold_token/tft_bridges/tfchain_stellar_bridge.md) + - [BSC-Stellar Bridge](../threefold_token/tft_bridges/bsc_stellar_bridge.md) + - [Ethereum-Stellar Bridge](../threefold_token/tft_bridges/tft_ethereum/tft_ethereum.md) diff --git a/collections/tfmanual/knowledge_base/technology/concepts/concepts_readme.md b/collections/tfmanual/knowledge_base/technology/concepts/concepts_readme.md new file mode 100644 index 0000000..37270cb --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/concepts/concepts_readme.md @@ -0,0 +1,19 @@ +# ThreeFold Grid Concepts + +On this section we will explore the fundamental principles and concepts behind the ThreeFold Grid. This comprehensive resource will take you on a journey through the core technologies that underpin the ThreeFold Grid, empowering you to understand and leverage the decentralized nature of this groundbreaking infrastructure. + +## Learn the Basics + +- [TFGrid Primitives](./grid_primitives.md) +- [TFGrid Component List](./grid3_components.md) +- [ThreeFold's Infrastructure as Code (IaC)](./grid3_iac.md) +- [Proof of Utilization](./proof_of_utilization.md) +- [Contract Grace Period](./contract_grace_period.md) +- [What's New on TFGrid v3.x](./grid3_whatsnew.md) +- [TFChain](./tfchain.md) +- [TFGrid by Design](./tfgrid_by_design.md) + +## Take an In-Depth Looks + +- [TF Technology](../technology_toc.md) +- [What's New on TFGrid v3.x](./grid3_whatsnew.md) \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/concepts/contract_grace_period.md b/collections/tfmanual/knowledge_base/technology/concepts/contract_grace_period.md new file mode 100644 index 0000000..7dc818a --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/concepts/contract_grace_period.md @@ -0,0 +1,89 @@ +

Grace Period: Ensuring Seamless Operations

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [What is the Grace Period?](#what-is-the-grace-period) +- [How does it work?](#how-does-it-work) +- [When does the Grace Period kick in?](#when-does-the-grace-period-kick-in) +- [How to resume your workloads:](#how-to-resume-your-workloads) +- [Grace Period Contract State: Easily Accessible Information](#grace-period-contract-state-easily-accessible-information) + - [Grid Weblets:](#grid-weblets) + - [ThreeFold Grid Proxy:](#threefold-grid-proxy) +- [TFChain GraphQL:](#tfchain-graphql) + - [Node Contract](#node-contract) + - [Rent Contract](#rent-contract) +- [PolkadotJS UI:](#polkadotjs-ui) + +*** + +## Introduction + +__The Grace Period__ serves as a crucial aspect of the ThreeFold ecosystem, providing a safety net for users when their funds run low. Let's explore the key details in a user-friendly manner: + +## What is the Grace Period? + +When a contract owner exhausts their wallet funds required for their deployment, the contract enters a Grace Period. During this time, the deployment becomes temporarily inaccessible to the user. However, once the wallet is replenished with TFT (ThreeFold Tokens), the contract resumes normal operation. + +It's important to note that if the Grace Period expires (typically after 2 weeks), the user's deployment and data will be deleted from the node. + +## How does it work? + +When a ``twin`` (a user account) depletes its funds, all linked contracts enter a Grace Period during the next billing cycle. +By default, the Grace Period lasts for 14 days. Throughout this period, users cannot utilize any deployments associated with the twin. + +Additionally, users cannot delete contracts during the Grace Period, whether they are related to nodes, names, or rent. +Workloads become usable again when the twin is funded with the required amount of TFT. + +If the twin is not funded during the Grace Period, the contracts will be automatically deleted after this period. + +## When does the Grace Period kick in? +The Grace Period commences when the twin balance falls below the minimum required for the respective deployments or workloads. + +## How to resume your workloads: +To regain access to workloads within the Grace Period, it is essential to fund your twin with sufficient TFT tokens. This action ensures the resumption of operations and allows you to continue your work seamlessly. + +The Grace Period feature acts as a safeguard, providing users with the opportunity to manage their funds effectively and maintain uninterrupted operations within the ThreeFold ecosystem. + +## Grace Period Contract State: Easily Accessible Information + +Checking the state of your contracts within the ``Grace Period`` is simple and convenient. Here's how you can do it: + +### Grid Weblets: +The Contracts tab on the Dashboard provides an easy way to monitor your contracts. Here, you can find comprehensive details about the desired ``contract``, including its ``State`` and ``Expiration date`` if the node is in the Grace Period. + +![](./img/manual__grace_period_weblets.png) + +### ThreeFold Grid Proxy: +Access the Grace Period contracts through the following endpoint: + +``https://gridproxy.grid.tf/contracts?state=GracePeriod&twin_id=`` + +![](./img/manual__grace_period_gridproxy.png) + +This allows you to retrieve information about contracts that are currently in the Grace Period. + +## TFChain GraphQL: +You can also check the Contract State using [__GraphQL queries__](https://graphql.grid.tf/graphql). Depending on the contract type, utilize the appropriate queries available for ``Node Contract`` and ``Rent Contract``. + +### Node Contract +![](./img/manual__grace_period_graphql_node.png) + +### Rent Contract +These queries provide insights into the status and details of the contracts. + +![](./img/manual__grace_period_graphql_rent.png) + +## PolkadotJS UI: +Another option is to check the Contract state using the [__PolkadotJS UI__](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Ftfchain.grid.tf#/chainstate). Simply navigate to ``chainstate`` -> ``SmartContractModule`` -> ``Contracts(ID_OF_CONTRACT)`` to view the relevant contract information. + +![](./img/manual__grace_period_polkadot_ui.png) + +With these user-friendly options at your disposal, you can effortlessly track and monitor the state of your contracts within the Grace Period. + + + + + + + diff --git a/collections/tfmanual/knowledge_base/technology/concepts/grid3_components.md b/collections/tfmanual/knowledge_base/technology/concepts/grid3_components.md new file mode 100644 index 0000000..c18fe19 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/concepts/grid3_components.md @@ -0,0 +1,351 @@ +

TFGrid Component List (Last Updated May 2023)

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [TFGrid Components (Alphabetical Orders)](#tfgrid-components-alphabetical-orders) + - [TF Admin Portal](#tf-admin-portal) + - [AtomicSwap](#atomicswap) + - [Builders](#builders) + - [TF Capacity Explorer](#tf-capacity-explorer) + - [Cloud Container](#cloud-container) + - [Cloud Console](#cloud-console) + - [TF Dashboard](#tf-dashboard) + - [Farm Management](#farm-management) + - [TF Farming Calculator](#tf-farming-calculator) + - [Farmerbot](#farmerbot) + - [Freeflow Twin Main App or Freeflow Connect (previously Uhuru)](#freeflow-twin-main-app-or-freeflow-connect-previously-uhuru) + - [GetTFT Shop](#gettft-shop) + - [TF Grid3 Client TS](#tf-grid3-client-ts) + - [TF Grid Proxy](#tf-grid-proxy) + - [TF Grid-SDK-Go](#tf-grid-sdk-go) + - [TF Grid-SDK-TS](#tf-grid-sdk-ts) + - [TF Grid Simulator](#tf-grid-simulator) + - [TF Grid Stats](#tf-grid-stats) + - [JS-SDK](#js-sdk) + - [JS-NG](#js-ng) + - [Itenv\_TFGridv2](#itenv_tfgridv2) + - [Libp2p-relay](#libp2p-relay) + - [Minting v3](#minting-v3) + - [Node-Pilot](#node-pilot) + - [Oauth-Proxy](#oauth-proxy) + - [TF Planetary Network Tool](#tf-planetary-network-tool) + - [TF Dashboard and Weblets](#tf-Dashboard-and-weblets) + - [QSFS](#qsfs) + - [Reliable Message Bus Relay (RMB-RS)](#reliable-message-bus-relay-rmb-rs) + - [RMB-SDK-Go](#rmb-sdk-go) + - [Terraform Provider](#terraform-provider) + - [TCP-Router](#tcp-router) + - [TFChain](#tfchain) + - [TFChain Activation Service](#tfchain-activation-service) + - [TFChain Explorer](#tfchain-explorer) + - [TFChain Block Explorer](#tfchain-block-explorer) + - [TFChain-GraphQL](#tfchain-graphql) + - [TFChain TFT Bridge](#tfchain-tft-bridge) + - [3Bot or Threebot](#3bot-or-threebot) + - [Threebot-deployer or 3Bot Deployer](#threebot-deployer-or-3bot-deployer) + - [ThreeFold Wallet](#threefold-wallet) + - [ThreeFold Connect App](#threefold-connect-app) + - [Zinit](#zinit) + - [0-OS or ZOS](#0-os-or-zos) + - [0-bootstrap](#0-bootstrap) + - [0-Bus or ZBus](#0-bus-or-zbus) + - [0-DB](#0-db) + - [0-DB-FS](#0-db-fs) + - [0-Flist](#0-flist) + - [0-Hub](#0-hub) + - [0-InitramFS](#0-initramfs) + - [0-stor\_v2](#0-stor_v2) + +*** + +## Introduction + +This list serves as a comprehensive glossary that provides an overview of the various components and tools within the ThreeFold Grid ecosystem. It serves as a valuable reference for developers, stakeholders, and enthusiasts who want to gain a deeper understanding of the building blocks that power the ThreeFold Grid. + +The glossary covers a wide range of components, including infrastructure elements, software tools, protocols, and services that are integral to the functioning and expansion of the grid. From blockchain-based technologies like TFChain and TFGrid Explorer to networking components like RMB-RS and Zinit, the TFGrid Component List offers concise explanations of each component's purpose and functionality. + +*** + +## TFGrid Components (Alphabetical Orders) + +### TF Admin Portal +A tool within TF Dashboard provided by ThreeFold for administrators to manage and monitor various aspects of the ThreeFold Grid ecosystem. It serves as a central hub where administrators can access and control different components of the grid, including nodes, capacity, workloads, and user management. + +The TF Admin Portal provides a comprehensive set of tools and features to configure, deploy, and monitor resources within the grid, ensuring efficient management and utilization of the decentralized infrastructure. Through the portal, administrators can track the performance and health of the grid, allocate resources, manage user permissions, and gain insights into the grid's utilization and usage patterns. + +> [Component Repository on Github (Archived)](https://github.com/threefoldtech/tfgrid_dashboard) + +### AtomicSwap +A component within the ThreeFold ecosystem that refers to Atomic Swaps, a cryptographic technology that enables the peer-to-peer exchange of cryptocurrencies or digital assets between different blockchain networks without the need for intermediaries. Atomic swaps use smart contracts to facilitate trustless and secure transactions, ensuring that both parties involved in the swap fulfill their obligations. By leveraging atomic swaps, users can seamlessly exchange digital assets across different blockchains, fostering interoperability and eliminating the reliance on centralized exchanges. + +> [Component Repository on Github](https://github.com/threefoldtech/atomicswap) + +### Builders +A Docker-based component within the ThreeFold Grid ecosystem. This particular aspect of Builders involves leveraging Docker containers to package and deploy applications and services on the ThreeFold Grid. Docker is an open-source platform that enables developers to build, package, and distribute applications as lightweight, portable containers. + +By using Builders as a Docker-based component, developers can easily containerize their applications, ensuring consistency and compatibility across different environments. This approach simplifies the deployment process, allowing developers to quickly deploy their applications on the ThreeFold Grid with minimal configuration and setup. The Builders component takes care of managing the underlying infrastructure and orchestrating the deployment of Docker containers, making it an efficient and convenient way to leverage the capabilities of the ThreeFold Grid for hosting and running applications. + +> [Component Repository on Github](https://github.com/threefoldtech/builders) + +### TF Capacity Explorer +A tool within the TF Dashboard provided by ThreeFold that allows users to explore and analyze the available capacity within the ThreeFold Grid. It provides insights into the distributed computing resources, including storage, processing power, and network bandwidth, that are available for utilization within the ThreeFold network. + +The TF Capacity Explorer enables users to discover and assess the capacity of different nodes and data centers within the ThreeFold Grid, helping them make informed decisions when deploying their workloads or applications. + +> [Component Repository on Github (Archived)](https://github.com/threefoldtech/tfgrid_dashboard) + +### Cloud Container +A containerization technology provided by ThreeFold that enables the deployment and management of applications and services in a cloud environment. It offers a lightweight and isolated execution environment for running applications, ensuring scalability, portability, and efficient resource utilization. + +With ThreeFold's Cloud Container, developers and organizations can package their applications along with their dependencies and configurations, making it easier to deploy and manage them in a cloud-native manner. The Cloud Container technology provides features such as automated scaling, load balancing, and resource allocation, allowing for efficient utilization of computing resources and optimal performance of applications. + +> [Component Repository on Github](https://github.com/threefoldtech/cloud-container) + +### Cloud Console +A web-based graphical user interface (GUI) provided by ThreeFold that allows users to manage and control their cloud infrastructure and resources. It serves as a central hub for managing various aspects of the cloud environment, including virtual machines, storage, networking, and other services. + +Through the cloud console, users can perform a wide range of tasks, such as provisioning and configuring virtual machines, managing storage volumes, creating and managing networks, monitoring resource usage, and accessing logs and metrics. It provides an intuitive and user-friendly interface that simplifies the management and administration of the cloud infrastructure. + +> [Component Repository on Github](https://github.com/threefoldtech/cloud-console) + +### TF Dashboard +A Graphical user interface (GUI) provided by ThreeFold for users to access and manage their ThreeFold Grid resources. It serves as a centralized control panel where users can monitor and control various aspects of their infrastructure, including their deployed workloads, storage capacity, network connectivity, and overall system health. The TF Dashboard provides real-time statistics, logs, and metrics to help users gain insights into the performance and utilization of their resources. It also offers tools for managing user accounts, configuring security settings, and accessing support and documentation. + +> [Component Repository on Github (Archived)](https://github.com/threefoldtech/tfgrid_dashboard) + +### Farm Management +A set of tools, processes, and functionalities provided by ThreeFold to manage and operate farms within the ThreeFold Grid. Farms are the physical locations where ThreeFold Farmers deploy and maintain the infrastructure that powers the decentralized network. TF Farm Management offers a comprehensive suite of features that enable farmers to efficiently manage their resources, monitor the health and performance of their infrastructure, and handle various administrative tasks. This includes functionalities such as capacity allocation, monitoring and reporting tools, farmer reputation management, billing and invoicing systems, and overall farm administration. + +Note: This is a feature that involves multiple component repositories. It is listed here to give a complete picture of ThreeFold's component list. + +### TF Farming Calculator +A tool provided by ThreeFold that allows users to estimate and calculate potential earnings from farming on the ThreeFold Grid. Farming refers to the process of providing computing resources, such as storage and processing power, to the ThreeFold Grid and earning tokens in return. The tf-farming-calculator takes into account various factors, including the amount of resources contributed, the duration of farming, and the current market conditions, to provide users with an estimate of their potential earnings in terms of ThreeFold Tokens (TFT). + +> [Component Repository on Github](https://github.com/threefoldtech/tf-farming-calculator) + +### Farmerbot +A software tool developed by ThreeFold that serves as a management and monitoring system for ThreeFold farmers. It is designed to automate various tasks related to operating and managing the ThreeFold Grid infrastructure. The TF Farmerbot helps farmers to efficiently manage their resources, including storage capacity, compute power, and network bandwidth. It provides real-time monitoring of the farmer's nodes, ensuring optimal performance and availability. + +> [Component Repository on Github](https://github.com/threefoldtech/farmerbot) + +### Freeflow Twin Main App or Freeflow Connect (previously Uhuru) +FFTwin is a component of the ThreeFold ecosystem that serves as the main interface for users to access and utilize the features of Freeflow Twin. Freeflow Twin is a decentralized communication and collaboration platform developed by ThreeFold. + +The Twin Main App allows users to securely communicate, share files, and collaborate with others in a decentralized manner, ensuring privacy and data sovereignty. Users can create chat channels, join communities, and engage in real-time messaging with end-to-end encryption. The app also supports file sharing, voice and video calls, and other collaborative features. With the Freeflow Twin Main App, users can experience a decentralized and secure communication platform that empowers them to connect and collaborate with others while maintaining control over their data. + +> [Component Repository on Github](https://github.com/threefoldtech/freeflow_twin_main_app) + +### GetTFT Shop +An official, online platform provided by ThreeFold where users can purchase ThreeFold Tokens (TFT) directly. It serves as a dedicated marketplace for individuals and organizations to buy TFT tokens using various payment methods. The GetTFT Shop ensures a seamless and user-friendly experience for acquiring TFT, which is the native cryptocurrency of the ThreeFold ecosystem. + +Note: This repository is private. You can visit the GetTFT Shop [here](https://gettft.com/gettft/shop/). + +### TF Grid3 Client TS +A software component that serves as a client library for interacting with the Grid3 platform. It provides developers with a set of tools, functions, and interfaces to communicate with the ThreeFold Grid and utilize its resources. The Grid3 Client TS allows users to perform various operations, such as creating and managing virtual machines, deploying applications, accessing storage services, and interacting with the decentralized network. It acts as a bridge between developers and the ThreeFold Grid, enabling them to leverage the platform's decentralized infrastructure and harness its capabilities programmatically. + +### TF Grid Proxy +A fundamental component which serves as a gateway that allows external applications and users to interact with the grid. Acting as a bridge between the decentralized infrastructure of the ThreeFold Grid and external networks, GridProxy facilitates seamless communication and integration. It provides a standardized interface for accessing and managing resources within the grid, enabling developers, businesses, and users to leverage the power and scalability of the ThreeFold Grid in their applications and workflows. By abstracting the complexities of the grid infrastructure, GridProxy simplifies the process of interacting with the grid, making it more accessible and user-friendly. + +> [Component Repository on Github (Archived)](https://github.com/threefoldtech/tfgridclient_proxy) + +### TF Grid-SDK-Go +ThreeFold Grid Software Development Kit (SDK) for the Go programming language. It is a collection of tools, libraries, and APIs provided by ThreeFold to facilitate the development and integration of applications with the ThreeFold Grid. The TFGrid-SDK-Go allows developers to interact with the ThreeFold Grid infrastructure, such as provisioning and managing compute resources, accessing storage, and interacting with blockchain-based services. It provides a standardized and efficient way to leverage the features and capabilities of the ThreeFold Grid within Go applications. + +> [Component Repository on Github](https://github.com/threefoldtech/tfgrid-sdk-go) + +### TF Grid-SDK-TS +ThreeFold Grid Software Development Kit (SDK) for TypeScript. It is a set of tools, libraries, and APIs provided by ThreeFold to simplify the development and integration of applications with the ThreeFold Grid. The TFGrid-SDK-TS enables developers to interact with the ThreeFold Grid infrastructure, such as provisioning and managing compute resources, accessing storage, and interacting with the blockchain-based services. It provides a standardized and convenient way to leverage the features and capabilities of the ThreeFold Grid within TypeScript applications. + +> [Component Repository on Github](https://github.com/threefoldtech/tfgrid-sdk-ts) + +### TF Grid Simulator +A component or tool within the ThreeFold ecosystem that allows for the simulation of the ThreeFold Grid infrastructure. It provides a simulated environment where users can test and evaluate the behavior and performance of the grid without the need for actual hardware or network resources. The tfgrid_simulator mimics the functionalities of the real ThreeFold Grid, enabling users to experiment with various configurations, scenarios, and workloads. This simulation tool is valuable for developers, administrators, and users who want to understand and optimize the behavior of the ThreeFold Grid, test applications, and evaluate the impact of different factors on grid performance. It helps in fine-tuning the grid setup and ensuring optimal resource allocation and utilization. + +> [Component Repository on Github](https://github.com/threefoldtech/tfgrid_simulator) + +### TF Grid Stats +A component or tool within the ThreeFold ecosystem that is designed to gather and provide statistics and metrics related to the ThreeFold Grid. It collects data on various aspects of the grid, such as the number of active nodes, their capacities, network performance, usage patterns, and other relevant information. tfgrid_stats allows users and administrators to monitor the health and performance of the grid, track its growth and utilization, and make informed decisions based on the collected data. + +> [Component Repository on Github (Archived)](https://github.com/threefoldtech/tfgrid_stats) + +### JS-SDK +A software development kit (SDK) provided by ThreeFold that enables developers to interact with and utilize the ThreeFold Grid infrastructure using JavaScript. It provides a set of libraries, tools, and APIs that simplify the integration and interaction with various ThreeFold services and functionalities. + +With the JS-SDK, developers can programmatically manage and deploy resources, interact with the ThreeFold Grid's decentralized storage, perform transactions on the ThreeFold Chain blockchain, and access other platform features. The JS-SDK empowers developers to build decentralized applications (dApps), create custom automation scripts, and leverage the capabilities of the ThreeFold Grid using the familiar JavaScript programming language. + +> [Component Repository on Github](https://github.com/threefoldtech/js-sdk) + +### JS-NG +JavaScript Next-Generation (js-ng) framework, which is a modern and advanced framework for building web applications using JavaScript. It provides developers with a set of tools, libraries, and utilities to streamline the development process and create high-performance, scalable, and maintainable web applications. The js-ng framework incorporates the latest features and best practices of JavaScript, allowing developers to write clean and efficient code. It offers a modular architecture, allowing for easy integration of third-party libraries and extensions. + +With js-ng, developers can build interactive user interfaces, handle data management, perform client-server communication, and implement various functionalities required for robust web applications. The framework promotes code reusability, testability, and code organization, making it an ideal choice for developing modern web applications. + +> [Component Repository on Github](https://github.com/threefoldtech/js-ng) + +### Itenv_TFGridv2 +The development and testing environment for the TFGrid v2, which is the second version of the ThreeFold Grid. It is a comprehensive set of tools, configurations, and resources that enable developers to create, test, and deploy applications on the ThreeFold Grid infrastructure. The itenv_tfgridv2 environment provides developers with the necessary tools and utilities to set up a local development environment that closely resembles the production environment of the ThreeFold Grid. It includes various components such as virtual machines, containers, networking configurations, and monitoring tools, all specifically tailored for the development and testing of applications on the ThreeFold Grid. + +Note: This repository is private. + +### Libp2p-relay +A component within the ThreeFold ecosystem that refers to the libp2p relay functionality. libp2p is a modular networking stack that allows peer-to-peer communication and data transfer between nodes in a decentralized network. The libp2p-relay component specifically focuses on providing relay services, which enable nodes that are behind firewalls or NATs (Network Address Translators) to establish direct connections with other nodes in the network. This relaying functionality helps overcome network obstacles and facilitates seamless communication between nodes, ensuring that the ThreeFold Grid operates efficiently and nodes can interact with each other effectively. + +> [Component Repository on Github](https://github.com/threefoldtech/libp2p-relay) + +### Minting v3 +The third version of the ThreeFold Token (TFT) minting process. It is a protocol implemented by ThreeFold to create new TFT tokens and manage the token supply. TF Minting v3 incorporates various features and improvements over its previous versions to enhance the functionality and security of token creation. It involves the issuance of new TFT tokens according to predefined rules and algorithms, such as token distribution, inflation rates, and token unlocking schedules. TF Minting v3 ensures a fair and transparent distribution of tokens while maintaining the integrity and stability of the ThreeFold ecosystem. + +> [Component Repository on Github](https://github.com/threefoldtech/minting_v3) + +### Node-Pilot +A software package provided by ThreeFold for running and managing individual nodes on the ThreeFold Grid. It is designed to enable users to set up and operate their own decentralized infrastructure nodes. TFNode-Pilot provides the necessary tools and functionality to deploy, configure, and monitor nodes, allowing users to contribute their computing resources to the ThreeFold Grid and participate in the decentralized ecosystem. + +With TFNode-Pilot, users can easily transform their hardware into powerful nodes that contribute to the storage, compute, and networking capabilities of the ThreeFold Grid. The software package includes features such as node management, resource monitoring, security measures, and integration with other components of the ThreeFold ecosystem. + +> [Component Repository on Github](https://github.com/threefoldtech/node-pilot-light) + +### Oauth-Proxy +A component specifically developed by ThreeFold to enhance security and facilitate the authentication process for accessing ThreeFold services and resources. It acts as a middleware between users, applications, and the ThreeFold infrastructure, implementing the OAuth protocol. By using the oauth-proxy, applications can securely obtain authorization to access protected resources on the ThreeFold network without directly handling user credentials. The oauth-proxy handles the authentication flow, obtaining consent from users, and issuing access tokens to authorized applications. This helps ensure that access to ThreeFold's services and resources is controlled and secure, protecting user data and privacy. + +> [Component Repository on Github](https://github.com/threefoldtech/oauth-proxy) + +### TF Planetary Network Tool +A software application or platform that provides users with the necessary tools and functionalities to interact with and utilize the ThreeFold Planetary Network. The ThreeFold Planetary Network is a decentralized and distributed infrastructure network that spans across the globe. It is built on the principles of autonomy, neutrality, and sustainability. The network consists of a vast number of interconnected computing resources, including servers, storage devices, and networking equipment, which are owned and operated by individuals and organizations called farmers. + +> [Component Repository on Github](https://github.com/threefoldtech/planetary_network) + +### TF Dashboard and Weblets +TF Dashboard and TF Weblets are two interconnected components of the ThreeFold ecosystem. TF Dashboard is a user-friendly web-based interface that serves as a sandbox environment for developers, allowing them to experiment, test, and deploy their applications on the ThreeFold Grid. It provides an intuitive interface where users can write, compile, and execute code, explore various programming languages and frameworks, and interact with the ThreeFold infrastructure. + +TF Weblets, on the other hand, are modular, lightweight applications that run on the ThreeFold Grid. They are designed to be decentralized, secure, and easily deployable, enabling users to create and deploy their own web-based services and applications on the ThreeFold network. + +> [Component Repository on Github (Archived)](https://github.com/threefoldtech/grid_weblets) + +### QSFS +It is ThreeFold's innovative storage solution designed to address the security challenges posed by quantum computing. QSFS employs advanced cryptographic techniques that are resistant to attacks from quantum computers, ensuring the confidentiality and integrity of stored data. By utilizing quantum-resistant algorithms, QSFS offers long-term data protection, even in the face of quantum threats. This technology is crucial in a future where quantum computers could potentially break traditional encryption methods. With ThreeFold's QSFS, users can have peace of mind knowing that their data is safeguarded against emerging quantum computing risks, reinforcing the security and resilience of the ThreeFold ecosystem. + +> [Component Repository on Github](https://github.com/threefoldtech/quantum-storage) + +### Reliable Message Bus Relay (RMB-RS) +A component or system that facilitates the reliable and secure transfer of messages between different entities or systems within the ThreeFold ecosystem. It acts as a relay or intermediary, ensuring that messages are delivered accurately and efficiently, even in the presence of network disruptions or failures. The RMB-RS employs robust protocols and mechanisms to guarantee message reliability, integrity, and confidentiality. It plays a crucial role in enabling seamless communication and data exchange between various components, applications, or nodes within the ThreeFold network, enhancing the overall reliability and performance of the system. + +> [Component Repository on Github](https://github.com/threefoldtech/rmb-rs) + +### RMB-SDK-Go +Software development kit (SDK) for interacting with the Reliable Message Bus (RMB) in the Go programming language. The Reliable Message Bus is a messaging system used within the ThreeFold ecosystem to enable reliable and secure communication between different components and services. The rmb-sdk-go provides a set of tools, libraries, and APIs that developers can use to integrate their Go applications with the RMB infrastructure. It simplifies the process of sending and receiving messages, managing subscriptions, and handling the reliability and security aspects of messaging within the ThreeFold environment. + +> [Component Repository on Github](https://github.com/threefoldtech/rmb-sdk-go) + +### Terraform Provider +A software tool that integrates with the popular infrastructure-as-code platform, Terraform. It enables users to provision and manage resources on the ThreeFold Grid using Terraform's declarative configuration language. The provider acts as a bridge between Terraform and the ThreeFold Grid, allowing users to define and deploy infrastructure components such as virtual machines, storage, and networking resources with ease. This integration simplifies the process of building and managing infrastructure on the ThreeFold Grid, offering users the familiar and powerful capabilities of Terraform while leveraging the decentralized and scalable nature of the ThreeFold technology. + +> [Component Repository on Github](https://github.com/threefoldtech/terraform-provider-grid) + +### TCP-Router +A component of the ThreeFold technology stack that acts as a TCP (Transmission Control Protocol) router and load balancer. It serves as a network gateway for incoming TCP connections, routing them to the appropriate destinations based on predefined rules and configurations. The TCP-Router component is responsible for distributing incoming network traffic across multiple backend services or nodes, ensuring efficient load balancing and high availability. It helps optimize network performance by evenly distributing the workload and preventing any single node from being overwhelmed. By managing and balancing TCP connections, tcprouter contributes to the overall scalability, reliability, and performance of applications running on the ThreeFold Grid. + +> [Component Repository on Github](https://github.com/threefoldtech/tcprouter) + +### TFChain +A blockchain developed by the ThreeFold Foundation. It serves as the underlying technology for managing the ThreeFold Grid. TFChain is built on Parity Substrate. It is responsible for storing information related to the ThreeFold Grid, including identity information of entities, 3Node and farmer details, reputation information, digital twin registry, and more. TFChain also acts as the backend for the TFChain database and supports smart contracts for provisioning workloads on top of the ThreeFold Grid. + +> [Component Repository on Github](https://github.com/threefoldtech/tfchain) + +### TFChain Activation Service +A component within the ThreeFold ecosystem that facilitates the activation of TFChain accounts. TFChain is a blockchain developed by ThreeFold that serves as the backbone of the ThreeFold Grid. The Activation Service provides the necessary infrastructure and processes to activate and onboard users onto the TFChain network. It ensures that users can securely create and manage their TFChain accounts, including generating cryptographic keys, validating user identities, and enabling the activation of TFChain functionalities. + +> [Component Repository on Github](https://github.com/threefoldtech/tfchain_activation_service) + +### TFChain Explorer +A web-based tool that allows users to explore and interact with the TFChain blockchain. It provides a graphical interface where users can view transaction history, account balances, smart contracts, and other blockchain-related information. The TFChain Explorer offers transparency and visibility into the TFChain ecosystem, enabling users to track transactions, verify balances, and monitor the overall health of the network. + +> [Component Repository on Github](https://github.com/threefoldtech/tfchain_explorer) + +### TFChain Block Explorer +A web-based tool provided by ThreeFold that allows users to explore and interact with the TFChain blockchain. It provides a user-friendly interface to browse through blocks, transactions, and addresses on the TFChain network. Users can view detailed information about individual blocks and transactions, including timestamps, transaction amounts, and involved addresses. The block explorer also enables searching for specific transactions or addresses, making it easier to track and verify transactions on the TFChain blockchain. With the TFChain Block Explorer, users can gain transparency and visibility into the TFChain network, facilitating better understanding and analysis of blockchain activities. + +> [Component Repository on Github](https://github.com/threefoldtech/tfchain_block_explorer) + +### TFChain-GraphQL +The integration of GraphQL, a query language for APIs, with TFChain, the blockchain technology used by ThreeFold. It enables developers and users to interact with the TFChain blockchain using GraphQL queries and mutations. GraphQL provides a flexible and efficient way to retrieve and manipulate data from the TFChain blockchain, allowing for customized and precise data retrieval. With TFChain-GraphQL, users can easily query blockchain information, such as transaction details, account balances, or smart contract data, and perform mutations, such as submitting transactions or updating contract states. + +> [Component Repository on Github](https://github.com/threefoldtech/tfchain_graphql) + +### TFChain TFT Bridge +The bridge mechanism that enables the conversion of TFT tokens between different blockchain networks, specifically between the ThreeFold Chain (TFChain) and other blockchain networks such as Ethereum or Stellar. The TFChain TFT Bridge allows TFT tokens to be transferred seamlessly and securely across different blockchain platforms, maintaining their value and integrity. This bridge plays a crucial role in interoperability, enabling users to leverage TFT tokens on multiple blockchain networks, unlocking new possibilities for decentralized applications and token ecosystems. + +> [Component Repository on Github](https://github.com/threefoldtech/tfchain_tft_bridge) + +### 3Bot or Threebot +3Bot is a component of the ThreeFold ecosystem that refers to a personal digital assistant. It is a software entity that acts as a virtual representation of an individual or organization, providing various services and performing tasks on their behalf. The 3Bot is designed to be decentralized and secure, running on the ThreeFold Grid infrastructure. It can handle functions such as managing personal data, interacting with other digital entities, executing transactions, and offering a range of services through its customizable capabilities. The 3Bot component enables individuals and organizations to have their own private and secure digital assistant, tailored to their specific needs and preferences. + +Note: This is a feature that involves multiple component repositories. It is listed here to give a complete picture of ThreeFold's component list. + +### Threebot-deployer or 3Bot Deployer +A tool provided by ThreeFold that facilitates the deployment of ThreeFold's ThreeBot applications. A ThreeBot is a personal digital assistant that can perform various tasks and provide services to users. The threebot-deployer simplifies the process of setting up and configuring a ThreeBot instance by automating many of the steps involved. It allows users to specify the desired configuration and parameters for their ThreeBot, such as the domain name, authentication settings, and available services. The threebot-deployer then handles the deployment process, ensuring that the ThreeBot is properly installed and configured according to the specified parameters. This tool streamlines the deployment process and enables users to quickly and easily set up their own personalized ThreeBot instances. + +> [Component Repository on Github](https://github.com/threefoldtech/threebot-deployer) + +### ThreeFold Wallet +A digital wallet designed to securely store and manage ThreeFold Tokens (TFT) and other digital assets inside the ThreeFold Connect App (TFConnect App). It provides users with a convenient and user-friendly interface to interact with their tokens, perform transactions, and track their token balances. The ThreeFold Wallet offers features such as wallet creation, private key management, token transfers, and transaction history. It ensures the security of users' assets through encryption and various authentication methods. The wallet serves as a gateway for users to access and engage with the ThreeFold ecosystem, enabling them to participate in token transactions, staking, and other activities. + +> [Component Repository on Github](https://github.com/threefoldtech/threefold_connect_wallet) + +### ThreeFold Connect App +Mobile application developed by ThreeFold that serves as a gateway to the ThreeFold Grid. It provides users with a secure and user-friendly wallet interface to access and manage their digital assets, such as ThreeFold Tokens (TFT), and interact with various services and applications within the ThreeFold ecosystem. The ThreeFold Connect App also provides an authenticator feature that ensures secure access and authentication to various services within the ThreeFold ecosystem. As an authenticator, it verifies the identity of users and provides them with secure access to their accounts and associated resources. + +> [Component Repository on Github](https://github.com/threefoldtech/threefold_connect) + +### Zinit +A lightweight, fast, and versatile package manager designed to simplify the installation and management of software components within the ThreeFold ecosystem. It provides a user-friendly interface for developers and system administrators to easily install, update, and remove software packages on their ThreeFold nodes. Zinit supports various package sources, including remote repositories, local files, and even directly from Git repositories, allowing users to easily fetch and install the desired software components. It also supports dependency resolution, ensuring that all required dependencies are installed correctly. + +> [Component Repository on Github](https://github.com/threefoldtech/zinit) + +### 0-OS or ZOS +ZOS (Zero Operating System) is a lightweight and secure operating system designed specifically for running workloads on the ThreeFold Grid. ZOS provides a minimalistic and containerized environment for applications, enabling efficient resource allocation and management. With ZOS, developers can deploy their applications easily and take advantage of the scalability and resilience offered by the ThreeFold Grid. + +> [Component Repository on Github](https://github.com/threefoldtech/zos) + +### 0-bootstrap +Also known as Zero-Bootstrap, is a component of the ThreeFold Grid infrastructure. It serves as the initial bootstrap mechanism for setting up and initializing the ThreeFold Grid network. 0-bootstrap provides the necessary tools and processes to deploy the core components of the ThreeFold Grid, including the Zero-OS operating system and other essential services. It helps in establishing the foundational layer of the grid network, enabling the deployment and management of compute resources, storage, and other decentralized services. + +> [Component Repository on Github](https://github.com/threefoldtech/0-bootstrap) + +### 0-Bus or ZBus +A component that facilitates interprocess communication (IPC) within the ThreeFold technology stack. It provides a lightweight and efficient messaging system that allows different software components or services to communicate with each other in a distributed environment. zbus implements a message bus architecture, where components can publish messages to topics and subscribe to receive messages from those topics. It enables decoupled and asynchronous communication between various parts of the system, promoting modularity and scalability. zbus plays a crucial role in enabling communication and coordination between different components of the ThreeFold infrastructure, such as the ThreeBot, ThreeFold Chain, and storage services, allowing them to work together seamlessly to deliver the desired functionality. + +> [Component Repository on Github](https://github.com/threefoldtech/zbus) + +### 0-DB +a distributed key-value database system. It is designed to provide efficient and secure storage for data in a decentralized environment. +In 0-db, data is stored as key-value pairs, allowing for fast and efficient retrieval of information. It provides high-performance read and write operations, making it suitable for applications that require quick access to data. The distributed nature of 0-db ensures that data is replicated and stored across multiple nodes, enhancing data availability and durability. + +> [Component Repository on Github](https://github.com/threefoldtech/0-db) + +### 0-DB-FS +A storage system that allows for efficient and secure storage of files on the ThreeFold Grid. 0-db-fs is built on top of 0-db, which is a key-value store optimized for high performance and scalability. It provides a decentralized and distributed approach to file storage, ensuring data redundancy and availability. With 0-db-fs, users can securely store and retrieve files, benefiting from the decentralized nature of the ThreeFold Grid, which enhances data privacy, security, and resilience. + +> [Component Repository on Github](https://github.com/threefoldtech/0-db-fs) + +### 0-Flist +Also known as Zero-Flist, is a file system image format used in the ThreeFold Grid infrastructure. It represents a compressed and immutable snapshot of a specific file system configuration or application stack. 0-Flist files are used to package and distribute software, data, and configurations within the ThreeFold Grid. They contain all the necessary files and dependencies required to run an application or service. 0-Flist files are lightweight, portable, and easy to distribute, making them ideal for deploying applications across the decentralized network. + +> [Component Repository on Github](https://github.com/threefoldtech/0-flist) + +### 0-Hub +Also known as Zero-Hub, is a key component of the ThreeFold Grid infrastructure. It serves as the central hub or entry point for users and applications to connect with the decentralized network. 0-hub provides a user-friendly interface and API endpoints that allow users to interact with the ThreeFold Grid and access its resources. It acts as a bridge between the users and the underlying infrastructure, enabling them to deploy and manage their workloads, access decentralized storage, and utilize other services provided by the ThreeFold Grid. 0-hub also plays a crucial role in facilitating peer-to-peer communication and collaboration within the network, connecting users and allowing them to share and exchange resources securely. + +> [Component Repository on Github](https://github.com/threefoldtech/0-hub) + +### 0-InitramFS +Initial RAM file system used in the ThreeFold ecosystem. An initramfs is a temporary file system that is loaded into memory during the boot process before the root file system is mounted. It contains essential files and utilities needed to initialize the system and prepare it for the boot process. In the context of ThreeFold, the 0-initramfs is a customized initial RAM file system specifically designed for the ThreeFold Grid infrastructure. It includes necessary components and configurations to ensure a smooth and efficient boot process for ThreeFold nodes. By utilizing the 0-initramfs, the ThreeFold ecosystem can optimize the boot sequence and ensure the proper initialization of the system components before transitioning to the main operating system. + +> [Component Repository on Github](https://github.com/threefoldtech/0-initramfs) + +### 0-stor_v2 +A component of the ThreeFold technology stack that refers to the second version of the 0-stor storage system. 0-stor_v2 is a distributed and decentralized storage solution that enables data storage and retrieval on the ThreeFold Grid. It utilizes erasure coding and sharding techniques to distribute data across multiple storage nodes, ensuring high availability and data redundancy. The 0-stor_v2 component provides an efficient and secure way to store data on the ThreeFold Grid, with features such as data encryption, replication, and integrity checks. It is designed to be scalable and fault-tolerant, allowing for the seamless expansion of storage capacity as needed. Developers and users can leverage 0-stor_v2 to store and manage their data in a decentralized and resilient manner, ensuring data privacy and accessibility on the ThreeFold Grid. + +> [Component Repository on Github](https://github.com/threefoldtech/0-stor_v2) + + diff --git a/collections/tfmanual/knowledge_base/technology/concepts/grid3_iac.md b/collections/tfmanual/knowledge_base/technology/concepts/grid3_iac.md new file mode 100644 index 0000000..321d059 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/concepts/grid3_iac.md @@ -0,0 +1,47 @@ +

Infrastructure as Code (IaC)

+ +

Table of Contents

+ +- [What is IaC?](#what-is-iac) +- [Benefits of IaC](#benefits-of-iac) +- [ThreeFold's IaC](#threefolds-iac) +- [How it Works](#how-it-works) +- [Dive Deeper](#dive-deeper) +- [Manuals](#manuals) + +*** + +## What is IaC? +Infrastructure as Code (IaC) is a concept that revolutionizes the way infrastructure is provisioned and managed in the world of IT. It involves the use of declarative scripts or configuration files to define and automate the deployment, configuration, and management of infrastructure resources. With IaC, organizations can treat infrastructure provisioning as code, applying software development principles and practices to infrastructure management. This approach brings numerous benefits, such as increased efficiency, consistency, scalability, and reproducibility. + +## Benefits of IaC +Using IaC in the ThreeFold ecosystem brings several benefits. + +- __Streamlined operations and increased efficiency__: One of the key benefits of Infrastructure as Code (IaC) is the significant improvement in speed and consistency. By eliminating manual processes and automating infrastructure provisioning through code, tasks can be completed faster and with greater accuracy. There is no longer a need to wait for IT administrators to manually perform tasks or worry about their availability. This allows for quicker iterations and faster deployments, enabling organizations to be more agile in their development processes. Consistency is also enhanced as infrastructure configurations are defined in code, ensuring that the same setup is replicated across environments and reducing the risk of configuration drift. + +- __Empowered software development lifecycle__: IaC places more control in the hands of developers, enabling them to focus on application development rather than spending time on infrastructure management. With reliable and consistent infrastructure provisioning, developers can leverage reusable code scripts to deploy and manage resources efficiently. This streamlines the software development lifecycle, enabling faster development cycles and reducing the time and effort spent on manual infrastructure tasks. Developers can quickly spin up development and testing environments, experiment with different configurations, and roll out changes with ease. + +- __Reduced management overhead__: IaC eliminates the need for multiple roles dedicated to managing different layers of hardware and middleware in traditional data center environments. With IaC, the management overhead is significantly reduced as infrastructure is defined and managed through code. This frees up administrators to focus on exploring and implementing new technologies and innovations, rather than being tied down by routine maintenance tasks. It simplifies the operational structure and allows for a more efficient allocation of resources, ultimately leading to cost savings and increased productivity. + +Overall, IaC brings faster speed, improved consistency, efficient software development, and reduced management overhead. It empowers organizations to accelerate their deployment processes, enhance collaboration between development and operations teams, and optimize resource utilization. By adopting IaC practices, organizations can achieve greater agility, scalability, and cost efficiency in their infrastructure management, enabling them to stay competitive in today's fast-paced digital landscape. + +## ThreeFold's IaC +At ThreeFold, IaC plays a crucial role in the deployment and management of the ThreeFold Grid infrastructure. ThreeFold leverages popular IaC tools and methodologies to enable users to define and manage their infrastructure resources in a programmatic and scalable way. The IaC mechanism in ThreeFold involves components like __Terraform__, __TypeScript Client__, __GraphQL Client__, and __Grid Proxy REST API__. + +__Terraform__ acts as the foundation for infrastructure provisioning, allowing users to define their desired infrastructure state using declarative configuration files. __The TypeScript and GraphQL clients__ provide interfaces for interacting with the ThreeFold Grid and managing resources programmatically, while the__ Grid Proxy REST API__ enables integration with external systems and applications. + +## How it Works +Firstly, __Terraform__ acts as the primary infrastructure provisioning tool. It provides a declarative language for defining infrastructure resources and their configurations, enabling users to express their infrastructure requirements in a human-readable and version-controlled manner. + +__TypeScript Client and GraphQL Client__ serve as interfaces for interacting with the ThreeFold Grid, allowing users to create, update, and manage their infrastructure resources programmatically. These clients offer rich functionality and flexibility for managing various aspects of the ThreeFold Grid, including node deployment, capacity allocation, networking, and more. + +__Grid Proxy REST API__ further enhances the extensibility of the IaC mechanism by enabling integration with external systems and applications, allowing for seamless automation and orchestration of infrastructure tasks. Together, these components form a robust and efficient IaC framework within the ThreeFold ecosystem, empowering users to manage their infrastructure as code with ease and precision. + +## Dive Deeper +- [How the Grid Works](../grid3_howitworks.md) +- [ThreeFold's Component List](./grid3_components.md) +- [Grace Periods](./contract_grace_period.md) + +## Manuals +- [Terraform](../../../documentation/system_administrators/terraform/terraform_toc.md) +- [Typescript Client](../../../documentation/developers/javascript/grid3_javascript_readme.md) \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/concepts/grid3_whatsnew.md b/collections/tfmanual/knowledge_base/technology/concepts/grid3_whatsnew.md new file mode 100644 index 0000000..d97fca3 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/concepts/grid3_whatsnew.md @@ -0,0 +1,61 @@ +

What's New on ThreeFold Grid v3.x

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [TFChain v3.x](#tfchain-v3x) + - [Key Features of TFChain v3.x:](#key-features-of--tfchain-v3x) +- [Proof of Utilization: Enhancing Your Cloud Experience](#proof-of-utilization-enhancing-your-cloud-experience) + - [Key Features:](#key-features) + - [New TFGrid Explorer UI](#new-tfgrid-explorer-ui) + +*** + +## Introduction + +The ThreeFold Grid v3.x is packed with exciting new features and enhancements. This marks a significant milestone in the evolution of our decentralized grid infrastructure, bringing even more power, flexibility, and innovation to our users. In this introduction, we will highlight some of the key new features that make ThreeFold Grid v3.x a game-changer in the world of decentralized technologies. + +> Click [here](../concepts/grid3_components.md) to see the complete TFGrid Component List + +## TFChain v3.x + +[__TFChain v3.x__](../concepts/tfchain.md) is a decentralized chain that holds all the information about the entities comprising the ThreeFold Grid. It operates on the Parity Substrate blockchain infrastructure. + +### Key Features of TFChain v3.x: + +- Your identity and proofs/reputation are stored on our blockchain. +- All information about TFGrid, including nodes and farmers, is made available. +- A GraphQL interface that allows easy querying of the blockchain. +- Provide Side chains supports, enabling unlimited scalability and allowing others to run their own blockchains. +- TFT now exists on TFChain, addressing scalability issues with Stellar. +- A bridge facilitates the transfer of TFT between Stellar and TFChain. +- Blockchain-based provisioning process/ +- TFChain API that is available in JavaScript, Golang, and Vlang. +- 'Infrastructure as Code' (IAC) framework support for: + - Terraform + - Kubernetes, Helm, Kubernetes + - Ansible (planned) +- Support for App deployment using CapRover +- The use of RMB (Reliable Message Bus) that ensures secure peer-to-peer communication with Zero-OS. + +Please note that the above list summarizes the key features introduced in TFChain v3.0. + +## Proof of Utilization: Enhancing Your Cloud Experience + +Experience the benefits of Proof of Utilization, a user-friendly feature that optimizes your cloud usage and rewards your pre-purchases. Here are the key features: + +### Key Features: + +- __Hourly Resource Utilization__: Your resource utilization is accurately captured and calculated on an hourly basis, ensuring transparency and precision in tracking your cloud usage. + +- __Secure Storage on TFChain__: Your resource utilization data is securely stored in TFChain, our dedicated blockchain, providing a reliable and tamper-proof record of your usage history. + +- __Automated Discount System__: Our innovative automated discount system acknowledges your pre-purchased cloud needs. Based on the amount of TFT (ThreeFold Tokens) you hold in your account and the duration you maintain these tokens, you can enjoy significant price discounts. + +- __Personalized Discounts__: The discount you receive is customized to your TFT holdings and usage patterns. For instance, if you hold TFT tokens equivalent to 12 months' worth of usage, you receive a generous 40% discount. Holding TFT tokens for 36 months unlocks an impressive 60% discount on your cloud services. + + +### New TFGrid Explorer UI + +- The TFGrid Explorer v3.x has an updated user interface that is now nicer and easier to use. +- It utilizes the GraphQL layer of TFChain. diff --git a/collections/tfmanual/knowledge_base/technology/concepts/grid_primitives.md b/collections/tfmanual/knowledge_base/technology/concepts/grid_primitives.md new file mode 100644 index 0000000..24812df --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/concepts/grid_primitives.md @@ -0,0 +1,60 @@ +

ThreeFold Grid Primitives: Empowering Your Solutions

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Compute](#compute) +- [Storage](#storage) +- [Network](#network) +- [Zero-OS Advantages](#zero-os-advantages) +- [Conclusion](#conclusion) + +*** + +## Introduction + +Within the ThreeFold Grid, we offer a range of __low-level constructs known as Primitives__. These powerful functionalities enable you to create diverse and customized solutions atop the grid, opening up a world of possibilities. It's important to note that any application compatible with Linux can seamlessly run on the ThreeFold Grid, ensuring maximum flexibility. + +## Compute + +Harness the power of computation with our compute primitives, measured in [compute units](../../cloud/cloudunits.md) (CU). + +- [ZKube](../../technology/primitives/compute/zkube.md): Deploy and manage Kubernetes clusters effortlessly. +- [ZMachine](../../technology/primitives/compute/zmachine.md): Run your applications within containers or virtual machines powered by the Zero-OS operating system. +- [CoreX](../../technology/primitives/compute/corex.md) (optional): Gain remote access to your ZMachine by utilizing the CoreX process manager. + +## Storage + +Leverage our robust storage Primitives, measured in [storage units](../../cloud/cloudunits.md) (SU), to meet your data storage requirements efficiently. + +- [ZOS Filesystem](../../technology/primitives/storage/zos_fs.md): Enjoy a deduplicated and immutable filesystem for secure and reliable data storage. +- [ZOS Mount](../../technology/primitives/storage/zmount.md): Utilize a portion of a high-speed SSD (Solid State Drive) as a mounted disk directly accessible within your ZMachine. +- [Quantum Safe Filesystem](../../technology/primitives/storage/qsfs.md): Secure your data with an unbreakable storage system, ideal for secondary storage needs. +- [Zero-DB](../../technology/primitives/storage/zdb.md): Experience a powerful key-value storage mechanism that serves as the foundation for other storage mechanisms. +- [Zero-Disk](../../technology/primitives/storage/zdisk.md) (OEM only): Employ a virtual disk format designed exclusively for original equipment manufacturers. + +## Network + +Harness our network Primitives, measured in [network units](../../cloud/cloudunits.md) (CU), to enable seamless communication and connectivity. + +- [ZNET](../../technology/primitives/network/znet.md): Establish private networks between ZMachines, ensuring secure and efficient communication. +- [ZNIC](../../technology/primitives/network/znic.md): Access and manage network interfaces within the Planetary Network, enabling efficient data transfer and communication. +- [WebGateway](../../technology/primitives/network/webgw3.md): Connect your ZNET to the internet with ease, facilitating seamless integration with the wider network. + +## Zero-OS Advantages + +Enjoy the [numerous advantages](../../technology/zos/benefits/zos_advantages.md) that Zero-OS brings to the table. + +- [Zero Install](../../technology/zos/benefits/zos_advantages.md#zero-os-installation): Experience hassle-free deployment without the need for complex installations. +- [Unbreakable Storage](../../technology/zos/benefits/zos_advantages.md#unbreakable-storage): Ensure the integrity and security of your data with our robust storage mechanisms. +- [Zero Hacking Surface](../../technology/zos/benefits/zos_advantages.md#zero-hacking-surface): Benefit from a minimized attack surface, bolstering the security of your infrastructure. +- [Zero Boot](../../technology/zos/benefits/zos_advantages.md#zero-boot): Enjoy lightning-fast boot times, allowing for swift and efficient system initialization. +- [Deterministic Deployment](../../technology/zos/benefits/zos_advantages.md#deterministic-deployment): Achieve consistent and predictable deployments, streamlining your development process. +- [ZOS Protect](../../technology/zos/benefits/zos_advantages.md#zero-os-protect): Experience enhanced protection and security measures to safeguard your infrastructure. + +## Conclusion + +With these powerful Primitives and Zero-OS advantages, the ThreeFold Grid empowers you to build, scale, and secure your solutions with ease. Unleash your creativity and unlock limitless possibilities within the ThreeFold ecosystem. + + + diff --git a/collections/tfmanual/knowledge_base/technology/concepts/img/layers.jpeg b/collections/tfmanual/knowledge_base/technology/concepts/img/layers.jpeg new file mode 100644 index 0000000..fa1d017 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/concepts/img/layers.jpeg differ diff --git a/collections/tfmanual/knowledge_base/technology/concepts/img/manual__grace_period_graphql_node.png b/collections/tfmanual/knowledge_base/technology/concepts/img/manual__grace_period_graphql_node.png new file mode 100644 index 0000000..e25e4ec Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/concepts/img/manual__grace_period_graphql_node.png differ diff --git a/collections/tfmanual/knowledge_base/technology/concepts/img/manual__grace_period_graphql_rent.png b/collections/tfmanual/knowledge_base/technology/concepts/img/manual__grace_period_graphql_rent.png new file mode 100644 index 0000000..cc0db2c Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/concepts/img/manual__grace_period_graphql_rent.png differ diff --git a/collections/tfmanual/knowledge_base/technology/concepts/img/manual__grace_period_gridproxy.png b/collections/tfmanual/knowledge_base/technology/concepts/img/manual__grace_period_gridproxy.png new file mode 100644 index 0000000..d21ce2d Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/concepts/img/manual__grace_period_gridproxy.png differ diff --git a/collections/tfmanual/knowledge_base/technology/concepts/img/manual__grace_period_polkadot_ui.png b/collections/tfmanual/knowledge_base/technology/concepts/img/manual__grace_period_polkadot_ui.png new file mode 100644 index 0000000..ccd17c8 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/concepts/img/manual__grace_period_polkadot_ui.png differ diff --git a/collections/tfmanual/knowledge_base/technology/concepts/img/manual__grace_period_weblets.png b/collections/tfmanual/knowledge_base/technology/concepts/img/manual__grace_period_weblets.png new file mode 100644 index 0000000..939f40c Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/concepts/img/manual__grace_period_weblets.png differ diff --git a/collections/tfmanual/knowledge_base/technology/concepts/img/payment.png b/collections/tfmanual/knowledge_base/technology/concepts/img/payment.png new file mode 100644 index 0000000..68b2e1d Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/concepts/img/payment.png differ diff --git a/collections/tfmanual/knowledge_base/technology/concepts/img/tft.png b/collections/tfmanual/knowledge_base/technology/concepts/img/tft.png new file mode 100644 index 0000000..03d884e Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/concepts/img/tft.png differ diff --git a/collections/tfmanual/knowledge_base/technology/concepts/proof_of_utilization.md b/collections/tfmanual/knowledge_base/technology/concepts/proof_of_utilization.md new file mode 100644 index 0000000..c86b4c3 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/concepts/proof_of_utilization.md @@ -0,0 +1,29 @@ +

Proof of Utilization

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Overview](#overview) +- [CU, SU, NU](#cu-su-nu) + +*** + +## Introduction + +The ThreeFold Grid employs a unique mechanism called __Proof of Utilization__ to track and measure resource utilization within its decentralized network. We provide here an overview of this mechanism. + +## Overview + +Proof of Utilization is a system that records resource usage on an hourly basis and serves as a transparent and reliable way to validate and verify the utilization of various components of the grid. + +The Proof of Utilization concept encompasses the monitoring and tracking of three key types of resources within the ThreeFold Grid:__Compute Resources (CU)__, __Storage Resources (SU)__, and __Network resources (NU)__. These resources are essential for supporting the diverse needs of users and applications on the grid. + +## CU, SU, NU + +__Compute resources (CU)__ refer to the computational power and processing capabilities provided by the ThreeFold Grid. This includes the ability to run applications, execute tasks, and perform complex computations in a distributed and decentralized manner. + +__Storage resources (SU)__ encompass the capacity to store and manage data within the ThreeFold Grid. It enables users to securely store and retrieve their data, ensuring reliable and scalable data management solutions. + +__Network resources (NU)__ focus on the network connectivity and bandwidth available within the ThreeFold Grid. This includes the transmission of data, communication between nodes, and facilitating the seamless flow of information across the decentralized network. + +In addition to the resources mentioned above, the Proof of Utilization system also tracks network utilization parameters such as __IPv4 addresses__, __DNS services__, and __name-on-web gateways__. These elements play a crucial role in enabling effective communication and accessibility within the ThreeFold Grid. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/concepts/tfchain.md b/collections/tfmanual/knowledge_base/technology/concepts/tfchain.md new file mode 100644 index 0000000..ee95510 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/concepts/tfchain.md @@ -0,0 +1,37 @@ +

ThreeFold Chain

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Overview](#overview) +- [Key Functionalities](#key-functionalities) + +*** + +## Introduction + +__TFChain__, also known as __ThreeFold Chain__, is the blockchain at the core of managing the ThreeFold Grid, which operates as a decentralized autonomous organization (DAO). Built on Substrate, TFChain provides the infrastructure to support the seamless functioning of the ThreeFold Grid ecosystem. + +## Overview + +One of the key features of TFChain is its __compatibility with multiple blockchains__. The native token of the ThreeFold ecosystem, TFT, can be utilized across different blockchain networks including TFChain, Stellar, and Binance Smart Chain. This compatibility enables users to transfer their TFT tokens seamlessly between these blockchains, providing flexibility and convenience. + +To leverage the Internet Capacity available on the ThreeFold Grid, users are required to transfer funds to their TFChain account. This ensures that users have the necessary financial resources to access and utilize the storage, compute, and network services offered by the ThreeFold Grid. By transferring money to their TFChain account, users can seamlessly tap into the vast potential of the decentralized Internet Capacity provided by the ThreeFold Grid. + +TFChain serves as the backbone of the ThreeFold ecosystem, facilitating efficient transactions, secure transfers of value, and the management of user accounts. It plays a vital role in supporting the seamless interaction between users and the ThreeFold Grid, enabling them to leverage the available Internet Capacity and contribute to the growth of the decentralized network. + +## Key Functionalities + +__TFChain (Threefold Chain)__ is a powerful blockchain that orchestrates the interactions within the ThreeFold Grid ecosystem, providing users with a range of key functions. Let's explore some of these user-friendly functions: + +- __Users Registration__: TFChain allows seamless registration for users to join the ThreeFold Grid. By creating an account, users can easily become part of the decentralized network and access the various resources and services available. + +- __Farms Management__: TFChain simplifies the process of managing node farms within the ThreeFold Grid. It provides a streamlined registration system, enabling farmers to register their nodes and effectively contribute to the grid. Additionally, TFChain facilitates IP management, allowing farmers to efficiently manage and allocate IP addresses to their nodes. + +- __Fund Transfers__: TFChain supports secure and efficient fund transfers within the ThreeFold ecosystem. Users can seamlessly transfer funds, including the native TFT token, between accounts on TFChain. This feature enables easy financial transactions and fosters a thriving economy within the ThreeFold Grid. + +- __Billing and Consumption Reports__: TFChain offers detailed billing and consumption reports, providing users with insights into their resource usage and associated costs. Users can easily track their consumption, monitor usage patterns, and access comprehensive reports, ensuring transparency and accountability in resource management. + +And More: TFChain is continuously evolving and expanding its functionality. In addition to the key functions mentioned above, TFChain provides a robust foundation for other essential features within the ThreeFold Grid. This includes __facilitating secure transactions, maintaining a transparent ledger, enabling governance mechanisms,__ and supporting various interactions and operations within the decentralized ecosystem. + +TFChain's user-friendly functions empower users to participate actively in the ThreeFold Grid, seamlessly manage their resources, and engage in secure and efficient transactions. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/concepts/tfgrid_by_design.md b/collections/tfmanual/knowledge_base/technology/concepts/tfgrid_by_design.md new file mode 100644 index 0000000..02672f7 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/concepts/tfgrid_by_design.md @@ -0,0 +1,152 @@ +

TFGrid by Design: Deployment Architectures and Solution Categories

+ +

Table of Contents

+ +- [Introduction](#introduction) + - [TFGrid by Design](#tfgrid-by-design) + - [Capacity and Connectivity](#capacity-and-connectivity) +- [TFGrid Main Components Overview and Examples](#tfgrid-main-components-overview-and-examples) + - [Storage Units](#storage-units) + - [0-DB-FS](#0-db-fs) + - [0-stor\_v2](#0-stor_v2) + - [QSFS](#qsfs) + - [Compute Units](#compute-units) + - [Virtual CPUs (vCPUs)](#virtual-cpus-vcpus) + - [Kubernetes](#kubernetes) + - [TF Grid-SDK-Go and TF Grid-SDK-TS](#tf-grid-sdk-go-and-tf-grid-sdk-ts) + - [Network Units](#network-units) + - [Reliable Message Bus Relay (RMB-RS)](#reliable-message-bus-relay-rmb-rs) + - [TCP-Router](#tcp-router) +- [Solution Categories](#solution-categories) + - [DIY Workloads](#diy-workloads) + - [Independent Commercial Offerings](#independent-commercial-offerings) + - [ThreeFold Commercial Offerings](#threefold-commercial-offerings) +- [Best Practices](#best-practices) +- [Questions and Feedback](#questions-and-feedback) + +*** + +# Introduction + +Before starting a project on the TFGrid, it can be good idea to consider the overall design of the grid itself, and to ponder the potential solution designs you can come up with to ensure reliable and resilient deployments. This text will explore some of the main components of the TFGrid as well as its inherent design in order to provide sufficient information for system administrators to deploy effective and reliable solutions. We will also cover the three main solution categories that can be built on top of the TFGrid. + +## TFGrid by Design + +At its core, the TFGrid is composed of thousands of 3Nodes. 3Nodes provide storage, compute and network units to the TFGrid. By design, 3Nodes are not reliable in themselves, in the sense that a 3Node online today could be offline tomorrow if hardware or connection failures arise. This reality is inherent to any cloud enterprises. But this does not mean that reliability is not possible on the TFGrid. To the contrary, the TFGrid is composed of different components that can be utilized to provide reliability in all aspects of the grid: storage, compute and network. It is the role of system administrators to develop solutions that will be reliable in themselves. + +A myriad of possibilities and configurations are possible within the TFGrid ecosystem and, by understanding the interconnectedness between the grid components, one can knowingly build a solid deployment that will respond to the needs of a given project. + +## Capacity and Connectivity + +When it comes to deployments, we must consider two major aspects of the Internet infrastructure: capacity and connectivity. While capacity can be thought as the individual 3Nodes composing the TFGrid, where information is processed and stored within the 3Nodes, connectivity can be thought as the links and information transfers between the 3Nodes and the public Internet. + +As a general consideration, the TFGrid works mostly on the capacity side, whereas a 3Node will always be connected to the Internet by ways of different Internet Service Providers (ISP) depending on the farmer's location and resources. The 3Nodes provide storage and compute units where users can store information on SSD and HDD disks and where they can generate compute processes with CPUs. Another major component of the TFGrid would be network units. While, as said before, the TFGrid does not provide directly connectivity as per the traditional ISP services, elements such as gateways and Wireguard VPNs are further related to network units than compute or storage units. + +To build a reliable deployment on the TFGrid, you need to take into consideration the three different types of unit on the TFGrid: storage, compute and network. Let's delve into these a little bit more. + +# TFGrid Main Components Overview and Examples + +We provide here an overview of some of the main components of the TFGrid. We also provide examples for each of those components in order for the reader to obtain a clear understanding of the TF Ecosystem. By understanding the different components of the TFGrid, system administrators will be able to deploy resilient, redundant and reliable solutions on the grid. + +For a complete list of the TFGrid components, read [this documentation](./grid3_components.md). + +## Storage Units + +Storage units are related to the data stored in SSD and HDD disks. The Quantum Safe Filesystem (QSFS) technology developed by ThreeFold ensures redundancy and resilience in storage units. If one disk of the QSFS array goes offline, the rest of the system can still function properly. To the contrary, if a user stores information on one single 3Node and this 3Node has a drastic disk failure, the user will lose the data. Another way to achieve redundancy in the storage category would be to deploy a solution with real-time synced databases of two or more 3nodes connected via a wireguard VPN. Note that other configurations offering reliability and redundancy are possible. + +Let's explore some storage components of the ThreeFold Grid. + +### 0-DB-FS + +[0-DB-FS](./grid3_components.md#0-db-fs) is storage system that allows for efficient and secure storage of files on the ThreeFold Grid. 0-DB-FS is built on top of 0-DB, which is a key-value store optimized for high performance and scalability. It provides a decentralized and distributed approach to file storage, ensuring data redundancy and availability. + +### 0-stor_v2 + +[0-stor_v2](./grid3_components.md#0-stor_v2) is a distributed and decentralized storage solution that enables data storage and retrieval on the ThreeFold Grid. + +### QSFS + +[Quantum Safe Filesystem (QSFS)](./grid3_components.md#qsfs) is ThreeFold's innovative storage solution designed to address the security challenges posed by quantum computing. QSFS employs advanced cryptographic techniques that are resistant to attacks from quantum computers, ensuring the confidentiality and integrity of stored data. By its design, QSFS also offers a high level of redundancy. + +## Compute Units + +Compute units are related to the CPUs doing calculations during the deployment. If a user deploys on a 3Node and uses the CPUs of the units while those CPUs experience failure, the user will lose compute power. as a main example, a way to achieve redundancy in the compute category would be to deploy a solution via Kubernetes. In this case, the CPU workload is balanced between the different 3Nodes of the Kubernetes cluster and if one 3Node fails, the deployment can still function properly. + +Let's explore some compute components of the ThreeFold Grid. + +### Virtual CPUs (vCPUs) + +Virtual CPUs (vCPUs) are virtual representations of physical CPUs that allow multiple virtual machines (VMs) to run concurrently on a single physical server or host. Virtualization platforms allocate vCPUs to each VM, enabling them to execute tasks and run applications as if they were running on dedicated physical hardware. The number of vCPUs assigned to a VM determines its processing power and capacity to handle workloads. On the TFGrid, the number of vCPUs is limited to the physical number of CPUs on the host (i.e. the 3Node). Since this limitation is done per VM, this means that a node with 8 cores can still have 2 VMs each with 8 vCPUs. + +### Kubernetes + +[Kubernetes](../../../documentation/dashboard/solutions/k8s.md) is an open-source container orchestration system for automating software deployment, scaling, and management. On the TFGrid, Kubernetes clusters can be deployed out of the box. Thus, system administrators can seamlessly deploy solutions on the TFGrid that are reliable in terms of compute units. + +### TF Grid-SDK-Go and TF Grid-SDK-TS + +The [TFGrid-SDK-Go](./grid3_components.md#tf-grid-sdk-go) and [TFGrid-SDK-TS](./grid3_components.md#tf-grid-sdk-ts) enable developers to interact with the ThreeFold Grid infrastructure, such as provisioning and managing compute resources, accessing storage, and interacting with the blockchain-based services. They provide a standardized and convenient way to leverage the features and capabilities of the ThreeFold Grid within Go and Typescript applications. + +## Network Units + +Network units are related to the data transmitted over the Internet. While TFGrid does not provide direct ISP services, elements such as gateways are clearly related to the network. [Gateways](../../../documentation/system_administrators/terraform/resources/terraform_vm_gateway.md) can be used to balance network workloads. A deployment could consist of two different gateways with a master node gateway and a worker node gateway. If the master gateway would fail, the worker gateway would take the lead and become the master gateway. Deploying solutions with several gateways can help system administrators build reliable solutions. + +Note that it is also possible to deploy a Wireguard virtual private network (VPN) between different 3Nodes and synchronize their databases. This provides resilience and redundancy. Read more on VPN and synced databases [here](../../../documentation/system_administrators/terraform/advanced/terraform_mariadb_synced_databases.md). + +Let's explore some network components of the ThreeFold Grid. + +### Reliable Message Bus Relay (RMB-RS) + +[Reliable Message Bus Relay (RMB-RS)](./grid3_components.md#reliable-message-bus-relay-rmb-rs) is a component or system that facilitates the reliable and secure transfer of messages between different entities or systems within the ThreeFold ecosystem. It acts as a relay or intermediary, ensuring that messages are delivered accurately and efficiently, even in the presence of network disruptions or failures. The RMB-RS employs robust protocols and mechanisms to guarantee message reliability, integrity, and confidentiality. + +### TCP-Router + +[TCP-Router](./grid3_components.md#tcp-router) is a component of the ThreeFold technology stack that acts as a TCP (Transmission Control Protocol) router and load balancer. It serves as a network gateway for incoming TCP connections, routing them to the appropriate destinations based on predefined rules and configurations. The TCP-Router component is responsible for distributing incoming network traffic across multiple backend services or nodes, ensuring efficient load balancing and high availability. + +# Solution Categories + +There are three main solution categories on the TFGrid: DIY workloads, independent commercial offerings, and ThreeFold commercial offerings. Let's take a look at them and discuss their basic properties. + +## DIY Workloads + +Out-of-the-box applications are available on the [TF Dashboard](../../../documentation/dashboard/deploy/applications.md) and [Terraform](../../../documentation/system_administrators/terraform/terraform_toc.md), where anyone can [buy TFTs](../../../documentation/threefold_token/buy_sell_tft/buy_sell_tft.md) and deploy on the decentralized and open-source grid. The reliability of those deployments depend on the capacity and resources of each DIY system administrator. + +In essence, when you deploy on the decentralized and open-source TFGrid, you act as a centralized entity building the solution architecture. You must design the solution in a way that it can be reliable with high-availability and resilience levels that suit the needs of your project. + +Note that when you deploy on the ThreeFold Grid, you are doing so in accordance with the [ThreeFold Terms and Conditions](../../legal/terms_conditions_all3.md). + +## Independent Commercial Offerings + +Since the TFGrid is open-source, anyone could decide to build a commercial offering on top of the grid. In this case, it would be recommended for the commercial offering to provide Terms and Conditions, clear support, a website to advertise the product and a marketing strategy to obtain customers. + +In this case, the commercial offering is the centralized entity and if the company makes a mistake, it would be liable to the users to the extent discussed in the T&C. + +The ThreeFold Manual already contains a lot of resourceful information on how to [deploy applications](../../../documentation/dashboard/deploy/applications.md) on the TFGrid. We invite everyone to develop independent commercial offerings on top of the ThreeFold Grid. + +## ThreeFold Commercial Offerings + +ThreeFold is building commercial offerings on top of the TFGrid. Those commercial offerings are for-profit organizations. Each of those organizations would function as a centralized entity. + +ThreeFold Ventures will be the branch exploring this aspect of the TF Ecosystem. A major project on the way is [ThreeFold Cloud](https://cloud.threefold.io/). ThreeFold Cloud is thus a centralized entity that will generate its own Terms and Conditions, support, marketing and website strategy. Furthermore, ThreeFold Cloud will be liable to its users to the extent developed in the ThreeFold Cloud Terms and Conditions. + +# Best Practices + +This text provided an introduction to some deployment architectures and solution categories possible on the TFGrid. In the future, we will expand on some of the main TFGrid best practices. Stay tuned for more on this topic. + +Some of the best practices to be covered are the following: + +* Use Kubernetes to deploy redundant workloads +* Use multi-gateways deployments for redundancy + * Deploy manually two VMs + * Use two webgateways to access the VMs + * Choose a data replication strategy to have content on both places (e.g. syncing databases) +* Use continous deployment and integration workloads + * Deploy on 2 different VMs + * Ensure continuous deployment and integration when changes occur +* Use DNS with redundancy +* Use QSFS for storage resilience and redundancy + +These are only a few of the many possibilities that the TFGrid offers. We invite everyone to explore the TFGrid and share their experience and learning. + +# Questions and Feedback + +If you have any questions or feedback, we invite you to discuss with the ThreeFold community on the [ThreeFold Forum](http://forum.threefold.io/) or on the [ThreeFold Grid Tester Community](https://t.me/threefoldtesting) chat on Telegram. diff --git a/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/consensus3.md b/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/consensus3.md new file mode 100644 index 0000000..9ba3105 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/consensus3.md @@ -0,0 +1,19 @@ +![](img/grid_header.jpg) + +# DAO Consensus Engine + +!!!include:dao_info + +## DAO Engine + +On TFGrid 3.0 ThreeFold has implemented a DAO consensus engine using Polkadot/Substrate blockchain technology. + +This is a powerful blockchain construct which allows us to run our TFGrid and maintain consensus on global scale. + +This system has been designed to be compatible with multiple blockchains. + +!!!include:consensus3_overview_graph + +!!!include:consensus3_toc + +!!!def alias:consensus3,consensus_engine \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/consensus3_engine_farming.md b/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/consensus3_engine_farming.md new file mode 100644 index 0000000..1774781 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/consensus3_engine_farming.md @@ -0,0 +1,17 @@ +![](img/grid_header.jpg) + +### consensus engine in relation to TFT Farming Rewards in TFGrid 3.0 + +!!!include:consensus3_overview_graph + +The consensus engine checks the farming rules as defined in + +- [farming logic 3.0](farming_reward) +- [farming reward calculator](farming_calculator) + +- if uptime + 98% per month then the TFT will be rewarded to the farmer (for TFGrid 3.0, can change later). + +All the data of the farmer and the 3nodes are registered on TFChain + + +!!!include:consensus3_toc \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/consensus3_oracles.md b/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/consensus3_oracles.md new file mode 100644 index 0000000..0af143f --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/consensus3_oracles.md @@ -0,0 +1,44 @@ + +## Consensus 3.X Oracles used + +Oracles are external resources of information. + +The TFChain captures and holds that information so we get more certainty about the accuracy. + +We have oracles for price & reputation for e.g. TF Farmers and 3Nodes. + +These oracles are implemented on TF_CHAIN for TFGrid 3.0. + +```mermaid + + +graph TB + subgraph Digital Currency Ecosystem + money_blockchain[Money Blockchain Explorers] + Exch1[Money Blockchain Decentralized Exchange] + OracleEngine --> Exch1[Polkadot] + OracleEngine --> Exch1[Money Blockchain Exchange] + OracleEngine --> Exch2[Binance Exchange] + OracleEngine --> Exch3[other... exchanges] + end + subgraph ThreeFold Grid + Monitor_Engine --> 3Node1 + Monitor_Engine --> 3Node2 + Monitor_Engine --> 3Node3 + end + subgraph TFChainNode1[TFGrid Blockchain Node] + Monitor_Engine + Explorers[TFChain Explorers]-->TFGridDB --> BCNode + Explorers --> BCNode + ConsensusEngine1-->BCNode[Blockchain Validator Node] + ConsensusEngine1 --> money_blockchain[Money Blockchain] + ConsensusEngine1 --> ReputationEngine[Reputation Engine] + ReputationEngine --> Monitor_Engine[Monitor Engine] + ConsensusEngine1 --> OracleEngine[Oracle For Pricing Digital Currencies] + end + +``` + +> TODO: outdated info + +!!!include:consensus3_toc \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/consensus3_overview_graph.md b/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/consensus3_overview_graph.md new file mode 100644 index 0000000..8221c40 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/consensus3_overview_graph.md @@ -0,0 +1,51 @@ + +```mermaid +graph TB + subgraph Money Blockchain + money_blockchain --> account1 + money_blockchain --> account2 + money_blockchain --> account3 + click money_blockchain "/threefold/#money_blockchain" + end + subgraph TFChainNode1[TFChain BCNode] + Explorer1-->BCNode1 + ConsensusEngine1-->BCNode1 + ConsensusEngine1 --> money_blockchain + ConsensusEngine1 --> ReputationEngine1 + ReputationEngine1 --> Monitor_Engine1 + click ReputationEngine1 "/info/threefold/#reputationengine" + click ConsensusEngine1 "/info/threefold/#consensusengine" + click BCNode1 "/info/threefold/#bcnode" + click Explorer1 "/info/threefold/#tfexplorer" + end + subgraph TFChainNode2[TFChain BCNode] + Explorer2-->BCNode2 + ConsensusEngine2-->BCNode2 + ConsensusEngine2 --> money_blockchain + ConsensusEngine2 --> ReputationEngine2 + ReputationEngine2 --> Monitor_Engine2 + click ReputationEngine2 "/info/threefold/#reputationengine" + click ConsensusEngine2 "/info/threefold/#consensusengine" + click BCNoBCNode2de1 "/info/threefold/#bcnode" + click Explorer2 "/info/threefold/#tfexplorer" + + end + Monitor_Engine1 --> 3Node1 + Monitor_Engine1 --> 3Node2 + Monitor_Engine1 --> 3Node3 + Monitor_Engine2 --> 3Node1 + Monitor_Engine2 --> 3Node2 + Monitor_Engine2 --> 3Node3 + click 3Node1 "/info/threefold/#3node" + click 3Node2 "/info/threefold/#3node" + click 3Node3 "/info/threefold/#3node" + click Monitor_Engine1 "/info/threefold/#monitorengine" + click Monitor_Engine2 "/info/threefold/#monitorengine" + + +``` + +*click on the parts of the image, they will go to more info* + +> TODO: outdated info + diff --git a/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/consensus3_principles.md b/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/consensus3_principles.md new file mode 100644 index 0000000..27ab007 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/consensus3_principles.md @@ -0,0 +1,45 @@ +# Consensus Mechanism + +## Blockchain node components + +!!!include:consensus3_overview_graph + +- A Blockchain node (= Substrate node) called TF-Chain, containing all entities interacting with each other on the TF-Grid +- An explorer = a Rest + GraphQL interface to TF-Chain (Graphql is a nice query language to make it easy for everyone to query for info) +- Consensus Engine + - is a Multisignature Engine running on TF-Chain + - The multisignature is done for the Money BlockchainAccounts + - It checks the AccountMetadata versus reality and if ok, will sign, which allows transactions to happen after validation of the "smart contract" +- SLA & reputation engine + - Each node uptime is being checked by Monitor_Engine + - Also bandwidth will be checked in the future (starting 3.x) + +### Remarks + +- Each Monitor_Engine checks uptime of X nr of nodes (in beginning it can do all nodes), and stores the info in local DB (to keep history of check) + +## Principle + +- We keep things as simple as we can + - Money Blockchain blockchain used to hold the money + - Money Blockchain has all required features to allow users to manage their money like wallet support, decentralized exchange, good reporting, low transaction fees, ... + - Substrate based TFChain is holding the metadata for the accounts which express what we need to know per account to allow the start contracts to execute. + - Smart Contracts are implemented using multisignature feature on Money Blockchain in combination with Multi Signature done by Consensus_Engine. +- on money_blockchain: + - each user has Money BlockchainAccounts (each of them holds money) + - there are normal Accounts (means people can freely transfer money from these accounts) as well as RestrictedAccounts. Money cannot be transfered out of RestrictedAccounts unless consensus has been achieved from ConsensusEngine. +- Restricted_Account + - On stellar we use the multisignature feature to make sure that locked/vesting or FarmingPool cannot transfer money unless consensus is achieved by the ConsensusEngine + +- Each account on money_blockchain (Money BlockchainAccount) has account record in TFChain who needs advanced features like: + - lockup + - vesting + - minting (rewards to farmers) + - tfta to tft conversion + +- The Account record in TFGrid_DB is called AccountMetadata. + - The AccountMetadata describes all info required to be able for consensus engine to define what to do for advanced features like vesting, locking, ... + +> TODO: outdated info + +!!!include:consensus3_toc \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/consensus3_toc.md b/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/consensus3_toc.md new file mode 100644 index 0000000..ec2109c --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/consensus3_toc.md @@ -0,0 +1,13 @@ + +## Consensus Engine Information + +- [Consensus Engine Homepage](consensus3) +- [Principles TFChain 3.0 Consensus](consensus3_principles) +- [Consensus Engine Farming 3.0](consensus3_engine_farming) +- [TFGrid 3.0 wallets](tfgrid3_wallets) +- Architecture: + - [Money Blockchains/Substrate architecture](money_blockchain_partity_link) + + +> implemented in TFGrid 3.0 + diff --git a/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/img/grid_header.jpg b/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/img/grid_header.jpg new file mode 100644 index 0000000..d2808e3 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/img/grid_header.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/img/limitedsupply_.png b/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/img/limitedsupply_.png new file mode 100644 index 0000000..b9220ec Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/img/limitedsupply_.png differ diff --git a/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/money_blockchain_partity_link.md b/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/money_blockchain_partity_link.md new file mode 100644 index 0000000..ae8845e --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/money_blockchain_partity_link.md @@ -0,0 +1,53 @@ + +## Link between different Money Blockchain & TFChain + +TF-Chain is the ThreeFold blockchain infrastructure, set up in the Substrate framework. + +We are building a consensus layer which allows us to easily bridge between different money blockchains. + +Main blockchain for TFT remains the Stellar network for now. A secure bridging mechanism exists, able to transfer TFT between the different blockchains. +Active bridges as from TFGrid 3.0 release: +- Stellar <> Binance Smart Chain +- Stellar <> Parity Substrate +More bridges are under development. + +```mermaid + + +graph TB + subgraph Money Blockchain + money_blockchain --- account1a + money_blockchain --- account2a + money_blockchain --- account3a + account1a --> money_user_1 + account2a --> money_user_2 + account3a --> money_user_3 + click money_blockchain "/info/threefold/#money_blockchain" + end + subgraph ThreeFold Blockchain On Parity + TFBlockchain --- account1b[account 1] + TFBlockchain --- account2b[account 2] + TFBlockchain --- account3b[account 3] + account1b --- smart_contract_data_1 + account2b --- smart_contract_data_2 + account3b --- smart_contract_data_3 + click TFBlockchain "/info/threefold/#tfchain" + end + account1b ---- account1a[account 1] + account2b ---- account2a[account 2] + account3b ---- account3a[account 3] + + consensus_engine --> smart_contract_data_1[fa:fa-ban smart contract metadata] + consensus_engine --> smart_contract_data_2[fa:fa-ban smart contract metadata ] + consensus_engine --> smart_contract_data_3[fa:fa-ban smart contract metadata] + consensus_engine --> account1a + consensus_engine --> account2a + consensus_engine --> account3a + click consensus_engine "/info/threefold/#consensus_engine" + + +``` + +Above diagram shows how our consensus engine can deal with Substrate and multiple Money Blockchains at same time. + +!!!include:consensus3_toc \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/roadmap_tfchain3.md b/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/roadmap_tfchain3.md new file mode 100644 index 0000000..28f484f --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/roadmap_tfchain3.md @@ -0,0 +1,52 @@ + +# Roadmap For our TFCHain and ThreeFold DAO + +![](img/limitedsupply_.png) + +## TFChain / DAO 3.0.2 + +For this phase our TFChain and TFDAO has been implemented using parity/substrate. + +Features + +- poc +- pou +- identity management +- consensus for upgrades of DAO and TFChain (code) +- capacity tracking (how much capacity used) +- uptime achieved +- capacity utization +- smart contract for IT +- storage of value = TFT +- request/approval for adding a validator + +Basically all basic DAO concepts are in place + +## TFChain / DAO 3.0.x + +TBD version nr, planned Q1 2022 + +NEW + +- proposals for TFChain/DAO/TFGrid changes (request for change) = we call them TFCRP (ThreeFold Change Request Proposal) +- voting on proposals = we call them TFCRV (ThreeFold Change Request Vote) + + +## TFChain / DAO 3.1.x + +TBD version nr, planned Q1 2022 + +This version adds more layers to our existing DAO and prepares for an even more scalable future. + +NEW + +- Cosmos based chain on L2 +- Validator Nodes for TFGrid and TFChain. +- Cosmos based HUB = security for all TFChains + +> More info about our DAO strategy see TFDAO. + + + +!!!def alias:tfchain_roadmap,dao_roadmap,tfdao_roadmap + diff --git a/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/tfgrid3_wallets.md b/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/tfgrid3_wallets.md new file mode 100644 index 0000000..f054c65 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/tfgrid3_wallets.md @@ -0,0 +1,73 @@ + +# TFGrid 3.0 Wallets + +ThreeFold has a mobile wallet which will allow to be used on the TFChain backend (Substrate) as well as any other Money Blockchain it supports. + +This provides for a very secure digital currency infrastructure with lots of advantages. + +- [X] ultra flexible smart contracts possible +- [X] super safe +- [X] compatible with multiple blockchains (money blockchains) +- [X] ultra scalable + +```mermaid + + +graph TB + + subgraph Money Blockchain + money_blockchain[Money Blockchain Explorers] + money_blockchain --- money_blockchain_node_1 & money_blockchain_node_2 + money_blockchain_node_1 + money_blockchain_node_2 + end + + subgraph ThreeFold Wallets + mobile_wallet[Mobile Wallet] + desktop_wallet[Desktop Wallet] + mobile_wallet & desktop_wallet --> money_blockchain + mobile_wallet & desktop_wallet --> Explorers + money_blockchain_wallet[Any Money Blockchain Wallet] --> money_blockchain + end + + + subgraph TFChain[TFGrid Blockchain on Substrate] + Explorers[TFChain Explorers]-->TFGridDB --> BCNode + Explorers --> BCNode + end + + +``` + +Generic overview: + +```mermaid + +graph TB + + subgraph TFChain[TFGrid Chain] + guardian1[TFChain Node 1] + guardian2[TFChain Node 2] + guardian3[TFChain Node 3...9] + end + + User_wallet[User Wallet] --> money_blockchain_account + User_wallet[User Wallet] --> money_blockchain_restricted_account + + subgraph Money Blockchain Ecosystem + money_blockchain_account + money_blockchain_restricted_account --- guardian1 & guardian2 & guardian3 + end + + subgraph consensus[Consensus Layer on Substrate] + guardian1 --> ReputationEngine & PricingOracle + guardian1 --> contract1[Smart Contract Vesting] + guardian1 --> contract2[Smart Contract Minting/Farming] + end + + + + +``` + +!!!include:consensus3_toc \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/tfgrid_db_models.v b/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/tfgrid_db_models.v new file mode 100644 index 0000000..b34cf6d --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/consensus3_mechanism/tfgrid_db_models.v @@ -0,0 +1,52 @@ + +// - vesting +// - startdate: epoch +// - currency: USD +// - [[$month_nr,$minprice_unlock,$TFT_to_vest],...] +// - if 48 months then list will have 48 parts +// - month 0 = first month +// - e.g. [[0,0.11,10000],[1,0.12,10000],[2,0.13,10000],[3,0.14,10000]...] + +//information stored at account level in TFGridDB +struct AccountMeta{ + //corresponds to unique address on money_blockchain + money_blockchain_address string + vesting Vesting[] + unlocked_TFT int +} + +struct Vesting{ + startdate int + //which currency is used to execute on the acceleration in the vesting + //if price above certain level (which is currency + amount of that currency) the auto unlock + currency CurrencyEnum + months []VestingMonth +} + +struct VestingMonth{ + month_nr int + //if 0 then will not unlock based on price + unlock_price f32 + tft_amount int +} + +enum CurrencyEnum{ + usd + eur + egp + gbp + aed +} + +//this is stored in the TFGridDB +fn (mut v AccountMeta) serialize() string{ + //todo code which does serialization see above + return "" +} + + +//write minting pool + + +//REMARKS +// if unlock triggered because of month or price then that record in the VestingMonth[] goes away and TFT go to unlocked_TFT \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/grid3_howitworks.md b/collections/tfmanual/knowledge_base/technology/grid3_howitworks.md new file mode 100644 index 0000000..c15025b --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/grid3_howitworks.md @@ -0,0 +1,33 @@ +

How It Works

+ +Welcome to the ThreeFold ecosystem, your gateway to a global and sustainable network! + +## TFGrid in a Nutshell + +The ThreeFold Grid is a remarkable network sustained by dedicated individuals, known as **ThreeFold farmers**, who offer network, storage and compute (CPU, GPU) resources to users via 3Nodes, specialized computers that run the innovative Zero-OS software. + +> [Become a ThreeFold farmer](../../documentation/farmers/farmers.md) + +## If it runs on Linux, it runs on the Grid! + +The ThreeFold Grid supports any application that can run on Linux, guaranteeing compatibility and flexibility. Moreover, it offers additional benefits, including enhanced privacy, security, proximity to end-users, and a significantly lower cost compared to traditional alternatives. + +> [Deploy on the TFGrid](../../documentation/system_administrators/getstarted/tfgrid3_getstarted.md) + +## Internet as a Resource + +In a similar manner to purchasing electricity or other utilities, the internet capacity provided by the ThreeFold Grid is produced and allocated locally. This decentralized approach empowers digital service and application providers to host their offerings closer to end-users, resulting in exceptional performance, competitive pricing, and improved profit margins. The TFGrid is fueled by the ThreeFold Token. + +> [Learn more about TFT](../about/token_overview/token_overview.md) + +## TFChain: The Backbone Blockchain Infrastructure + +__TFChain__, also known as __ThreeFold Chain__, is the powerful blockchain that orchestrates the interactions within the ThreeFold Grid ecosystem. TFChain is like the control center of the ThreeFold Grid, providing users and farmers with a wide range of key functionalities. + +> [Learn more about TFChain](../technology/concepts/tfchain.md) + +## ThreeFold Dashboard + +The [**ThreeFold Dashboard**](https://dashboard.grid.tf/) serves as an indispensable tool for farmers and users of the ThreeFold Grid, facilitating node registration, resource management, workload deployments and much more. + +> [Learn more about the ThreeFold Dashboard](../../documentation/dashboard/dashboard.md) diff --git a/collections/tfmanual/knowledge_base/technology/img/layer0_.jpg b/collections/tfmanual/knowledge_base/technology/img/layer0_.jpg new file mode 100644 index 0000000..fa1d017 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/img/layer0_.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/img/tech_architecture1.jpg b/collections/tfmanual/knowledge_base/technology/img/tech_architecture1.jpg new file mode 100644 index 0000000..8595e3a Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/img/tech_architecture1.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/img/tech_header.jpg b/collections/tfmanual/knowledge_base/technology/img/tech_header.jpg new file mode 100644 index 0000000..31cf3fb Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/img/tech_header.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/img/technology_home_.jpg b/collections/tfmanual/knowledge_base/technology/img/technology_home_.jpg new file mode 100644 index 0000000..9d975f3 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/img/technology_home_.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/layers/autonomous_layer_intro.md b/collections/tfmanual/knowledge_base/technology/layers/autonomous_layer_intro.md new file mode 100644 index 0000000..4a52295 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/layers/autonomous_layer_intro.md @@ -0,0 +1,12 @@ +## Autonomous Layer + +### Digital Twin + +>TODO: + +### 3Bot + +3Bot is a virtual system administrator that manages the user's IT workloads under a private key. This ensures an immutable record of any workload as well as a self-healing functionality to restore these workloads if/when needed. Also, all 3Bot IDs are registered on a modern type of phone book that uses blockchain technology. This phone book, also referred to as the Threefold Grid Blockchain, allows all 3Bots to find each other, connect and exchange information or resources in a fully end-to-end encrypted way. Here as well, there are "zero people involved, as 3Bots operate autonomously in the network, and only under the user's commands.  + +3Bot is equipped with a cryptographic 2-factor authentication mechanism. You can log in to your 3Bot via the ThreeFold Connect app on your device which contains your private key. The 3Bot is a very powerful tool that allows you to automate & manage thousands of virtual workloads on the ThreeFold_Grid. + diff --git a/collections/tfmanual/knowledge_base/technology/layers/capacity_layer_intro.md b/collections/tfmanual/knowledge_base/technology/layers/capacity_layer_intro.md new file mode 100644 index 0000000..31f60f3 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/layers/capacity_layer_intro.md @@ -0,0 +1,54 @@ +## Capacity Layer + +### Zero-OS + +ThreeFold has build its own operating system called, Zero-OS which was based starting from a Linux Kernel with as purpose to remove all the unnecessary complexity found on contemporary OS's. + +Zero-OS supports a small number of primitives, and performs low-level functions natively. + +It delivers 3 primitive functions: +- storage capacity +- compute capacity +- network capacity + +There is no shell, local nor remote attached to Zero-OS. It does not allow for inbound network connections to happen to the core. Also, given its shell-less nature, the people and organizations, called farmers, that run 3nodes cannot issue any commands nor access its features. In that sense, Zero-OS enables a "zero people" (autonomous) Internet, meaning hackers cannot get in, while also eliminating human error from the paradigm. + +### 3Node + +The ThreeFold_Grid needs hardware/servers to function. Servers of all shapes and sizes can be added to the grid by anyone, anywhere in the world. The production of Internet Capacity on the Threefold Grid is called Farming and people who add these servers to the grid are called Farmers. This is a fully decentralized process and they get rewarded by the means of TFT. + +Farmers download the Zero-OS operating system and boot their servers themselves. Once booted, these servers become 3Nodes. The 3Nodes will register themselves in a database called the TF_Explorer. Once registered in the TF_Explorer, the capacity of the 3Nodes will become available on the TF Grid Explorer. Also, given the autonomous nature of the ThreeFold_Grid, there is no need for any intermediaries between the user and 3Nodes. + +This enables a complete peer-to-peer environment for people to reserve their Internet Capacity directly from the hardware. + +### Smart Contract for IT + +The purpose of the smart contract for IT is to create and enable autonomous IT. Autonomous self-driving IT is possible when we adhere to two principles from start: + +1. Information technology architectures are configured and installed by bots (a ‘smart contract agent’), not people. +2. Human beings cannot have access to these architectures and change things. + +While sticking to these principles, it provides the basis to consider and describe everything in a contract type format and to deploy any self-driving and self-healing application on the ThreeFold_Grid. + +Once the smart contract for IT is created, it will be registered in the Blockchain Database in a complete end-to-end process. It will also leave instructions for the 3Nodes in a digital notary system for them to grab the necessary instructions and complete the smart contract. + +Learn more about smart contract for IT [here](smartcontract_it). + +### TFChain + +A blockchain running on the TFGrid stores following information (TFGrid 3.0) + +- registry for all digital twins (identity system, aka phonebook) +- registry for all farmers & 3nodes +- registry for our reputation system +- info as required for the Smart Contract for IT + +This is the hart of our operational system of the TFGrid + +### Peer-to-Peer Network + +The peer-to-peer network allows any zmachine or user to connect with other zmachine or users on the TF Grid securely and creates a private shortest path peer-to-peer network. + +### Web Gateway + + The Web Gateway is a mechanism to connect the private (overlay) networks to the open Internet. By not providing an open and direct path in to the private network, a lot of malicious phishing and hacking attempts are stopped at the Web Gateway level for container applications. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/layers/experience_layer_intro.md b/collections/tfmanual/knowledge_base/technology/layers/experience_layer_intro.md new file mode 100644 index 0000000..1992925 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/layers/experience_layer_intro.md @@ -0,0 +1 @@ +## Experience Layer diff --git a/collections/tfmanual/knowledge_base/technology/layers/technology_layers.md b/collections/tfmanual/knowledge_base/technology/layers/technology_layers.md new file mode 100644 index 0000000..e6ab9c5 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/layers/technology_layers.md @@ -0,0 +1,7 @@ + +!!!include:capacity_layer_intro + +!!!include:autonomous_layer_intro + +!!!include:experience_layer_intro + diff --git a/collections/tfmanual/knowledge_base/technology/primitives/compute/beyond_containers.md b/collections/tfmanual/knowledge_base/technology/primitives/compute/beyond_containers.md new file mode 100644 index 0000000..18b419c --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/primitives/compute/beyond_containers.md @@ -0,0 +1,17 @@ +## Beyond Containers + +![](img/container_native.jpg) + + +Default features: + +- compatible with Docker +- compatible with any Linux workload + +We have following unique advantages: + +- no need to work with images, we work with our unique zos_fs. +- every container runs in a dedicated virtual machine providing more security. +- the containers talk to each other over a private network: zos_net. +- the containers can use web_gw to allow users on the internet connect to the applications as running in their secure containers. +- can use core-x to manage the workload. diff --git a/collections/tfmanual/knowledge_base/technology/primitives/compute/compute_toc.md b/collections/tfmanual/knowledge_base/technology/primitives/compute/compute_toc.md new file mode 100644 index 0000000..2e52fa6 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/primitives/compute/compute_toc.md @@ -0,0 +1,7 @@ +# Compute + +

Table of Contents

+ +- [ZKube](./zkube.md) +- [ZMachine](./zmachine.md) +- [CoreX](./corex.md) \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/primitives/compute/corex.md b/collections/tfmanual/knowledge_base/technology/primitives/compute/corex.md new file mode 100644 index 0000000..e599792 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/primitives/compute/corex.md @@ -0,0 +1,21 @@ + +

CoreX

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [ZMachine Process Manager](#zmachine-process-manager) + +*** + +## Introduction + +CoreX allows you to manage your ZMachine over web remotely. + +## ZMachine Process Manager + +- Provide a web interface and a REST API to control your processes. +- Allow to watch the logs of your processes. +- Or use it as a web terminal (access over https to your terminal)! + +![](img/corex.jpg) \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/primitives/compute/img/container_native.jpg b/collections/tfmanual/knowledge_base/technology/primitives/compute/img/container_native.jpg new file mode 100644 index 0000000..c763329 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/primitives/compute/img/container_native.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/primitives/compute/img/corex.jpg b/collections/tfmanual/knowledge_base/technology/primitives/compute/img/corex.jpg new file mode 100644 index 0000000..977ab61 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/primitives/compute/img/corex.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/primitives/compute/img/kubernetes_0_.jpg b/collections/tfmanual/knowledge_base/technology/primitives/compute/img/kubernetes_0_.jpg new file mode 100644 index 0000000..f976a52 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/primitives/compute/img/kubernetes_0_.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/primitives/compute/img/tfgrid_compute_.jpg b/collections/tfmanual/knowledge_base/technology/primitives/compute/img/tfgrid_compute_.jpg new file mode 100644 index 0000000..37ee664 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/primitives/compute/img/tfgrid_compute_.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/primitives/compute/img/zkube_architecture_.jpg b/collections/tfmanual/knowledge_base/technology/primitives/compute/img/zkube_architecture_.jpg new file mode 100644 index 0000000..f8fc59a Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/primitives/compute/img/zkube_architecture_.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/primitives/compute/img/zmachine_zos_.jpg b/collections/tfmanual/knowledge_base/technology/primitives/compute/img/zmachine_zos_.jpg new file mode 100644 index 0000000..b8dec4f Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/primitives/compute/img/zmachine_zos_.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/primitives/compute/tfgrid_compute.md b/collections/tfmanual/knowledge_base/technology/primitives/compute/tfgrid_compute.md new file mode 100644 index 0000000..d8bd51d --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/primitives/compute/tfgrid_compute.md @@ -0,0 +1,25 @@ + +## TFGrid Compute Layer + +![](img/tfgrid_compute_.jpg) + +We are more than just Container or VM technology, see [our Beyond Container Document](beyond_containers). + +A 3Node is a Zero-OS enabled computer which is hosted with any of the TF_Farmers. + +There are 4 storage mechanisms which can be used to store your data: + +- ZOS_FS is our dedupe unique filesystem, replaces docker images. +- ZOS_Mount is a mounted disk location on SSD, this can be used as faster storage location. +- QSFS, 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, a virtual disk technology, only for TFTech OEM partners. + +There are 4 ways how networks can be connected to a Z-Machine. + +- Planetary_network : is a planetary scalable network, we have clients for windows, osx, android and iphone. +- zos_net : is a fast end2end encrypted network technology, keep your traffic between your z_machines 100% private. +- zos_bridge: connection to a public ipaddress +- web_gw: web gateway, a secure way to allow internet traffic reach your secure Z-Machine. + + + diff --git a/collections/tfmanual/knowledge_base/technology/primitives/compute/zkube.md b/collections/tfmanual/knowledge_base/technology/primitives/compute/zkube.md new file mode 100644 index 0000000..e933059 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/primitives/compute/zkube.md @@ -0,0 +1,40 @@ +

ZKube

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Unique for our Kubernetes implementation](#unique-for-our-kubernetes-implementation) +- [Features](#features) +- [ZMachine Benefits](#zmachine-benefits) +- [Architecture](#architecture) + +*** + +## Introduction + +TFGrid is compatible with Kubernetes Technology. + +Each eVDC as shown above is a full blown Kubernetes deployment. + +## Unique for our Kubernetes implementation + +- The Kubernetes networks are on top of our [ZNet](../network/znet.md) technology which means all traffic between containers and kubernetes hosts is end2end encrypted independent of where your Kubernetes nodes are deployed. +- You can mount a QSFS underneath a Kubernetes Node (VM), which means that you can deploy containers on top of QSFS to host unlimited amounts of storage in a super safe way. +- You Kubernetes environment is for sure 100% decentralized, you define where you want to deploy your Kubernetes nodes and only you have access to the deployed workloads on the TFGrid. + +## Features + +* integration with znet (efficient, secure encrypted network between the zmachines) +* can be easily deployed at the edge +* single-tenant! + +## ZMachine Benefits + +* [ZOS Protect](../../zos/benefits/zos_advantages.md#zero-os-protect): no hacking surface to the Zero-Nodes, integrate silicon route of trust + + +![](img/kubernetes_0_.jpg) + +## Architecture + +![](img/zkube_architecture_.jpg) \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/primitives/compute/zmachine.md b/collections/tfmanual/knowledge_base/technology/primitives/compute/zmachine.md new file mode 100644 index 0000000..3c88994 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/primitives/compute/zmachine.md @@ -0,0 +1,30 @@ +

ZMachine

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Features](#features) +- [Architecture](#architecture) + +*** + +## Introduction + +ZMachine is a unified container/virtual machine type. This can be used to start a virtual machine on a zos node. + +## Features + +* import from docker (market std for containers) +* can be easily deployed at the edge (edge cloud) +* single-tenant, fully decentralized! +* can deploy unlimited amounts of storage using our qsfs. +* [ZOS Protect](../../zos/benefits/zos_advantages.md#zero-os-protect): no hacking surface to the Zero-Nodes, integrate silicon route of trust +* [ZOS Filesystem](../storage/qsfs.md): dedupe, zero-install, hacker-proof +* [WebGateway](../network/webgw3.md:) intelligent connection between web (internet) and container services +* integration with [ZNet](../network/znet.md) (efficient, secure encrypted network between the zmachines) + +## Architecture + +![](img/zmachine_zos_.jpg) + +A ZMachine is running as a virtual machine on top of Zero-OS. diff --git a/collections/tfmanual/knowledge_base/technology/primitives/network/img/overlay_net1.jpg b/collections/tfmanual/knowledge_base/technology/primitives/network/img/overlay_net1.jpg new file mode 100644 index 0000000..9dd8138 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/primitives/network/img/overlay_net1.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/primitives/network/img/planet_net_.jpg b/collections/tfmanual/knowledge_base/technology/primitives/network/img/planet_net_.jpg new file mode 100644 index 0000000..afba046 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/primitives/network/img/planet_net_.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/primitives/network/img/planetary_lan.jpg b/collections/tfmanual/knowledge_base/technology/primitives/network/img/planetary_lan.jpg new file mode 100644 index 0000000..f60faa5 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/primitives/network/img/planetary_lan.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/primitives/network/img/planetary_net.jpg b/collections/tfmanual/knowledge_base/technology/primitives/network/img/planetary_net.jpg new file mode 100644 index 0000000..f4be658 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/primitives/network/img/planetary_net.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/primitives/network/img/redundant_net.jpg b/collections/tfmanual/knowledge_base/technology/primitives/network/img/redundant_net.jpg new file mode 100644 index 0000000..1975ef7 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/primitives/network/img/redundant_net.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/primitives/network/img/webgateway.jpg b/collections/tfmanual/knowledge_base/technology/primitives/network/img/webgateway.jpg new file mode 100644 index 0000000..ce67712 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/primitives/network/img/webgateway.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/primitives/network/img/webgw_scaling.jpg b/collections/tfmanual/knowledge_base/technology/primitives/network/img/webgw_scaling.jpg new file mode 100644 index 0000000..ad8819c Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/primitives/network/img/webgw_scaling.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/primitives/network/img/znet_redundancy.jpg b/collections/tfmanual/knowledge_base/technology/primitives/network/img/znet_redundancy.jpg new file mode 100644 index 0000000..af7dcb3 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/primitives/network/img/znet_redundancy.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/primitives/network/img/znet_znic.jpg b/collections/tfmanual/knowledge_base/technology/primitives/network/img/znet_znic.jpg new file mode 100644 index 0000000..f258522 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/primitives/network/img/znet_znic.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/primitives/network/img/znet_znic1.jpg b/collections/tfmanual/knowledge_base/technology/primitives/network/img/znet_znic1.jpg new file mode 100644 index 0000000..f258522 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/primitives/network/img/znet_znic1.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/primitives/network/img/zos_network_overlay.jpg b/collections/tfmanual/knowledge_base/technology/primitives/network/img/zos_network_overlay.jpg new file mode 100644 index 0000000..cf652ad Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/primitives/network/img/zos_network_overlay.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/primitives/network/network_toc.md b/collections/tfmanual/knowledge_base/technology/primitives/network/network_toc.md new file mode 100644 index 0000000..9b85fb4 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/primitives/network/network_toc.md @@ -0,0 +1,7 @@ +# Network + +

Table of Contents

+ +- [ZNET](./znet.md) +- [ZNIC](./znic.md) +- [WebGateway](./webgw3.md) \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/primitives/network/p2pagent.md b/collections/tfmanual/knowledge_base/technology/primitives/network/p2pagent.md new file mode 100644 index 0000000..97f6d77 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/primitives/network/p2pagent.md @@ -0,0 +1,5 @@ +# Peer2Peer Agent + +>TODO + +!!!include:zos_toc diff --git a/collections/tfmanual/knowledge_base/technology/primitives/network/planetary_network.md b/collections/tfmanual/knowledge_base/technology/primitives/network/planetary_network.md new file mode 100644 index 0000000..e3e3c5b --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/primitives/network/planetary_network.md @@ -0,0 +1,54 @@ +![](img/planetary_lan.jpg) + +# Planetary Network + +![](img/planet_net_.jpg) + + +The planetary network is an overlay network which lives on top of the existing internet or other peer2peer networks created. In this network, everyone is connected to everyone. End-to-end encryption between users of an app and the app running behind the network wall. + +Each user end network point is strongly authenticated and uniquely identified, independent of the network carrier used. There is no need for a centralized firewall or VPN solutions, as there is a circle based networking security in place. + +Benefits : +- It finds shortest possible paths between peers +- There's full security through end-to-end encrypted messaging +- It allows for peer2peer links like meshed wireless +- It can survive broken internet links and re-route when needed +- It resolves the shortage of IPV4 addresses + + +Whereas current computer networks depend heavily on very centralized design and configuration, this networking concept breaks this mould by making use of a global spanning tree to form a scalable IPv6 encrypted mesh network. This is a peer2peer implementation of a networking protocol. + +The following table illustrates high-level differences between traditional networks like the internet, and the planetary threefold network: + +| Characteristic | Traditional | Planetary Network | +| --------------------------------------------------------------- | ----------- | ----------------- | +| End-to-end encryption for all traffic across the network | No | Yes | +| Decentralized routing information shared using a DHT | No | Yes | +| Cryptographically-bound IPv6 addresses | No | Yes | +| Node is aware of its relative location to other nodes | No | Yes | +| IPv6 address remains with the device even if moved | No | Yes | +| Topology extends gracefully across different mediums, i.e. mesh | No | Yes | + +## What are the problems solved here? + +The internet as we know it today doesn’t conform to a well-defined topology. This has largely happened over time - as the internet has grown, more and more networks have been “bolted together”. The lack of defined topology gives us some unavoidable problems: + +- The routing tables that hold a “map” of the internet are huge and inefficient +- There isn’t really any way for a computer to know where it is located on the internet relative to anything else +- It’s difficult to examine where a packet will go on its journey from source to destination without actually sending it +- It’s very difficult to install reliable networks into locations that change often or are non-static, i.e. wireless mesh networks + +These problems have been partially mitigated (but not really solved) through centralization - rather than your computers at home holding a copy of the global routing table, your ISP does it for you. Your computers and network devices are configured just to “send it upstream” and to let your ISP decide where it goes from there, but this does leave you entirely at the mercy of your ISP who can redirect your traffic anywhere they like and to inspect, manipulate or intercept it. + +In addition, wireless meshing requires you to know a lot about the network around you, which would not typically be the case when you have outsourced this knowledge to your ISP. Many existing wireless mesh routing schemes are not scalable or efficient, and do not bridge well with existing networks. + +![](img/planetary_net.jpg) + +The planetary network is a continuation & implementation of the [Yggdrasil](https://yggdrasil-network.github.io/about.html) network initiative. This technology is in beta but has been proven to work already quite well. + +!!!def alias:planet_net,planetary_net,planetary_network,pan + +!!!include:zos_toc + +> Click [here](manual:planetary_network_connector) to read more about Planetary Network Connector Installation. Click [here](manual:yggdrasil_client) to read more about Planetary Network Installation (advanced). \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/primitives/network/tfgrid_network.md b/collections/tfmanual/knowledge_base/technology/primitives/network/tfgrid_network.md new file mode 100644 index 0000000..d3277a4 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/primitives/network/tfgrid_network.md @@ -0,0 +1,7 @@ +# TFGrid networking + +- znet : private network between zmachines +- [Planetary Network](planetary_network) : peer2peer end2end encrypted global network +- znic : interface to planetary network +- [WebGateway](webgw) : interface between internet and znet + diff --git a/collections/tfmanual/knowledge_base/technology/primitives/network/webgw.md b/collections/tfmanual/knowledge_base/technology/primitives/network/webgw.md new file mode 100644 index 0000000..4abd665 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/primitives/network/webgw.md @@ -0,0 +1,60 @@ + + +# WebGW 2.0 + +The Web Gateway is a mechanism to connect the private networks to the open Internet, in such a way that there is no direct connection between internet and the secure workloads running in the ZMachines. + +![](img/webgateway.jpg) + + +- Separation between where compute workloads are and where services are exposed. +- Better Security +- Redundant + - Each app can be exposed on multiple webgateways at once. +- Support for many interfaces... +- Helps resolve shortage of IPv4 addresses + +If (parts of) this private overlay network need to be reachable from the Internet, the zmachines initiate a secure connection *to* the web Gateway. + +### Implementation + +It is important to mention that this connection is not a standard network connection, it is a [network socket](https://en.wikipedia.org/wiki/Network_socket) initiated by the container or VM to the web gateway. The container calls out to one or more web gateways and sets up a secure & private socket connection to the web gateway. The type of connection required is defined on the smart contract for IT layer and as such is very secure. There is no IP (TCP/UDP) coming from the internet towards the containers providing more security. + +Up to the Web Gateway Internet traffic follows the same route as for any other network end point: A DNS entry tells the consumers client to what IP address to send traffic to. This endpoint is the public interface of the Web Gateway. That interface accepts the HTTP(s) (or any other TCP) packets and forward the packet payload over the secure socket connection (initiated by the container) to the container. + +No open pipe (NAT plus port forwarding) from the public internet to specific containers in the private (overlay) network exists. + +Web Gateways are created by so called network farmers. Network farmers are people and companies that have access to good connectivity and have a large number of public IP routable IP networks. They provide the facilities (hardware) for Web Gateways to run and terminate a lot of the public inbound and output traffic for the TF Grid. Examples of network farmers are ISP's and (regional, national and international Telcos, internet exchanges etc. + +### Security + +Buy not providing an open and direct path in to the private network a lot of malicious phishing and hacking attempts are stopped at the Web Gateway. By design any private network is meant to have multiple webgateways and by design these Web Gateways exist on different infrastructure in a different location. Sniffing around and finding out what can be done with a Web Gateway might (and will happen) but it will not compromise the containers in your private network. + +### Redundant Network Connection + +![](img/redundant_net.jpg) + + +### Unlimited Scale + +![](img/webgw_scaling.jpg) + + +The network architecture is a pure scale-out network system, it can scale to unlimited size, there is simply no bottleneck. Network "supply" is created by network farmers, and network "demand" is done by TF Grid users. Supply and demand scale independently, for supply there can be unlimited network farmers providing the web gateways on their own 3nodes and unlimited compute farmers providing 3nodes for compute and storage. The demand side is driven by developers creating software that runs on the grid, system integrators creating solutions for enterprise and this demand side is exponentially growing for data processing and storage use cases. + +### Network Wall (future) + +see [Network Wall](network_wall) + +## Roadmap + +Above described Web Gateway is for 2.0. + +For 3.0 we start with a HTTP(S) proxy over Planetary network connection. Not all features from WebGW 2.0 have been ported. + +Further future, we envisage support for many other protocols: sql, redis, udp, ... + +!!!def alias:web_gw,zos_web_gateway + +!!!include:zos_toc + diff --git a/collections/tfmanual/knowledge_base/technology/primitives/network/webgw3.md b/collections/tfmanual/knowledge_base/technology/primitives/network/webgw3.md new file mode 100644 index 0000000..eef289b --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/primitives/network/webgw3.md @@ -0,0 +1,50 @@ +

WebGW 2.0

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Implementation](#implementation) +- [Security](#security) +- [Redundant Network Connection](#redundant-network-connection) +- [Unlimited Scale](#unlimited-scale) + +*** + +## Introduction + +The Web Gateway is a mechanism to connect the private networks to the open Internet, in such a way that there is no direct connection between internet and the secure workloads running in the ZMachines. + +![](img/webgateway.jpg) + + +- Separation between where compute workloads are and where services are exposed. +- Redundant + - Each app can be exposed on multiple webgateways at once. +- Support for many interfaces... +- Helps resolve shortage of IPv4 addresses + +## Implementation + +Some 3nodes supports gateway functionality (configured by the farmers). A 3node with gateway config can then accept gateway workloads and then forward traffic to ZMachines that only has yggdrasil (planetary network) or Ipv6 addresses. + +The gateway workloads consists of a name (prefix) that need to be reserved on the block chain first. Then the list of backend IPs. There are other flags that can be set to control automatic TLS (please check terraform documentations for the exact details of a reservation) + +Once the 3node receives this workloads, the network configure proxy for this name and the yggdrasil ips. + +## Security + +ZMachines has to have an yggdrasil IP or any other IPv6 (also IPv4 are accepted) but it means that any person who is connected to the yggdrasil network, can also reach the ZMachine without the need for a proxy. + +So ti's up to the ZMachine owner/maintainer to make sure it is secured and only have the required ports open. + +## Redundant Network Connection + +![](img/redundant_net.jpg) + + +## Unlimited Scale + +![](img/webgw_scaling.jpg) + + +The network architecture is a pure scale-out network system, it can scale to unlimited size, there is simply no bottleneck. Network "supply" is created by network farmers, and network "demand" is done by TF Grid users. Supply and demand scale independently, for supply there can be unlimited network farmers providing the web gateways on their own 3nodes and unlimited compute farmers providing 3nodes for compute and storage. The demand side is driven by developers creating software that runs on the grid, system integrators creating solutions for enterprise and this demand side is exponentially growing for data processing and storage use cases. diff --git a/collections/tfmanual/knowledge_base/technology/primitives/network/znet.md b/collections/tfmanual/knowledge_base/technology/primitives/network/znet.md new file mode 100644 index 0000000..b4c7f21 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/primitives/network/znet.md @@ -0,0 +1,39 @@ +

ZNET

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Secure mesh overlay network (peer2peer)](#secure-mesh-overlay-network-peer2peer) +- [Redundancy](#redundancy) +- [Interfaces in Zero-OS](#interfaces-in-zero-os) + +*** + +## Introduction + +Decentralized networking platform allowing any compute and storage workload to be connected together on a private (overlay) network and exposed to the existing internet network. The Peer2Peer network platform allows any workload to be connected over secure encrypted networks which will look for the shortest path between the nodes. + +![](img/zos_network_overlay.jpg) + +## Secure mesh overlay network (peer2peer) + +Z_NET is the foundation of any architecture running on the TF Grid. It can be seen as a virtual private datacenter and the network allows all of the *N* containers to connected to all of the *(N-1)* other containers. Any network connection is a secure network connection between your containers and creates peer 2 peer network between containers. + +![](img/overlay_net1.jpg) + +No connection is made with the internet.The ZNet is a single tenant network and by default not connected to the public internet. Everything stays private. For connecting to the public internet a Web Gateway is included in the product to allows for public access if and when required. + +## Redundancy + +As integrated with [WebGW](./webgw3.md): + +![](img/znet_redundancy.jpg) + +- Any app can get (securely) connected to the internet by any chosen IP address made available by ThreeFold network farmers through WebGW. +- An app can be connected to multiple web gateways at once, the DNS round robin principle will provide load balancing and redundancy. +- An easy clustering mechanism where web gateways and nodes can be lost and the public service will still be up and running. +- Easy maintenance. When containers are moved or re-created the same end user connection can be reused as that connection is terminated on the Web Gateway. The moved or newly created Web Gateway will recreate the socket to the Web Gateway and receive inbound traffic. + +## Interfaces in Zero-OS + +![](img/znet_znic1.jpg) diff --git a/collections/tfmanual/knowledge_base/technology/primitives/network/znic.md b/collections/tfmanual/knowledge_base/technology/primitives/network/znic.md new file mode 100644 index 0000000..fbb8daa --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/primitives/network/znic.md @@ -0,0 +1,24 @@ +

ZNIC

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Use Cases](#use-cases) +- [Overview](#overview) + +*** + +## Introduction + +ZNIC is the network interface which is connected to Z_Machine. + +## Use Cases + +Can be implemented as interface to + +- planetary_network. +- public ip address on a Zero-OS. + +## Overview + +![](img/znet_znic.jpg) \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/primitives/primitives_toc.md b/collections/tfmanual/knowledge_base/technology/primitives/primitives_toc.md new file mode 100644 index 0000000..d8e313a --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/primitives/primitives_toc.md @@ -0,0 +1,19 @@ +# Primitives + +

Table of Contents

+ +- [Compute](./compute/compute_toc.md) + - [ZKube](./compute/zkube.md) + - [ZMachine](./compute/zmachine.md) + - [CoreX](./compute/corex.md) +- [Storage](./storage/storage_toc.md) + - [ZOS Filesystem](./storage/zos_fs.md) + - [ZOS Mount](./storage/zmount.md) + - [Quantum Safe File System](./storage/qsfs.md) + - [Zero-DB](./storage/zdb.md) + - [Zero-Disk](./storage/zdisk.md) +- [Network](./network/network_toc.md) + - [ZNET](./network/znet.md) + - [ZNIC](./network/znic.md) + - [WebGateway](./network/webgw3.md) +- [Zero-OS Advantages](../zos/benefits/zos_advantages.md) \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/primitives/storage/img/zdb_arch.jpg b/collections/tfmanual/knowledge_base/technology/primitives/storage/img/zdb_arch.jpg new file mode 100644 index 0000000..39f51d6 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/primitives/storage/img/zdb_arch.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/primitives/storage/img/zmount.jpg b/collections/tfmanual/knowledge_base/technology/primitives/storage/img/zmount.jpg new file mode 100644 index 0000000..35011b0 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/primitives/storage/img/zmount.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/primitives/storage/img/zos_zstor.jpg b/collections/tfmanual/knowledge_base/technology/primitives/storage/img/zos_zstor.jpg new file mode 100644 index 0000000..35f0b62 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/primitives/storage/img/zos_zstor.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/primitives/storage/qsfs.md b/collections/tfmanual/knowledge_base/technology/primitives/storage/qsfs.md new file mode 100644 index 0000000..5b3dac8 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/primitives/storage/qsfs.md @@ -0,0 +1,34 @@ +

Quantum Safe Filesystem

+ +

Table of Contents

+ +- [Introduction](#introduction) + - [Benefits](#benefits) + - [Use Cases](#use-cases) + - [Implementation](#implementation) + +*** + +## Introduction + +Quantum safe filesystem presents itself as a filesystem to the ZMachine. + +### Benefits + +- Safe +- Hacker Proof +- Ultra Reliable +- Low Overhead +- Ultra Scalable +- Self Healing = recovers service automatically in the event of outage with no human + +![](img/zos_zstor.jpg) + +### Use Cases + +- Backup and archive system +- Blockchain Storage Backend (OEM ONLY) + +### Implementation + +> QSFS is using QSSS inside. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/primitives/storage/storage_toc.md b/collections/tfmanual/knowledge_base/technology/primitives/storage/storage_toc.md new file mode 100644 index 0000000..d95b3a1 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/primitives/storage/storage_toc.md @@ -0,0 +1,9 @@ +# Storage + +

Table of Contents

+ +- [ZOS Filesystem](./zos_fs.md) +- [ZOS Mount](./zmount.md) +- [Quantum Safe File System](./qsfs.md) +- [Zero-DB](./zdb.md) +- [Zero-Disk](./zdisk.md) \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/primitives/storage/zdb.md b/collections/tfmanual/knowledge_base/technology/primitives/storage/zdb.md new file mode 100644 index 0000000..7b0855c --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/primitives/storage/zdb.md @@ -0,0 +1,21 @@ +

ZOS-DB (ZDB)

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Use Cases](#use-cases) +- [Overview](#overview) + +*** + +## Introduction + +0-db is a fast and efficient key-value store redis-protocol compatible, which makes data persistent inside an always append datafile, with namespaces support. + +## Use Cases + +> ZDB is being used as backend storage for [Quantum Safe Filesystem](./qsfs.md). + +## Overview + +![](img/zdb_arch.jpg) diff --git a/collections/tfmanual/knowledge_base/technology/primitives/storage/zdisk.md b/collections/tfmanual/knowledge_base/technology/primitives/storage/zdisk.md new file mode 100644 index 0000000..02b3297 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/primitives/storage/zdisk.md @@ -0,0 +1,18 @@ +

ZOS Disk

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Roadmap](#roadmap) + +*** + +## Introduction + +Virtual disk creates the possibility to create and use virtual disks which can be attached to containers (and virtual machines). + +The technology is designed to be redundant without having to do anything. + +## Roadmap + +- The virtual disk technology is available for OEM's only, contact TF_Tech. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/primitives/storage/zmount.md b/collections/tfmanual/knowledge_base/technology/primitives/storage/zmount.md new file mode 100644 index 0000000..d8cc663 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/primitives/storage/zmount.md @@ -0,0 +1,18 @@ +

ZOS Mount

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Overview](#overview) + +*** + +## Introduction + +ZOS mount is an SSD storage location on which can be written upon inside a VMachine and VKube. + +## Overview + +The SSD storage location is mounted on a chosen path inside your Z-Machine. + +![](img/zmount.jpg) \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/primitives/storage/zos_fs.md b/collections/tfmanual/knowledge_base/technology/primitives/storage/zos_fs.md new file mode 100644 index 0000000..3f17724 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/primitives/storage/zos_fs.md @@ -0,0 +1,39 @@ + +

ZOS FileSystem (ZOS-FS)

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Uses Flist Inside](#uses-flist-inside) + - [Why this ZFlist Concept](#why-this-zflist-concept) +- [Benefits](#benefits) + +*** + +## Introduction + +A deduped filesystem which is more efficient compared to images as used in other Virtual Machine technology. + +## Uses Flist Inside + +In Zero-OS, `flist` is the format used to store zmachine images. This format is made to provide +a complete mountable remote filesystem but downloading only the files contents that you actually needs. + +In practice, Flist itself is a small database which contains metadata about files and directories and file payload are stored on a tfgrid hub. You only need to download payload when you need it, this dramatically reduce zmachine boot time, bandwidth and disk overhead. + +### Why this ZFlist Concept + +Have you ever been in the following situation: you need two small files but they are embedded in a large archive. How to get to those 2 files in an efficient way? What a disappointment when you see this archive is 4 GB large and you only need 4 files of 2 MB inside. You'll need to download the full archive, store it somewhere to extract only what you need. Time, effort and bandwidth wasted. + +You want to start a Docker container and the base image you want to use is 2 GB. What do you need to do before being able to use your container ? Waiting to get the 2 GB downloaded. This problem exists everywhere but in Europe and the US the bandwidth speeds are such that this does not present a real problem anymore, hence none of the leading (current) tech companies are looking for solutions for this. + +We believe that there should a smarter way of dealing with this then simply throwing larger bandwidth at the problem: What if you could only download the files you actually want and not the full blob (archive, image, whatever...). + +ZFList is splitting metadata and data. Metadata is referential information about everything you need to know about content of the archive, but without the payload. Payload is the content of the referred files. The ZFList is exactly that: it consists of metadata with references that point to where to get the payload itself. So if you don't need it you won't get it. + +As soon as you have the flist mounted, you can see the full directory tree, and walk around it. The files are only downloaded and presented at moment that you try to access them. In other words, every time you want to read a file, or modify it, Zero FS will download it, so that the data is available too. You only download on-the-fly what you need which reduces dramatically the bandwidth requirement. + + +## Benefits + +- Efficient usage of bandwidth makes this service perform with and without (much) bandwidth \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/qsss/img/filesystem_abstract.jpg b/collections/tfmanual/knowledge_base/technology/qsss/img/filesystem_abstract.jpg new file mode 100644 index 0000000..b366139 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/qsss/img/filesystem_abstract.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/qsss/img/qsss_intro_0_.jpg b/collections/tfmanual/knowledge_base/technology/qsss/img/qsss_intro_0_.jpg new file mode 100644 index 0000000..7bb72cd Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/qsss/img/qsss_intro_0_.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/qsss/interfaces_usecases/img/filesystem.jpg b/collections/tfmanual/knowledge_base/technology/qsss/interfaces_usecases/img/filesystem.jpg new file mode 100644 index 0000000..c28a9b7 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/qsss/interfaces_usecases/img/filesystem.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/qsss/interfaces_usecases/img/http.jpg b/collections/tfmanual/knowledge_base/technology/qsss/interfaces_usecases/img/http.jpg new file mode 100644 index 0000000..87fa682 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/qsss/interfaces_usecases/img/http.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/qsss/interfaces_usecases/img/hyperdrive.jpg b/collections/tfmanual/knowledge_base/technology/qsss/interfaces_usecases/img/hyperdrive.jpg new file mode 100644 index 0000000..d07db0d Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/qsss/interfaces_usecases/img/hyperdrive.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/qsss/interfaces_usecases/img/ipfs.jpg b/collections/tfmanual/knowledge_base/technology/qsss/interfaces_usecases/img/ipfs.jpg new file mode 100644 index 0000000..0927468 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/qsss/interfaces_usecases/img/ipfs.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/qsss/interfaces_usecases/img/nft_architecture.jpg b/collections/tfmanual/knowledge_base/technology/qsss/interfaces_usecases/img/nft_architecture.jpg new file mode 100644 index 0000000..0c09946 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/qsss/interfaces_usecases/img/nft_architecture.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/qsss/interfaces_usecases/img/nft_storage.jpg b/collections/tfmanual/knowledge_base/technology/qsss/interfaces_usecases/img/nft_storage.jpg new file mode 100644 index 0000000..5f758d0 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/qsss/interfaces_usecases/img/nft_storage.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/qsss/interfaces_usecases/img/storage_architecture_1.jpg b/collections/tfmanual/knowledge_base/technology/qsss/interfaces_usecases/img/storage_architecture_1.jpg new file mode 100644 index 0000000..3a0d3fe Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/qsss/interfaces_usecases/img/storage_architecture_1.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/qsss/interfaces_usecases/img/syncthing.jpg b/collections/tfmanual/knowledge_base/technology/qsss/interfaces_usecases/img/syncthing.jpg new file mode 100644 index 0000000..cd1a17e Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/qsss/interfaces_usecases/img/syncthing.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/qsss/interfaces_usecases/nft_storage.md b/collections/tfmanual/knowledge_base/technology/qsss/interfaces_usecases/nft_storage.md new file mode 100644 index 0000000..fc41947 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/interfaces_usecases/nft_storage.md @@ -0,0 +1,97 @@ +# Quantum Safe Storage System for NFT + +![](img/nft_architecture.jpg) + +The owner of the NFT can upload the data using one of our supported interfaces + +- http upload (everything possible on https://nft.storage/ is also possible on our system) +- filesystem + +Every person in the world can retrieve the NFT (if allowed) and the data will be verified when doing so. The data is available everywhere in the world using multiple interfaces again (IPFS, HTTP(S), ...). Caching happens on global level. No special software or account on threefold is needed to do this. + +The NFT system uses a super reliable storage system underneath which is sustainable for the planet (green) and ultra secure and private. The NFT owner also owns the data. + + +## Benefits + +#### Persistence = owned by the data user (as represented by digital twin) + +![](img/nft_storage.jpg) + +Is not based on a shared-all architecture. + +Whoever stores the data has full control over + +- where data is stored (specific locations) +- redundancy policy used +- how long should the data be kept +- CDN policy (where should data be available and how long) + + +#### Reliability + +- data cannot be corrupted +- data cannot be lost +- each time data is fetched back hash (fingerprint) is checked, if issues autorecovery happens +- all data is encrypted and compressed (unique per storage owner) +- data owner chooses the level of redundancy + +#### Lookup + +- multi URL & storage network support (see further the interfaces section) +- IPFS, HyperDrive URL schema +- unique DNS schema (with long key which is globally unique) + +#### CDN support (with caching) + +Each file (movie, image) stored is available on many places worldwide. + +Each file gets a unique url pointing to the data which can be retrieved on all locations. + +Caching happens on each endpoint. + +#### Self Healing & Auto Correcting Storage Interface + +Any corruption e.g. bitrot gets automatically detected and corrected. + +In case of a HD crash or storage node crash the data will automatically be expanded again to fit the chosen redundancy policy. + +#### Storage Algoritm = Uses Quantum Safe Storage System as base + +Not even a quantum computer can hack data as stored on our QSSS. + +The QSSS is a super innovative storage system which works on planetary scale and has many benefits compared to shared and/or replicated storage systems. + +It uses forward looking error correcting codes inside. + +#### Green + +Storage uses upto 10x less energy compared to classic replicated system. + +#### Multi Interface + +The stored data is available over multiple interfaces at once. + +| interface | | +| -------------------------- | ----------------------- | +| IPFS | ![](img/ipfs.jpg) | +| HyperDrive / HyperCore | ![](img/hyperdrive.jpg) | +| http(s) on top of FreeFlow | ![](img/http.jpg) | +| syncthing | ![](img/syncthing.jpg) | +| filesystem | ![](img/filesystem.jpg) | + +This allows ultimate flexibility from enduser perspective. + +The object (video,image) can easily be embedded in any website or other representation which supports http. + + +## More Info + +* [Zero-OS overview](zos) +* [Quantum Safe Storage System](qsss_home) +* [Quantum Safe Storage Algorithm](qss_algorithm) +* [Smart Contract For IT Layer](smartcontract_it) + + + +!!!def alias:nft_storage,nft_storage_system \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/qsss/interfaces_usecases/qss_use_cases.md b/collections/tfmanual/knowledge_base/technology/qsss/interfaces_usecases/qss_use_cases.md new file mode 100644 index 0000000..5134fe9 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/interfaces_usecases/qss_use_cases.md @@ -0,0 +1,12 @@ +## Quantum Safe Storage use cases + +### Backup + +A perfect use case for the QSS is backup. Specific capbabilities needed for backup are a core part of a proper backup policy. Characteristics of QSS that makle backups secure, scalable, efficient and sustainable are: +- physical storage devices are always append. The lowest level of the storage devices, ZDB's, are storage engines that work by design as an always append storage device. +- easy provision of these ZDB's makes them almost like old fashioned tape devices that you have on a rotary schedule. Having this capability make is very visible and possible to use, store and phase out stored data in a way that is auditable and can be made very transparant +- + +### Archiving + +### \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/qsss/interfaces_usecases/s3_interface.md b/collections/tfmanual/knowledge_base/technology/qsss/interfaces_usecases/s3_interface.md new file mode 100644 index 0000000..267ee74 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/interfaces_usecases/s3_interface.md @@ -0,0 +1,15 @@ +# S3 Service + +If you like an S3 interface you can deploy this on top of our eVDC, it works very well together with our [quantumsafe_filesystem](quantumsafe_filesystem). + +A good opensource solution delivering an S3 solution is [min.io](https://min.io/). + +Thanks to our quantum safe storage layer, you could build fast, robust and reliable storage and archiving solutions. + +A typical setup would look like: + +![](img/storage_architecture_1.jpg) + +> TODO: link to manual on cloud how to deploy minio, using helm (3.0 release) + +!!!def alias:s3_storage \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/qsss/manual/qsfs_setup.md b/collections/tfmanual/knowledge_base/technology/qsss/manual/qsfs_setup.md new file mode 100644 index 0000000..e8bce76 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/manual/qsfs_setup.md @@ -0,0 +1,297 @@ +# QSFS getting started on ubuntu setup + +## Get components + +The following steps can be followed to set up a qsfs instance on a fresh +ubuntu instance. + +- Install the fuse kernel module (`apt-get update && apt-get install fuse3`) +- Install the individual components, by downloading the latest release from the + respective release pages: + - 0-db-fs: https://github.com/threefoldtech/0-db-fs/releases + - 0-db: https://github.com/threefoldtech/0-db, if multiple binaries + are available in the assets, choose the one ending in `static` + - 0-stor: https://github.com/threefoldtech/0-stor_v2/releases, if + multiple binaries are available in the assets, choose the one + ending in `musl` +- Make sure all binaries are executable (`chmod +x $binary`) + +## Setup and run 0-stor + +There are instructions below for a local 0-stor configuration. You can also deploy an eVDC and use the [provided 0-stor configuration](evdc_storage) for a simple cloud hosted solution. + +We will run 6 0-db instances as backends for 0-stor. 4 are used for the +metadata, 2 are used for the actual data. The metadata always consists +of 4 nodes. The data backends can be increased. You can choose to either +run 7 separate 0-db processes, or a single process with 7 namespaces. +For the purpose of this setup, we will start 7 separate processes, as +such: + +> This assumes you have moved the download 0-db binary to `/tmp/0-db` + +```bash +/tmp/0-db --background --mode user --port 9990 --data /tmp/zdb-meta/zdb0/data --index /tmp/zdb-meta/zdb0/index +/tmp/0-db --background --mode user --port 9991 --data /tmp/zdb-meta/zdb1/data --index /tmp/zdb-meta/zdb1/index +/tmp/0-db --background --mode user --port 9992 --data /tmp/zdb-meta/zdb2/data --index /tmp/zdb-meta/zdb2/index +/tmp/0-db --background --mode user --port 9993 --data /tmp/zdb-meta/zdb3/data --index /tmp/zdb-meta/zdb3/index + +/tmp/0-db --background --mode seq --port 9980 --data /tmp/zdb-data/zdb0/data --index /tmp/zdb-data/zdb0/index +/tmp/0-db --background --mode seq --port 9981 --data /tmp/zdb-data/zdb1/data --index /tmp/zdb-data/zdb1/index +/tmp/0-db --background --mode seq --port 9982 --data /tmp/zdb-data/zdb2/data --index /tmp/zdb-data/zdb2/index +``` + +Now that the data storage is running, we can create the config file for +0-stor. The (minimal) config for this example setup will look as follows: + +```toml +minimal_shards = 2 +expected_shards = 3 +redundant_groups = 0 +redundant_nodes = 0 +socket = "/tmp/zstor.sock" +prometheus_port = 9100 +zdb_data_dir_path = "/tmp/zdbfs/data/zdbfs-data" +max_zdb_data_dir_size = 25600 + +[encryption] +algorithm = "AES" +key = "000001200000000001000300000004000a000f00b00000000000000000000000" + +[compression] +algorithm = "snappy" + +[meta] +type = "zdb" + +[meta.config] +prefix = "someprefix" + +[meta.config.encryption] +algorithm = "AES" +key = "0101010101010101010101010101010101010101010101010101010101010101" + +[[meta.config.backends]] +address = "[::1]:9990" + +[[meta.config.backends]] +address = "[::1]:9991" + +[[meta.config.backends]] +address = "[::1]:9992" + +[[meta.config.backends]] +address = "[::1]:9993" + +[[groups]] +[[groups.backends]] +address = "[::1]:9980" + +[[groups.backends]] +address = "[::1]:9981" + +[[groups.backends]] +address = "[::1]:9982" +``` + +> A full explanation of all options can be found in the 0-stor readme: +https://github.com/threefoldtech/0-stor_v2/#config-file-explanation + +This guide assumes the config file is saved as `/tmp/zstor_config.toml`. + +Now `zstor` can be started. Assuming the downloaded binary was saved as +`/tmp/zstor`: + +`/tmp/zstor -c /tmp/zstor_config.toml monitor`. If you don't want the +process to block your terminal, you can start it in the background: +`nohup /tmp/zstor -c /tmp/zstor_config.toml monitor &`. + +## Setup and run 0-db + +First we will get the hook script. The hook script can be found in the +[quantum_storage repo on github](https://github.com/threefoldtech/quantum-storage). +A slightly modified version is found here: + +```bash +#!/usr/bin/env bash +set -ex + +action="$1" +instance="$2" +zstorconf="/tmp/zstor_config.toml" +zstorbin="/tmp/zstor" + +if [ "$action" == "ready" ]; then + ${zstorbin} -c ${zstorconf} test + exit $? +fi + +if [ "$action" == "jump-index" ]; then + namespace=$(basename $(dirname $3)) + if [ "${namespace}" == "zdbfs-temp" ]; then + # skipping temporary namespace + exit 0 + fi + + tmpdir=$(mktemp -p /tmp -d zdb.hook.XXXXXXXX.tmp) + dirbase=$(dirname $3) + + # upload dirty index files + for dirty in $5; do + file=$(printf "i%d" $dirty) + cp ${dirbase}/${file} ${tmpdir}/ + done + + ${zstorbin} -c ${zstorconf} store -s -d -f ${tmpdir} -k ${dirbase} & + + exit 0 +fi + +if [ "$action" == "jump-data" ]; then + namespace=$(basename $(dirname $3)) + if [ "${namespace}" == "zdbfs-temp" ]; then + # skipping temporary namespace + exit 0 + fi + + # backup data file + ${zstorbin} -c ${zstorconf} store -s --file "$3" + + exit 0 +fi + +if [ "$action" == "missing-data" ]; then + # restore missing data file + ${zstorbin} -c ${zstorconf} retrieve --file "$3" + exit $? +fi + +# unknown action +exit 1 +``` + +> This guide assumes the file is saved as `/tmp/zdbfs/zdb-hook.sh. Make sure the +> file is executable, i.e. chmod +x /tmp/zdbfs/zdb-hook.sh` + +The local 0-db which is used by 0-db-fs can be started as follows: + +```bash +/tmp/0-db \ + --index /tmp/zdbfs/index \ + --data /tmp/zdbfs/data \ + --datasize 67108864 \ + --mode seq \ + --hook /tmp/zdbfs/zdb-hook.sh \ + --background +``` + +## Setup and run 0-db-fs + +Finally, we will start 0-db-fs. This guides opts to mount the fuse +filesystem in `/mnt`. Again, assuming the 0-db-fs binary was saved as +`/tmp/0-db-fs`: + +```bash +/tmp/0-db-fs /mnt -o autons -o background +``` + +You should now have the qsfs filesystem mounted at `/mnt`. As you write +data, it will save it in the local 0-db, and it's data containers will +be periodically encoded and uploaded to the backend data storage 0-db's. +The data files in the local 0-db will never occupy more than 25GiB of +space (as configured in the 0-stor config file). If a data container is +removed due to space constraints, and data inside of it needs to be +accessed by the filesystem (e.g. a file is being read), then the data +container is recovered from the backend storage 0-db's by 0-stor, and +0-db can subsequently serve this data to 0-db-fs. + +### 0-db-fs limitation + +Any workload should be supported on this filesystem, with some exceptions: + +- Opening a file in 'always append mode' will not have the expected behavior +- There is no support of O_TMPFILE by fuse layer, which is a feature required by + overlayfs, thus this is not supported. Overlayfs is used by Docker for example. + +## docker setup + +It is possible to run the zstor in a docker container. First, create a data directory +on your host. Then, save the config file in the data directory as `zstor.toml`. Ensure +the storage 0-db's are running as desribed above. Then, run the docker container +as such: + +``` +docker run -ti --privileged --rm --network host --name fstest -v /path/to/data:/data -v /mnt:/mnt:shared azmy/qsfs +``` + +The filesystem is now available in `/mnt`. + +## Autorepair + +Autorepair automatically repairs object stored in the backend when one or more shards +are not reachable anymore. It does this by periodically checking if all the backends +are still reachable. If it detects that one or more of the backends used by an encoded +object are not reachable, the healthy shards are downloaded, the object is restored +and encoded again (possibly with a new config, if it has since changed), and uploaded +again. + +Autorepair does not validate the integrity of individual shards. This is protectected +against by having multiple spare (redundant) shards for an object. Corrupt shards +are detected when the object is rebuild, and removed before attempting to rebuild. +Autorepair also does not repair the metadata of objects. + +## Monitoring, alerting and statistics + +0-stor collects metrics about the system. It can be configured with a 0-db-fs mountpoint, +which will trigger 0-stor to collect 0-db-fs statistics, next to some 0-db statistics +which are always collected. If the `prometheus_port` config option is set, 0-stor +will serve metrics on this port for scraping by prometheus. You can then set up +graphs and alerts in grafana. Some examples include: disk space used vs available +per 0-db backend, total entries in 0-db backends, which backends are tracked, ... +When 0-db-fs monitoring is enabled, statistics are also exported about the filesystem +itself, such as read/write speeds, syscalls, and internal metrics + +For a full overview of all available stats, you can set up a prometheus scraper against +a running instance, and use the embedded promQl to see everything available. + +## Data safety + +As explained in the auto repair section, data is periodically checked and rebuild if +0-db backends become unreachable. This ensures that data, once stored, remains available, +as long as the metadata is still present. When needed, the system can be expanded with more +0-db backends, and the encoding config can be changed if needed (e.g. to change encryption keys). + +## Performance + +Qsfs is not a high speed filesystem, nor is it a distributed filesystem. It is intended to +be used for archive purposes. For this reason, the qsfs stack focusses on data safety first. +Where needed, reliability is chosen over availability (i.e. we won't write data if we can't +guarantee all the conditions in the required storage profile is met). + +With that being said, there are currently 2 limiting factors in the setup: +- speed of the disk on which the local 0-db is running +- network + +The first is the speed of the disk for the local 0-db. This imposes a hard limit on +the throughput of the filesystem. Performance testing has shown that write speeds +on the filesystem reach performance of roughly 1/3rd of the raw performance of the +disk for writing, and 1/2nd of the read performance. Note that in the case of _very_ +fast disks (mostly NVMe SSD's), the cpu might become a bottleneck if it is old and +has a low clock speed. Though this should not be a problem. + +The network is more of a soft cap. All 0-db data files will be encoded and distributed +over the network. This means that the upload speed of the node needs to be able to +handle this data througput. In the case of random data (which is not compressable), +the required upload speed would be the write speed of the 0-db-fs, increased by the +overhead generated by the storage policy. There is no feedback to 0-db-fs if the upload +of data is lagging behind. This means that in cases where a sustained high speed write +load is applied, the local 0-db might eventually grow bigger than the configured size limit +until the upload managed to catch up. If this happens for prolonged periods of time, it +is technically possible to run out of space on the disk. For this reason, you should +always have some extra space available on the disk to account for temprorary cache +excess. + +When encoded data needs to be recovered from backend nodes (if it is not in cache), +the read speed will be equal to the connection speed of the slowest backend, as all +shards are recovered before the data is build. This means that recovery of historical +data will generally be a slow process. Since we primarily focus on archive storage, +we do not consider this a priority. diff --git a/collections/tfmanual/knowledge_base/technology/qsss/product/concept/img/create_png b/collections/tfmanual/knowledge_base/technology/qsss/product/concept/img/create_png new file mode 100755 index 0000000..b232adf --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/product/concept/img/create_png @@ -0,0 +1,9 @@ +#!/bin/bash + +for name in ./*.mmd +do + output=$(basename $name mmd)png + echo $output + mmdc -i $name -o $output -w 4096 -H 2160 -b transparant + echo $name +done diff --git a/collections/tfmanual/knowledge_base/technology/qsss/product/concept/img/data_origin.mmd b/collections/tfmanual/knowledge_base/technology/qsss/product/concept/img/data_origin.mmd new file mode 100644 index 0000000..52c61dc --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/product/concept/img/data_origin.mmd @@ -0,0 +1,13 @@ +graph TD + subgraph Data Origin + file[Large chunk of data = part_1part_2part_3part_4] + parta[part_1] + partb[part_2] + partc[part_3] + partd[part_4] + file -.- |split part_1|parta + file -.- |split part_2|partb + file -.- |split part 3|partc + file -.- |split part 4|partd + parta --> partb --> partc --> partd + end \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/qsss/product/concept/img/data_substitution.mmd b/collections/tfmanual/knowledge_base/technology/qsss/product/concept/img/data_substitution.mmd new file mode 100644 index 0000000..89a1212 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/product/concept/img/data_substitution.mmd @@ -0,0 +1,20 @@ +graph TD + subgraph Data Substitution + parta[part_1] + partb[part_2] + partc[part_3] + partd[part_4] + parta -.-> vara[ A = part_1] + partb -.-> varb[ B = part_2] + partc -.-> varc[ C = part_3] + partd -.-> vard[ D = part_4] + end + subgraph Create equations with the data parts + eq1[A + B + C + D = 6] + eq2[A + B + C - D = 3] + eq3[A + B - C - D = 10] + eq4[ A - B - C - D = -4] + eq5[ A - B + C + D = 0] + eq6[ A - B - C + D = 5] + vara & varb & varc & vard --> eq1 & eq2 & eq3 & eq4 & eq5 & eq6 + end \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/qsss/product/concept/img/qsfs_principle.mmd b/collections/tfmanual/knowledge_base/technology/qsss/product/concept/img/qsfs_principle.mmd new file mode 100644 index 0000000..e11fe92 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/product/concept/img/qsfs_principle.mmd @@ -0,0 +1,44 @@ +graph TD + subgraph Data Origin + file[Large chunk of data = part_1part_2part_3part_4] + parta[part_1] + partb[part_2] + partc[part_3] + partd[part_4] + file -.- |split part_1|parta + file -.- |split part_2|partb + file -.- |split part 3|partc + file -.- |split part 4|partd + parta --> partb --> partc --> partd + parta -.-> vara[ A = part_1] + partb -.-> varb[ B = part_2] + partc -.-> varc[ C = part_3] + partd -.-> vard[ D = part_4] + end + subgraph Create equations with the data parts + eq1[A + B + C + D = 6] + eq2[A + B + C - D = 3] + eq3[A + B - C - D = 10] + eq4[ A - B - C - D = -4] + eq5[ A - B + C + D = 0] + eq6[ A - B - C + D = 5] + vara & varb & varc & vard --> eq1 & eq2 & eq3 & eq4 & eq5 & eq6 + end + subgraph Disk 1 + eq1 --> |store the unique equation, not the parts|zdb1[A + B + C + D = 6] + end + subgraph Disk 2 + eq2 --> |store the unique equation, not the parts|zdb2[A + B + C - D = 3] + end + subgraph Disk 3 + eq3 --> |store the unique equation, not the parts|zdb3[A + B - C - D = 10] + end + subgraph Disk 4 + eq4 --> |store the unique equation, not the parts|zdb4[A - B - C - D = -4] + end + subgraph Disk 5 + eq5 --> |store the unique equation, not the parts|zdb5[ A - B + C + D = 0] + end + subgraph Disk 6 + eq6 --> |store the unique equation, not the parts|zdb6[A - B - C + D = 5] + end \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/qsss/product/concept/img/quantum_safe_architecture.mmd b/collections/tfmanual/knowledge_base/technology/qsss/product/concept/img/quantum_safe_architecture.mmd new file mode 100644 index 0000000..3f7a2eb --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/product/concept/img/quantum_safe_architecture.mmd @@ -0,0 +1,34 @@ +graph TD + subgraph Local laptop, computer or server + user[End User] + protocol[Storage protocol] + qsfs[Filesystem on local OS] + 0store[Quantum Safe storage engine] + end + subgraph Grid storage - metadata + etcd1[ETCD-1] + etcd2[ETCD-2] + etcd3[ETCD-3] + end + subgraph Grid storage - zero proof data + zdb1[ZDB-1] + zdb2[ZDB-2] + zdb3[ZDB-3] + zdb4[ZDB-4] + zdb5[ZDB-5] + zdb6[ZDB-6] + zdb7[ZDB-7] + user -.- protocol + protocol -.- qsfs + qsfs --- 0store + 0store --- etcd1 + 0store --- etcd2 + 0store --- etcd3 + 0store <-.-> zdb1[ZDB-1] + 0store <-.-> zdb2[ZDB-2] + 0store <-.-> zdb3[ZDB-3] + 0store <-.-> zdb4[ZDB-4] + 0store <-.-> zdb5[ZDB-5] + 0store <-.-> zdb6[ZDB-...] + 0store <-.-> zdb7[ZDB-N] + end \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/qsss/product/file_system/img/create_png b/collections/tfmanual/knowledge_base/technology/qsss/product/file_system/img/create_png new file mode 100755 index 0000000..b232adf --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/product/file_system/img/create_png @@ -0,0 +1,9 @@ +#!/bin/bash + +for name in ./*.mmd +do + output=$(basename $name mmd)png + echo $output + mmdc -i $name -o $output -w 4096 -H 2160 -b transparant + echo $name +done diff --git a/collections/tfmanual/knowledge_base/technology/qsss/product/file_system/img/qsss_intro_.jpg b/collections/tfmanual/knowledge_base/technology/qsss/product/file_system/img/qsss_intro_.jpg new file mode 100644 index 0000000..25fda06 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/qsss/product/file_system/img/qsss_intro_.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/qsss/product/file_system/img/qsstorage_architecture.jpg b/collections/tfmanual/knowledge_base/technology/qsss/product/file_system/img/qsstorage_architecture.jpg new file mode 100644 index 0000000..811e6ab Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/qsss/product/file_system/img/qsstorage_architecture.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/qsss/product/file_system/qss_filesystem.md b/collections/tfmanual/knowledge_base/technology/qsss/product/file_system/qss_filesystem.md new file mode 100644 index 0000000..54c3638 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/product/file_system/qss_filesystem.md @@ -0,0 +1,39 @@ + + +![](img/qsss_intro_.jpg) + +# Quantum Safe Filesystem + +A redundant filesystem, can store PB's (millions of gigabytes) of information. + +Unique features: + +- Unlimited scalable (many petabytes) filesystem +- Quantum Safe: + - On the TFGrid, no farmer knows what the data is about + - Even a quantum computer cannot decrypt +- Data can't be lost + - Protection for [datarot](datarot), data will autorepair +- Data is kept for ever +- Data is dispersed over multiple sites +- Sites can go down, data not lost +- Up to 10x more efficient than storing on classic storage cloud systems +- Can be mounted as filesystem on any OS or any deployment system (OSX, Linux, Windows, Docker, Kubernetes, TFGrid, ...) +- Compatible with +- all data workloads (not high performance data driven workloads like a database) +- Self-healing: when a node or disk lost, storage system can get back to original redundancy level +- Helps with compliance to regulations like GDPR (as the hosting facility has no view on what is stored, information is encrypted and incomplete) +- Hybrid: can be installed onsite, public, private, ... +- Read-write caching on encoding node (the front end) + + +## Architecture + +By using our filesystem inside a Virtual Machine or Kubernetes the TFGrid user can deploy any storage application on top e.g. Minio for S3 storage, OwnCloud as online fileserver. + +![](img/qsstorage_architecture.jpg) + +Any storage workload can be deployed on top of the zstor. + +!!!def alias:quantumsafe_filesystem,planetary_fs,planet_fs,quantumsafe_file_system,zstor,qsfs + +!!!include:qsss_toc \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/qsss/product/file_system/qss_system.mmd b/collections/tfmanual/knowledge_base/technology/qsss/product/file_system/qss_system.mmd new file mode 100644 index 0000000..5c8e8b7 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/product/file_system/qss_system.mmd @@ -0,0 +1,14 @@ +graph TD +subgraph Data Ingress and Egress +qss[Quantum Safe Storage Engine] +end +subgraph Physical Data storage +st1[Virtual Storage Device 1] +st2[Virtual Storage Device 2] +st3[Virtual Storage Device 3] +st4[Virtual Storage Device 4] +st5[Virtual Storage Device 5] +st6[Virtual Storage Device 6] +st7[Virtual Storage Device 7] +qss -.-> st1 & st2 & st3 & st4 & st5 & st6 & st7 +end \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/qsss/product/img/create_png b/collections/tfmanual/knowledge_base/technology/qsss/product/img/create_png new file mode 100755 index 0000000..b232adf --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/product/img/create_png @@ -0,0 +1,9 @@ +#!/bin/bash + +for name in ./*.mmd +do + output=$(basename $name mmd)png + echo $output + mmdc -i $name -o $output -w 4096 -H 2160 -b transparant + echo $name +done diff --git a/collections/tfmanual/knowledge_base/technology/qsss/product/img/data_origin.mmd b/collections/tfmanual/knowledge_base/technology/qsss/product/img/data_origin.mmd new file mode 100644 index 0000000..52c61dc --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/product/img/data_origin.mmd @@ -0,0 +1,13 @@ +graph TD + subgraph Data Origin + file[Large chunk of data = part_1part_2part_3part_4] + parta[part_1] + partb[part_2] + partc[part_3] + partd[part_4] + file -.- |split part_1|parta + file -.- |split part_2|partb + file -.- |split part 3|partc + file -.- |split part 4|partd + parta --> partb --> partc --> partd + end \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/qsss/product/img/data_substitution.mmd b/collections/tfmanual/knowledge_base/technology/qsss/product/img/data_substitution.mmd new file mode 100644 index 0000000..89a1212 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/product/img/data_substitution.mmd @@ -0,0 +1,20 @@ +graph TD + subgraph Data Substitution + parta[part_1] + partb[part_2] + partc[part_3] + partd[part_4] + parta -.-> vara[ A = part_1] + partb -.-> varb[ B = part_2] + partc -.-> varc[ C = part_3] + partd -.-> vard[ D = part_4] + end + subgraph Create equations with the data parts + eq1[A + B + C + D = 6] + eq2[A + B + C - D = 3] + eq3[A + B - C - D = 10] + eq4[ A - B - C - D = -4] + eq5[ A - B + C + D = 0] + eq6[ A - B - C + D = 5] + vara & varb & varc & vard --> eq1 & eq2 & eq3 & eq4 & eq5 & eq6 + end \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/qsss/product/img/qsfs_principle.mmd b/collections/tfmanual/knowledge_base/technology/qsss/product/img/qsfs_principle.mmd new file mode 100644 index 0000000..15a8b2f --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/product/img/qsfs_principle.mmd @@ -0,0 +1,44 @@ +rgraph TD + subgraph Data Origin + file[Large chunk of data = part_1part_2part_3part_4] + parta[part_1] + partb[part_2] + partc[part_3] + partd[part_4] + file -.- |split part_1|parta + file -.- |split part_2|partb + file -.- |split part 3|partc + file -.- |split part 4|partd + parta --> partb --> partc --> partd + parta -.-> vara[ A = part_1] + partb -.-> varb[ B = part_2] + partc -.-> varc[ C = part_3] + partd -.-> vard[ D = part_4] + end + subgraph Create equations with the data parts + eq1[A + B + C + D = 6] + eq2[A + B + C - D = 3] + eq3[A + B - C - D = 10] + eq4[ A - B - C - D = -4] + eq5[ A - B + C + D = 0] + eq6[ A - B - C + D = 5] + vara & varb & varc & vard --> eq1 & eq2 & eq3 & eq4 & eq5 & eq6 + end + subgraph Disk 1 + eq1 --> |store the unique equation, not the parts|zdb1[A + B + C + D = 6] + end + subgraph Disk 2 + eq2 --> |store the unique equation, not the parts|zdb2[A + B + C - D = 3] + end + subgraph Disk 3 + eq3 --> |store the unique equation, not the parts|zdb3[A + B - C - D = 10] + end + subgraph Disk 4 + eq4 --> |store the unique equation, not the parts|zdb4[A - B - C - D = -4] + end + subgraph Disk 5 + eq5 --> |store the unique equation, not the parts|zdb5[ A - B + C + D = 0] + end + subgraph Disk 6 + eq6 --> |store the unique equation, not the parts|zdb6[A - B - C + D = 5] + end \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/qsss/product/img/qss_system.jpg b/collections/tfmanual/knowledge_base/technology/qsss/product/img/qss_system.jpg new file mode 100644 index 0000000..3c4656e Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/qsss/product/img/qss_system.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/qsss/product/img/quantumsafe_storage_algo.jpg b/collections/tfmanual/knowledge_base/technology/qsss/product/img/quantumsafe_storage_algo.jpg new file mode 100644 index 0000000..448c7a7 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/qsss/product/img/quantumsafe_storage_algo.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/qsss/product/img/tf_banner_grid_.jpg b/collections/tfmanual/knowledge_base/technology/qsss/product/img/tf_banner_grid_.jpg new file mode 100644 index 0000000..fb093de Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/qsss/product/img/tf_banner_grid_.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/qsss/product/qss_algorithm.md b/collections/tfmanual/knowledge_base/technology/qsss/product/qss_algorithm.md new file mode 100644 index 0000000..b92dfaa --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/product/qss_algorithm.md @@ -0,0 +1,82 @@ +# Quantum Safe Storage Algoritm + +![](img/tf_banner_grid_.jpg) + +The Quantum Safe Storage Algorithm is the heart of the Storage engine. The storage engine takes the original data objects and creates data part descriptions that it stores over many virtual storage devices (ZDB/s) + + +![](../img/.jpg) + +Data gets stored over multiple ZDB's in such a way that data can never be lost. + +Unique features + +- data always append, can never be lost +- even a quantum computer cannot decrypt the data +- is spread over multiple sites, sites can be lost, data will still be available +- protects for [datarot](datarot) + +### Why + +Today we produce more data than ever before. We could not continue to make full copies of data to make sure it is stored reliably. This will simply not scale. We need to move from securing the whole dataset to securing all the objects that make up a dataset. + +ThreeFold is using space technology to store data (fragments) over multiple devices (physical storage devices in 3Nodes). The solution does not distribute and store parts of an object (file, photo, movie...) but describes the part of an object. This could be visualized by thinking of it as equations. + + +### Details + +Let a,b,c,d.... be the parts of that original object. You could create endless unique equations using these parts. A simple example: let's assume we have 3 parts of original objects that have the following values: +``` +a=1 +b=2 +c=3 +``` +(and for reference that part of real-world objects is not a simple number like `1` but a unique digital number describing the part, like the binary code for it `110101011101011101010111101110111100001010101111011.....`). With these numbers we could create endless amounts of equations: +``` +1: a+b+c=6 +2: c-b-a=0 +3: b-c+a=0 +4: 2b+a-c=2 +5: 5c-b-a=12 +...... +``` +Mathematically we only need 3 to describe the content (=value) of the fragments. But creating more adds reliability. Now store those equations distributed (one equation per physical storage device) and forget the original object. So we no longer have access to the values of a, b, c and see and we just remember the locations of all the equations created with the original data fragments. Mathematically we need three equations (any 3 of the total) to recover the original values for a, b or c. So do a request to retrieve 3 of the many equations and the first 3 to arrive are good enough to recalculate the original values. Three randomly retrieved equations are: + +``` +5c-b-a=12 +b-c+a=0 +2b+a-c=2 +``` +And this is a mathematical system we could solve: +- First: `b-c+a=0 -> b=c-a` +- Second: `2b+a-c=2 -> c=2b+a-2 -> c=2(c-a)+a-2 -> c=2c-2a+a-2 -> c=a+2` +- Third: `5c-b-a=12 -> 5(a+2)-(c-a)-a=12 -> 5a+10-(a+2)+a-a=12 -> 5a-a-2=2 -> 4a=4 -> a=1` + +Now that we know `a=1` we could solve the rest `c=a+2=3` and `b=c-a=2`. And we have from 3 random equations regenerated the original fragments and could now recreate the original object. + +The redundancy and reliability in such system comes in the form of creating (more than needed) equations and storing them. As shown these equations in any random order could recreate the original fragments and therefore +redundancy comes in at a much lower overhead. + +### Example of 16/4 + +![](img/quantumsafe_storage_algo.jpg) + + +Each object is fragmented into 16 parts. So we have 16 original fragments for which we need 16 equations to mathematically describe them. Now let's make 20 equations and store them dispersedly on 20 devices. To recreate the original object we only need 16 equations, the first 16 that we find and collect which allows us to recover the fragment and in the end the original object. We could lose any 4 of those original 20 equations. + +The likelihood of losing 4 independent, dispersed storage devices at the same time is very low. Since we have continuous monitoring of all of the stored equations, we could create additional equations immediately when one of them is missing, making it an auto-regeneration of lost data and a self-repairing storage system. The overhead in this example is 4 out of 20 which is a mere **20%** instead of (up to) **400%.** + +### Content distribution Policy (10/50) + +This system can be used as backend for content delivery networks. + +Imagine a movie being stored on 60 locations from which we can loose 50 at the same time. + +If someone now wants to download the data the first 10 locations who answer fastest will provide enough of the data parts to allow the data to be rebuild. + +The overhead here is much more compared to previous example but stil order of magnitude lower compared to other cdn systems. + + +!!!def alias:quantumsafe_storage_algo,quantumsafe_storage_algorithm,space_algo,space_algorithm,quantum_safe_storage_algo,qs_algo,qs_codec + +!!!include:qsss_toc \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/qsss/product/qss_datarot.md b/collections/tfmanual/knowledge_base/technology/qsss/product/qss_datarot.md new file mode 100644 index 0000000..9ae4e4e --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/product/qss_datarot.md @@ -0,0 +1,8 @@ +# Datarot Cannot Happen on our Storage System + +Fact that data storage degrades over time and becomes unreadable, on e.g. a harddisk. +The storage system provided by ThreeFold intercepts this silent data corruption, making that it can pass by unnotified. + +> see also https://en.wikipedia.org/wiki/Data_degradation + +!!!def alias:bitrot,datarot \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/qsss/product/qss_zero_knowledge_proof.md b/collections/tfmanual/knowledge_base/technology/qsss/product/qss_zero_knowledge_proof.md new file mode 100644 index 0000000..71f4de3 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/product/qss_zero_knowledge_proof.md @@ -0,0 +1,11 @@ + +# Zero Knowledge Proof Storage system. + +The quantum save storage system is zero knowledge proof compliant. The storage system is made up / split into 2 components: The actual storage devices use to store the data (ZDB's) and the Quantum Safe Storage engine. + + +![](img/qss_system.jpg) + +The zero proof knowledge compliancy comes from the fact the all the physical storage nodes (3nodes) can proof that they store a valid part of what data the quantum safe storage engine (QSSE) has stored on multiple independent devices. The QSSE can validate that all the QSSE storage devices have a valid part of the original information. The storage devices however have no idea what the original stored data is as they only have a part (description) of the origina data and have no access to the original data part or the complete origal data objects. + +!!!def \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/qsss/qss_benefits.md b/collections/tfmanual/knowledge_base/technology/qsss/qss_benefits.md new file mode 100644 index 0000000..7fb099b --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/qss_benefits.md @@ -0,0 +1,12 @@ +![](img/filesystem_abstract.jpg) + +# Quantum Safe Storage System benefits + +!!!include:qss_benefits_ + +!!!include:qsss_toc + + + + + diff --git a/collections/tfmanual/knowledge_base/technology/qsss/qss_benefits_.md b/collections/tfmanual/knowledge_base/technology/qsss/qss_benefits_.md new file mode 100644 index 0000000..bb27444 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/qss_benefits_.md @@ -0,0 +1,6 @@ +- Up to 10x more efficient (power and usage of hardware) +- Ultra reliable, data can not be lost +- Ultra safe & private +- Ultra scalable +- Sovereign, data is close to you in the country of your choice +- Truly peer-to-peer, by everyone for everyone diff --git a/collections/tfmanual/knowledge_base/technology/qsss/qsss.md b/collections/tfmanual/knowledge_base/technology/qsss/qsss.md new file mode 100644 index 0000000..e9b34c4 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/qsss.md @@ -0,0 +1,2 @@ + +!!!include:qsss_home \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/qsss/qsss2_home.md b/collections/tfmanual/knowledge_base/technology/qsss/qsss2_home.md new file mode 100644 index 0000000..d62400a --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/qsss2_home.md @@ -0,0 +1,21 @@ +![](img/qsstorage_architecture.jpg) + +# Quantum Safe Storage System + +Imagine a storage system with the following benefits + +!!!include:qss_benefits_ + +> This is not a dream but does exist and is the underpinning of the TFGrid. + +Our storage architecture follows the true peer-to-peer design of the TF grid. Any participating node only stores small incomplete parts of objects (files, photos, movies, databases...) by offering a slice of the present (local) storage devices. Managing the storage and retrieval of all of these distributed fragments is done by a software that creates development or end-user interfaces for this storage algorithm. We call this '**dispersed storage**'. + +Peer-to-peer provides the unique proposition of selecting storage providers that match your application and service of business criteria. For example, you might be looking to store data for your application in a certain geographic area (for governance and compliance) reasons. Also, you might want to use different "storage policies" for different types of data. Examples are live versus archived data. All of these uses cases are possible with this storage architecture and could be built by using the same building blocks produced by farmers and consumed by developers or end-users. + + +!!!include:qsss_toc + +!!!def alias:qsss,quantum_safe_storage_system + + + diff --git a/collections/tfmanual/knowledge_base/technology/qsss/qsss_home.md b/collections/tfmanual/knowledge_base/technology/qsss/qsss_home.md new file mode 100644 index 0000000..a6efb37 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/qsss_home.md @@ -0,0 +1,34 @@ + + +

Quantum Safe Storage System

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [QSS Benefits](#qss-benefits) +- [Peer-to-Peer Design](#peer-to-peer-design) +- [Overview](#overview) + +*** + +## Introduction + +ThreeFold offers a quantum safe storage system (QSS). QSS is a decentralized, globally distributed data storage system. It is unbreakable, self-healing, append-only and immutable. + +## QSS Benefits + +Imagine a storage system with the following benefits: + +{{#include ./qss_benefits_.md}} + +This is not a dream but does exist and is the underpinning of the TFGrid. + +## Peer-to-Peer Design + +Our storage architecture follows the true peer-to-peer design of the TF grid. Any participating node only stores small incomplete parts of objects (files, photos, movies, databases...) by offering a slice of the present (local) storage devices. Managing the storage and retrieval of all of these distributed fragments is done by a software that creates development or end-user interfaces for this storage algorithm. We call this '**dispersed storage**'. + +Peer-to-peer provides the unique proposition of selecting storage providers that match your application and service of business criteria. For example, you might be looking to store data for your application in a certain geographic area (for governance and compliance) reasons. Also, you might want to use different "storage policies" for different types of data. Examples are live versus archived data. All of these uses cases are possible with this storage architecture and could be built by using the same building blocks produced by farmers and consumed by developers or end-users. + +## Overview + +![](img/qsss_intro_0_.jpg) \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/qsss/qsss_toc.md b/collections/tfmanual/knowledge_base/technology/qsss/qsss_toc.md new file mode 100644 index 0000000..57670da --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/qsss_toc.md @@ -0,0 +1,7 @@ +

Quantum Safe Storage More Info

+ +

Table of Contents

+ +- [Quantum Safe Storage Overview](./qsss_home.md) +- [Quantum Safe Filesystem](qss_filesystem) +- quantumsafe_storage_algo \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/qsss/roadmap/img/roadmap.jpg b/collections/tfmanual/knowledge_base/technology/qsss/roadmap/img/roadmap.jpg new file mode 100644 index 0000000..ccb52e9 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/qsss/roadmap/img/roadmap.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/qsss/roadmap/quantumsafe_roadmap.md b/collections/tfmanual/knowledge_base/technology/qsss/roadmap/quantumsafe_roadmap.md new file mode 100644 index 0000000..3613d08 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/roadmap/quantumsafe_roadmap.md @@ -0,0 +1,7 @@ +![roadmap](img/roadmap.jpg) + +# Roadmap + +>TODO: to be filled in + +> See Quantum Safe Storage project [kanban](https://github.com/orgs/threefoldtech/projects/152). \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/qsss/sidebar.md b/collections/tfmanual/knowledge_base/technology/qsss/sidebar.md new file mode 100644 index 0000000..ec25d46 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/sidebar.md @@ -0,0 +1,20 @@ +- [**Home**](@threefold_home) +- [**Technology**](@technology) +------------ +**Quantum Safe Filesystem** + +- [Home](@qsss_home) +- [Filesystem](@qss_filesystem) +- [Algorithm](@qss_algorithm) + + + + + + + + diff --git a/collections/tfmanual/knowledge_base/technology/qsss/specs_todo/img/specs_header.jpg b/collections/tfmanual/knowledge_base/technology/qsss/specs_todo/img/specs_header.jpg new file mode 100644 index 0000000..e84a21f Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/qsss/specs_todo/img/specs_header.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/qsss/specs_todo/policy.md b/collections/tfmanual/knowledge_base/technology/qsss/specs_todo/policy.md new file mode 100644 index 0000000..3d58d59 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/specs_todo/policy.md @@ -0,0 +1,3 @@ +# zstor filesystem (zstor) Policy + +Describe how it works... diff --git a/collections/tfmanual/knowledge_base/technology/qsss/specs_todo/qss_specs.md b/collections/tfmanual/knowledge_base/technology/qsss/specs_todo/qss_specs.md new file mode 100644 index 0000000..0e66004 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/specs_todo/qss_specs.md @@ -0,0 +1,68 @@ +![specs](img/specs_header.jpg) + +# System requirements + +System that is easy to provision storage capacity on the TF grid +- user can create X storage nodes on a random or specific locations +- user can list their storage nodes +- check node status/info in some shape or form in a monitoring solution +- external authentication/payment system using threefold connect app +- user can delete their storage nodes +- user can provision mode storage nodes +- user can increase total size of storage solutions +- user can install the quantum safe filesystem on any linux based system, physical or virtual + +# Non-functional requirements + +- How many expected concurrent users: not application - each user will have it's own local binary and software install. +- How many users on the system: 10000-100000 +- Data store: fuse filesystem plus local and grid based ZDB's +- How critical is the system? it needs to be alive all the time. +- What do we know about the external payment system? +Threefold Connect, use QR code for payments and validate on the blockchain +- Life cycle of the storage nodes? How does the user keep their nodes alive? The local binary / application has a wallet from which it can pay for the existing and new storage devices. This wallet needs to be kept topped up. +- When the user is asked to sign the deployment of 20 storage nodes: + - will the user sign each single reservation? or should the system itself sign it for the user and show the QR code only for payments? +- Payments should be done to the a specific user wallet and with a background service with extend the user pools or /extend in the bot conversation? to be resolved +- Configuration and all metadata should be stored as a hash / private key. With this information you are able to regain access to your stored data from everywhere. + + +# Components mapping / SALs + +- Entities: User, storage Node +- ReservationBuilder: builds reservation for the user to sign (note the QR code data size limit is 3KB) +- we need to define how many nodes can we deploy at a time, shouldn't exceed 3KB for the QR Code, if it exceeds the limit should we split the reservations? + +- UserInfo: user info are loaded from threefold login system +- Blockchain Node (role, configurations) +- Interface to Threefold connect (authentication+payment) /identify + generate payments +- User notifications / topup +- Monitoring: monitoring + redeployment of the solutions again if they go down, when redeploying who owns the reservation to delete -can be fixed with delete signers field- and redeploy, but to deploy we need the user identity or should we inform the user in telegram and ask him to /redeploy +- Logging + +# Tech stack + +- [JS-SDK[](https://github.com/threefoldtech/js-sdk) (?) +- [0-db](https://github.com/threefoldtech/0-db-s) +- [0-db-fs](https://github.com/threefoldtech/0-db-fs) +- [0-stor_v2](https://github.com/threefoldtech/0-stor_v2) +- [quantum_storage](https://github.com/threefoldtech/quantum-storage) + + + +# Blockers + + +Idea from blockchain jukekebox brainstorm: + +## payments +- QR code contains threebot://signandpay/#https://tf.grid/api/a6254a4a-bdf4-11eb-8529-0242ac130003 (can also be uni link) +- App gets URL +- URL gives data +- { DataToSign : {RESERVATIONDETAILS}, Payment: {PAYMENTDETAILS}, CallbackUrl: {CALLBACKURL} } +- App signs reservation, makes payment, calls callbackurl { SingedData : {SINGEDRESERVATION}, Payment: {FINISHED_PAYMENTDETAILS}} + +Full flow: +- User logs in using normal login flow +- User scans QR +- User confirms reservation and payment in the app diff --git a/collections/tfmanual/knowledge_base/technology/qsss/specs_todo/quantum_safe_filesystem.md b/collections/tfmanual/knowledge_base/technology/qsss/specs_todo/quantum_safe_filesystem.md new file mode 100644 index 0000000..cb47e70 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/specs_todo/quantum_safe_filesystem.md @@ -0,0 +1,3 @@ +# Specs zstor filesystem + +- [Quantum Safe File System](quantum_safe_filesystem_2_6) \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/qsss/specs_todo/quantum_safe_filesystem_2_6.md b/collections/tfmanual/knowledge_base/technology/qsss/specs_todo/quantum_safe_filesystem_2_6.md new file mode 100644 index 0000000..0051d2c --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/specs_todo/quantum_safe_filesystem_2_6.md @@ -0,0 +1,20 @@ +# zstor filesystem 2.6 + +## requirements + +- redundancy/uptime + - data can never be lost if older than 20 min (avg will be 7.5 min, because we use 15 min push) + - if a datacenter or node goes down and we are in storage policy the storage stays available +- reliability + - data cannot have hidden data corruption, when bitrot the FS will automatically recover +- self healing + - when data policy is lower than required level then should re-silver (means make sure policy is intact again) + +## NEW + +- 100% redundancy + +## architecture + +!!!include:quantum_safe_filesystem_architecture +!!!include:quantum_safe_filesystem_sequence_graph diff --git a/collections/tfmanual/knowledge_base/technology/qsss/specs_todo/quantum_safe_filesystem_architecture.md b/collections/tfmanual/knowledge_base/technology/qsss/specs_todo/quantum_safe_filesystem_architecture.md new file mode 100644 index 0000000..ef373f7 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/specs_todo/quantum_safe_filesystem_architecture.md @@ -0,0 +1,37 @@ + +## zstor Architecture + +```mermaid +graph TD + subgraph TFGridLoc2 + ZDB5 + ZDB6 + ZDB7 + ZDB8 + ETCD3 + end + subgraph TFGridLoc1 + ZDB1 + ZDB2 + ZDB3 + ZDB4 + ETCD1 + ETCD2 + KubernetesController --> ETCD1 + KubernetesController --> ETCD2 + KubernetesController --> ETCD3 + end + + + subgraph eVDC + PlanetaryFS --> ETCD1 & ETCD2 & ETCD3 + PlanetaryFS --> MetadataStor + PlanetaryFS --> ReadWriteCache + MetadataStor --> LocalZDB + ReadWriteCache --> LocalZDB + LocalZDB & PlanetaryFS --> ZeroStor + ZeroStor --> ZDB1 & ZDB2 & ZDB3 & ZDB4 & ZDB5 & ZDB6 & ZDB7 & ZDB8 + end + + +``` \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/qsss/specs_todo/quantum_safe_filesystem_sequence_graph.md b/collections/tfmanual/knowledge_base/technology/qsss/specs_todo/quantum_safe_filesystem_sequence_graph.md new file mode 100644 index 0000000..28b43d7 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/specs_todo/quantum_safe_filesystem_sequence_graph.md @@ -0,0 +1,40 @@ +## zstor Sequence Diagram + +```mermaid +sequenceDiagram + participant user as user + participant fs as 0-fs + participant lzdb as local 0-db + participant zstor as 0-stor + participant etcd as ETCD + participant zdbs as backend 0-dbs + participant mon as Monitor + + alt Writing data + user->>fs: write data to files + fs->>lzdb: write data blocks + opt Datafile is full + lzdb->>zstor: encode and chunk data file + zstor->>zdbs: write encoded datafile chunks to the different backends + zstor->>etcd: write metadata about encoded file to metadata storage + end + else Reading data + user->>fs: read data from file + fs->>lzdb: read data blocks + opt Datafile is missing + lzdb->>zstor: request retrieval of data file + zstor->>etcd: load file encoding and storage metadata + zstor->>zdbs: read encoded datafile chunks from multiple backends and rebuilds original datafile + zstor->>lzdb: replaces the missing datafile + end + end + + loop Monitor action + mon->>lzdb: delete local data files which are full and have been encoded, AND have not been accessed for some time + mon->>zdbs: monitors health of used namespaces + opt Namespace is lost or corrupted + mon->>zstor: checks storage configuration + mon->>zdbs: rebuilds missing shard on new namespace from storage config + end + end +``` diff --git a/collections/tfmanual/knowledge_base/technology/qsss/testplan/img/failure_points.jpg b/collections/tfmanual/knowledge_base/technology/qsss/testplan/img/failure_points.jpg new file mode 100644 index 0000000..5bb3924 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/qsss/testplan/img/failure_points.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/qsss/testplan/img/testplan_points.mmd b/collections/tfmanual/knowledge_base/technology/qsss/testplan/img/testplan_points.mmd new file mode 100644 index 0000000..7ffae96 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/testplan/img/testplan_points.mmd @@ -0,0 +1,34 @@ +graph TD + subgraph Local laptop, computer or server + user[End User *11* ] + protocol[Storage Protocol *6*] + qsfs[Filesystem *7*] + 0store[Storage Engine *8*] + end + subgraph Grid storage - metadata + etcd1[ETCD-1 *9*] + etcd2[ETCD-2 *9*] + etcd3[ETCD-3 *9*] + end + subgraph Grid storage - zero proof data + zdb1[ZDB-1 *10*] + zdb2[ZDB-2 *10*] + zdb3[ZDB-3 *10*] + zdb4[ZDB-4 *10*] + zdb5[ZDB-5 *10*] + zdb6[ZDB-... *10*] + zdb7[ZDB-N *10*] + user -.- |-1-| protocol + protocol -.- |-2-| qsfs + qsfs --- |-3-| 0store + 0store --- |-4-| etcd1 + 0store --- |-4-| etcd2 + 0store --- |-4-| etcd3 + 0store <-.-> |-5-| zdb1 + 0store <-.-> |-5-| zdb2 + 0store <-.-> |-5-| zdb3 + 0store <-.-> |-5-| zdb4 + 0store <-.-> |-5-| zdb5 + 0store <-.-> |-5-| zdb6 + 0store <-.-> |-5-| zdb7 + end \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/qsss/testplan/testplan.md b/collections/tfmanual/knowledge_base/technology/qsss/testplan/testplan.md new file mode 100644 index 0000000..4b4a431 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/qsss/testplan/testplan.md @@ -0,0 +1,131 @@ +## Quantum Safe Storage Testplan + +### Prerequisites +The quantum safe storage system runs on the following platforms +- bare metal linux installation. +- kubernetes cluster with Helm installation scripts. + +### Installation +For instructions in installing the QSFS please see the manual [here](../manual/README.md). + +#### Bare metal Linux +The software comes as a single binary which will install all the necessary components (local) to run the quantum safe file system. The server in the storage front end and the TF Grid is the storage backend. The storage backend configuration can be provided in two different ways: +- the user has access to the eVDC facility of Threefold and is able to download the kubernetes configuration file. +- the binary has built in options to ask for backend storage components to be provisioned an delivered. + +### Architecture and failure modes + +Quantum Safe Storage is built from a number of components. Components are connected and interacting and therefore there are a number of failure modes that need to be considered for the test plan. + +Failure modes which we have testplans and cases for: + + - [Enduser](#enduser) + - [Storage protocol](#storage-protocol) + - [Filesystem](#filesystem) + - [Storage engine](#storage-engine) + - [Metadata store](#metadata-store) + - [Physical storage devices](#physical-storage-devices) + - [Interaction Enduser - Storage Protocol](#enduser-to-storage-protocol) + - [Interaction Storage Protocol - Filesystem](#storage-protocol---filesystem) + - [Interaction Filesystem - Storage Engine](#filesystem-to-storage-engine) + - [Interaction Storage Engine - Physical Storage Device](#storage-engine-to-physical-storage-device) + - [Interaction Storage Engine - Metadata Store](#storage-engine-to-metadata-store) + +![](img/failure_points.jpg) + +#### Enduser + +Failure scanerio's +- End user enters weird / wrong data at during QSS install +- End user deletes / changes things on the QSS engine host + - End user stops / deletes the storage protocol application of any of its configuration / temp storage facilities + - End user deletes the quantum safe file system and / or it configuration files + - End user deletes the storage enginer and / or its configuration and temp storage files. + + +Tests to conduct +#### Storage protocol + + +Failure scanerio's + +Storage protocol can be anything from IPFS, minio, sFTP and all the other protocols available. The possible failure modes for these are endless to test. For a couple of well knownm protocols we will do some basic testing +- **minio** +- **sFTP** +- **syncthing** +- **scp** + +For all these protocols a number of simple tests can he done: + - stop the protocol binary while data is being pushed in. restart the binary and see if normal operation commences (data loss eg. data in transfer when failure happened is accaptable). + - make changes to the config file (policy, parameters, etc) and see if normal operation commences. + +Tests to conduct +#### Filesystem + +Direct access to the filesystem and eliminates the dependency of the interface protocol. The filesystem provides a well knmow interface to browse, create, store and retrieve data in an easy and structured way. + +Tests to conduct. Testing is required to see if the filesystem can deal with: + - create a large number of nested directories and see if all this is causing problems + - create a large number fo small files and see if this is creating problems + - create a number of very large files (1GB+) and see if this is causing any problems. + - delete a (large) number of files + - delete a (large) number of derectories + - move a (large) number of files + - move a (large) number of directories + +#### Storage engine + +The storage engine takes files (data) and runs a "forward error correcting algorithm" on the data. The algorithm requires a "storage" policy to specify how to treat the inbound data and where to store the resuling data descriptions. This engine is non-redundant at this point in time and we should test how it behaves with certain failure modes. + +Tests to conduct: + - storage policy is change during operation of the storage engine + - physical storage devices are added + - physical storage devices are deleted + - storage policy (example - 16:4) is changed during operation + - other configuration components are changed + - physical storage access passwords + - encryption key + +#### Metadata store + +The metadatastore stores the information needed to retrieve the part of descriptions that make up an original piece of data. These metadata stores are redundant (3x?) and store all data required. + +Testing needs to be done on: + - corruption / deleting one out of the three metadata stores + - corruption / deleting two out of three metadata stores + - rebuilding failed metadata stores + - create high workloads of adding new data and retrieving stored data - no longer available in a local cache. + +#### Physical storage devices + +Physical storage devices are ZDB's on one the the TF Grid networks (Mainnet, Testnet, Devnet). ZDB's manage slices of physical disk space on HDD's and SSD's. They have a very simple operational model and API interface. ZDB's are operating in "append only" mode by default. + +Testing needs to be done: + - create a high workload writing and reading a the same time + - get + +#### Enduser to Storage Protocol + +Failure scanerio's + +Tests to conduct +#### Storage Protocol to Filesystem + +Failure scanerio's + +Tests to conduct +#### Filesystem to Storage Engine + +Failure scanerio's + +Tests to conduct +#### Storage Engine to Physical Storage Device + +Failure scanerio's + +Tests to conduct +#### Storage Engine to Metadata Store + +Failure scanerio's + +Tests to conduct diff --git a/collections/tfmanual/knowledge_base/technology/smartcontract_it/img/iac_overview.jpg b/collections/tfmanual/knowledge_base/technology/smartcontract_it/img/iac_overview.jpg new file mode 100644 index 0000000..2687c63 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/smartcontract_it/img/iac_overview.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/smartcontract_it/img/smart_contract_it_.jpg b/collections/tfmanual/knowledge_base/technology/smartcontract_it/img/smart_contract_it_.jpg new file mode 100644 index 0000000..e3c86d1 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/smartcontract_it/img/smart_contract_it_.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/smartcontract_it/img/smartcontract3_flow.jpg b/collections/tfmanual/knowledge_base/technology/smartcontract_it/img/smartcontract3_flow.jpg new file mode 100644 index 0000000..801a591 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/smartcontract_it/img/smartcontract3_flow.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/smartcontract_it/img/smartcontract_3bot.jpg b/collections/tfmanual/knowledge_base/technology/smartcontract_it/img/smartcontract_3bot.jpg new file mode 100644 index 0000000..c58ad70 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/smartcontract_it/img/smartcontract_3bot.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/smartcontract_it/img/smartcontract_iac.jpg b/collections/tfmanual/knowledge_base/technology/smartcontract_it/img/smartcontract_iac.jpg new file mode 100644 index 0000000..0718469 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/smartcontract_it/img/smartcontract_iac.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/smartcontract_it/img/smartcontract_it.jpg b/collections/tfmanual/knowledge_base/technology/smartcontract_it/img/smartcontract_it.jpg new file mode 100644 index 0000000..f4e4c88 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/smartcontract_it/img/smartcontract_it.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/smartcontract_it/smartcontract_3bot.md b/collections/tfmanual/knowledge_base/technology/smartcontract_it/smartcontract_3bot.md new file mode 100644 index 0000000..9d262b1 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/smartcontract_it/smartcontract_3bot.md @@ -0,0 +1,25 @@ +

Smart Contract For IT 3Bot Integration

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Use Cases](#use-cases) +- [Overview](#overview) + +*** + +## Introduction + +The Smart Contract for IT allows you, your company or your community to execute the storage and running of your files and applications securely with consensus and automatic billing. + +## Use Cases + +With the 3Bot integration, you can use smart contracts to define different sets of Internet resources you need for various types of work, such as storing files, running applications, and communicating across the network. + +You can use smart contracts to define different sets of Internet resources , such as storing files, running applications, communicate across the network, etc. + +You can also define a consensus mechanism and create multi-signatures for smart contract execution or completion to deliver appropriate digital services. + +## Overview + +![](img/smartcontract_3bot.jpg) \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/smartcontract_it/smartcontract_iac.md b/collections/tfmanual/knowledge_base/technology/smartcontract_it/smartcontract_iac.md new file mode 100644 index 0000000..841d268 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/smartcontract_it/smartcontract_iac.md @@ -0,0 +1,21 @@ +

Infrastructure As Code

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Overview](#overview) +- [Smart Contract](#smart-contract) + +*** + +## Introduction + +IAC = DevOps is a process framework that ensures collaboration between Development and Operations Team to deploy code to production environment faster in a repeatable and automated way. ... In simple terms, DevOps can be defined as an alignment between development and IT operations with better communication and collaboration. + +## Overview + +![](img/iac_overview.jpg) + +## Smart Contract + +![](img/smartcontract_iac.jpg) \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/smartcontract_it/smartcontract_it.md b/collections/tfmanual/knowledge_base/technology/smartcontract_it/smartcontract_it.md new file mode 100644 index 0000000..bec47ca --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/smartcontract_it/smartcontract_it.md @@ -0,0 +1,50 @@ +# Smart Contract for IT + +Ability for every developer to launch IT workloads on the TFGrid using our TFGrid primitives. + +![](img/smart_contract_it_.jpg) + + + +## Smart Contract Together with 3bot + +Is for TFGrid 2.0 + +![](img/smartcontract_it.jpg) + +3Bot is your virtual system administrator and can execute IT tasks on your behalf. + +**STEP 1: IT Experts create smart contracts:** + +IT experts create smart contracts describing what needs to be done in order to deploy this architecture. The smart contract has to be specific and describe each little detail of the IT architecture. The experts create knowledge for the 3bots (it's like god defining our DNA of our cells) + +**STEP 2: Business and or Enduser customers consume smart contracts**: + + Users have digital needs and in order to procure services for their digital needs they will find smart contracts describing applications (application setups) meeting their needs. Consumers will instruct their 3bot to deploy an IT workload following their requirements buy using a smart contract created + +* e.g. give me an archive of 1 PB in CH, e.g. deploy a CRM for 100 users, … +* e.g. deploy my new banking app feature X +* e.g. deploy my artificial intelligence data mining job for … + +**STEP 3: The 3bot executes the smart contract:** + +Creates & Registers the “IT” smart contract in the BCDB (Blockchain Database). This is a complete end-to-end deployment cycle for all sorts of IT deployments - both simple and complicated, bound to one location of many. The 3bot will provision all the compute and storage capacity needed to meet the IT architecture’s requirement and do all the commercial trades required to get this. It will then leave instructions for the nodes in a digital notary system in order for nodes to be able to grab instructions on what they have to do in order to meet smart contract completion. The 3bot remains the orchestrator for this smart contract execution and will store and secure all intermediate and final state information in the notary service (blockchain database). + +**STEP 4: Business IT Workload Stakeholders:** + +is optional but when required stakeholder can be defined to give consensus and sign off on the successful execution of the “IT smart contract” delivering the appropriate digital service. Stakeholders can be defined in a “multi signature” blockchain to provide sign off on regulatory, commercial and other business requirements. Approvals can include IT expert checks the quality of the code, a legal guy checks GDPR, a business person checks budget etc. + +**STEP 5: The capacity layer: 3 Nodes…** + +* thousands of 3 nodes can work together to execute and deliver the “IT Smart Contract” (if required) +* verify if consensus was reached between the business stakeholders +* verify the validity of the smart contract and download the “IT workload definition” +* download the right files to execute the smart contract and each file gets verified (signature) +* run the required processes and again signatures are checked to make sure the workload is pure. +* ensures that no person (hacker or IT person) can ever gain access or influence on the execution process. + + +## Remarks + +- in TFGrid 2.x smart contract for IT is implemented using ThreeFold Explorer and multisignature capabilities. +- in TFGrid 3.0 this is being re-implemented on TF-Chain on Parity/Substrate blockchain, to become a fully decentralized process. See [here](smartcontract_tfgrid3). diff --git a/collections/tfmanual/knowledge_base/technology/smartcontract_it/smartcontract_tfgrid3.md b/collections/tfmanual/knowledge_base/technology/smartcontract_it/smartcontract_tfgrid3.md new file mode 100644 index 0000000..a5818b5 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/smartcontract_it/smartcontract_tfgrid3.md @@ -0,0 +1,97 @@ +

Smart Contract on TFGrid 3.0

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Architecture](#architecture) +- [1: To deploy a workload, the user interacts with this smart contract pallet and calls: `create_contract` with the input being:](#1-to-deploy-a-workload-the-user-interacts-with-this-smart-contract-pallet-and-calls-create_contract-with-the-input-being) +- [2: The user sends the contractID and workload through the RMB to the destination Node.](#2-the-user-sends-the-contractid-and-workload-through-the-rmb-to-the-destination-node) +- [3: The Node sends consumption reports to the chain](#3-the-node-sends-consumption-reports-to-the-chain) +- [Notes](#notes) + +*** + +## Introduction + +From TFGrid 3.0, the 'Smart Contract for IT' concept for reserving capacity is fully decentralized and runs on TF-Chain, the ThreeFold blockchain infrastructure on Parity Substrate. + +## Architecture + +Two main components play a role in achieving a decentralised consensus between a user and a farmer. + +- TFGrid Substrate Database Pallet TFGrid +- TFGrid Smart Contract + +The TF-Grid Substrate Database will keep a record of all Entities, Twins, Nodes and Farmers in the TF-Grid network. This makes it easy to integrate the Smart Contract on Substrate as well since we can read from that storage in runtime. + +![flow](img/smartcontract3_flow.jpg) + +The Smart Contract on Substrate works as following: + +## 1: To deploy a workload, the user interacts with this smart contract pallet and calls: `create_contract` with the input being: + +The user must instruct his twin to create the contract. *This program containing his digital twin is yet to be defined.* A contract will always belong to a twin and to a node. This relationship is important because only the user's twin and target node's twin can update the contract. + +```js +contract = { + version: contractVersion, + contract_id: contractID, + twin_id: NumericTwinID for the contract, + // node_address is the node address. + node_id: NumericNodeID + // data is the encrypted deployment body. This encrypted the deployment with the **USER** public key. So only the user can read this data later on (or any other key that he keeps safe). + // this data part is read only by the user and can actually hold any information to help him reconstruct his deployment or can be left empty. + data: encrypted(deployment) // optional + // hash: is the deployment predictable hash. the node must use the same method to calculate the challenge (bytes) to compute this same hash. + //used for validating the deployment from node side. + deployment_hash: hash(deployment), + // public_ips: number of ips that need to be reserved by the contract and used by the deployment + public_ips: 0, + state: ContractState (created, deployed), + public_ips_list: list of public ips on this contract +} +``` + +The `node_id` field is the target node's ID. A user can do lookup for a node to find its corresponding ID. + +The workload data is encrypted by the user and contains the workload definition for the node. + +If `public_ips` is specified, the contract will reserve the number of public ips requested on the node's corresponding farm. If there are not enough ips available an error will be returned. If the contract is canceled by either the user or the node, the IPs for that contract will be freed. + +This pallet saves this data to storage and returns the user a `contract_id`. + +## 2: The user sends the contractID and workload through the RMB to the destination Node. + +The Node reads from the [RMB](https://github.com/threefoldtech/rmb) and sees a deploy command, it reads the contractID and workload definition from the payload. +It decodes the workload and reads the contract from chain using the contract ID, the Node will check if the user that created the contract and the deployment hash on the contract is the same as what the Node receives over RMB. If all things check out, the Node deploys the workload. + +## 3: The Node sends consumption reports to the chain + +The Node periodically sends consumption reports back to the chain for each deployed contract. The chain will compute how much is being used and will bill the user based on the farmers prices (the chain can read these prices by quering the farmers storage and reading the pricing data). See [PricingPolicy](https://github.com/threefoldtech/substrate-pallets/blob/03a5823ce79200709d525ec182036b47a60952ef/pallet-tfgrid/src/types.rs#L120). + +A report looks like: + +json +``` +{ + "contract_id": contractID, + "timestamp": "timestampOfReport", + "cru": cpus, + "sru": ssdInBytes, + "hru": hddInBytes, + "mru": memInBytes, + "nru": trafficInBytes +} +``` + +The node can call `add_reports` on this module to submit reports in batches. + +Usage of SU, CU and NU will be computed based on the prices and the rules that Threefold set out for cloud pricing. + +Billing will be done in Database Tokens and will be send to the corresponding farmer. If the user runs out of funds the chain will set the contract state to `cancelled` or it will be removed from storage. The Node needs to act on this 'contract cancelled' event and decommission the workload. + +The main currency of this chain. More information on this is explained here: TODO + +## Notes + +Sending the workloads encrypted to the chain makes sure that nobody except the user can read his deployment data. It also facilitates a way for the user to recreate his workload data from the chain. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/smartcontract_it/smartcontract_toc.md b/collections/tfmanual/knowledge_base/technology/smartcontract_it/smartcontract_toc.md new file mode 100644 index 0000000..f047e9a --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/smartcontract_it/smartcontract_toc.md @@ -0,0 +1,7 @@ +

Smart Contract IT

+ +

Table of Contents

+ +- [Introduction](./smartcontract_tfgrid3.md) +- [Infrastructure As Code (IAC)](./smartcontract_iac.md) +- [3Bot Integration](./smartcontract_3bot.md) \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/technology_toc.md b/collections/tfmanual/knowledge_base/technology/technology_toc.md new file mode 100644 index 0000000..d496344 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/technology_toc.md @@ -0,0 +1,16 @@ +

Technology

+ +This section covers the technology behind the ThreeFold Grid. ThreeFold has created an amazing technology system to allow anyone to host their applications and data close to them. + +To build on the ThreeFold Grid, refer to the [Developers](../../documentation/developers/developers.md) section. + +

Table of Contents

+ +- [How It Works](./grid3_howitworks.md) +- [Grid Concepts](./concepts/concepts_readme.md) +- [Primitives](./primitives/primitives_toc.md) +- [Quantum Safe Storage](./qsss/qsss_home.md) +- [Smart Contract IT](./smartcontract_it/smartcontract_toc.md) + + + diff --git a/collections/tfmanual/knowledge_base/technology/tfgrid_primitives.md b/collections/tfmanual/knowledge_base/technology/tfgrid_primitives.md new file mode 100644 index 0000000..de46ec7 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/tfgrid_primitives.md @@ -0,0 +1,44 @@ +![](img/layer0_.jpg) + +# TFGrid Low Level Functions = Primitives + +The following are the low level constructs which can be deployed on the TFGrid. + +The following functionalities allow you to create any solutions on top of the grid. +Any application which can run on linux can run on the TFGrid. + +### Compute + +- [ZKube](zkube) : kubernetes deployment +- [ZMachine](zmachine) : the container or virtual machine running inside ZOS +- [CoreX](corex) : process manager (optional), can be used to get remote access to your zmachine + +Uses [Compute Units = CU](cloudunits). + +### Storage (uses SU) + +- [ZOS Filesystem](zos_fs) : deduped immutable filesystem +- [ZOS Mount](zmount) : a part of a SSD (fast disk), mounted underneath your zmachine +- [Quantum Safe Filesystem](qsfs) : unbreakable storage system (secondary storage only) +- [Zero-DB](zdb) : the lowest level storage primitive, is a key value stor, used underneath other storage mechanisms typically +- [Zero-Disk](zdisk) : OEM only, virtual disk format + +Uses [Storage Units = SU](cloudunits). + +### Network (uses NU) + +- znet : private network between zmachines +- [Planetary Network](planetary_network) : peer2peer end2end encrypted global network +- znic : interface to planetary network +- [WebGateway](webgw) : interface between internet and znet + + +Uses [Network Units = SU](cloudunits). + +## Zero-OS Advantages + +!!!include:zos_advantages + + +!!!def alias:tfgrid_primitives,grid_primitives + diff --git a/collections/tfmanual/knowledge_base/technology/zos/benefits/deterministic_deployment.md b/collections/tfmanual/knowledge_base/technology/zos/benefits/deterministic_deployment.md new file mode 100644 index 0000000..c312a37 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/zos/benefits/deterministic_deployment.md @@ -0,0 +1,25 @@ + +## Deterministic Deployment + +- flists concept (deduped vfilesystem, no install, ...) + +The Dedupe filesystem flist uses fuse = interface which allows you to create the file system interface in user space, it is a virtual filesystem. +Metadata is exposed. The system sees the full tree of the image, but data itself not there, data is downloaded whenever they are accessed. + +There are multiple ways to create an flist: + - Convert an existing docker image which is hosted on the docker hub + - Push an archive like a tjz on the hub + - A library and CLI tool exist to build the flist from scratch: doing it this way, the directory is locally populated, and the flist is then created from the CLI tool. + - A [GitHub action](https://github.com/threefoldtech/publish-flist) allows to build a flist directly from GitHub action, useful for developers on GitHub + +Be aware that the flist system works a bit differently than the usual deployment of containers (dockers), which doesn't do mounting of volumes from your local disk into container for configuration. +With flists you need to modify your image to get configuration from environment. This is basically how docker was originally intended to be used. + + - Smart contract for IT + The smart contract for IT concept is applicable to any workload: containers, VMs, all gateways primitives, volumes, kubernetes and network. + It is a static agreement between farmer and user about deployment of an IT workload. + + - no dynamic behavior for deployment at runtime + + - no process can start unless the files are 100% described on flist level + \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/zos/benefits/docker_compatibility.md b/collections/tfmanual/knowledge_base/technology/zos/benefits/docker_compatibility.md new file mode 100644 index 0000000..c2e0221 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/zos/benefits/docker_compatibility.md @@ -0,0 +1,14 @@ +# Docker compatibility + + +Docker is being recognized as the market leader as a technology provider for containerization technology. Many enterprise and software developers have adopted Docker's technology stack to built a devops (development and operations, more information [here](https://en.wikipedia.org/wiki/DevOps)) "train" (internal process, a way of developing and delivering software) for delivering updates to applications and new applications. Regardless of how this devops "train" is organised it always spits out docker (application) images and deployments methods. Hercules is built with a 100% backwards compatibility in mind to the created docker images and deployment methods. + +A major step in accepting and importing Docker images is to transpose docker images to the [ZOS Filesystem](zos_fs). + +## Features + +- 100 % backwards compatible with all existing and new to be created docker images. +- Easy import and transpose facility +- deduplicated application deployment simplifying aplication image management and versioning + +!!!include:zos_toc \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/zos/benefits/img/network_architecture.jpg b/collections/tfmanual/knowledge_base/technology/zos/benefits/img/network_architecture.jpg new file mode 100644 index 0000000..4732889 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/zos/benefits/img/network_architecture.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/zos/benefits/img/network_architecture2.jpg b/collections/tfmanual/knowledge_base/technology/zos/benefits/img/network_architecture2.jpg new file mode 100644 index 0000000..c5308ed Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/zos/benefits/img/network_architecture2.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/zos/benefits/network_wall.md b/collections/tfmanual/knowledge_base/technology/zos/benefits/network_wall.md new file mode 100644 index 0000000..3e47799 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/zos/benefits/network_wall.md @@ -0,0 +1,38 @@ +# Network wall + +![](img/webgateway.jpg) + + +> the best security = no network = no incoming tcp/ip from internet to containers  + +This is done via sockets. + +- TCP router client opens up socket to TCP router server, residing on the web gateway. +- When http arrives on this tcp router server, payload van http is brought back over socket to tcp router client. +- TCP router client sends http request that is made to server residing in the container. +- No TCP comes from outside world to the container, creating the most secure connection possible. +- The TCP router client opens the socket, TCP router server that received http request throws it on the socket. +- On the socket there is only data that comes in, which is replayed. TCP router client does a https request. + +This mechanism is now implemented for https, but in the future also other protocols such as sql, redis, http … can be supported. + +The end result is that only data goes over the network. +If container can no longer go to local tcp stack but only to make outgoing connection to the gateway, then there is no longer tcp coming’s in from outside. + +This is what we call the 'Network wall'. +As a consequence, no tcp/ip is coming in AT ALL, making the full set-up reach unprecedented security. + + +## More detailed explanation + +- Containers are behind NAT. We don’t allow traffic coming in. +- All connection needs to come from container to the outside world. = very neat as network security. +- Connection needs to be outwards, secures against DDOS and other hacking etc, nothing to connect to. +- How to access it ? Drive traffic inside the container: proxy or load balancer which is exposed publicly, rest of the traffic in private network, not accessible. +- So you can limit the number of containers that are really accessible from the outside world. +- You don’t have to worry about ‘how to secure my DB’ as my DB is not exposed, only accessible in Wireguard private network. +- In containers you can specify to have specific IPv6 address, so deploy reverse proxy in container which has public access, = entry point in the network, deploy reverse tcp connection (=tcp router client), connects to the gateways and allows incoming connection. + +!!!def alias:network_wall,net_wall + +!!!include:zos_toc diff --git a/collections/tfmanual/knowledge_base/technology/zos/benefits/p2p_networking.md b/collections/tfmanual/knowledge_base/technology/zos/benefits/p2p_networking.md new file mode 100644 index 0000000..a2ed92c --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/zos/benefits/p2p_networking.md @@ -0,0 +1,30 @@ +![](img/network_architecture2.jpg) + +# Peer2Peer Network Concept + +## Introduction + +True peer-to-peer is a principle that exists everywhere within Threefold's technology stack, especially on its Network Architecture. Farmers produce IT capacity by connecting hardwares to the network and installing Zero-OS. The peer-to-peer network of devices forms the TF Grid. This TF Grid is a universal substrate of which a large variety of IT workloads exist and run. + +## Peer-to-peer networking + +The TF Grid is built by 3Nodes (hardware + Zero-OS) that are connected to the internet by using the IPv6 protocol. To future-proof this grid, IPv6 has been chosen as ThreeFold Grid's native networking technology. The TF Grid operates on IPv6 (where available) and creates peer-to-peer network connections between all the containers (and other primitives). Please find more about Zero-OS primitives in our [SDK manual](manual3_home) + +This creates a many-to-many web of (encrypted) point-to-point network connections which together make a (private) secure **overlay network**. This network is completely private and connects only the primitives that have been deployed in your network. + +TF Network Characteristics: + +- Connect all containers point-to-point; +- All traffic is encrypted; +- High performance; +- The shortest path between two end-points, multi-homed containers; +- Could span large geographical areas and create virtual data centers; +- All created and made operational **without** public access from the internet. + +## Existing Enterprise Private Networks + +At Threefold, we are aware of the existence of private networks, IPsec, VPN, WAN's and more. We have the facility to create bridges to make those networks part of the deployed private overlay networks. This is in an early stage development, but with the right level(s) of interest this could be built out and carried out in the near future. + +![](img/network_architecture.jpg) + +!!!def alias:quantumsafe_network_concept,qsn_concept \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/zos/benefits/unbreakable_storage.md b/collections/tfmanual/knowledge_base/technology/zos/benefits/unbreakable_storage.md new file mode 100644 index 0000000..3bef57f --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/zos/benefits/unbreakable_storage.md @@ -0,0 +1,14 @@ + +## Unbreakable Storage + +- Unlimited history +- Survives network, datacenter or node breakdown +- No silent corruption possible +- Quantum safe (data cannot be decrypted by quantum computers) as long as quantum computer has no access to the metadata +- Self-healing & autocorrecting + + +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. + +For more information, read [this documentation](../../primitives/storage/qsfs.md). \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/zos/benefits/zero_boot.md b/collections/tfmanual/knowledge_base/technology/zos/benefits/zero_boot.md new file mode 100644 index 0000000..ea605fd --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/zos/benefits/zero_boot.md @@ -0,0 +1,40 @@ +## Zero Boot + +> Zero Boot = Zero-OS boot process + +ZOS Boot is a boot facility that allows 3nodes to boot from network boot servers located in the TF Grid. This boot mechanism creates as little as possible operational and administration overhead. ZOS Boot is a crucial part for enabling autonomy by *not* having the operating system installed on local disks on 3nodes. With a boot network facility and no local operating system files you immediate erase a number of operational and administration tasks: + +- to install the operating system to start with +- to keep track of which systems run which version of the operating system (especially in large setups this is a complicated and error prone task) +- to keep track of patches and bug fixes that have been applied to systems + +That's just the administration and operational part of maintaining a server estate with local installed operating system. On the security side of things the benefits are even greater: +- many hacking activities are geared towards adding to or changing parts of the operating system files. This is a threat from local physical access to servers as well as over the network. When there are no local operating system files installed this threat does not exist. +- accidental overwrite, delete or corruption of operating system files. Servers run many processes and many of these processes have administrative access to be able to do what they need to do. Accidental deletion or overwrites of crucial files on disk will make the server fail a reboot. +- access control. I there is no local operating system installed access control, user rights etc etc. are unnecessary functions and features and do not have to be implemented. + +### How + +In this image from fs, a small partition is mounted in memory to start booting the machine, it gets IPXE (downloads what it needs), and then 0-OS boots. +After that, going to the hub, downloading different lists. + +There is 1 main flist that triggers downloads of multiple flists. Read more [here](../../../flist/flist.md). +In there all the components/daemons that do part of the 0-OS. +Also the download of the zos-bins, i.e. external binaries are triggered this way (https://hub.grid.tf/tf-zos-bins). + +The core components of zero-os can be found in: [Zero-OS repo](https://github.com/threefoldtech/zos/tree/master/bins/packages) = If something changes in the directory, a workflow is triggered to rebuild the full flist and push it to the hub. + +When a node discovers there is a new version of one of these lists on the hub, it downloads it, restarts the daemon with the new version. +Over the lifetime of the node, it keeps pulling on the hub directories to check whether new daemons/flists/binaries are available and whether things need get upgraded. + +### Features + +The features of ZOS Boot are: + +- no local operating system installed +- network boot from the grid to get on the grid +- decreased administrative and operational work, allowing for autonomous operations +- increased security +- increased efficiency (deduplication, only one version of the OS stored for thousands of servers) +- all server storage space is available for enduser workloads (average operating system size around 10GB) +- bootloader is less than 1MB in size and can be presented to the servers as a PXE script, USB boot device, ISO boot image. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/zos/benefits/zero_hacking_surface.md b/collections/tfmanual/knowledge_base/technology/zos/benefits/zero_hacking_surface.md new file mode 100644 index 0000000..10a41cf --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/zos/benefits/zero_hacking_surface.md @@ -0,0 +1,6 @@ +## Zero Hacking Surface + +Zero does not mean is not possible but we use this term to specificy that we minized the attack surface for hackers. + +- There is no shell/server interface on zero-os level (our operating system) +- There are no hidden or unintended processes running which are not prevalidatedOne comment: still ssh server running with keys of a few people on each server, not yet disabled. To be disabled in the near future, now still useful to debug but it is a backdoor. The creation of a new primitive where the farmer agrees to give access to administrators under analysis. This way, when a reservation is sent to a node, a ssh server is booted up with chosen key to allow admins to go in. diff --git a/collections/tfmanual/knowledge_base/technology/zos/benefits/zero_install.md b/collections/tfmanual/knowledge_base/technology/zos/benefits/zero_install.md new file mode 100644 index 0000000..48e8b08 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/zos/benefits/zero_install.md @@ -0,0 +1,19 @@ +## Zero-OS Installation + +The Zero-OS is delivered to the 3Nodes over the internet network (network boot) and does not need to be installed. + +### 3Node Install + +1. Acquire a computer (server). +2. Configure a farm on the TFGrid explorer. +3. Download the bootloader and put on a USB stick or configure a network boot device. +4. Power on the computer and connect to the internet. +5. Boot! The computer will automatically download the components of the operating system (Zero-OS). + +The actual bootloader is very small. It brings up the network interface of your computer and queries TFGeid for the remainder of the boot files needed. + +The operating system is not installed on any local storage medium (hard disk, ssd). Zero-OS is stateless. + +The mechanism to allow this to work in a safe and efficient manner is a ThreeFold innovation called our container virtual filesystem. + +For more information on setting a 3Node, please refer to the [Farmers documentation](../../../farmers/farmers.md). \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/zos/benefits/zos_advantages.md b/collections/tfmanual/knowledge_base/technology/zos/benefits/zos_advantages.md new file mode 100644 index 0000000..7569789 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/zos/benefits/zos_advantages.md @@ -0,0 +1,134 @@ +

Zero-OS Advantages

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Zero-OS Installation](#zero-os-installation) + - [3Node Install](#3node-install) +- [Unbreakable Storage](#unbreakable-storage) +- [Zero Hacking Surface](#zero-hacking-surface) +- [Zero Boot](#zero-boot) + - [How](#how) + - [Features](#features) +- [Deterministic Deployment](#deterministic-deployment) +- [Zero-OS Protect](#zero-os-protect) + +## Introduction + +We present the many advantages of Zero-OS. + +## Zero-OS Installation + +The Zero-OS is delivered to the 3Nodes over the internet network (network boot) and does not need to be installed. + +### 3Node Install + +1. Acquire a computer (server). +2. Configure a farm on the TFGrid explorer. +3. Download the bootloader and put on a USB stick or configure a network boot device. +4. Power on the computer and connect to the internet. +5. Boot! The computer will automatically download the components of the operating system (Zero-OS). + +The actual bootloader is very small. It brings up the network interface of your computer and queries TFGeid for the remainder of the boot files needed. + +The operating system is not installed on any local storage medium (hard disk, ssd). Zero-OS is stateless. + +The mechanism to allow this to work in a safe and efficient manner is a ThreeFold innovation called our container virtual filesystem. + +For more information on setting a 3Node, please refer to the [Farmers documentation](../../../../documentation/farmers/farmers.md). + + +## Unbreakable Storage + +- Unlimited history +- Survives network, datacenter or node breakdown +- No silent corruption possible +- Quantum safe (data cannot be decrypted by quantum computers) as long as quantum computer has no access to the metadata +- Self-healing & autocorrecting + + +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. + +For more information, read [this documentation](../../primitives/storage/qsfs.md). + +## Zero Hacking Surface + +Zero does not mean is not possible but we use this term to specificy that we minized the attack surface for hackers. + +- There is no shell/server interface on zero-os level (our operating system) +- There are no hidden or unintended processes running which are not prevalidatedOne comment: still ssh server running with keys of a few people on each server, not yet disabled. To be disabled in the near future, now still useful to debug but it is a backdoor. The creation of a new primitive where the farmer agrees to give access to administrators under analysis. This way, when a reservation is sent to a node, a ssh server is booted up with chosen key to allow admins to go in. + +## Zero Boot + +> Zero Boot = Zero-OS boot process + +ZOS Boot is a boot facility that allows 3nodes to boot from network boot servers located in the TF Grid. This boot mechanism creates as little as possible operational and administration overhead. ZOS Boot is a crucial part for enabling autonomy by *not* having the operating system installed on local disks on 3nodes. With a boot network facility and no local operating system files you immediate erase a number of operational and administration tasks: + +- to install the operating system to start with +- to keep track of which systems run which version of the operating system (especially in large setups this is a complicated and error prone task) +- to keep track of patches and bug fixes that have been applied to systems + +That's just the administration and operational part of maintaining a server estate with local installed operating system. On the security side of things the benefits are even greater: +- many hacking activities are geared towards adding to or changing parts of the operating system files. This is a threat from local physical access to servers as well as over the network. When there are no local operating system files installed this threat does not exist. +- accidental overwrite, delete or corruption of operating system files. Servers run many processes and many of these processes have administrative access to be able to do what they need to do. Accidental deletion or overwrites of crucial files on disk will make the server fail a reboot. +- access control. I there is no local operating system installed access control, user rights etc etc. are unnecessary functions and features and do not have to be implemented. + +### How + +In this image from fs, a small partition is mounted in memory to start booting the machine, it gets IPXE (downloads what it needs), and then 0-OS boots. +After that, going to the hub, downloading different lists. + +There is 1 main flist that triggers downloads of multiple flists. Read more [here](../../../../documentation/developers/flist/flist.md). +In there all the components/daemons that do part of the 0-OS. +Also the download of the zos-bins, i.e. external binaries are triggered this way (https://hub.grid.tf/tf-zos-bins). + +The core components of zero-os can be found in: [Zero-OS repo](https://github.com/threefoldtech/zos/tree/master/bins/packages) = If something changes in the directory, a workflow is triggered to rebuild the full flist and push it to the hub. + +When a node discovers there is a new version of one of these lists on the hub, it downloads it, restarts the daemon with the new version. +Over the lifetime of the node, it keeps pulling on the hub directories to check whether new daemons/flists/binaries are available and whether things need get upgraded. + +### Features + +The features of ZOS Boot are: + +- no local operating system installed +- network boot from the grid to get on the grid +- decreased administrative and operational work, allowing for autonomous operations +- increased security +- increased efficiency (deduplication, only one version of the OS stored for thousands of servers) +- all server storage space is available for enduser workloads (average operating system size around 10GB) +- bootloader is less than 1MB in size and can be presented to the servers as a PXE script, USB boot device, ISO boot image. + + +## Deterministic Deployment + +- flists concept (deduped vfilesystem, no install, ...) + +The Dedupe filesystem flist uses fuse = interface which allows you to create the file system interface in user space, it is a virtual filesystem. +Metadata is exposed. The system sees the full tree of the image, but data itself not there, data is downloaded whenever they are accessed. + +There are multiple ways to create an flist: + - Convert an existing docker image which is hosted on the docker hub + - Push an archive like a tjz on the hub + - A library and CLI tool exist to build the flist from scratch: doing it this way, the directory is locally populated, and the flist is then created from the CLI tool. + - A [GitHub action](https://github.com/threefoldtech/publish-flist) allows to build a flist directly from GitHub action, useful for developers on GitHub + +Be aware that the flist system works a bit differently than the usual deployment of containers (dockers), which doesn't do mounting of volumes from your local disk into container for configuration. +With flists you need to modify your image to get configuration from environment. This is basically how docker was originally intended to be used. + + - Smart contract for IT + The smart contract for IT concept is applicable to any workload: containers, VMs, all gateways primitives, volumes, kubernetes and network. + It is a static agreement between farmer and user about deployment of an IT workload. + + - no dynamic behavior for deployment at runtime + + - no process can start unless the files are 100% described on flist level + +## Zero-OS Protect + +- The operating system of the 3node (Zero-OS) is made to exist in environments without the presence of technical knowhow. 3nodes are made to exist everywhere where network meet a power socket. The OS does not have a login shell and does not allow people to log in with physical access to a keyboard and screen nor does it allows logins over the network. There is no way the 3node accepts user initiated login attempts. +- For certified capacity a group of known strategic vendors are able to lock the [BIOS](https://en.wikipedia.org/wiki/BIOS) of their server range and make sure no-one but them can unlock and change features present in the BIOS. Some vendors have an even higher degree of security and can store private keys in chips in side the computer to provider unique identification based on private keys or have mechanisms to check wether the server has been opened / tampered with in the transportation from the factory / vendor to the Farmer. All of this leads to maximum protection on the hardware level. +- 3nodes boot from a network facility. This means that they do not have local installed operating system files. Also they do not have a local username / password file or database. Viruses and hackers have very little work with if there are no local files to plant viruses or trojan horses in. Also the boot facility provides hashes for the files sent to the booting 3node so that the 3node can check wether is receives the intended file, no more man in the middle attacks. +- The zos_fs provides the same hash and file check mechanism. Every application file presented to a booting container has a hash describing it and the 3node on which the container is booting can verify if the received file matches the previously received hash. +- Every deployment of one or more applications starts with the creation of a (private) [znet](../../primitives/network/znet.md). This private overlay network is single tenant and not connected to the public internet. Every application or service that is started in a container in this overlay network is connection to all of the other containers via a point to point, encrypted network connection. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/zos/benefits/zos_advantages_toc.md b/collections/tfmanual/knowledge_base/technology/zos/benefits/zos_advantages_toc.md new file mode 100644 index 0000000..5c18b95 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/zos/benefits/zos_advantages_toc.md @@ -0,0 +1,10 @@ +# Zero-OS Advantages + +

Table of Contents

+ +- [Zero-OS Installation](./zero_install.md) +- [Unbreakable Storage](./unbreakable_storage.md) +- [Zero Hacking Surface](./zero_hacking_surface.md) +- [Booting Process](./zero_boot.md) +- [Deterministic Deployment](./deterministic_deployment.md) +- [Zero-OS Protect](./zos_protect.md) \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/zos/benefits/zos_monitoring.md b/collections/tfmanual/knowledge_base/technology/zos/benefits/zos_monitoring.md new file mode 100644 index 0000000..90fc551 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/zos/benefits/zos_monitoring.md @@ -0,0 +1,39 @@ +# ZOS Monitoring + + +ZOS collects data from deployed solutions and applications and presents data in a well known open source monitoring solution called prometheus. + +Prometheus is an open-source systems monitoring and alerting toolkit originally built at SoundCloud. Since its inception in 2012, many companies and organizations have adopted Prometheus, and the project has a very active developer and user community. It is now a standalone open source project and maintained independently of any company. + +For more elaborate overviews of Prometheus, see [here](https://prometheus.io/) + +### Features + +- a multi-dimensional data model with time series data identified by metric name and key/value pairs +- PromQL, a flexible query language to leverage this dimensionality +- no reliance on distributed storage; single server nodes are autonomous +- time series collection happens via a pull model over HTTP +- pushing time series is supported via an intermediary gateway +- targets are discovered via service discovery or static configuration +- multiple modes of graphing and dashboarding support + +### Components + +The Prometheus ecosystem consists of multiple components, many of which are optional: + +- the main Prometheus server which scrapes and stores time series data +- client libraries for instrumenting application code +- a push gateway for supporting short-lived jobs +- special-purpose exporters for services like HAProxy, StatsD, Graphite, etc. +- an alertmanager to handle alerts +- various support tools + + +### Roadmap + +- ONLY for OEM partners today + + +!!!def alias:zos_monitoring + +!!!include:zos_toc diff --git a/collections/tfmanual/knowledge_base/technology/zos/benefits/zos_protect.md b/collections/tfmanual/knowledge_base/technology/zos/benefits/zos_protect.md new file mode 100644 index 0000000..040d8c4 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/zos/benefits/zos_protect.md @@ -0,0 +1,7 @@ +# ZOS Protect + +- The operating system of the 3node (Zero-OS) is made to exist in environments without the presence of technical knowhow. 3nodes are made to exist everywhere where network meet a power socket. The OS does not have a login shell and does not allow people to log in with physical access to a keyboard and screen nor does it allows logins over the network. There is no way the 3node accepts user initiated login attempts. +- For certified capacity a group of known strategic vendors are able to lock the [BIOS](https://en.wikipedia.org/wiki/BIOS) of their server range and make sure no-one but them can unlock and change features present in the BIOS. Some vendors have an even higher degree of security and can store private keys in chips in side the computer to provider unique identification based on private keys or have mechanisms to check wether the server has been opened / tampered with in the transportation from the factory / vendor to the Farmer. All of this leads to maximum protection on the hardware level. +- 3nodes boot from a network facility. This means that they do not have local installed operating system files. Also they do not have a local username / password file or database. Viruses and hackers have very little work with if there are no local files to plant viruses or trojan horses in. Also the boot facility provides hashes for the files sent to the booting 3node so that the 3node can check wether is receives the intended file, no more man in the middle attacks. +- The zos_fs provides the same hash and file check mechanism. Every application file presented to a booting container has a hash describing it and the 3node on which the container is booting can verify if the received file matches the previously received hash. +- Every deployment of one or more applications starts with the creation of a (private) [znet](../../primitives/network/znet.md). This private overlay network is single tenant and not connected to the public internet. Every application or service that is started in a container in this overlay network is connection to all of the other containers via a point to point, encrypted network connection. \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/zos/img/zero_os_overview.jpg b/collections/tfmanual/knowledge_base/technology/zos/img/zero_os_overview.jpg new file mode 100644 index 0000000..0550294 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/zos/img/zero_os_overview.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/zos/img/zos22.png b/collections/tfmanual/knowledge_base/technology/zos/img/zos22.png new file mode 100644 index 0000000..a40cfa3 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/zos/img/zos22.png differ diff --git a/collections/tfmanual/knowledge_base/technology/zos/img/zos_network_overview.jpg b/collections/tfmanual/knowledge_base/technology/zos/img/zos_network_overview.jpg new file mode 100644 index 0000000..febb1d6 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/zos/img/zos_network_overview.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/zos/img/zos_overview_compute_storage.jpg b/collections/tfmanual/knowledge_base/technology/zos/img/zos_overview_compute_storage.jpg new file mode 100644 index 0000000..23257e5 Binary files /dev/null and b/collections/tfmanual/knowledge_base/technology/zos/img/zos_overview_compute_storage.jpg differ diff --git a/collections/tfmanual/knowledge_base/technology/zos/zos.md b/collections/tfmanual/knowledge_base/technology/zos/zos.md new file mode 100644 index 0000000..5522e68 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/zos/zos.md @@ -0,0 +1,44 @@ +![](img/zos22.png) + +# Zero-OS + +![](img/zero_os_overview.jpg) + + +!!!include:whatis_zos + +### Imagine an operating system with the following benefits + +- upto 10x more efficient for certain workloads (e.g. storage) +- no install required +- all files are deduped for the VM's, containers and the ZOS itself, no more data duplicated filesystems +- the hacking footprint is super small, which leads to much more safe systems + - every file is fingerprinted and gets checked at launch time of an application + - there is no shell or server interface on the operating system + - the networks are end2end encrypted between all Nodes +- there is the possibility to completely disconnect the compute/storage from the network service part which means hackers have a lot less chance to get to the data. +- a smart contract for IT layer allows groups of people to deploy IT workloads with concensus and full control +- all workloads which can run on linux can run on Zero-OS but in a much more controlled, private and safe way + +> ThreeFold has created an operating system from scratch, we used the Linux kernel and its components and then build further on it, we have been able to achieve all above benefits. + +## The requirements for our TFGrid based on Zero OS are: + +- **Autonomy**: TF Grid needs to create compute, storage and networking capacity everywhere. We could not rely on a remote (or a local) maintenance of the operating system by owners or operating system administrators. +- **Simplicity**: An operating system should be simple, able to exist anywhere, for anyone, good for the planet. +- **Stateless**. In a grid (peer-to-peer) set up, the sum of the components is providing a stable basis for single elements to fail and not bring the whole system down. Therefore, it is necessary for single elements to be stateless, and the state needs to be stored within the grid. + + + +!!!def alias:zos,zero-os,threefold_operating_system,tf_os,threefold_os + + + + \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/zos/zos_compute_storage.md b/collections/tfmanual/knowledge_base/technology/zos/zos_compute_storage.md new file mode 100644 index 0000000..54985b7 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/zos/zos_compute_storage.md @@ -0,0 +1,6 @@ +## ZOS compute storage overview + +![](img/zos_overview_compute_storage.jpg) + + +!!!include:zos_toc \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/zos/zos_install.md b/collections/tfmanual/knowledge_base/technology/zos/zos_install.md new file mode 100644 index 0000000..1f32caf --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/zos/zos_install.md @@ -0,0 +1 @@ +# Zero-OS Install diff --git a/collections/tfmanual/knowledge_base/technology/zos/zos_install_mechanism.md b/collections/tfmanual/knowledge_base/technology/zos/zos_install_mechanism.md new file mode 100644 index 0000000..4bc9043 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/zos/zos_install_mechanism.md @@ -0,0 +1,21 @@ +### Zero OS install + +The Zero-OS is delivered to the 3Nodes over the internet network (network boot) and does not need to be installed. + +# Zero-OS Install Mechanism + +## Stateless Install + +1. Acquire a computer (server). +2. Configure a farm on the TFGrid explorer. +3. Download the bootloader and put on a USB stick or configure a network boot device. +4. Power on the computer and connect to the internet. +5. Boot! The computer will automatically download the components of the operating system (Zero-OS). + +The actual bootloader is very small. It brings up the network interface of your computer and queries TFGrid for the remainder of the boot files needed. + +The operating system is not installed on any local storage medium (hard disk, ssd). Zero-OS is stateless. + +The mechanism to allow this to work in a safe and efficient manner is a ThreeFold innovation called our container virtual filesystem. This is explained in more detail [here](flist) + +!!!def alias:zero_os_install \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/zos/zos_network.md b/collections/tfmanual/knowledge_base/technology/zos/zos_network.md new file mode 100644 index 0000000..004175b --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/zos/zos_network.md @@ -0,0 +1,6 @@ +# ZOS network overview + +![](img/zos_network_overview.jpg) + + +!!!include:zos_toc diff --git a/collections/tfmanual/knowledge_base/technology/zos_advantages.md b/collections/tfmanual/knowledge_base/technology/zos_advantages.md new file mode 100644 index 0000000..3a61099 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/zos_advantages.md @@ -0,0 +1,6 @@ +- [Zero Install](zero_install) +- [Unbreakable Storage](unbreakable_storage) +- [Zero Hacking Surface](zero_hacking_surface) +- [Zero Boot](zero_boot) +- [Deterministic Deployment](deterministic_deployment) +- [ZOS Protect](zos_protect) \ No newline at end of file diff --git a/collections/tfmanual/knowledge_base/technology/zos_toc.md b/collections/tfmanual/knowledge_base/technology/zos_toc.md new file mode 100644 index 0000000..29f3202 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/zos_toc.md @@ -0,0 +1,24 @@ +## Zero OS as generator for Compute, Storage, Network capacity. + +### Compute (uses CU) + +- [ZKube](zkube) : kubernetes deployment +- [ZMachine](zmachine) : the container or virtual machine running inside ZOS +- [CoreX](corex) : process manager (optional), can be used to get remote access to your zmachine + +### Storage (uses SU) + +- [ZOS Filesystem](zos_fs) : deduped immutable filesystem +- [ZOS Mount](zmount) : a part of a SSD (fast disk), mounted underneath your zmachine +- [Quantum Safe Filesystem](!@qsss_home) : unbreakable storage system (secondary storage only) +- [Zero-DB](zdb) : the lowest level storage primitive, is a key value stor, used underneath other storage mechanisms typically +- [Zero-Disk](zdisk) : OEM only, virtual disk format + +### Network (uses NU) + +- zos_net : private network between zmachines +- [Planetary Network](planetary_network) : peer2peer end2end encrypted global network +- [WebGateway](webgw) : interface between internet and znet +- zos_bridge: network interface to planetary_net or public ipaddress + + diff --git a/collections/tfmanual/knowledge_base/technology/zos_tools/flist_hub.md b/collections/tfmanual/knowledge_base/technology/zos_tools/flist_hub.md new file mode 100644 index 0000000..45caca6 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/zos_tools/flist_hub.md @@ -0,0 +1,4 @@ +!!!include:flist_hub_ + +!!!def alias:tfhub,zflist_hub,flist_hub + diff --git a/collections/tfmanual/knowledge_base/technology/zos_tools/flist_hub_.md b/collections/tfmanual/knowledge_base/technology/zos_tools/flist_hub_.md new file mode 100644 index 0000000..3f0a572 --- /dev/null +++ b/collections/tfmanual/knowledge_base/technology/zos_tools/flist_hub_.md @@ -0,0 +1,12 @@ + +## TFGrid Flist Hub + +We provide a public hub you could use to upload your own Flist or filesystem directly and take advantages of Flist out-of-box on Zero-OS. +You can convert an existing docker image the same way. + +Public hub: [hub.grid.tf](https://hub.grid.tf) + +If you want to experiment the hub and features, you could use the [playground hub](https://playground.hub.grid.tf). +This hub could be reset anytime, don't put sensitive or production code there. + + diff --git a/collections/tfmanual/values/CU_MUSD_HOUR.md b/collections/tfmanual/values/CU_MUSD_HOUR.md new file mode 100644 index 0000000..44eb204 --- /dev/null +++ b/collections/tfmanual/values/CU_MUSD_HOUR.md @@ -0,0 +1 @@ +30.56 \ No newline at end of file diff --git a/collections/tfmanual/values/CU_TFT_HOUR.md b/collections/tfmanual/values/CU_TFT_HOUR.md new file mode 100644 index 0000000..50c9a07 --- /dev/null +++ b/collections/tfmanual/values/CU_TFT_HOUR.md @@ -0,0 +1 @@ +15.28 \ No newline at end of file diff --git a/collections/tfmanual/values/DNAME_MUSD_HOUR.md b/collections/tfmanual/values/DNAME_MUSD_HOUR.md new file mode 100644 index 0000000..bee3bd1 --- /dev/null +++ b/collections/tfmanual/values/DNAME_MUSD_HOUR.md @@ -0,0 +1 @@ +2.78 \ No newline at end of file diff --git a/collections/tfmanual/values/IP_MUSD_HOUR.md b/collections/tfmanual/values/IP_MUSD_HOUR.md new file mode 100644 index 0000000..cc891cf --- /dev/null +++ b/collections/tfmanual/values/IP_MUSD_HOUR.md @@ -0,0 +1 @@ +6.94 \ No newline at end of file diff --git a/collections/tfmanual/values/NAME_MUSD_HOUR.md b/collections/tfmanual/values/NAME_MUSD_HOUR.md new file mode 100644 index 0000000..c520ed0 --- /dev/null +++ b/collections/tfmanual/values/NAME_MUSD_HOUR.md @@ -0,0 +1 @@ +1.39 \ No newline at end of file diff --git a/collections/tfmanual/values/NU_MUSD_HOUR.md b/collections/tfmanual/values/NU_MUSD_HOUR.md new file mode 100644 index 0000000..2af48f0 --- /dev/null +++ b/collections/tfmanual/values/NU_MUSD_HOUR.md @@ -0,0 +1 @@ +50.00 \ No newline at end of file diff --git a/collections/tfmanual/values/SU_MUSD_HOUR.md b/collections/tfmanual/values/SU_MUSD_HOUR.md new file mode 100644 index 0000000..849efca --- /dev/null +++ b/collections/tfmanual/values/SU_MUSD_HOUR.md @@ -0,0 +1 @@ +19.44 \ No newline at end of file diff --git a/collections/tfmanual/values/tft_supply.md b/collections/tfmanual/values/tft_supply.md new file mode 100644 index 0000000..6f8db6d --- /dev/null +++ b/collections/tfmanual/values/tft_supply.md @@ -0,0 +1 @@ +780000000 \ No newline at end of file diff --git a/docs/hero_create_mdbook.md b/docs/hero_create_mdbook.md new file mode 100644 index 0000000..8cb9ce6 --- /dev/null +++ b/docs/hero_create_mdbook.md @@ -0,0 +1,174 @@ +

Create a New mdbook with Hero

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Creating a New mdbook](#creating-a-new-mdbook) + - [Cloning the mdbook Repository](#cloning-the-mdbook-repository) + - [Directory Tree Example](#directory-tree-example) + - [Files and Directories Example](#files-and-directories-example) +- [Generating the mdbook Locally](#generating-the-mdbook-locally) +- [Pushing the Changes](#pushing-the-changes) +- [Generating the mdbook from a Remote Repository](#generating-the-mdbook-from-a-remote-repository) + +*** + +## Introduction + +We show how to build an mdbook using the [Hero tool](https://github.com/freeflowuniverse/crystallib/tree/development/cli/hero). + +For this guide, we will show how to add an mdbook to the TFGrid repository `info_tfgrid` on `git.ourworld.tf`. + +## Prerequisites + +Before proceeding further, make sure you read and completed the [guide on how to use Hero and mdbook](./hero_fullvm.md). + +## Creating a New mdbook + +Let's go through all the steps to create a new mdbook. We will call our book `new_mdbook`. + +### Cloning the mdbook Repository + +For this guide, we will add a book to `info_tfgrid`. For this reason, we first start to clone the repository. Note that this step can be done automatically by Hero, but it might be easier to do it manually for later steps, such as pushing changes with git. + +``` +mkdir -p /root/code/git.ourworld.tf/tfgrid +cd /root/code/git.ourworld.tf/tfgrid +git clone https://git.ourworld.tf/tfgrid/info_tfgrid +``` + +Once we've cloned the repository, we can make changes to the repository and then push it to `git.ourworld.tf` when we're ready. + +Before creating the new mdbook, let's have a look at how the overall directory tree will look like. + +### Directory Tree Example + +We first show the directory tree template to give an overview of the project. Without taking into account the other mdbooks within the repository, the overall directory tree would look like this: + +``` +├── books +│   └── new_mdbook +│   ├── SUMMARY.md +│   └── sync_production.sh +├── collections +│   └── new_mdbook +│   ├── .collection +│   ├── new_mdbook_example1.md +│   └── new_mdbook_example2.md +└── heroscript + └── new_mdbook + ├── book_collections.md + ├── context.md + └── sshkey.md +``` + +### Files and Directories Example + +Hero uses three main directories to build an mdbook `books`, `collections` and `heroscript`. Let's have a look at each of them. + +- `books` + - This directory contains the file `SUMMARY.md` of every mdbook as well as a script file called `sync_production.sh`. Each summary file is within the proper mdbook directory (here we have `new_mdbook`). + - In our case, we will have `books/new_mdbook/SUMMARY.md`. + - The summary file will point to the markdown files we want our mdbook populated with. + - We note that the SUMMARY.md file needs to point to a directory contained within the `collections` directory, as shown just below. + ``` + - [Example 1](new_mdbook/new_mdbook_example1.md) + - [Example 2](new_mdbook/new_mdbook_example2.md) + ``` + - The script file named `sync_production.sh` should contain the following content (make sure to adjust with the proper book name): + ``` + #!/bin/bash + rsync -rv ~/hero/www/info/new_mdbook/ root@info.ourworld.tf:/root/hero/www/info/new_mdbook/ + ``` +- `collections` + - This directory contains all the markdown files needed to build all the books in the repository. + - In our case, we will put two markdown files in the new collections named `new_mdbook` + - `collections/new_mdbook/new_mdbook_example1.md` + - `collections/new_mdbook/new_mdbook_example2.md` + - Note that each collections directory should contain a file called `.collection`. This file should be empty. + ``` + touch .collection + ``` +- `heroscript` + - This directory contains three files that are necessary for Hero to build the mdbook, `book_collections.md`, `context.md` and `sshkey.md` + - `context.md` sets the proper configuration for the mdbook using the command `configure` + - This file is the same throughout all the `info_tfgrid` repository. + ``` + !!books.configure + buildroot:'~/hero/var/mdbuild' + publishroot:'~/hero/www/info' + install:true + reset:false + ``` + - `sshkey.md` contains the private SSH key + - This file is the same throughout all the `info_tfgrid` repository. + ``` + !!sshagent.key_add + name:'books' + privkey:' + -----BEGIN OPENSSH PRIVATE KEY----- + b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAAAMwAAAAtzc2gtZW + QyNTUxOQAAACDXf9Z/2AH8/8a1ppagCplQdhWyQ8wZAieUw3nNcxsDiQAAAIhb3ybRW98m + 0QAAAAtzc2gtZWQyNTUxOQAAACDXf9Z/2AH8/8a1ppagCplQdhWyQ8wZAieUw3nNcxsDiQ + AAAEC+fcDBPqdJHlJOQJ2zXhU2FztKAIl3TmWkaGCPnyts49d/1n/YAfz/xrWmlqAKmVB2 + FbJDzBkCJ5TDec1zGwOJAAAABWJvb2tz + -----END OPENSSH PRIVATE KEY----- + ' + + ``` + - `book_collections.md` has many purposes + - It is used to generate the mdbook name + - It points the URL where the SUMMARY.md is located + - In the directory `books` as we've seen above + - It also point the URLs where the markdown files are located + - In the directory `collections` as we've seen above + ``` + !!book.generate name:'new_mdbook' title:'New mdbook' + url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/books/new_mdbook' + + + !!doctree.add + url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/new_mdbook' + + ``` + +## Generating the mdbook Locally + +Once you've created all the necessary files for your mdbook, you can build the mdbook locally with Hero: + +``` +hero mdbook -p /root/code/git.ourworld.tf/tfgrid/info_tfgrid/heroscript/new_mdbook +``` + +Then you can open the mdbook locally: + +``` +hero mdbook -p /root/code/git.ourworld.tf/tfgrid/info_tfgrid/heroscript/new_mdbook -o +``` + +If you're using a remote VM for Hero, you can run the following line to see the book on your local browser. Check the [Hero Full VM guide](./hero_fullvm.md) for more information on this. + +``` +pushd /root/hero/www/info/new_mdbook/; python3 -m http.server 5173; popd; +``` + +## Pushing the Changes + +Once you've set the files and directories for your new mdbook and that you are satisfied with the result, you can push the changes to `git.ourworld.tf`. + +``` +git add . +git commit -m "added new book to info_tfgrid" +git push +``` + +## Generating the mdbook from a Remote Repository + +Once the changes are uploaded to the remote repository, you will be able to build and open the new mdbook using the remote repository URL: + +``` +hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/new_mdbook -gr +hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/new_mdbook +hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/new_mdbook -o +``` \ No newline at end of file diff --git a/docs/hero_mdbook_fullvm.md b/docs/hero_mdbook_fullvm.md index 40a4a73..f038136 100644 --- a/docs/hero_mdbook_fullvm.md +++ b/docs/hero_mdbook_fullvm.md @@ -6,17 +6,17 @@ - [Setting the Full VM](#setting-the-full-vm) - [Remote Explorer Access](#remote-explorer-access) - [Set the SSH Key Pair](#set-the-ssh-key-pair) -- [Install hero, crysallib and V](#install-hero-crysallib-and-v) +- [Install Hero, Crystallib and V](#install-hero-crystallib-and-v) - [Use Hero to Generate mdbooks](#use-hero-to-generate-mdbooks) - [Troubleshooting](#troubleshooting) - - [Fix the error: "cli execution error: Cannot pull repo: /root/code/git.ourworld.tf/tfgrid/info\_tfgrid because there are changes in the dir."](#fix-the-error-cli-execution-error-cannot-pull-repo-rootcodegitourworldtftfgridinfo_tfgrid-because-there-are-changes-in-the-dir) + - [Fix the error: "cli execution error: Cannot pull repo..."](#fix-the-error-cli-execution-error-cannot-pull-repo) - [Fix: Git hangs at "Cloning into..."](#fix-git-hangs-at-cloning-into) *** ## Introduction -In this tutorial, we show all the steps to deploy an mdbook with the [hero](https://github.com/freeflowuniverse/crystallib/tree/development/cli/hero) tool. +In this tutorial, we show all the steps to deploy an mdbook with the [Hero](https://github.com/freeflowuniverse/crystallib/tree/development/cli/hero) tool. For this guide, we show an example using the mdbook from the repository [info_tfgrid](https://git.ourworld.tf/tfgrid/info_tfgrid). This setup can be done locally or on a VM. Note that it should be run as root. @@ -26,7 +26,7 @@ We will be using SSH to connect to the VM and to create an SSH tunnel between th To manage the mdbook files, we will be using the remote explorer feature of either VSCodium or VSCode. -We include some troubleshooting tips from testing the installation. +We also include some troubleshooting tips. ## Setting the Full VM @@ -61,18 +61,18 @@ You can use the remote explorer feature of both [VSCode](https://marketplace.vis ## Set the SSH Key Pair - Generate an SSH key pair - - To make it work with info_tfgrid, use books for the filename + - To make it work with info_tfgrid, save it here: `/root/.ssh/books` ``` -ssh-keygen # save in /root/.ssh/books +ssh-keygen ``` - Note the public key ``` -cat ~/.ssh/books.pub +cat /root/.ssh/books.pub ``` - Add the SSH public key on [git.ourworld.tf](https://git.ourworld.tf/user/settings/keys) and [github](https://github.com/settings/keys) - - Optional: on git.ourworld.tf, verify the key + - Optional: on git.ourworld.tf, verify the key. Make sure to put the proper token. ``` -echo -n 'token' | ssh-keygen -Y sign -n gitea -f /path/to/private/key +echo -n 'token' | ssh-keygen -Y sign -n gitea -f /root/.ssh/books ``` - Start the ssh agent ``` @@ -83,7 +83,9 @@ eval $(ssh-agent) ssh-add /root/.ssh/books ``` -## Install hero, crysallib and V +## Install Hero, Crystallib and V + +We install hero, Crystallib and V with a script. ``` curl https://raw.githubusercontent.com/freeflowuniverse/crystallib/development/scripts/build_hero.sh > /tmp/build_hero.sh @@ -92,28 +94,59 @@ bash /tmp/build_hero.sh ## Use Hero to Generate mdbooks -- You can download the repository. +We generate mdbooks with Hero. + +Download the git repository from a URL: + +- Download the repository ``` hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/bookname -gp ``` -- To open the mdbook on your local browser: + - The line above will clone the repository `info_tfgrid` at the path `/root/code/git.ourworld.tf/tfgrid`. The same result can be obtained by running the following lines: + ``` + mkdir -p /root/code/git.ourworld.tf/tfgrid + cd /root/code/git.ourworld.tf/tfgrid + git clone https://git.ourworld.tf/tfgrid/info_tfgrid + ``` -``` -hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/bookname -o -``` +For the next steps, you can either run the commands locally (with -p and the proper path) or remotely (with -u and the proper URL). Running the command locally is useful when you are doing changes to the mdbook and you want to test them before pushing the new files to the remote repository. -> Note: In both cases, make sure to replace **bookname** by the name of your book, e.g. test. +- Build the book + - Option 1: Build the book with a URL + ``` + hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/bookname + ``` -To see the mdbook online on a local browser (via the file **index.html**), run the following command and open a browser with the URL **localhost:5173**: + - Option 2: Build the book with a local path + ``` + hero mdbook -p /path/to/tfgrid/info_tfgrid/src/branch/main/heroscript/bookname + ``` + +- Open the book + - Option 1: Open the mdbook on your local browser with a URL: + + ``` + hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/bookname -o + ``` + + - Option 2: Open the mdbook on your local browser with a local path: + + ``` + hero mdbook -p /path/to/tfgrid/info_tfgrid/src/branch/main/heroscript/bookname -o + ``` + +> Note: In all cases, make sure to replace **bookname** by the name of your book, e.g. test. + +To preview the mdbook on a local browser (via the file **index.html**), run the following command and open a browser with the URL **localhost:5173**. Make sure to replace `` with the name of the book. ``` -pushd /root/hero/www/info/tfgrid/; python3 -m http.server 5173; popd; +pushd /root/hero/www/info//; python3 -m http.server 5173; popd; ``` ## Troubleshooting -### Fix the error: "cli execution error: Cannot pull repo: /root/code/git.ourworld.tf/tfgrid/info_tfgrid because there are changes in the dir." +### Fix the error: "cli execution error: Cannot pull repo..." -Remove then rerun the command +If you get the following error: "cli execution error: Cannot pull repo: /root/code/git.ourworld.tf/tfgrid/info_tfgrid because there are changes in the dir.", you can try the following as a fix: ``` rm -r /root/code/git.ourworld.tf/tfgrid/info_tfgrid @@ -133,4 +166,3 @@ If it happens another time, you can try to download it manually: mkdir -p /root/code/git.ourworld.tf/tfgrid && cd $_ git clone https://git.ourworld.tf/tfgrid/info_tfgrid ``` - diff --git a/heroscript/info_grid/book_collections.md b/heroscript/info_grid/book_collections.md index 7e5355e..5f1273f 100644 --- a/heroscript/info_grid/book_collections.md +++ b/heroscript/info_grid/book_collections.md @@ -5,14 +5,11 @@ !!book.generate name:'info_grid' title:'ThreeFold Manual' url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/books/info_grid' -!!doctree.add - url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/documentation' - -!!doctree.add - url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/knowledge_base' - !!doctree.add url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/intro' +!!doctree.add + url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/documentation' + ``` diff --git a/heroscript/new_mdbook/book_collections.md b/heroscript/new_mdbook/book_collections.md new file mode 100644 index 0000000..203a937 --- /dev/null +++ b/heroscript/new_mdbook/book_collections.md @@ -0,0 +1,9 @@ +```js + +!!book.generate name:'new_mdbook' title:'New mdBook' + url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/books/new_mdbook' + +!!doctree.add + url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/new_mdbook' + +``` \ No newline at end of file diff --git a/heroscript/new_mdbook/context.md b/heroscript/new_mdbook/context.md new file mode 100644 index 0000000..a8f5892 --- /dev/null +++ b/heroscript/new_mdbook/context.md @@ -0,0 +1,11 @@ + +```js + +!!books.configure + buildroot:'~/hero/var/mdbuild' + publishroot:'~/hero/www/info' + install:true + reset:false + +``` + diff --git a/heroscript/new_mdbook/sshkey.md b/heroscript/new_mdbook/sshkey.md new file mode 100644 index 0000000..85acfe6 --- /dev/null +++ b/heroscript/new_mdbook/sshkey.md @@ -0,0 +1,14 @@ + +```js +!!sshagent.key_add + name:'books' + privkey:' + -----BEGIN OPENSSH PRIVATE KEY----- + b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAAAMwAAAAtzc2gtZW + QyNTUxOQAAACDXf9Z/2AH8/8a1ppagCplQdhWyQ8wZAieUw3nNcxsDiQAAAIhb3ybRW98m + 0QAAAAtzc2gtZWQyNTUxOQAAACDXf9Z/2AH8/8a1ppagCplQdhWyQ8wZAieUw3nNcxsDiQ + AAAEC+fcDBPqdJHlJOQJ2zXhU2FztKAIl3TmWkaGCPnyts49d/1n/YAfz/xrWmlqAKmVB2 + FbJDzBkCJ5TDec1zGwOJAAAABWJvb2tz + -----END OPENSSH PRIVATE KEY----- + ' +``` \ No newline at end of file diff --git a/heroscript/tfmanual/book_collections.md b/heroscript/tfmanual/book_collections.md new file mode 100644 index 0000000..7e5f1cc --- /dev/null +++ b/heroscript/tfmanual/book_collections.md @@ -0,0 +1,12 @@ + + +```js + +!!book.generate name:'tfmanual' title:'ThreeFold Manual Hero Version' + url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/books/tfmanual' + +!!doctree.add + url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/tfmanual' + +``` + diff --git a/heroscript/tfmanual/context.md b/heroscript/tfmanual/context.md new file mode 100644 index 0000000..a8f5892 --- /dev/null +++ b/heroscript/tfmanual/context.md @@ -0,0 +1,11 @@ + +```js + +!!books.configure + buildroot:'~/hero/var/mdbuild' + publishroot:'~/hero/www/info' + install:true + reset:false + +``` + diff --git a/heroscript/tfmanual/sshkey.md b/heroscript/tfmanual/sshkey.md new file mode 100644 index 0000000..85acfe6 --- /dev/null +++ b/heroscript/tfmanual/sshkey.md @@ -0,0 +1,14 @@ + +```js +!!sshagent.key_add + name:'books' + privkey:' + -----BEGIN OPENSSH PRIVATE KEY----- + b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAAAMwAAAAtzc2gtZW + QyNTUxOQAAACDXf9Z/2AH8/8a1ppagCplQdhWyQ8wZAieUw3nNcxsDiQAAAIhb3ybRW98m + 0QAAAAtzc2gtZWQyNTUxOQAAACDXf9Z/2AH8/8a1ppagCplQdhWyQ8wZAieUw3nNcxsDiQ + AAAEC+fcDBPqdJHlJOQJ2zXhU2FztKAIl3TmWkaGCPnyts49d/1n/YAfz/xrWmlqAKmVB2 + FbJDzBkCJ5TDec1zGwOJAAAABWJvb2tz + -----END OPENSSH PRIVATE KEY----- + ' +``` \ No newline at end of file