OpenHands / OpenHands/docs

[Feature]: Docker / Docker Compose Instructions

Open Beginner friendly
#658 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
MDX
Stars
12
Forks
52
Avg merge
1d 6h
Merged PRs (30d)
32

Description

Is there an existing feature request for this?
  • I have searched existing issues and feature requests, and this is not a duplicate.
Problem or Use Case

There are instructions on how to install with Docker Desktop. In Linux though, most won't want to install that.

You could put instructions on how to install with regular Docker, and/or with Docker Compose. I think that's a much better approach of installing it.

Proposed Solution

Add Docker / Docker Compose installation instructions besides Docker Desktop.

Alternatives Considered

No response

Priority / Severity

Medium - Would improve experience

Estimated Scope

Small - UI tweak, config option, or minor change

Feature Area

Documentation

Technical Implementation Ideas (Optional)

No response

Additional Context

No response

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the existing Docker Desktop installation instructions in the documentation and review how installation options are organized. Add instructions for regular Docker and Docker Compose alongside the existing guidance; the work is done when Linux users can follow either supported approach without relying on Docker Desktop.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, docker-compose
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.