Overview
This guide covers the required agent-sandbox related configuration changes for FastGPT Docker Compose deployments, as part of the 4.14.10 upgrade process. All configuration steps and parameters are sourced directly from the official FastGPT deployment repository. This configuration does not apply to Sealos commercial deployments, which use an alternative sandbox service setup.
Step-by-Step Configuration
- Retrieve the latest official Docker Compose deployment file from the FastGPT GitHub repository at the specified public location.
- Add the top-level anchor authentication token variable at the start of the docker-compose.yml file: ``
yaml x-volume-manager-auth-token: &x-volume-manager-auth-token 'vmtoken'`` - Append three new service definitions to the compose file:
opensandbox-server,volume-manager, andagent-sandbox-image. - Copy the pre-defined
configsblock from the bottom of the sample deployment file and append it directly to your local compose file. - Update the environment variables section of the existing
fastgptservice to include the full agent sandbox configuration block: ``yaml # ==================== Agent sandbox config ==================== AGENT_SANDBOX_PROVIDER: opensandbox # OpenSandbox config (effective when PROVIDER: opensandbox) AGENT_SANDBOX_OPENSANDBOX_BASEURL: http://opensandbox-server:8090 AGENT_SANDBOX_OPENSANDBOX_API_KEY: AGENT_SANDBOX_OPENSANDBOX_RUNTIME: docker AGENT_SANDBOX_OPENSANDBOX_IMAGE_REPO: ghcr.io/labring/fastgpt/fastgpt-agent-sandbox AGENT_SANDBOX_OPENSANDBOX_IMAGE_TAG: v0.0.2 # Volume persistence config (optional under opensandbox provider) AGENT_SANDBOX_ENABLE_VOLUME: true AGENT_SANDBOX_VOLUME_MANAGER_URL: http://volume-manager:3000 AGENT_SANDBOX_VOLUME_MANAGER_TOKEN: *x-volume-manager-auth-token``
Configuration Parameters
All agent sandbox environment variables must be added to the fastgpt service's environment list. The following table lists each required and optional parameter:
| Parameter | Requirement | Example Value |
|---|---|---|
AGENT_SANDBOX_PROVIDER | Required | opensandbox |
AGENT_SANDBOX_OPENSANDBOX_BASEURL | Required | http://opensandbox-server:8090 |
AGENT_SANDBOX_OPENSANDBOX_API_KEY | Optional | (empty string) |
AGENT_SANDBOX_OPENSANDBOX_RUNTIME | Required | docker |
AGENT_SANDBOX_OPENSANDBOX_IMAGE_REPO | Required | ghcr.io/labring/fastgpt/fastgpt-agent-sandbox |
AGENT_SANDBOX_OPENSANDBOX_IMAGE_TAG | Required | v0.0.2 |
AGENT_SANDBOX_ENABLE_VOLUME | Optional | true |
AGENT_SANDBOX_VOLUME_MANAGER_URL | Required if enabling volume persistence | http://volume-manager:3000 |
AGENT_SANDBOX_VOLUME_MANAGER_TOKEN | Required if enabling volume persistence | Reference to the top-level anchor token *x-volume-manager-auth-token |
Source: FastGPT official source
Applicability and version scope
Use this page for the documented Deployment and upgrades scenario. Confirm the FastGPT, dependency, API, and deployment versions in the official source before applying a change.
Safety guardrails
Use [REDACTED_CREDENTIAL] for credentials and private data. Confirm the documented environment and version before review.
Rollback guidance
Restore the prior technical-content authority snapshot. Restore saved configuration and data snapshots, then repeat the smallest verification scenario.