diff --git a/README.md b/README.md index cdc8694815a6..150263e67e71 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ Learn more at [docs.all-hands.dev](https://docs.all-hands.dev), or jump to the [ ## ⚡ Quick Start The easiest way to run OpenHands is in Docker. -See the [Installation](https://docs.all-hands.dev/modules/usage/installation) guide for +See the [Running OpenHands](https://docs.all-hands.dev/modules/usage/installation) guide for system requirements and more information. ```bash @@ -69,7 +69,7 @@ run OpenHands in a scriptable [headless mode](https://docs.all-hands.dev/modules interact with it via a [friendly CLI](https://docs.all-hands.dev/modules/usage/how-to/cli-mode), or run it on tagged issues with [a github action](https://docs.all-hands.dev/modules/usage/how-to/github-action). -Visit [Installation](https://docs.all-hands.dev/modules/usage/installation) for more information and setup instructions. +Visit [Running OpenHands](https://docs.all-hands.dev/modules/usage/installation) for more information and setup instructions. > [!CAUTION] > OpenHands is meant to be run by a single user on their local workstation. diff --git a/docs/modules/usage/getting-started.mdx b/docs/modules/usage/getting-started.mdx index 0a7140b91dd6..b01c4d147686 100644 --- a/docs/modules/usage/getting-started.mdx +++ b/docs/modules/usage/getting-started.mdx @@ -1,6 +1,6 @@ # Getting Started with OpenHands -So you've [installed OpenHands](./installation) and have +So you've [run OpenHands](./installation) and have [set up your LLM](./installation#setup). Now what? OpenHands can help you tackle a wide variety of engineering tasks. But the technology diff --git a/docs/modules/usage/installation.mdx b/docs/modules/usage/installation.mdx index d35eeb409fa8..d559440fac3b 100644 --- a/docs/modules/usage/installation.mdx +++ b/docs/modules/usage/installation.mdx @@ -1,12 +1,51 @@ -# Installation +# Running OpenHands ## System Requirements -- Docker version 26.0.0+ or Docker Desktop 4.31.0+. -- You must be using Linux or Mac OS. - - If you are on Windows, you must use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install). +- MacOS with [Docker Desktop support](https://docs.docker.com/desktop/setup/install/mac-install/#system-requirements) +- Linux +- Windows with [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) and [Docker Desktop support](https://docs.docker.com/desktop/setup/install/windows-install/#system-requirements) -## Start the app +## Prerequisites + +
+ MacOS + ### Docker Desktop + + 1. [Install Docker Desktop on Mac](https://docs.docker.com/desktop/setup/install/mac-install). + 2. Open Docker Desktop, go to `Settings > Advanced` and ensure `Allow the default Docker socket to be used` is enabled. +
+ +
+ Linux + + :::note + Tested with Ubuntu 22.04. + ::: + + ### Docker Desktop + + 1. [Install Docker Desktop on Linux](https://docs.docker.com/desktop/setup/install/linux/). + +
+ +
+ Windows + ### WSL + + 1. [Install WSL](https://learn.microsoft.com/en-us/windows/wsl/install). + 2. Run `wsl --version` in powershell and confirm `Default Version: 2`. + + ### Docker Desktop + + 1. [Install Docker Desktop on Windows](https://docs.docker.com/desktop/setup/install/windows-install). + 2. Open Docker Desktop, go to `Settings` and confirm the following: + - General: `Use the WSL 2 based engine` is enabled. + - Resources > WSL Integration: `Enable integration with my default WSL distro` is enabled. + +
+ +## Start the App The easiest way to run OpenHands is in Docker. diff --git a/docs/sidebars.ts b/docs/sidebars.ts index b7def32dd68f..a8d88d9dfca1 100644 --- a/docs/sidebars.ts +++ b/docs/sidebars.ts @@ -5,7 +5,7 @@ const sidebars: SidebarsConfig = { docsSidebar: [ { type: 'doc', - label: 'Installation', + label: 'Running OpenHands', id: 'usage/installation', }, {