Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update docker run cmd in readme.md #4786

Closed
wants to merge 1 commit into from
Closed

docs: update docker run cmd in readme.md #4786

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,20 @@ docker pull docker.all-hands.dev/all-hands-ai/runtime:0.12-nikolaik

docker run -it --pull=always \
-e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.all-hands.dev/all-hands-ai/runtime:0.12-nikolaik \
-e SANDBOX_USER_ID=${SANDBOX_USER_ID:-1234} \
-e WORKSPACE_MOUNT_PATH=${WORKSPACE_BASE:-$PWD/workspace} \
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These were removed on purpose in the latest release. Is there a specific reason you have added them?

Copy link
Author

@Tomlili43 Tomlili43 Nov 7, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

problem: file sync from container to local machine
issue
solution add env variable to sync

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The default way to run OpenHands in the README is not providing a local filesystem.
If you wanted to attach a local filesystem, you can use the document here which is also mentioned in this readme a bit below:
https://docs.all-hands.dev/modules/usage/runtimes#connecting-to-your-filesystem

This doc has all the options you show above so I don't think this PR is required in the main README.

-v /var/run/docker.sock:/var/run/docker.sock \
-p 3000:3000 \
--add-host host.docker.internal:host-gateway \
--name openhands-app \
docker.all-hands.dev/all-hands-ai/openhands:0.12
```

if you run from a local machine, you can use the following command:
```
docker compose up
```
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was added by a community member but is not supported officially by the maintainers.


You'll find OpenHands running at [http://localhost:3000](http://localhost:3000)!

Finally, you'll need a model provider and API key.
Expand Down