mirror of
https://github.com/block/goose.git
synced 2026-04-28 11:39:43 +00:00
docs: run extensions in containers (#6971)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
parent
c7718a425a
commit
57033b70b5
5 changed files with 60 additions and 75 deletions
|
|
@ -1,12 +1,14 @@
|
|||
---
|
||||
title: Building goose in Docker
|
||||
title: goose in Docker
|
||||
sidebar_label: goose in Docker
|
||||
description: Run goose inside Docker containers, or run extensions in existing containers for devcontainer workflows
|
||||
---
|
||||
|
||||
:::info Tell Us What You Need
|
||||
There are various scenarios where you might want to build goose in Docker. If the instructions below do not meet your needs, please contact us by replying to our [discussion topic](https://github.com/block/goose/discussions/1496).
|
||||
:::
|
||||
This guide covers two Docker-related scenarios:
|
||||
1. **Running goose inside Docker** - Build and run the goose process itself in a container
|
||||
2. **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.
|
||||
|
||||
|
|
@ -18,7 +20,9 @@ To begin, you will need to modify the `Dockerfile` and `docker-compose.yml` file
|
|||
|
||||
- **Optional:** Mounting your personal goose settings and hints files in the `docker-compose.yml` file. This allows you to use your personal settings and hints files within the Docker container.
|
||||
|
||||
|
||||
:::tip Automated Alternative
|
||||
For an automated approach to running goose in containers, see the [Container-Use MCP extension](/docs/mcp/container-use-mcp), which creates and manages containers for you through conversation.
|
||||
:::
|
||||
|
||||
After setting the credentials, you can build the Docker image using the following command:
|
||||
|
||||
|
|
@ -48,4 +52,37 @@ After that, you can start a session:
|
|||
goose session
|
||||
```
|
||||
|
||||
You should now be able to connect to goose with your configured extensions enabled.
|
||||
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
|
||||
|
||||
```bash
|
||||
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](/docs/getting-started/installation) inside the container
|
||||
|
||||
### Examples
|
||||
|
||||
```bash
|
||||
# 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"
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue