feat: Build Goose in a Docker Container by ZhenLian · Pull Request #1551 · block/goose

ZhenLian · 2025-03-06T16:13:17Z

Description

This update partially addresses issue #1072, where users requested the ability to build and run Goose in a Docker container. Since users may have different use cases for using Docker, I've added a discussion thread to explore additional use cases and allow users to contribute their own. This update also includes a brief guide on how to build Goose within a Docker container.

Testing

I tested this on my local laptop.

When running the Goose CLI in the docker container, you can observe the following:
On the first run of goose config, you select the API key settings:
On the second run of goose config, you choose the extension settings (I selected the developer tool).
Running goose session will then initiate a Goose session with developer tool capabilities.

github-actions · 2025-03-06T16:14:52Z

PR Preview Action v1.6.0
🚀 View preview at https://block.github.io/goose/pr-preview/pr-1551/
Built to branch `gh-pages` at 2025-03-07 16:00 UTC. Preview will be ready when the GitHub Pages deployment is complete.

lily-de

thanks for the documentation! 🙏

yingjiehe-xyz · 2025-03-06T16:50:17Z

Thanks for the contribution! Have you tried run goose with custom extensions?

yingjiehe-xyz · 2025-03-06T16:51:43Z

Dockerfile

+    rm -rf /var/lib/apt/lists/*
+
+# Install common development tools
+RUN apt-get update && apt-get install -y \


do we want to install uv as well?

Certainly! I included a line to install uv and verified within the Docker container that it is properly installed.

yingjiehe-xyz · 2025-03-06T16:53:22Z

docker-compose.yml

+      # Preserve git author info
+      - GIT_AUTHOR_NAME=${GIT_AUTHOR_NAME:-Goose User}
+      - GIT_AUTHOR_EMAIL=${GIT_AUTHOR_EMAIL:[email protected]}
+      # Set GOOGLE_API_KEY to your own API key


should we ignore the env variable here? I think it would be better to set it via goose configure

Yeah, there are some nuances here. Docker operates in a headless environment, and it lacks certain built-in packages for user display. When we attempt to set and save the key into the keyring using goose configure, we will encounter this error:

Error Failed to access secure storage: Platform secure storage failure: DBus error: Unable to autolaunch a dbus-daemon without a $DISPLAY for X11 Please check your system's secure storage and run 'goose configure' again. If your system is unable to use secure storage, please try setting secret key(s) via environment variables.

In the Dockerfile, I've included a script to try installing DBus, but it hasn't worked yet. I'll continue monitoring this issue, and if I find a solution for storing this in the keyring, I'll update the code and instructions accordingly!

Dockerfile

kalvinnchau · 2025-03-06T16:58:39Z

docker-compose.yml

+      - SSH_AUTH_SOCK
+    stdin_open: true
+    tty: true
+    entrypoint: ["/bin/bash"]


does this override the goose-wrapper entrypoint and is that intentional?

Good catch! The goose-wrapper entrypoint isn't being utilized. I've removed it and revised some of the wording.

kalvinnchau · 2025-03-06T17:00:33Z

docker-compose.yml

+      # Mount git config (optional)
+      - ~/.gitconfig:/home/goose/.gitconfig:ro
+      # Mount SSH keys (optional)
+      - ~/.ssh:/home/goose/.ssh:ro


how are these defined as optional? wouldn't this always mount the directories via docker compose?

Yes, my goal was to inform users that the volume mounting configurations are adjustable - they can decide whether to comment out those lines. That seems to be confusing though. I removed the optional wording, as users can simply read the code and remove those lines if necessary.

michaelneale

the dockerfile and compose should be in docs dir, not root, as they are for illustration purposes is that right?

ZhenLian · 2025-03-07T16:01:24Z

the dockerfile and compose should be in docs dir, not root, as they are for illustration purposes is that right?

Sure, I moved them to the docs folder and updated the instructions for how to compile them.

ZhenLian · 2025-03-07T16:07:18Z

Have you tried run goose with custom extensions?

Not yet. My goal was to create a basic Docker template file to help users understand how to build Docker images from it. Once they're connected to the container, they have the freedom to add additional dependencies or custom extensions as they wish.
That being said, if there are any particularly useful extensions, I'd be glad to test them and add them to the documentation (so far, I've only worked with the built-in extensions :)). Given that Docker runs in a headless environment, some extensions might not be as advantageous as others. Maybe we could wait until a user specifically requests an extension?

ZhenLian · 2025-03-07T16:14:25Z

@kalvinnchau @michaelneale @yingjiehe-xyz
Cool, I think I've addressed all your comments above. Could I ask for another review of this PR? Thank you very much!

michaelneale

thanks!

ZhenLian · 2025-03-10T16:20:33Z

@yingjiehe-xyz @michaelneale Awesome, thanks for the review!
@kalvinnchau I am merging this, but if you happen to spot anything in the future, feel free to let me know - happy to submit a fix in a supplemental PR after this!

* main: feat: enable smart approve for user by default (#1599) ui: fix modal state (#1598) ui: setting configuration (#1597) fix: merge error logging in goose bench (#1545) feat: add additional goosebench evals (#1571) chore: update types and imports (#1594) Retain session through view changes (#1580) docs: Add steps for desktop tutorial (#1590) remove env vars from bottom menu model setting (#1584) Fix Goosehints modal UI (#1581) docs: typo fix (#1593) feat: update config endpoints for use with providers (#1563) fix: update anthropic provider headers (#1592) feat: Build Goose in a Docker Container (#1551) docs: voyp blog post (#1588)

evangineer · 2025-04-12T19:23:39Z

I'm working on integrating Goose with a multi-Docker Compose setup, and have been puzzled by the line below.

- OOSE_HOME=/root/.goose

Is it a typo and why can't I find any info at all for either OOSE_HOME or GOOSE_HOME in the docs, the repo and the discord?

goose/documentation/docs/docker/docker-compose.yml

Line 18 in b1bf9d7

- OOSE_HOME=/root/.goose

blevz · 2025-04-27T16:32:19Z

Yup, this satisfies the thrust of my request. Tysm

Build Goose in a Docker Container

f015cc8

ZhenLian marked this pull request as ready for review March 6, 2025 16:13

lily-de approved these changes Mar 6, 2025

View reviewed changes

yingjiehe-xyz reviewed Mar 6, 2025

View reviewed changes

kalvinnchau reviewed Mar 6, 2025

View reviewed changes

kalvinnchau changed the title ~~Build Goose in a Docker Container~~ feat: Build Goose in a Docker Container Mar 6, 2025

michaelneale requested changes Mar 7, 2025

View reviewed changes

ZhenLian added 3 commits March 7, 2025 07:15

resolve comments

5340196

update key

e2498d8

move docker files to docs

dcdf146

ZhenLian requested review from kalvinnchau, michaelneale and yingjiehe-xyz March 7, 2025 16:12

yingjiehe-xyz approved these changes Mar 7, 2025

View reviewed changes

michaelneale approved these changes Mar 9, 2025

View reviewed changes

ZhenLian merged commit 9004c19 into main Mar 10, 2025
4 checks passed

ZhenLian deleted the zhen_docker_1 branch March 10, 2025 16:20

ahau-square pushed a commit that referenced this pull request May 2, 2025

feat: Build Goose in a Docker Container (#1551)

7d0458b

cbruyndoncx pushed a commit to cbruyndoncx/goose that referenced this pull request Jul 20, 2025

feat: Build Goose in a Docker Container (block#1551)

c6ed11c

Conversation

ZhenLian commented Mar 6, 2025

Description

Testing

Uh oh!

github-actions bot commented Mar 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Built to branch gh-pages at 2025-03-07 16:00 UTC. Preview will be ready when the GitHub Pages deployment is complete.

Uh oh!

lily-de left a comment

Choose a reason for hiding this comment

Uh oh!

yingjiehe-xyz commented Mar 6, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

michaelneale left a comment

Choose a reason for hiding this comment

Uh oh!

ZhenLian commented Mar 7, 2025

Uh oh!

ZhenLian commented Mar 7, 2025

Uh oh!

ZhenLian commented Mar 7, 2025

Uh oh!

michaelneale left a comment

Choose a reason for hiding this comment

Uh oh!

ZhenLian commented Mar 10, 2025

Uh oh!

Uh oh!

evangineer commented Apr 12, 2025

Uh oh!

blevz commented Apr 27, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

github-actions bot commented Mar 6, 2025 •

edited

Loading

Built to branch `gh-pages` at 2025-03-07 16:00 UTC.
Preview will be ready when the GitHub Pages deployment is complete.