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.

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: improve custom sandbox guide with more configuration options #5589

Merged
merged 2 commits into from
Jan 17, 2025

Conversation

neubig
Copy link
Contributor

@neubig neubig commented Dec 13, 2024

This PR improves the custom sandbox guide by:

  1. Clarifying that any base image can be used, not just Debian-based ones
  2. Adding examples using both the default nikolaik/python-nodejs image and a Ruby-specific image
  3. Adding a new section "Additional Configuration Options" that documents:
    • runtime_extra_deps for installing additional dependencies
    • runtime_startup_env_vars for setting environment variables
    • platform for multi-architecture builds

To run this PR locally, use the following command:

docker run -it --rm   -p 3000:3000   -v /var/run/docker.sock:/var/run/docker.sock   --add-host host.docker.internal:host-gateway   -e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.all-hands.dev/all-hands-ai/runtime:b8beaf6-nikolaik   --name openhands-app-b8beaf6   docker.all-hands.dev/all-hands-ai/openhands:b8beaf6

@neubig neubig self-assigned this Dec 27, 2024
@neubig neubig requested a review from mamoodi December 29, 2024 03:40
@neubig neubig assigned mamoodi and unassigned neubig Dec 29, 2024
@xingyaoww xingyaoww merged commit 62fbe4c into main Jan 17, 2025
15 checks passed
@xingyaoww xingyaoww deleted the update-custom-sandbox-docs branch January 17, 2025 21:05
csmith49 pushed a commit to csmith49/OpenHands that referenced this pull request Jan 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants