goose in Docker
This guide covers two Docker-related scenarios:
- Running goose inside Docker - Build and run the goose process itself in a container
- Running extensions in Docker - Run goose on your host but execute extensions inside a container
Running goose Inside Docker
You can build goose from the source file within a Docker container. This approach not only provides security benefits by creating an isolated environment but also enhances consistency and portability. For example, if you need to troubleshoot an error on a platform you don't usually work with (such as Ubuntu), you can easily debug it using Docker.
To begin, you will need to modify the Dockerfile and docker-compose.yml files to suit your requirements. Some changes you might consider include:
-
Required: Setting your API key, provider, and model in the
docker-compose.ymlfile as environment variables because the keyring settings do not work on Ubuntu in Docker. This example uses Google Gemini. -
Optional: Changing the base image to a different Linux distribution in the
Dockerfile. This example uses Ubuntu, but you can switch to another distribution such as CentOS, Fedora, or Alpine. -
Optional: Mounting your personal goose settings and hints files in the
docker-compose.ymlfile. This allows you to use your personal settings and hints files within the Docker container.
For an automated approach to running goose in containers, see the Container-Use MCP extension, which creates and manages containers for you through conversation.
After setting the credentials, you can build the Docker image using the following command:
docker-compose -f documentation/docs/docker/docker-compose.yml build
Next, run the container and connect to it using the following command:
docker-compose -f documentation/docs/docker/docker-compose.yml run --rm goose-cli
Inside the container, run the following command to configure goose:
goose configure
When prompted to save the API key to the keyring, select No, as you are already passing the API key as an environment variable.
Configure goose a second time, and this time, you can add any extensions you need.
After that, you can start a session:
goose session
You should now be able to connect to goose with your configured extensions enabled.
Running Extensions in Docker Containers
The --container flag allows you to run goose extensions inside your Docker containers.
Usage
goose session --container <container-id-or-name>
Extensions configured in your config.yaml will automatically run inside the specified container. Find your container ID or name with docker ps.
Requirements
- Extensions must exist in the container and be accessible via the same paths used in your extension config
- To run built-in extensions, the goose CLI must be installed inside the container
Examples
# Start an interactive session with extensions from config.yaml
goose session --container my-dev-container
# Start a non-interactive session with instructions
goose run --container my-dev-container --text "your instructions here"
# Specify an extension to run in the container
goose session --container 4c76a1beed85 --with-extension "uvx mcp-server-fetch"
# Workaround: Use full path if container can't find the command
goose session --container 4c76a1beed85 --with-extension "/root/.local/bin/uvx mcp-server-fetch"