From 1495be7fecbc9e48f5d0ae8776ebfd43fa5fae10 Mon Sep 17 00:00:00 2001 From: Mik-TF Date: Thu, 13 Jun 2024 19:33:21 -0400 Subject: [PATCH] farmers and devs hero --- books/developers/Makefile | 4 + books/developers/SUMMARY.md | 157 ++++++++++++++++++ .../scripts/calculate_cloud_pricing.sh | 29 ++++ .../developers/scripts/calculate_marketcap.sh | 18 ++ books/developers/scripts/generate_wallets.sh | 25 +++ books/developers/sync_production.sh | 5 + books/farmers/SUMMARY.md | 57 ++++++- collections/developers/developers_book_toc.md | 90 ++++++++++ heroscript/developers/book_collections.md | 46 +++++ heroscript/developers/context.md | 11 ++ heroscript/developers/sshkey.md | 14 ++ 11 files changed, 455 insertions(+), 1 deletion(-) create mode 100644 books/developers/Makefile create mode 100644 books/developers/SUMMARY.md create mode 100755 books/developers/scripts/calculate_cloud_pricing.sh create mode 100755 books/developers/scripts/calculate_marketcap.sh create mode 100755 books/developers/scripts/generate_wallets.sh create mode 100755 books/developers/sync_production.sh create mode 100644 collections/developers/developers_book_toc.md create mode 100644 heroscript/developers/book_collections.md create mode 100644 heroscript/developers/context.md create mode 100644 heroscript/developers/sshkey.md diff --git a/books/developers/Makefile b/books/developers/Makefile new file mode 100644 index 0000000..f678ceb --- /dev/null +++ b/books/developers/Makefile @@ -0,0 +1,4 @@ +build: + ./scripts/generate_wallets.sh + ./scripts/calculate_marketcap.sh + ./scripts/calculate_cloud_pricing.sh \ No newline at end of file diff --git a/books/developers/SUMMARY.md b/books/developers/SUMMARY.md new file mode 100644 index 0000000..d1eef4a --- /dev/null +++ b/books/developers/SUMMARY.md @@ -0,0 +1,157 @@ +- [Table of Contents](developers/developers_book_toc.md) +- [Javascript Client](developers/javascript/grid3_javascript_readme.md) + - [Installation](developers/javascript/grid3_javascript_installation.md) + - [Loading Client](developers/javascript/grid3_javascript_loadclient.md) + - [Deploy a VM](developers/javascript/grid3_javascript_vm.md) + - [Capacity Planning](developers/javascript/grid3_javascript_capacity_planning.md) + - [Deploy Multiple VMs](developers/javascript/grid3_javascript_vms.md) + - [Deploy CapRover](developers/javascript/grid3_javascript_caprover.md) + - [Gateways](developers/javascript/grid3_javascript_vm_gateways.md) + - [Deploy a Kubernetes Cluster](developers/javascript/grid3_javascript_kubernetes.md) + - [Deploy a ZDB](developers/javascript/grid3_javascript_zdb.md) + - [Deploy ZDBs for QSFS](developers/javascript/grid3_javascript_qsfs_zdbs.md) + - [QSFS](developers/javascript/grid3_javascript_qsfs.md) + - [Key Value Store](developers/javascript/grid3_javascript_kvstore.md) + - [VM with Wireguard and Gateway](developers/javascript/grid3_wireguard_gateway.md) + - [GPU Support](developers/javascript/grid3_javascript_gpu_support.md) +- [Go Client](developers/go/grid3_go_readme.md) + - [Installation](developers/go/grid3_go_installation.md) + - [Loading Client](developers/go/grid3_go_load_client.md) + - [Deploy a VM](developers/go/grid3_go_vm.md) + - [Deploy Multiple VMs](developers/go/grid3_go_vms.md) + - [Deploy Gateways](developers/go/grid3_go_gateways.md) + - [Deploy Kubernetes](developers/go/grid3_go_kubernetes.md) + - [Deploy a QSFS](developers/go/grid3_go_qsfs.md) + - [GPU and Go](developers/go/grid3_go_gpu.md) + - [GPU Support](developers/go/grid3_go_gpu_support.md) + - [Deploy a VM with GPU](developers/go/grid3_go_vm_with_gpu.md) +- [TFCMD](developers/tfcmd/tfcmd.md) + - [Getting Started](developers/tfcmd/tfcmd_basics.md) + - [Deploy a VM](developers/tfcmd/tfcmd_vm.md) + - [Deploy Kubernetes](developers/tfcmd/tfcmd_kubernetes.md) + - [Deploy ZDB](developers/tfcmd/tfcmd_zdbs.md) + - [Gateway FQDN](developers/tfcmd/tfcmd_gateway_fqdn.md) + - [Gateway Name](developers/tfcmd/tfcmd_gateway_name.md) + - [Contracts](developers/tfcmd/tfcmd_contracts.md) +- [TFROBOT](developers/tfrobot/tfrobot.md) + - [Installation](developers/tfrobot/tfrobot_installation.md) + - [Configuration File](developers/tfrobot/tfrobot_config.md) + - [Deployment](developers/tfrobot/tfrobot_deploy.md) + - [Commands and Flags](developers/tfrobot/tfrobot_commands_flags.md) + - [Supported Configurations](developers/tfrobot/tfrobot_configurations.md) +- [ThreeFold Chain](developers/tfchain/dev_tfchain.md) + - [Introduction](developers/tfchain/introduction.md) + - [Farming Policies](developers/tfchain/farming_policies.md) + - [External Service Contract](developers/tfchain/tfchain_external_service_contract.md) + - [Solution Provider](developers/tfchain/tfchain_solution_provider.md) +- [Grid Proxy](developers/proxy/proxy_readme.md) + - [Introducing Grid Proxy](developers/proxy/proxy.md) + - [Setup](developers/proxy/setup.md) + - [DB Testing](developers/proxy/db_testing.md) + - [Commands](developers/proxy/commands.md) + - [Contributions](developers/proxy/contributions.md) + - [Explorer](developers/proxy/explorer.md) + - [Database](developers/proxy/database.md) + - [Production](developers/proxy/production.md) + - [Release](developers/proxy/release.md) +- [Flist](developers/flist/flist.md) + - [Zero-OS Hub](developers/flist/flist_hub/zos_hub.md) + - [Generate an API Token](developers/flist/flist_hub/api_token.md) + - [Convert Docker Image Into Flist](developers/flist/flist_hub/convert_docker_image.md) + - [Supported Flists](developers/flist/grid3_supported_flists.md) + - [Flist Case Studies](developers/flist/flist_case_studies/flist_case_studies.md) + - [Case Study: Debian 12](developers/flist/flist_case_studies/flist_debian_case_study.md) + - [Case Study: Nextcloud AIO](developers/flist/flist_case_studies/flist_nextcloud_case_study.md) +- [Internals](developers/internals/internals.md) + - [Reliable Message Bus - RMB](developers/internals/rmb/rmb_toc.md) + - [Introduction to RMB](developers/internals/rmb/rmb_intro.md) + - [Coding Guides](developers/internals/rmb/rmb_coding_guides.md) + - [RMB Specs](developers/internals/rmb/rmb_specs.md) + - [RMB Peer](developers/internals/rmb/uml/peer.md) + - [RMB Relay](developers/internals/rmb/uml/relay.md) + - [Zero-OS](developers/internals/zos/zos_readme.md) + - [Manual](developers/internals/zos/manual/manual.md) + - [Workload Types](developers/internals/zos/manual/workload_types.md) + - [Internal Modules](developers/internals/zos/internals/zos_internals.md) + - [Identity](developers/internals/zos/internals/identity/identity_readme.md) + - [Node ID Generation](developers/internals/zos/internals/identity/identity.md) + - [Node Upgrade](developers/internals/zos/internals/identity/upgrade.md) + - [Node](developers/internals/zos/internals/node/node_readme.md) + - [Storage](developers/internals/zos/internals/storage/storage_readme.md) + - [Network](developers/internals/zos/internals/network/network_readme.md) + - [Introduction](developers/internals/zos/internals/network/introduction.md) + - [Definitions](developers/internals/zos/internals/network/definitions.md) + - [Mesh](developers/internals/zos/internals/network/mesh.md) + - [Setup](developers/internals/zos/internals/network/setup_farm_network.md) + - [Flist](developers/internals/zos/internals/flist/flist_readme.md) + - [Container](developers/internals/zos/internals/container/container_readme.md) + - [VM](developers/internals/zos/internals/vmd/vmd_readme.md) + - [Provision](developers/internals/zos/internals/provision/provision_readme.md) + - [Capacity](developers/internals/zos/internals/capacity.md) + - [Performance Monitor Package](developers/internals/zos/performance/performance.md) + - [Public IPs Validation Task](developers/internals/zos/performance/publicips.md) + - [CPUBenchmark](developers/internals/zos/performance/cpubench.md) + - [IPerf](developers/internals/zos/performance/iperf.md) + - [Health Check](developers/internals/zos/performance/healthcheck.md) + - [API](developers/internals/zos/manual/api.md) +- [Grid Deployment](developers/grid_deployment/grid_deployment.md) + - [TFGrid Stacks](developers/grid_deployment/tfgrid_stacks.md) + - [Full VM Grid Deployment](developers/grid_deployment/grid_deployment_full_vm.md) + - [Grid Snapshots](developers/grid_deployment/snapshots.md) + - [Deploy the Dashboard](developers/grid_deployment/deploy_dashboard.md) + - [Application Case Study: Nextcloud](developers/grid_deployment/app_case_study_nextcloud.md) +- [ThreeFold Dashboard](dashboard/dashboard.md) + - [Wallet Connector](dashboard/wallet_connector.md) + - [TFGrid](dashboard/tfgrid/tfgrid.md) + - [Grid Status](dashboard/tfgrid/grid_status.md) + - [Node Statistics](dashboard/tfgrid/node_statistics.md) + - [Node Monitoring](dashboard/tfgrid/node_monitoring.md) + - [Deploy](dashboard/deploy/deploy.md) + - [Pricing Calculator](dashboard/deploy/pricing_calculator.md) + - [Node Finder](dashboard/deploy/node_finder.md) + - [Virtual Machines](dashboard/solutions/vm_intro.md) + - [Micro and Full VM Differences ](dashboard/solutions/vm_differences.md) + - [Full Virtual Machine](dashboard/solutions/fullvm.md) + - [Micro Virtual Machine](dashboard/solutions/microvm.md) + - [Nixos MicroVM](dashboard/solutions/nixos_micro.md) + - [Add a Domain](dashboard/solutions/add_domain.md) + - [Orchestrators](dashboard/deploy/orchestrators.md) + - [Kubernetes](dashboard/solutions/k8s.md) + - [Caprover](dashboard/solutions/caprover.md) + - [Caprover Admin](dashboard/solutions/caprover_admin.md) + - [Caprover Worker](dashboard/solutions/caprover_worker.md) + - [Applications](dashboard/deploy/applications.md) + - [Algorand](dashboard/solutions/algorand.md) + - [CasperLabs](dashboard/solutions/casper.md) + - [Discourse](dashboard/solutions/discourse.md) + - [Funkwhale](dashboard/solutions/funkwhale.md) + - [Mattermost](dashboard/solutions/mattermost.md) + - [Nextcloud](dashboard/solutions/nextcloud.md) + - [Node Pilot](dashboard/solutions/nodepilot.md) + - [Peertube](dashboard/solutions/peertube.md) + - [Presearch](dashboard/solutions/presearch.md) + - [Static Website](dashboard/solutions/static_website.md) + - [Subsquid](dashboard/solutions/subsquid.md) + - [Taiga](dashboard/solutions/taiga.md) + - [Umbrel](dashboard/solutions/umbrel.md) + - [WordPress](dashboard/solutions/wordpress.md) + - [Your Contracts](dashboard/deploy/your_contracts.md) + - [Images](dashboard/deploy/images.md) + - [SSH Keys](dashboard/deploy/ssh_keys.md) + - [Farms](dashboard/farms/farms.md) + - [Your Farms](dashboard/farms/your_farms.md) + - [Farm Finder](dashboard/farms/farms_finder.md) + - [Node Installer](dashboard/farms/node_installer.md) + - [Simulator](dashboard/farms/simulator.md) + - [TFChain](dashboard/tfchain/tfchain.md) + - [Your Profile](dashboard/tfchain/your_profile.md) + - [TF DAO](dashboard/tfchain/tf_dao.md) + - [Voting Weight Example](dashboard/tfchain/tf_dao_voting_weight.md) + - [TF Token Bridge](dashboard/tfchain/tf_token_bridge.md) + - [TF Token Transfer](dashboard/tfchain/tf_token_transfer.md) + - [TF Minting Reports](dashboard/tfchain/tf_minting_reports.md) +- [ThreeFold Connect](tfconnect/tfconnect_toc.md) + - [TFConnect Overview](tfconnect/tfconnect_overview.md) + - [TFConnect Authenticator](tfconnect/tfconnect_authenticator.md) + - [TFConnect Advanced](tfconnect/tfconnect_advanced.md) + - [TFConnect Troubleshooting](tfconnect/tfconnect_troubleshooting.md) \ No newline at end of file diff --git a/books/developers/scripts/calculate_cloud_pricing.sh b/books/developers/scripts/calculate_cloud_pricing.sh new file mode 100755 index 0000000..ebce4bb --- /dev/null +++ b/books/developers/scripts/calculate_cloud_pricing.sh @@ -0,0 +1,29 @@ +#!/usr/bin/env bash + +cd ../../collections/manual/values + +value=$(cat tft_value.md) + +CU=$(cat cu_musd_hour.md) +CUTFT=$(echo "$CU / $value" | bc -l) +printf "%.2f" $CUTFT > cu_mtft_hour.md + +SU=$(cat su_musd_hour.md) +SUTFT=$(echo "$SU / $value" | bc -l) +printf "%.2f" $SUTFT > su_mtft_hour.md + +NU=$(cat nu_musd_hour.md) +NUTFT=$(echo "$NU / $value" | bc -l) +printf "%.2f" $NUTFT > nu_mtft_hour.md + +IP=$(cat ip_musd_hour.md) +IPTFT=$(echo "$IP / $value" | bc -l) +printf "%.2f" $IPTFT > ip_mtft_hour.md + +NAME=$(cat name_musd_hour.md) +NAME=$(echo "$NAME / $value" | bc -l) +printf "%.2f" $NAME > name_mtft_hour.md + +DNAME=$(cat dname_musd_hour.md) +DNAME=$(echo "$DNAME / $value" | bc -l) +printf "%.2f" $DNAME > dname_mtft_hour.md \ No newline at end of file diff --git a/books/developers/scripts/calculate_marketcap.sh b/books/developers/scripts/calculate_marketcap.sh new file mode 100755 index 0000000..53a0287 --- /dev/null +++ b/books/developers/scripts/calculate_marketcap.sh @@ -0,0 +1,18 @@ +#!/usr/bin/env bash + +cd ../../collections/manual/values + +coinId="threefold-token" + +url="https://api.coingecko.com/api/v3/simple/price?ids=${coinId}&vs_currencies=usd"; + +curl -sL ${url} \ +-H 'Accept: application/json' | jq '."threefold-token".usd' | xargs printf "%.3f" > tft_value.md + +supply=$(cat tft_supply.md) + +value=$(cat tft_value.md) + +TFT_MARKETCAP=$(echo "$supply * $value" | bc -l) + +printf "%'.0f" $TFT_MARKETCAP > tft_marketcap.md \ No newline at end of file diff --git a/books/developers/scripts/generate_wallets.sh b/books/developers/scripts/generate_wallets.sh new file mode 100755 index 0000000..08a4483 --- /dev/null +++ b/books/developers/scripts/generate_wallets.sh @@ -0,0 +1,25 @@ +#!/usr/bin/env bash + +mkdir -p ../../collections/manual/knowledge_base/about/token_overview/special_wallets/wallet_data +cd ../../collections/manual/knowledge_base/about/token_overview/special_wallets/wallet_data + +wallets=( +GA7OPN4A3JNHLPHPEWM4PJDOYYDYNZOM7ES6YL3O7NC3PRY3V3UX6ANM +GDSKFYNMZWTB3V5AN26CEAQ27643Q3KB4X6MY4UTO2LIIDFND4SPQZYU +GBQHN7RL4LSRPR2TT74ID2UJPZ2AXCHQY2WKGCTDLJM3NXVJ7GQHUCOD +GBTPAXXP6534UPC4MLNGFGJWCD6DNSRVIPPOZWXAQAWI4FKTLOJY2A2S +GB2C5HCZYWNGVM6JGXDWQBJTMUY4S2HPPTCAH63HFAQVL2ALXDW7SSJ7 +GDLVIB44LVONM5K67LUPSFZMSX7G2RLYVBM5MMHUJ4NAQJU7CH4HBJBO +GDKXTUYNW4BJKDM2L7B5XUYFUISV52KUU4G7VPNLF4ZSIKBURM622YPZ +GDIJY6K2BBRIRX423ZFUYKKFDN66XP2KMSBZFQSE2PSNDZ6EDVQTRLSU +GCWHWDRXYPXQAOYMQKB66SZPLM6UANKGMSL4SP7LSOIA6OTTOYQ6HBIH +GBV734I2SV4YDDPVJMYXU3IZ2AIU5GEAJRAD4E4BQG7CA2N63NXSPMD6 +GAI4C2BGOA3YHVQZZW7OW4FHOGGYWTUBEVNHB6MW4ZAFG7ZAA7D5IPC3 +GCEJ7DMULFTT25UH4FAAGOZ6KER4WXAYQGJUSIITQD527DGTKSXKBQGR +GAQXBLFG4BZGIVY6DBJVWE5EAP3UNHMIA2PYCUVLY2JUSPVWPUF36BW4 +GAUGOSYLCX7JZTQYF2K7RIMHFWKSA3WSI2OQ4IRKXMDMVE6ABJIJMFQR +) + +for wallet in "${wallets[@]}"; do + curl -sL "https://horizon.stellar.org/accounts/${wallet}" -H 'Accept: application/json' | jq --raw-output '.balances[] | select(.asset_code == "TFT") | .balance' | xargs printf "%.2f" > ${wallet,,}.md +done \ No newline at end of file diff --git a/books/developers/sync_production.sh b/books/developers/sync_production.sh new file mode 100755 index 0000000..f2496fe --- /dev/null +++ b/books/developers/sync_production.sh @@ -0,0 +1,5 @@ +#!/bin/bash +set -ex +export NAME=developers +hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/manual/heroscript/$NAME +rsync -rv ~/hero/www/info/$NAME/ root@info.ourworld.tf:/root/hero/www/info/$NAME/ diff --git a/books/farmers/SUMMARY.md b/books/farmers/SUMMARY.md index e8c8fcf..de729be 100644 --- a/books/farmers/SUMMARY.md +++ b/books/farmers/SUMMARY.md @@ -24,4 +24,59 @@ - [Additional Information](farmers/farmerbot/farmerbot_information.md) - [Minting and the Farmerbot](farmers/farmerbot/farmerbot_minting.md) - [Node Status Bot](farmers/node_status_bot/node_status_bot.md) -- [Farming Troubleshooting](farmers/farming_troubleshooting.md) \ No newline at end of file +- [Farming Troubleshooting](farmers/farming_troubleshooting.md) +- [ThreeFold Dashboard](dashboard/dashboard.md) + - [Wallet Connector](dashboard/wallet_connector.md) + - [TFGrid](dashboard/tfgrid/tfgrid.md) + - [Grid Status](dashboard/tfgrid/grid_status.md) + - [Node Statistics](dashboard/tfgrid/node_statistics.md) + - [Node Monitoring](dashboard/tfgrid/node_monitoring.md) + - [Deploy](dashboard/deploy/deploy.md) + - [Pricing Calculator](dashboard/deploy/pricing_calculator.md) + - [Node Finder](dashboard/deploy/node_finder.md) + - [Virtual Machines](dashboard/solutions/vm_intro.md) + - [Micro and Full VM Differences ](dashboard/solutions/vm_differences.md) + - [Full Virtual Machine](dashboard/solutions/fullvm.md) + - [Micro Virtual Machine](dashboard/solutions/microvm.md) + - [Nixos MicroVM](dashboard/solutions/nixos_micro.md) + - [Add a Domain](dashboard/solutions/add_domain.md) + - [Orchestrators](dashboard/deploy/orchestrators.md) + - [Kubernetes](dashboard/solutions/k8s.md) + - [Caprover](dashboard/solutions/caprover.md) + - [Caprover Admin](dashboard/solutions/caprover_admin.md) + - [Caprover Worker](dashboard/solutions/caprover_worker.md) + - [Applications](dashboard/deploy/applications.md) + - [Algorand](dashboard/solutions/algorand.md) + - [CasperLabs](dashboard/solutions/casper.md) + - [Discourse](dashboard/solutions/discourse.md) + - [Funkwhale](dashboard/solutions/funkwhale.md) + - [Mattermost](dashboard/solutions/mattermost.md) + - [Nextcloud](dashboard/solutions/nextcloud.md) + - [Node Pilot](dashboard/solutions/nodepilot.md) + - [Peertube](dashboard/solutions/peertube.md) + - [Presearch](dashboard/solutions/presearch.md) + - [Static Website](dashboard/solutions/static_website.md) + - [Subsquid](dashboard/solutions/subsquid.md) + - [Taiga](dashboard/solutions/taiga.md) + - [Umbrel](dashboard/solutions/umbrel.md) + - [WordPress](dashboard/solutions/wordpress.md) + - [Your Contracts](dashboard/deploy/your_contracts.md) + - [Images](dashboard/deploy/images.md) + - [SSH Keys](dashboard/deploy/ssh_keys.md) + - [Farms](dashboard/farms/farms.md) + - [Your Farms](dashboard/farms/your_farms.md) + - [Farm Finder](dashboard/farms/farms_finder.md) + - [Node Installer](dashboard/farms/node_installer.md) + - [Simulator](dashboard/farms/simulator.md) + - [TFChain](dashboard/tfchain/tfchain.md) + - [Your Profile](dashboard/tfchain/your_profile.md) + - [TF DAO](dashboard/tfchain/tf_dao.md) + - [Voting Weight Example](dashboard/tfchain/tf_dao_voting_weight.md) + - [TF Token Bridge](dashboard/tfchain/tf_token_bridge.md) + - [TF Token Transfer](dashboard/tfchain/tf_token_transfer.md) + - [TF Minting Reports](dashboard/tfchain/tf_minting_reports.md) +- [ThreeFold Connect](tfconnect/tfconnect_toc.md) + - [TFConnect Overview](tfconnect/tfconnect_overview.md) + - [TFConnect Authenticator](tfconnect/tfconnect_authenticator.md) + - [TFConnect Advanced](tfconnect/tfconnect_advanced.md) + - [TFConnect Troubleshooting](tfconnect/tfconnect_troubleshooting.md) \ No newline at end of file diff --git a/collections/developers/developers_book_toc.md b/collections/developers/developers_book_toc.md new file mode 100644 index 0000000..b2d59a3 --- /dev/null +++ b/collections/developers/developers_book_toc.md @@ -0,0 +1,90 @@ +# ThreeFold Developers + +This book covers all practical tutorials on how to develop and build on the ThreeFold Grid. + +

Table of Contents

+ +- [Javascript Client](grid3_javascript_readme.md) + - [Installation](grid3_javascript_installation.md) + - [Loading Client](grid3_javascript_loadclient.md) + - [Deploy a VM](grid3_javascript_vm.md) + - [Capacity Planning](grid3_javascript_capacity_planning.md) + - [Deploy Multiple VMs](grid3_javascript_vms.md) + - [Deploy CapRover](grid3_javascript_caprover.md) + - [Gateways](grid3_javascript_vm_gateways.md) + - [Deploy a Kubernetes Cluster](grid3_javascript_kubernetes.md) + - [Deploy a ZDB](grid3_javascript_zdb.md) + - [Deploy ZDBs for QSFS](grid3_javascript_qsfs_zdbs.md) + - [QSFS](grid3_javascript_qsfs.md) + - [Key Value Store](grid3_javascript_kvstore.md) + - [VM with Wireguard and Gateway](grid3_wireguard_gateway.md) + - [GPU Support](grid3_javascript_gpu_support.md) +- [Go Client](grid3_go_readme.md) + - [Installation](grid3_go_installation.md) + - [Loading Client](grid3_go_load_client.md) + - [Deploy a VM](grid3_go_vm.md) + - [Deploy Multiple VMs](grid3_go_vms.md) + - [Deploy Gateways](grid3_go_gateways.md) + - [Deploy Kubernetes](grid3_go_kubernetes.md) + - [Deploy a QSFS](grid3_go_qsfs.md) + - [GPU Support](grid3_go_gpu.md) +- [TFCMD](tfcmd.md) + - [Getting Started](tfcmd_basics.md) + - [Deploy a VM](tfcmd_vm.md) + - [Deploy Kubernetes](tfcmd_kubernetes.md) + - [Deploy ZDB](tfcmd_zdbs.md) + - [Gateway FQDN](tfcmd_gateway_fqdn.md) + - [Gateway Name](tfcmd_gateway_name.md) + - [Contracts](tfcmd_contracts.md) +- [TFROBOT](tfrobot.md) + - [Installation](tfrobot_installation.md) + - [Configuration File](tfrobot_config.md) + - [Deployment](tfrobot_deploy.md) + - [Commands and Flags](tfrobot_commands_flags.md) + - [Supported Configurations](tfrobot_configurations.md) +- [ThreeFold Chain](tfchain.md) + - [Introduction](introduction.md) + - [Farming Policies](farming_policies.md) + - [External Service Contract](tfchain_external_service_contract.md) + - [Solution Provider](tfchain_solution_provider.md) +- [Grid Proxy](proxy_readme.md) + - [Introducing Grid Proxy](proxy.md) + - [Setup](setup.md) + - [DB Testing](db_testing.md) + - [Commands](commands.md) + - [Contributions](contributions.md) + - [Explorer](explorer.md) + - [Database](database.md) + - [Production](production.md) + - [Release](release.md) +- [Flist](flist.md) + - [ThreeFold Hub Intro](zos_hub.md) + - [Generate an API Token](api_token.md) + - [Convert Docker Image Into Flist](convert_docker_image.md) + - [Supported Flists](grid3_supported_flists.md) + - [Flist Case Studies](flist_case_studies.md) + - [Case Study: Debian 12](flist_debian_case_study.md) + - [Case Study: Nextcloud AIO](flist_nextcloud_case_study.md) +- [Internals](internals.md) + - [Reliable Message Bus (RMB)](rmb_toc.md) + - [Introduction to RMB](rmb_intro.md) + - [RMB Specs](rmb_specs.md) + - [RMB Peer](peer.md) + - [RMB Relay](relay.md) + - [ZOS](index.md) + - [Manual](manual.md) + - [Workload Types](workload_types.md) + - [Internal Modules](zos_internals.md) + - [Capacity](capacity.md) + - [Performance Monitor Package](performance.md) + - [Public IPs Validation Task](publicips.md) + - [CPUBenchmark](cpubench.md) + - [IPerf](iperf.md) + - [Health Check](healthcheck.md) + - [API](api.md) +- [Grid Deployment](grid_deployment.md) + - [TFGrid Stacks](tfgrid_stacks.md) + - [Full VM Grid Deployment](grid_deployment_full_vm.md) + - [Grid Snapshots](snapshots.md) + - [Deploy the Dashboard](deploy_dashboard.md) + - [Application Case Study: Nextcloud](app_case_study_nextcloud.md) \ No newline at end of file diff --git a/heroscript/developers/book_collections.md b/heroscript/developers/book_collections.md new file mode 100644 index 0000000..a661952 --- /dev/null +++ b/heroscript/developers/book_collections.md @@ -0,0 +1,46 @@ +```js + +!!book.generate name:'developers' title:'ThreeFold Developers Manual' printbook:false foldlevel:1 + url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/books/developers' + +!!doctree.add + url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/manual' + +!!doctree.add + url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/dashboard' +!!doctree.add + url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/tfconnect' +!!doctree.add + url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/developers' +!!doctree.add + url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/farmers' +!!doctree.add + url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/system_administrators' +!!doctree.add + url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/threefold_token' +!!doctree.add + url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/faq' + +!!doctree.add + url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/about' +!!doctree.add + url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/tech' +!!doctree.add + url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/legal' +!!doctree.add + url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/farming' +!!doctree.add + url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/cloud' +!!doctree.add + url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/collaboration' +!!doctree.add + url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/partners_utilization' + +!!doctree.add + url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/vindo' + +!!doctree.add + url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/mkondo' + +``` + diff --git a/heroscript/developers/context.md b/heroscript/developers/context.md new file mode 100644 index 0000000..a8f5892 --- /dev/null +++ b/heroscript/developers/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/developers/sshkey.md b/heroscript/developers/sshkey.md new file mode 100644 index 0000000..85acfe6 --- /dev/null +++ b/heroscript/developers/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