From 418cda23c5aa71c2c3a75beff7dae5217930a92f Mon Sep 17 00:00:00 2001 From: Xingyao Wang Date: Thu, 27 Jun 2024 03:58:19 +0800 Subject: [PATCH] Update custom_sandbox_guide.md (#2650) --- docs/modules/usage/custom_sandbox_guide.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/modules/usage/custom_sandbox_guide.md b/docs/modules/usage/custom_sandbox_guide.md index f8a716d0e3..66db26aa15 100644 --- a/docs/modules/usage/custom_sandbox_guide.md +++ b/docs/modules/usage/custom_sandbox_guide.md @@ -1,4 +1,4 @@ -# How to Create a Custom Docker Sandbox +# 💿 How to Create a Custom Docker Sandbox The default OpenDevin sandbox comes with a [minimal ubuntu configuration](https://github.com/OpenDevin/OpenDevin/blob/main/containers/sandbox/Dockerfile). Your use case may need additional software installed by default. This guide will teach you how to accomplish this by utilizing a custom docker image. @@ -10,6 +10,9 @@ To get started running with your own Docker Sandbox image you need to ensure you 3. Then run ```make run``` 4. Finally navigate your browser to ```localhost:3001``` to ensure that your local build of OpenDevin is functional + +Please refer to [Development.md](https://github.com/OpenDevin/OpenDevin/blob/main/Development.md) for more installation details. + > Note that the above steps will take some time to run and will require that your have python3.11, poetry (a python package manager), and Docker installed @@ -101,8 +104,9 @@ sandbox_user_id="1001" ``` ### Port use errors -If you see an error about a port being in use or unavailable, try deleting all running Docker Containers and then re-running ```make run``` + +If you see an error about a port being in use or unavailable, try deleting all running Docker Containers (run `docker ps` and `docker rm` relevant containers) and then re-running ```make run``` ## Discuss -For other issues or questions join the [Slack](https://join.slack.com/t/opendevin/shared_invite/zt-2jsrl32uf-fTeeFjNyNYxqSZt5NPY3fA) or [Discord](https://discord.gg/ESHStjSjD4) and ask! \ No newline at end of file +For other issues or questions join the [Slack](https://join.slack.com/t/opendevin/shared_invite/zt-2jsrl32uf-fTeeFjNyNYxqSZt5NPY3fA) or [Discord](https://discord.gg/ESHStjSjD4) and ask!