docs: clarify Docker Helper vs localhost URLs in local setup #1994
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mrjones-plip
requested changes
Sep 22, 2025
Contributor
mrjones-plip
left a comment
mrjones-plip
left a comment
There was a problem hiding this comment.
Nice work here - thank you!
Requesting to changes to get this tidied up a bit.
mrjones-plip
requested changes
Sep 23, 2025
Contributor
mrjones-plip
left a comment
mrjones-plip
left a comment
There was a problem hiding this comment.
Thanks @najuna-brian ! I think maybe reducing the URL to have the localhost IP and just requesting they update the port might be easier. I've made some suggestions to this end.
Comment on lines
+216
to
+219
|
|
||
| {{< callout type="tip" >}} | ||
| Docker Helper users: copy the exact `...local-ip.medicmobile.org:PORT` URL that the helper prints and use it in all `cht` commands. With this URL, you do not need `--accept-self-signed-certs` because the certificate is valid. | ||
| {{< /callout >}} |
Contributor
There was a problem hiding this comment.
I think this call out is a great idea! However, I think it will be more contextual when it's directly next two the your-local-ip type URLs. Let's remove it here and add an inline call out below:
Suggested change
| {{< callout type="tip" >}} | |
| Docker Helper users: copy the exact `...local-ip.medicmobile.org:PORT` URL that the helper prints and use it in all `cht` commands. With this URL, you do not need `--accept-self-signed-certs` because the certificate is valid. | |
| {{< /callout >}} |
Comment on lines
+234
to
+237
|
|
||
| ```shell | ||
| cht --url=https://medic:password@<your-local-ip.medicmobile.org:PORT> csv-to-docs upload-docs | ||
| ``` |
Contributor
There was a problem hiding this comment.
Suggested change
| ```shell | |
| cht --url=https://medic:password@<your-local-ip.medicmobile.org:PORT> csv-to-docs upload-docs | |
| ``` | |
| Be sure to update the `<PORT>` to be correct. It will be a 5 digits number like `10443`. The full URL is show right after you [start a docker helper instance]({{< relref "/hosting/cht/app-developer#cht-docker-helper" >}}). | |
| ```shell | |
| cht --url=https://medic:password@127-0-0-1.local-ip.medicmobile.org:<PORT> csv-to-docs upload-docs | |
| ``` |
Comment on lines
264
to
266
| ```shell | ||
| # accept-self-signed-certs bypasses normal SSL certificate verification. This is necessary when connecting to a local CHT instance. | ||
| cht --url=https://medic:password@localhost --accept-self-signed-certs | ||
| cht --url=https://medic:password@<your-local-ip.medicmobile.org:PORT> compile-app-settings upload-app-settings | ||
| ``` |
Contributor
There was a problem hiding this comment.
Suggested change
| ```shell | |
| # accept-self-signed-certs bypasses normal SSL certificate verification. This is necessary when connecting to a local CHT instance. | |
| cht --url=https://medic:password@localhost --accept-self-signed-certs | |
| cht --url=https://medic:password@<your-local-ip.medicmobile.org:PORT> compile-app-settings upload-app-settings | |
| ``` | |
| Be sure to update the `<PORT>` to be correct. It will be a 5 digits number like `10443`. The full URL is show right after you [start a docker helper instance]({{< relref "/hosting/cht/app-developer#cht-docker-helper" >}}). | |
| ```shell | |
| cht --url=https://medic:password@127-0-0-1.local-ip.medicmobile.org:<PORT> csvcompile-app-settings upload-app-settings | |
| ``` |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #1945
Description
Clarifies when to use the Docker Helper URL (
…local-ip.medicmobile.org:PORT, valid TLS) vshttps://localhost(self-signed) in local setup andcht-confexamples. Adds a tip and tabbed examples to prevent URL/cert errors.License
The software is provided under AGPL-3.0. Contributions to this project are accepted under the same license.