github/OpenHands
1
0
Fork 0
mirror of https://github.com/OpenHands/OpenHands.git synced 2025-12-26 05:48:36 +08:00
Code Issues Packages Projects Releases Wiki Activity

One-step launch instructions (#2189)

Browse Source 
Co-authored-by: மனோஜ்குமார் பழனிச்சாமி <smartmanoj42857@gmail.com>
Co-authored-by: Robert Brennan <accounts@rbren.io>
This commit is contained in:
Xida Ren (Cedar) 2024-06-03 23:28:50 -07:00 committed by GitHub
parent 2374374778
commit 1314a09ce9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 17 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -49,25 +49,20 @@ OpenDevin agents collaborate with human developers to write code, fix bugs, and
The easiest way to run OpenDevin is inside a Docker container. It works best with the most recent version of Docker, `26.0.0`.
You must be using Linux, Mac OS, or WSL on Windows.
To start the app, run these commands, replacing `$(pwd)/workspace` with the directory you want OpenDevin to work with.
To start OpenDevin in a docker container, run the following commands in your terminal:
> [!WARNING]
> OpenDevin runs bash commands within a Docker sandbox, so it should not affect your machine.
> But your workspace directory will be attached to that sandbox, and files in the directory may be modified or deleted.
```bash
# The directory you want OpenDevin to work with. MUST be an absolute path!
export WORKSPACE_BASE=$(pwd)/workspace;
```
> When you run the following command, files in `./workspace` may be modified or deleted.
```bash
OPENDEVIN_WORKSPACE=$(pwd)/workspace
docker run -it \
--pull=always \
-e SANDBOX_USER_ID=$(id -u) \
-e PERSIST_SANDBOX="true" \
-e SSH_PASSWORD="make something up here" \
-e WORKSPACE_MOUNT_PATH=$WORKSPACE_BASE \
-v $WORKSPACE_BASE:/opt/workspace_base \
-e WORKSPACE_MOUNT_PATH=$OPENDEVIN_WORKSPACE \
-v $OPENDEVIN_WORKSPACE:/opt/workspace_base \
-v /var/run/docker.sock:/var/run/docker.sock \
-p 3000:3000 \
--add-host host.docker.internal:host-gateway \
@ -75,7 +70,9 @@ docker run -it \
ghcr.io/opendevin/opendevin:0.6
```
You'll find OpenDevin running at [http://localhost:3000](http://localhost:3000).
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.
## 🚀 Documentation

20
docs/modules/usage/intro.mdx
View File

@ -61,25 +61,21 @@ Explore the codebase of OpenDevin on [GitHub](https://github.com/OpenDevin/OpenD
The easiest way to run OpenDevin is inside a Docker container. It works best with the most recent version of Docker, `26.0.0`.
You must be using Linux, Mac OS, or WSL on Windows.
To start the app, run these commands, replacing `$(pwd)/workspace` with the directory you want OpenDevin to work with.
```
# The directory you want OpenDevin to work with. It MUST be an absolute path!
export WORKSPACE_BASE=$(pwd)/workspace
```
To start OpenDevin in a docker container, run the following commands in your terminal:
:::warning
OpenDevin runs bash commands within a Docker sandbox, so it should not affect your machine. But your workspace directory will be attached to that sandbox, and files in the directory may be modified or deleted.
When you run the following command, files in `./workspace` may be modified or deleted.
:::
```
```bash
OPENDEVIN_WORKSPACE=$(pwd)/workspace
docker run -it \
--pull=always \
-e SANDBOX_USER_ID=$(id -u) \
-e PERSIST_SANDBOX="true" \
-e SSH_PASSWORD="make something up here" \
-e WORKSPACE_MOUNT_PATH=$WORKSPACE_BASE \
-v $WORKSPACE_BASE:/opt/workspace_base \
-e WORKSPACE_MOUNT_PATH=$OPENDEVIN_WORKSPACE \
-v $OPENDEVIN_WORKSPACE:/opt/workspace_base \
-v /var/run/docker.sock:/var/run/docker.sock \
-p 3000:3000 \
--add-host host.docker.internal:host-gateway \
@ -87,7 +83,9 @@ docker run -it \
ghcr.io/opendevin/opendevin:0.6
```
You'll find OpenDevin running at [http://localhost:3000](http://localhost:3000).
You'll find OpenDevin running at [http://localhost:3000](http://localhost:3000) with access to `./workspace`. Place your code in `./workspace` to have Devin operate on them.
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.
:::tip
If you want to use the **(unstable!)** bleeding edge, you can use `ghcr.io/opendevin/opendevin:main` as the image (last line).