Skip to content

Clarify local setup instructions for Docker users to avoid URL confusion #1945

@Phil-Mwago

Description

@Phil-Mwago

During the local setup process using CHT Docker Helper script, users frequently encounter confusion when running cht-confcommands because the documentation shows examples using localhost while docker helper gives URLs that have a unique IP to each user and use valid HTTPS (e.g., 127-0-0-1.local-ip.medicmobile.org:10443).

This leads to build errors and unnecessary troubleshooting time.

The issue is particularly prominent in the "Upload Test Data" section, where users need to substitute the example localhost URL with their Docker-generated domain. This should be explicitly called out in the documentation with either:

A note about URL substitution for Docker users, or Dynamic examples that match the Docker helper script's output format

This clarification would help new developers avoid a common pitfall and streamline the local setup experience.

Good first issue

Welcome, first-time contributor! Please read through all of these notes before beginning 🙏

This ticket involves setting up the CHT locally to be able to develop an app/configuration for it, per above. Before you get started, go learn how to use the CHT Docker Helper script. Note: this is NOT the same as core developer set up - you don't need to do any of those steps in the context of the issue!

The main goal is to create one happy path that sets up the first time user for success using the CHT for app development. If there are details that are not relevant to the happy path, consider excluding them. You should be ready to repeat the setup steps a few times, ensuring that each step is well covered in the local set up guide. Very likely the happy path will acknowledge the existence of other solutions (downloading a compose file, manually calling docker compose up) but that docker helper is the easy way that most everyone should use.

While questions about the ticket are here on the ticket and more general questions are best asked on the forum, don't hesitate to ask wherever you like! That said, when you do ask a question, be sure to list explicit steps on how to reproduce your issue.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Good First IssueGood for first time contributions

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions