getodk / getodk/docs

Provide quick install steps

Open
#1,610 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
58
Forks
160
Avg merge
5d 11h
Merged PRs (30d)
12

Description

From https://www.reddit.com/r/selfhosted/comments/13j37tx/comment/jkeh6cl/

> One bit of advice, and only since you posted here: you mention self-hosting and open source a few places, and I have now made multiple clicks to try to find a docker compose file, but no matter what I'm given a partial set up steps then told to look at the Digital Ocean guide. You might want to just have a readily available docker compose file and .env template in your docs for people to easily copy and paste

I agree that it'd be nice to have a place that lists the steps you need to get started without so much prose. https://docs.getodk.org/central-upgrade/ does a good job of this...

Contributor guide

Open the contributing guide

Research direction

Start with the linked central-upgrade documentation and the existing Digital Ocean setup guidance to find the current installation steps and deployment references. Add a concise quick-start section with a readily copyable Docker Compose file and .env template, and confirm that the resulting steps cover a fresh setup without requiring the longer guide.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker-compose
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.