# Documentation

**URL:** https://forum.communityhealthtoolkit.org/c/product/documentation/28.md

[Latest](https://forum.communityhealthtoolkit.org/latest.md) · [Categories](https://forum.communityhealthtoolkit.org/categories.md) · [Tags](https://forum.communityhealthtoolkit.org/tags.md)

---

## [About the Documentation category](https://forum.communityhealthtoolkit.org/t/about-the-documentation-category/773)

<div class="topic-metadata">

**Author:** [@marc](https://forum.communityhealthtoolkit.org/u/marc)\
**Replies:** 0\
**Last updated:** [May 15, 2020, 8:07pm UTC](https://forum.communityhealthtoolkit.org/t/about-the-documentation-category/773 "2020-05-15T20:07:12Z")

</div>

Help us improve and discuss CHT’s guides and technical documentation. Report unclear, outdated, or missing documentation Suggest improvements to make content more useful Discuss how to best use CHT’s technical resource…

---

## [Hosting cost estimation improvement suggestions](https://forum.communityhealthtoolkit.org/t/hosting-cost-estimation-improvement-suggestions/4694)

<div class="topic-metadata">

**Author:** [@elijah](https://forum.communityhealthtoolkit.org/u/elijah)\
**Replies:** 8\
**Last updated:** [May 21, 2026, 10:00pm UTC](https://forum.communityhealthtoolkit.org/t/hosting-cost-estimation-improvement-suggestions/4694 "2026-05-21T22:00:08Z")

</div>

Hello community! CHT documentation has a very useful guide for estimating deployment resourcing needs and hosting costs. In addition to this, a total cost of ownership squad has been established to optimize disk space u…

---

## [Launch of Interactive CHT Hosting Cost Calculator](https://forum.communityhealthtoolkit.org/t/launch-of-interactive-cht-hosting-cost-calculator/5618)

<div class="topic-metadata">

**Author:** [@mrjones](https://forum.communityhealthtoolkit.org/u/mrjones)\
**Replies:** 0\
**Last updated:** [May 21, 2026, 9:57pm UTC](https://forum.communityhealthtoolkit.org/t/launch-of-interactive-cht-hosting-cost-calculator/5618 "2026-05-21T21:57:59Z")

</div>

Hello! Earlier we posted about early development of an interactive tool to estimate hosting costs for the CHT. We’re proud to announce that this tool is now live on our docs site under Host → CHT Core → Cost - check it…

---

## [New Swagger REST API Docs Live!](https://forum.communityhealthtoolkit.org/t/new-swagger-rest-api-docs-live/5570)

<div class="topic-metadata">

**Author:** [@jkuester](https://forum.communityhealthtoolkit.org/u/jkuester)\
**Replies:** 0\
**Last updated:** [April 16, 2026, 7:02pm UTC](https://forum.communityhealthtoolkit.org/t/new-swagger-rest-api-docs-live/5570 "2026-04-16T19:02:25Z")

</div>

The new “Swagger” UI for our docs for the CHT REST api is now live on the docs site! This new documentation format is easier to read/browse thanks to the consistency and features of Swagger. It is also much easier t…

---

## [Search on docs site: Do you use it? Does it work for you?](https://forum.communityhealthtoolkit.org/t/search-on-docs-site-do-you-use-it-does-it-work-for-you/5386)

<div class="topic-metadata">

**Author:** [@mrjones](https://forum.communityhealthtoolkit.org/u/mrjones)\
**Replies:** 8\
**Last updated:** [October 6, 2025, 3:27pm UTC](https://forum.communityhealthtoolkit.org/t/search-on-docs-site-do-you-use-it-does-it-work-for-you/5386 "2025-10-06T15:27:56Z")

</div>

Hi all! Recently we upgraded the docs site to the latest version of Hextra, which has enabled some great new features (This is different from the recently added Kapa AI tool). My question to the community is how is sea…

---

## [Proposal: Remove CHT 3.x Hosting documentation](https://forum.communityhealthtoolkit.org/t/proposal-remove-cht-3-x-hosting-documentation/5133)

<div class="topic-metadata">

**Author:** [@mrjones](https://forum.communityhealthtoolkit.org/u/mrjones)\
**Replies:** 7\
**Last updated:** [August 4, 2025, 8:58pm UTC](https://forum.communityhealthtoolkit.org/t/proposal-remove-cht-3-x-hosting-documentation/5133 "2025-08-04T20:58:43Z")

</div>

Intro Hi there! I’m proposing we remove CHT 3.x hosting documentation. Background The last major revision of CHT (3.17.0) was released in Oct 2022 and the last minor version (3.17.2) was released a year later in Oct 20…

---

## [New theme for documentation website](https://forum.communityhealthtoolkit.org/t/new-theme-for-documentation-website/4962)

<div class="topic-metadata">

**Author:** [@mrjones](https://forum.communityhealthtoolkit.org/u/mrjones)\
**Replies:** 2\
**Last updated:** [May 8, 2025, 12:31pm UTC](https://forum.communityhealthtoolkit.org/t/new-theme-for-documentation-website/4962 "2025-05-08T12:31:37Z")

</div>

We’re excited to announce the new theme for our documentation site! If you can’t wait to see it - go explore right now! Otherwise, read on below to discover the improvements and changes. Over the past month a number o…

---

## [Sample hierarchy is not consistent with depth examples](https://forum.communityhealthtoolkit.org/t/sample-hierarchy-is-not-consistent-with-depth-examples/4662)

<div class="topic-metadata">

**Author:** [@bamatic](https://forum.communityhealthtoolkit.org/u/bamatic)\
**Replies:** 1\
**Last updated:** [February 14, 2025, 10:40pm UTC](https://forum.communityhealthtoolkit.org/t/sample-hierarchy-is-not-consistent-with-depth-examples/4662 "2025-02-14T22:40:16Z")

</div>

Hi community in this doc page the proposed hierarchy is: district \> health\_center \> clinic \> area \> family \> patient However, in the sample table, as we go deeper, with greaters values of depth, we never get the “ar…

---

## [Pyxform installation](https://forum.communityhealthtoolkit.org/t/pyxform-installation/4019)

<div class="topic-metadata">

**Author:** [@Esther\_Moturi](https://forum.communityhealthtoolkit.org/u/Esther_Moturi)\
**Replies:** 6\
**Last updated:** [September 23, 2024, 6:05pm UTC](https://forum.communityhealthtoolkit.org/t/pyxform-installation/4019 "2024-09-23T18:05:52Z")

</div>

Hey, Is anyone able to use sudo python -m pip install git+https://github.com/medic/pyxform.git@medic-conf-1.17#egg=pyxform-medic command indicated in the documentation site to install pyxform?

---

## [Version Update Brief/detail](https://forum.communityhealthtoolkit.org/t/version-update-brief-detail/3107)

<div class="topic-metadata">

**Author:** [@Sandip\_Parajuli](https://forum.communityhealthtoolkit.org/u/Sandip_Parajuli)\
**Replies:** 3\
**Last updated:** [July 29, 2024, 6:17am UTC](https://forum.communityhealthtoolkit.org/t/version-update-brief-detail/3107 "2024-07-29T06:17:57Z")

</div>

Is there any place where we can see the updates made on new release version of CHT?

---

## [Is the documentation on developing the CHT for feature phone available? i cannot find it](https://forum.communityhealthtoolkit.org/t/is-the-documentation-on-developing-the-cht-for-feature-phone-available-i-cannot-find-it/3767)

<div class="topic-metadata">

**Author:** [@Sandip\_Parajuli](https://forum.communityhealthtoolkit.org/u/Sandip_Parajuli)\
**Replies:** 3\
**Last updated:** [July 17, 2024, 9:47am UTC](https://forum.communityhealthtoolkit.org/t/is-the-documentation-on-developing-the-cht-for-feature-phone-available-i-cannot-find-it/3767 "2024-07-17T09:47:51Z")

</div>

I wanted to see if the development of CHT for feature phone is possible? i want to see documentation and searched but i cannot find it, can someone provide the documentation if it is available?

---

## [Benchmark 4.6 vs 4.5](https://forum.communityhealthtoolkit.org/t/benchmark-4-6-vs-4-5/3418)

<div class="topic-metadata">

**Author:** [@magp18](https://forum.communityhealthtoolkit.org/u/magp18)\
**Replies:** 4\
**Last updated:** [April 4, 2024, 5:25pm UTC](https://forum.communityhealthtoolkit.org/t/benchmark-4-6-vs-4-5/3418 "2024-04-04T17:25:22Z")

</div>

Hi Everyone! I am not sure where to share this but wanted to make a post on the impact of the recently released 4.6 on two of our CHT running algorithms! The categories we benchmarked are : Loading screen : How long…

---

## [Required column](https://forum.communityhealthtoolkit.org/t/required-column/3367)

<div class="topic-metadata">

**Author:** [@magp18](https://forum.communityhealthtoolkit.org/u/magp18)\
**Replies:** 2\
**Last updated:** [March 7, 2024, 3:42pm UTC](https://forum.communityhealthtoolkit.org/t/required-column/3367 "2024-03-07T15:42:49Z")

</div>

Hi I just wanted to post a (at least for me) revelation that might help others. In the required field, we used to have “true()” which is not a function in JS but mentioned in ODK docs, making questions mandatory BUT you…

---

## [Preferred method for local dev setup; native or docker helper?](https://forum.communityhealthtoolkit.org/t/preferred-method-for-local-dev-setup-native-or-docker-helper/3343)

<div class="topic-metadata">

**Author:** [@twier](https://forum.communityhealthtoolkit.org/u/twier)\
**Replies:** 3\
**Last updated:** [February 21, 2024, 3:40pm UTC](https://forum.communityhealthtoolkit.org/t/preferred-method-for-local-dev-setup-native-or-docker-helper/3343 "2024-02-21T15:40:05Z")

</div>

Hello There seem to be two ways to set up a local instance of cht-core for development; the docker helper script at scripts/docker-helper-4.x/cht-docker-compose.sh and natively using npm (although still with couchdb in …

---

## [New documentation available re: Muting](https://forum.communityhealthtoolkit.org/t/new-documentation-available-re-muting/2476)

<div class="topic-metadata">

**Author:** [@Esther\_Moturi](https://forum.communityhealthtoolkit.org/u/Esther_Moturi)\
**Replies:** 5\
**Last updated:** [March 24, 2023, 1:41am UTC](https://forum.communityhealthtoolkit.org/t/new-documentation-available-re-muting/2476 "2023-03-24T01:41:23Z")

</div>

Hallo, we are happy to announce that high level functional documentation on muting is now available on the documentation site. Muting is a feature that temporarily silences tasks and SMS schedules for a person or a house…

---

## [Count total docs in CHT](https://forum.communityhealthtoolkit.org/t/count-total-docs-in-cht/2536)

<div class="topic-metadata">

**Author:** [@iesmail](https://forum.communityhealthtoolkit.org/u/iesmail)\
**Replies:** 1\
**Last updated:** [March 8, 2023, 2:22pm UTC](https://forum.communityhealthtoolkit.org/t/count-total-docs-in-cht/2536 "2023-03-08T14:22:22Z")

</div>

I am trying to get a count of the total number of documents in CHT. I would like to know which dbs I should query to get the total count. So far, I am thinking of medic and \_users dbs. This is the curl command I am usin…

---

## [Local dev setup docker-compose file not found using curl](https://forum.communityhealthtoolkit.org/t/local-dev-setup-docker-compose-file-not-found-using-curl/2217)

<div class="topic-metadata">

**Author:** [@KiharaSimon](https://forum.communityhealthtoolkit.org/u/KiharaSimon)\
**Replies:** 3\
**Last updated:** [October 3, 2022, 5:18pm UTC](https://forum.communityhealthtoolkit.org/t/local-dev-setup-docker-compose-file-not-found-using-curl/2217 "2022-10-03T17:18:43Z")

</div>

Hello, I’m attempting to grab the newest version of the docker-compose file from the cht-core repository, but it appears that it is missing. Please assist me in getting the file. This is the description from the cht d…

---

## [How are tasks ordered?](https://forum.communityhealthtoolkit.org/t/how-are-tasks-ordered/718)

<div class="topic-metadata">

**Author:** [@michael](https://forum.communityhealthtoolkit.org/u/michael)\
**Replies:** 1\
**Last updated:** [April 19, 2020, 10:59pm UTC](https://forum.communityhealthtoolkit.org/t/how-are-tasks-ordered/718 "2020-04-19T22:59:38Z")

</div>

It is clear that Tasks are ordered by their “Due” date on the tasks tab, but from the documentation, it’s not clear how Tasks are ordered if there are multiple tasks with the same “Due” date. What is the sort algorithm…

---

## [Upgrading to version v3.13](https://forum.communityhealthtoolkit.org/t/upgrading-to-version-v3-13/1718)

<div class="topic-metadata">

**Author:** [@melema](https://forum.communityhealthtoolkit.org/u/melema)\
**Replies:** 2\
**Last updated:** [February 15, 2022, 3:22am UTC](https://forum.communityhealthtoolkit.org/t/upgrading-to-version-v3-13/1718 "2022-02-15T03:22:00Z")

</div>

I am trying to install this Release 3.13.0 · medic/cht-core · GitHub but docker-compose.yml points to medicmobile/medic-os:cht-3.9.0-rc.2. I also checked docker hub and did not find image for 3.13.0. Do you have Dockerfi…

---

## [New documentation available re: integration with RapidPro](https://forum.communityhealthtoolkit.org/t/new-documentation-available-re-integration-with-rapidpro/900)

<div class="topic-metadata">

**Author:** [@michael](https://forum.communityhealthtoolkit.org/u/michael)\
**Replies:** 0\
**Last updated:** [August 28, 2020, 1:48am UTC](https://forum.communityhealthtoolkit.org/t/new-documentation-available-re-integration-with-rapidpro/900 "2020-08-28T01:48:12Z")

</div>

We recently added some content to the CHT Documentation Site regarding RapidPro integrations and we’d love to get your feedback! For a high level overview, check out the Features page For some more detailed info, check…

---

## [Self Hosted CHT - Production Installation instructions and advice](https://forum.communityhealthtoolkit.org/t/self-hosted-cht-production-installation-instructions-and-advice/826)

<div class="topic-metadata">

**Author:** [@munjoma](https://forum.communityhealthtoolkit.org/u/munjoma)\
**Replies:** 7\
**Last updated:** [August 23, 2020, 4:31am UTC](https://forum.communityhealthtoolkit.org/t/self-hosted-cht-production-installation-instructions-and-advice/826 "2020-08-23T04:31:22Z")

</div>

Hi, Is there documentation for a Production set up of CHT? I could only find development setup documentation: 1. Development Setup and 2. Easy Deployment - Docker Is it advisable to go the Docker route for a productio…

---

## [The CHT Documentation Style Guide](https://forum.communityhealthtoolkit.org/t/the-cht-documentation-style-guide/507)

<div class="topic-metadata">

**Author:** [@francesca](https://forum.communityhealthtoolkit.org/u/francesca)\
**Replies:** 1\
**Last updated:** [July 10, 2020, 2:46am UTC](https://forum.communityhealthtoolkit.org/t/the-cht-documentation-style-guide/507 "2020-07-10T02:46:50Z")

</div>

Interested in writing or improving documentation for the Community Health Toolkit? Check out our style guide, created by community member Rajakavitha1! Have a suggestion or want to make an addition? Create a pull reques…

---

## [Help us identify what documentation we are missing](https://forum.communityhealthtoolkit.org/t/help-us-identify-what-documentation-we-are-missing/639)

<div class="topic-metadata">

**Author:** [@kenn](https://forum.communityhealthtoolkit.org/u/kenn)\
**Replies:** 6\
**Last updated:** [July 8, 2020, 5:26pm UTC](https://forum.communityhealthtoolkit.org/t/help-us-identify-what-documentation-we-are-missing/639 "2020-07-08T17:26:17Z")

</div>

We want to ensure our tools are accessible and can be easily used by the people who need them most. A key component of that effort will be creating new documentation, refining existing resources, and finding the best way…

---

## [Product Documentation Improvements](https://forum.communityhealthtoolkit.org/t/product-documentation-improvements/740)

<div class="topic-metadata">

**Author:** [@Max](https://forum.communityhealthtoolkit.org/u/Max)\
**Replies:** 4\
**Last updated:** [June 30, 2020, 9:10pm UTC](https://forum.communityhealthtoolkit.org/t/product-documentation-improvements/740 "2020-06-30T21:10:39Z")

</div>

A couple of weeks ago we formed a new working group focused on creating and improving the product documentation that serves to make the Community Health Toolkit more accessible. I’m helming the work, and am joined by @ma…

---

## [New Product Documentation Site Launch!](https://forum.communityhealthtoolkit.org/t/new-product-documentation-site-launch/834)

<div class="topic-metadata">

**Author:** [@Max](https://forum.communityhealthtoolkit.org/u/Max)\
**Replies:** 0\
**Last updated:** [June 29, 2020, 1:24pm UTC](https://forum.communityhealthtoolkit.org/t/new-product-documentation-site-launch/834 "2020-06-29T13:24:26Z")

</div>

We are thrilled to announce the release of the new CHT Documentation site! Documentation is a key way that our community learns about CHT product features and functionality, and we are excited to have this new site up li…

---

## [What permissions do different users in v0.4 have?](https://forum.communityhealthtoolkit.org/t/what-permissions-do-different-users-in-v0-4-have/81)

<div class="topic-metadata">

**Author:** [@medicbot](https://forum.communityhealthtoolkit.org/u/medicbot)\
**Replies:** 0\
**Last updated:** [September 28, 2016, 6:01am UTC](https://forum.communityhealthtoolkit.org/t/what-permissions-do-different-users-in-v0-4-have/81 "2016-09-28T06:01:00Z")

</div>

Imported Question by sanchaygupta · Sep 28, 2016 at 09:53 PM Do we have documentation on what each of the users in app settings (kujua user, national admin, district admin, kujua gateway, data entry) can and can’t do? …
