From 038e8f8caa3c2f5bedfd2a2d62cedf8fb309cad1 Mon Sep 17 00:00:00 2001 From: "r.e.e.c.h.e.e" Date: Fri, 5 Jul 2024 05:13:35 +0100 Subject: [PATCH] docs: update docker run command to pull default 'latest' tag (#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. --- docs/modules/usage/intro.mdx | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/docs/modules/usage/intro.mdx b/docs/modules/usage/intro.mdx index 303341fa45e1..0851b7556acd 100644 --- a/docs/modules/usage/intro.mdx +++ b/docs/modules/usage/intro.mdx @@ -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).