mirror of
https://github.com/OpenHands/OpenHands.git
synced 2025-12-26 05:48:36 +08:00
docs: Reorder docs and small update to README (#2860)
Co-authored-by: Mahmoud Work <mahmoudwork@mahmouds-mini.home>
This commit is contained in:
parent
351127db55
commit
e2636f9ece
@ -75,9 +75,11 @@ docker run -it \
|
||||
> Choose the tag that best suits your needs based on stability requirements and desired features.
|
||||
|
||||
You'll find OpenDevin running at [http://localhost:3000](http://localhost:3000) with access to `./workspace`. To have OpenDevin operate on your code, place it in `./workspace`.
|
||||
|
||||
OpenDevin will only have access to this workspace folder. The rest of your system will not be affected as it runs in a secured docker sandbox.
|
||||
|
||||
Upon opening OpenDevin, you must select the appropriate `Model` and enter the `API Key` within the settings that should pop up automatically. These can be set at any time by selecting
|
||||
the `Settings` button (gear icon) in the UI. If the required `Model` does not exist in the list, you can manually enter it in the text box.
|
||||
|
||||
For the development workflow, see [Development.md](https://github.com/OpenDevin/OpenDevin/blob/main/Development.md).
|
||||
|
||||
Are you having trouble? Check out our [Troubleshooting Guide](https://opendevin.github.io/OpenDevin/modules/usage/troubleshooting).
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
sidebar_position: 8
|
||||
---
|
||||
|
||||
# 📚 Misc
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
sidebar_position: 7
|
||||
---
|
||||
|
||||
# 🏛️ System Architecture Overview
|
||||
|
||||
@ -1,14 +1,18 @@
|
||||
# 💿 How to Create a Custom Docker Sandbox
|
||||
---
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
# 💿 How to Create and Use 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.
|
||||
|
||||
There are two ways you can do so:
|
||||
1. Use an existing image from docker hub. For instance, if you want to have `nodejs` installed, you can do so by using the `node:20` image.
|
||||
2. Creating your own custom docker image.
|
||||
1. Use an existing image from docker hub. For instance, if you want to have `nodejs` installed, you can do so by using the `node:20` image
|
||||
2. Creating your own custom docker image and using it
|
||||
|
||||
If you want to take the first approach, you can skip the next section.
|
||||
If you want to take the first approach, you can skip the `Create Your Docker Image` section.
|
||||
|
||||
## Setup
|
||||
|
||||
@ -17,7 +21,7 @@ Make sure you are able to run OpenDevin using the [Development.md](https://githu
|
||||
## Create Your Docker Image
|
||||
To create a custom docker image, it must be debian/ubuntu based.
|
||||
|
||||
For example, if we want OpenDevin to have access to the "node" binary, we would use the following Dockerfile:
|
||||
For example, if we want OpenDevin to have access to the `node` binary, we would use the following Dockerfile:
|
||||
|
||||
```dockerfile
|
||||
# Start with latest ubuntu image
|
||||
@ -30,9 +34,9 @@ RUN apt-get update && apt-get install -y
|
||||
RUN apt-get install -y nodejs
|
||||
```
|
||||
|
||||
Next build your docker image with the name of your choice, for example "custom_image".
|
||||
Next build your docker image with the name of your choice, for example `custom_image`.
|
||||
|
||||
To do this you can create a directory and put your file inside it with the name "Dockerfile", and inside the directory run the following command:
|
||||
To do this you can create a directory and put your file inside it with the name `Dockerfile`, and inside the directory run the following command:
|
||||
|
||||
```bash
|
||||
docker build -t custom_image .
|
||||
@ -58,9 +62,9 @@ run_as_devin=true
|
||||
sandbox_container_image="custom_image"
|
||||
```
|
||||
|
||||
For sandbox_container_image, you can specify either:
|
||||
1. The name of your custom image that you built in the previous step (e.g., "custom_image")
|
||||
2. A pre-existing image from Docker Hub (e.g., "node:20" if you want a sandbox with Node.js pre-installed)
|
||||
For `sandbox_container_image`, you can specify either:
|
||||
1. The name of your custom image that you built in the previous step (e.g., `”custom_image”`)
|
||||
2. A pre-existing image from Docker Hub (e.g., `”node:20”` if you want a sandbox with Node.js pre-installed)
|
||||
|
||||
## Run
|
||||
Run OpenDevin by running ```make run``` in the top level directory.
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
sidebar_position: 5
|
||||
---
|
||||
|
||||
# ✅ Providing Feedback
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
# 🚧 Troubleshooting
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user