TFGrid Studio Documentation¶
Complete development platform for ThreeFold Grid
Build, deploy, and scale decentralized applications with tfgrid-compose CLI and integrated tools.
π New here? Check out our main website for an overview of TFGrid Studio, pricing, and features.
π― What is TFGrid Studio?¶
TFGrid Studio is a complete development platform for ThreeFold Grid. The flagship tool, tfgrid-compose, brings docker-compose-style simplicity to decentralized deployments.
No vendor lock-in. Industry standards. Decentralized infrastructure.
π Quick Start¶
1. Install tfgrid-compose¶
# One-line installer
curl -sSL install.tfgrid.studio/install.sh | sh
# Verify installation
tfgrid-compose --version
2. Set Up ThreeFold¶
Need a ThreeFold wallet with TFT? See the complete setup guide.
Already have a wallet? Configure it:
3. Deploy an App¶
# Deploy official app from registry
tfgrid-compose up tfgrid-ai-stack
# Or deploy by name
tfgrid-compose up tfgrid-ai-agent
# Or use local path
tfgrid-compose up ./my-app
That's it! Your application is now running on ThreeFold Grid. π
π Where to go next¶
1. New to TFGrid Studio?¶
- Introduction β what TFGrid Studio and
tfgrid-composeare. - Installation β install and configure
tfgrid-compose. - ThreeFold Setup β wallet, TFT, and account setup.
- Quick Start β deploy your first application in a few minutes.
2. Prefer a visual dashboard?¶
- TFGrid Dashboard β GUI alternative to the CLI for apps, deployments, and commands.
- TFGrid AI Stack β full AI workspace (dashboard, agent, and Gitea).
3. Need more depth?¶
- Guides β product and workflow guides for TFGrid Compose and apps.
- Deployment patterns β singleβVM, gateway, and k3s patterns.
- CLI reference β detailed commands and flags.
4. Building on top of TFGrid Studio?¶
- Submit your app β share apps with the community.
- Pattern contract β how patterns communicate.
- Architecture overview β how the system fits together.
π― Official Apps¶
Deploy production-ready applications with one command:
| App | Description | Command |
|---|---|---|
| tfgrid-ai-stack | AI + Git + Gateway (flagship) | tfgrid-compose up tfgrid-ai-stack |
| tfgrid-ai-agent | AI coding assistant | tfgrid-compose up tfgrid-ai-agent |
| tfgrid-gitea | Self-hosted Git service | tfgrid-compose up tfgrid-gitea |
| tfgrid-wordpress | WordPress + Caddy + MariaDB | tfgrid-compose up tfgrid-wordpress |
| tfgrid-nextcloud | File sync & collaboration | tfgrid-compose up tfgrid-nextcloud |
| tfgrid-erpnext | Business ERP system | tfgrid-compose up tfgrid-erpnext |
Browse all apps: registry.tfgrid.studio
π οΈ Custom Apps & Advanced Usage¶
Build and deploy your own applications:
# Deploy custom app from local directory
tfgrid-compose up ./my-app
# Deploy with gateway pattern (SSL + custom domain)
tfgrid-compose up my-webapp --pattern=gateway --domain=myapp.com
# Deploy on Kubernetes cluster
tfgrid-compose up my-saas --pattern=k3s
Learn more: - Custom Apps Guide - Create your own deployable apps - Tarball Releases - Versioned releases with rollback - Deployment Patterns - single-vm, gateway, k3s
π‘ Why TFGrid Compose?¶
β No Vendor Lock-in¶
Uses industry standards: Terraform, Ansible, Kubernetes. Your apps aren't locked to ThreeFold Grid.
β Simple & Powerful¶
Heroku-like UX with production-ready patterns. One command to deploy, full control when needed.
β Decentralized Infrastructure¶
Runs on ThreeFold Grid: decentralized compute, no single point of failure, cost-effective.
β Open Source¶
Apache 2.0 license. Free to use, modify, and distribute. Community-driven development.
β Battle-Tested¶
Built from ThreeFold open-source proven, working code implementations: - Gateway pattern: Based on mik-tf/tfgrid-gateway - K3s pattern: Based on ucli-tools/tfgrid-k3s - AI agent: Based on mik-tf/tfgrid-ai-agent
π Links¶
- Website: tfgrid.studio - Marketing site
- Documentation: docs.tfgrid.studio - You are here!
- GitHub: github.com/tfgrid-studio - Organization
- CLI Tool: tfgrid-compose - Main repository
- AI Agent: tfgrid-ai-agent - AI development
- Gitea: tfgrid-gitea - Self-hosted Git
- ThreeFold Grid: threefold.io - Infrastructure
π€ Community & Support¶
- Discussions: GitHub Discussions
- Issues: Open issues in respective repositories
- Contributing: See contributing guide
π License¶
FOSS Repositories: Apache 2.0 License
Commercial Repositories: Business Source License / Proprietary
See individual repositories for details.
Made with π₯ for the decentralized web
Get Started β’ View on GitHub
TFGrid Studio Ecosystem
Integrated tools and resources