Skip to content

Commit

Permalink
docs: update docker run command to pull default 'latest' tag (All-Han…
Browse files Browse the repository at this point in the history
…ds-AI#2804)

- Ensure users get the most recent stable release version when pulling default image.
- Explains the main tag for those who want the most recent updates.
  • Loading branch information
richardokonicha authored Jul 5, 2024
1 parent 143f38d commit 038e8f8
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions docs/modules/usage/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -78,17 +78,22 @@ docker run -it \
-p 3000:3000 \
--add-host host.docker.internal:host-gateway \
--name opendevin-app-$(date +%Y%m%d%H%M%S) \
ghcr.io/opendevin/opendevin:0.7
ghcr.io/opendevin/opendevin
```

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`.
:::note
By default, this command pulls the `latest` tag, which represents the most recent stable release of OpenDevin. You have other options as well:

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.
- For a specific release version, use `ghcr.io/opendevin/opendevin:0.7` (replace 0.7 with the desired version number).
- For the most up-to-date development version, use `ghcr.io/opendevin/opendevin:main`. Note that this version may be **(unstable!)** and is recommended for testing or development purposes only.

:::tip
If you want to use the **(unstable!)** bleeding edge, you can use `ghcr.io/opendevin/opendevin:main` as the image (last line).
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.

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).
Expand Down

0 comments on commit 038e8f8

Please sign in to comment.