Deploy using Docker Compose

How to deploy Toolbox using Docker Compose.

Before you begin

  1. Install Docker Compose.

Configure tools.yaml file

Create a tools.yaml file that contains your configuration for Toolbox. For details, see the configuration section.

Deploy using Docker Compose

  1. Create a docker-compose.yml file, customizing as needed:
services: toolbox: # TODO: It is recommended to pin to a specific image version instead of latest. image: us-central1-docker.pkg.dev/database-toolbox/toolbox/toolbox:latest hostname: toolbox platform: linux/amd64 ports: - "5000:5000" volumes: - ./config:/config command: [ "toolbox", "--tools_file", "/config/tools.yaml", "--address", "0.0.0.0"] depends_on: db: condition: service_healthy networks: - tool-network db: # TODO: It is recommended to pin to a specific image version instead of latest. image: postgres hostname: db environment: POSTGRES_USER: toolbox_user POSTGRES_PASSWORD: my-password POSTGRES_DB: toolbox_db ports: - "5432:5432" volumes: - ./db:/var/lib/postgresql/data # This file can be used to bootstrap your schema if needed. # See "initialization scripts" on https://hub.docker.com/_/postgres/ for more info - ./config/init.sql:/docker-entrypoint-initdb.d/init.sql healthcheck: test: ["CMD-SHELL", "pg_isready -U toolbox_user -d toolbox_db"] interval: 10s timeout: 5s retries: 5 networks: - tool-network networks: tool-network:
  1. Run the following command to bring up the Toolbox and Postgres instance

    docker-compose up -d

Tip

You can use this setup quickly set up Toolbox + Postgres to follow along in our Quickstart

Connecting with Toolbox Client SDL

Next, we will use Toolbox with the Client SDKs:

  1. The url for the Toolbox server running using docker-compose will be:

    http://localhost:5000
    
  2. Import and initialize the client with the URL:

    from toolbox_langchain_sdk import ToolboxClient # Replace with the cloud run service URL generated above toolbox = ToolboxClient("$YOUR_URL")