search

All-Hands-AI / OpenHands

🙌 OpenHands: Code Less, Make More
https://all-hands.dev
MIT License
37.38k stars 4.23k forks source link

docs: improve custom sandbox guide with detailed requirements and examples #5268

Open h55nick opened 3 hours ago

h55nick commented 3 hours ago

This PR improves the custom sandbox guide documentation by:

  1. Adding a clear "Important Requirements" section highlighting:

    • Debian-based image requirement
    • Root user requirement
    • System-wide package availability

  2. Providing a complete example Dockerfile with multiple packages

  3. Adding two methods for building and running:

    • Direct Docker build
    • Docker Compose setup

  4. Including detailed sections on:

    • Configuration options
    • Common issues and troubleshooting
    • Testing procedures
    • Security considerations

This addresses issue #5266 by making the custom sandbox setup process more clear and comprehensive.

Changes include: