Self-hosted
Self-hosted deployment documentation.
4.86
Tagged pages in the 4.86 documentation.
Agents environment variables
Reference documentation for Retool Agents environment variables for self-hosted deployments.
Reference
Agents environment variables
Reference documentation for Retool Agents environment variables for self-hosted deployments.
Reference
Agents environment variables
Reference documentation for Retool Agents-related environment variables for self-hosted deployments.
Reference
AI for self-hosted instances
Learn about using AI with self-hosted instances.
Concept
Authentication environment variables
Reference documentation for authentication-related environment variables.
Reference
Backup and disaster recovery best practices
Learn how to back up and recover your self-managed Retool instance.
Concept
Capacity planning best practices
Learn how to plan and size your self-managed Retool instance for production workloads.
Concept
Code executor environment variables
Reference documentation of environment variables for the code-executor service.
Reference
Configure and migrate to an external platform database
Learn how to configure and migrate the platform database for self-hosted Retool instances.
Guide
Configure app hostnames
Learn how to serve apps and the app builder preview on their own hostnames on a self-hosted Retool instance deployed with Helm.
Guide
Configure code-executor resource limits
Set memory limits for workflow code block execution on self-hosted Retool.
Guide
Configure code-executor security and privileges
Learn how to disable the default security configuration for code-executor or run in unprivileged mode.
Guide
Configure Microsoft Entra ID SAML SSO
Learn how to configure SSO with Microsoft Entra ID SAML.
Tutorial
Configure multiple Secrets Manager configurations
You can create multiple Secrets Manager configurations if you need to retrieve secrets from different locations.
Guide
Configure Retool-managed deployment secrets and environment variables
Learn how to configure secrets and environment variables for Retool-managed, self-hosted deployments in AWS Secrets Manager.
Guide
Configure same-origin and sandbox for iframes
Learn how to configure same-origin policy and sandboxing for iframes and custom components in classic apps.
Guide
Configure scoped secret access for resources and workflows
Restrict secrets usage to specific resource or workflow folders using naming enforcement.
Guide
Configure SSL and custom certificates
Learn how to connect to Retool with HTTPS and configure custom certificates for Docker-based deployments.
Guide
Configure telemetry for self-hosted Retool
Configure the Retool telemetry collector, choose which data Retool receives, and send telemetry data to your own monitoring destinations.
Guide
Configure the app builder's orchestration backend
Learn how self-hosted Retool chooses between pg-boss and Temporal for the app builder, how to check which one it uses, and how to change it.
Guide
Container logs
Learn about capturing logs for your Retool deployment.
Concept
Cookies environment variables
Reference documentation for cookie-related environment variables.
Reference
Custom code execution security
How Retool sandboxes custom code across services and the container privilege requirements for each.
Concept
Deploy Retool on AWS with Terraform
Deploy a production-ready self-hosted Retool instance on AWS using Retool's Terraform blueprints.
Tutorial
Deploy Retool on Azure with Terraform
Deploy a production-ready self-hosted Retool instance on Azure using Retool's Terraform blueprints.
Tutorial
Deploy Retool on GCP with Terraform
Deploy a production-ready self-hosted Retool instance on Google Cloud using Retool's Terraform blueprints.
Tutorial
Deploy Retool on Kubernetes with Helm
Deploy Retool on Kubernetes with the Helm package manager using your own cluster.
Tutorial
Deploy self-hosted Retool on Kubernetes
Tutorials for initial installation of a production instance of Retool on Kubernetes.
Tutorial
Deploy self-hosted Retool with Docker
Deploy a non-production instance of self-hosted Retool on a Linux-based VM using Docker.
Tutorial
Enable Retool-managed Vectors on self-hosted deployments
Learn how to configure and enable Retool-managed Vectors for self-hosted Retool deployments.
Guide
Enable the MCP server
Enable Retool's MCP server on a self-hosted instance so MCP clients can connect and authenticate with OAuth 2.0.
Guide
Environment variables reference
Environment variables for self-hosted Retool deployments.
Reference
General environment variables
Reference documentation for general environment variables.
Reference
Hardened images for self-hosted Retool
Learn about hardened images for self-hosted Retool, including security changes, ARM64 support, and migration guidance.
Concept
Logging environment variables
Reference documentation for logging-related environment variables.
Reference
Manage secrets with environment variables
Learn how to use secrets to manage environment variables.
Guide
Manage secrets with the file system
Learn how to use the file system to manage secrets.
Guide
Migrate a self-hosted Retool instance
Guides for migrating existing self-hosted Retool instances to supported infrastructure.
Guide
Migrate from Cloud to Self-hosted
Learn how to migrate to a self-hosted deployment from Retool Cloud.
Guide
Migrate from Docker Compose to Kubernetes
Migrate a production Retool deployment from Docker Compose to a supported Kubernetes blueprints deployment.
Guide
Migrate from ECS to Kubernetes
Migrate an existing Retool deployment on Amazon ECS to a supported Kubernetes blueprints deployment.
Guide
Migrate from Self-hosted to Cloud
Learn how to migrate from a self-hosted deployment to Retool Cloud.
Guide
Mobile environment variables
Reference documentation for Retool Mobile-related environment variables.
Reference
Monitor app and user analytics
Learn how to access usage and adoption trends across your Retool organization.
Guide
Monitoring and alerting best practices
Learn how to monitor and set up alerting for your self-managed Retool instance.
Concept
Multi-instance deployment
Learn about deploying self-hosted Retool to multiple instances.
Concept
Multiplayer for self-hosted classic apps
Learn how to set up multiplayer for classic apps on a self-hosted deployment.
Guide
Prevent users from creating or using specific resource types
Learn how to restrict users from creating or using certain resource integration types.
Guide
Protect resources with Source Control
Learn how to protect and sync resources using Source Control.
Guide
Protect themes with Source Control
Learn how to protect and sync themes using Source Control.
Guide
Queries environment variables
Reference documentation for query-related environment variables.
Reference
Redact sandbox tokens from ingress access logs
Set up your network gateway to redact short-lived authentication tokens from access logs.
Guide
Redis environment variables
Reference documentation for Redis-related environment variables.
Reference
Resources environment variables
Reference documentation for resource-related environment variables.
Reference
Retool-managed deployment architecture
Learn about the system architecture for Retool-managed, self-hosted deployments.
Concept
Retool-managed deployment concept guides
Learn about relevant features, functionality, and principles related to Retool-managed, self-hosted deployments.
Retool-managed deployment health monitoring and scaling
Learn about monitoring and scaling Retool-managed, self-hosted deployments.
Concept
Retool-managed deployment how-to guides
Step-by-step instructions for using common features and functionality of Retool-managed, self-hosted deployments.
Retool-managed deployment ownership and responsibilities
Information about the ownership and responsibilities for Retool-managed, self-hosted deployments.
Reference
Retool-managed deployment quickstart
Learn about the fundamental concepts of self-hosted, Retool-managed deployments.
Quickstart
Retool-managed deployment reference
Reference documentation for Retool-managed, self-hosted deployments.
Retool-managed deployment security
Learn about security and restrictions for Retool-managed, self-hosted deployments.
Concept
Retrieve secrets from AWS Secrets Manager
Learn how to use AWS Secrets Manager to store your Retool resource secrets.
Guide
Retrieve secrets from Azure Key Vault
Learn how to use Azure Key Vault to store your Retool resource secrets.
Guide
Retrieve secrets from GCP Secrets Manager
Learn how to use Google Cloud Platform (GCP) Secrets Manager to store your Retool resource secrets.
Guide
Retrieve secrets from HashiCorp Vault
Learn how to use HashiCorp Vault to store your Retool resource secrets.
Guide
Rotate SSH keys
Learn how to rotate Retool's SSH keys.
Guide
Rotate your encryption key
Learn how to rotate Retool's encryption keys.
Guide
Scale your self-hosted deployment infrastructure
Learn how to scale your Retool deployment and infrastructure.
Guide
Security checklist for self-managed Retool
A checklist of security controls to apply before and after deploying self-managed Retool.
Concept
Security environment variables
Reference documentation for security-related environment variables.
Reference
Security hardening best practices
Learn about security hardening options for self-hosted Retool.
Concept
Self-hosted deployments
Choose between a Retool-managed or self-managed self-hosted Retool instance.
Self-hosted Retool concept guides
Learn about relevant features, functionality, and principles related to self-hosted Retool.
Self-hosted Retool egress connections
Learn about external connections and data egress from self-hosted Retool deployments.
Reference
Self-hosted Retool glossary
Learn the meanings of self-hosted Retool-related terms.
Reference
Self-hosted Retool how-to guides
Step-by-step instructions for common features and functionality of self-hosted Retool deployments.
Self-hosted Retool migration guides
Learn how to migrate between Retool Cloud and self-hosted Retool.
Guide
Self-hosted Retool reference
Reference documentation for self-hosted Retool.
Self-hosted Retool secrets management guides
Use secrets from third-party secrets managers in Self-hosted Retool.
Guide
Self-hosted Retool tutorials
Hands-on guides for deploying self-hosted Retool.
Self-hosted Retool upgrade best practices
Learn about best practices for upgrading your self-hosted Retool deployment.
Concept
Self-hosted, Retool-managed deployments
Deploy a self-hosted, Retool-managed Retool instance on your own infrastructure.
Self-hosted, self-managed
Host and manage a self-hosted, self-managed Retool instance on your own infrastructure.
Self-hosted, self-managed Retool quickstart
Learn about the fundamental concepts of a self-hosted, self-managed Retool deployment.
Quickstart
Self-managed Retool administration best practices
Best practices for administering, maintaining, and operating self-managed Retool instances.
Concept
Set spend controls for AI usage
Set limits on AI credit and token usage for users, groups, and models.
Guide
Set up Retool Database on Self-hosted deployments
Learn how to configure Retool Database on self-hosted Retool deployments.
Guide
Set up Retool Storage on Self-hosted deployments
Learn how to configure Retool Storage on self-hosted Retool deployments.
Guide
Source Control environment variables
Reference documentation of environment variables for Source Control.
Reference
Storage database environment variables
Reference documentation of environment variables for the postgres service and database.
Reference
System architecture of self-hosted Retool deployments
Learn about Retool's self-hosted architecture.
Concept
Temporal Clusters for Self-hosted Retool
Learn about Temporal Clusters for self-hosted Retool deployments.
Concept
Temporal environment variables for local clusters
Temporal environment variable reference for self-hosted organizations using a local cluster.
Reference
Troubleshooting self-managed instances
Diagnose and resolve common issues with self-managed Retool deployments.
Guide
Upgrade from Retool 3.x to 4.0
Upgrade an existing self-hosted Retool 3.x instance to Retool 4.0.
Guide
Upgrade from Retool 3.x to 4.0 (Docker Compose)
Upgrade an existing self-hosted Retool 3.x Docker Compose deployment to Retool 4.0.
Guide
Upgrade from Retool 3.x to 4.0 (Helm)
Upgrade an existing self-hosted Retool 3.x Helm deployment to Retool 4.0.
Guide
Upgrade or migrate self-hosted Retool
Guides for upgrading and migrating existing self-hosted Retool instances.
Guide
Upgrade planning best practices
Learn how to plan and manage Retool upgrades for self-managed instances.
Concept
Upgrade within the Retool 4.x line
Upgrade an existing self-hosted Retool 4.x instance to a later 4.x stable release.
Guide
Upgrade within the Retool 4.x line (Docker Compose)
Upgrade an existing self-hosted Retool 4.x Docker Compose instance to a later 4.x stable release.
Guide
Upgrade within the Retool 4.x line (Helm)
Upgrade an existing self-hosted Retool 4.x Helm instance to a later 4.x stable release.
Guide
Use Kerberos authentication with Microsoft SQL Server resources
Learn how to configure a self-hosted instance to use Kerberos authentication with Microsoft SQL Server resources.
Guide
Workflows environment variables
Reference documentation for Retool Workflows-related environment variables.
Reference