docs: add Cloudflare Zero Trust documentation for self-hosted instances#347
docs: add Cloudflare Zero Trust documentation for self-hosted instances#347ezkemboi wants to merge 3 commits intodimagi:mainfrom
Conversation
|
@ezkemboi can you move these tech docs to the "Tech Hub" section ? This is where articles that engineers will refer to and it keeps them separate from OCS users who will not need to understand self hosting. Simon and I discussed and came up with this structure for the menus - dimagi/open-chat-studio#3010 (comment) https://github.com/dimagi/open-chat-studio-docs/blob/main/docs/tech-hub/index.md Let me know if you have concerns or questions |
|
@lisa-jwayela should I move these into dimagi/open-chat-studio#3190? Or move to cc. @snopoke |
|
@lisa-jwayela I have been able to get the answer, I will leave this inside this repo, but move into the Tech Hub section. |
snopoke
left a comment
There was a problem hiding this comment.
@ezkemboi this seems to overlap with the docs in dimagi/open-chat-studio#3190. I haven't fully reviewed either but in general I think the self hosting docs should be in the developer docs (https://developers.openchatstudio.com/hosting/). It's fine to mention it here but we probably just want a single page about self hosting that points to the other docs.
@lisa-jwayela what do you think?
|
@snopoke I agree with that feedback. It makes sense to keep the self-hosting documentation in a single place (the Developer Docs) and reference it from here. I’ll take some time to review both areas of change and share my thoughts and any suggestions afterward. cc. @lisa-jwayela |
|
@lisa-jwayela and @snopoke , I have moved the technical and administrative reference to developer docs. |
snopoke
left a comment
There was a problem hiding this comment.
Thanks for the changes. Let's make this even more generic and just link to the main 'hosting' page in the dev docs: https://developers.openchatstudio.com/hosting/
Summary
This PR adds Zero Trust access documentation for self-hosters who need to expose Open Chat Studio — including webhook endpoints for WhatsApp, Telegram, Slack, and Twilio — without opening inbound ports on their server. No application code changes.
Changes
Added
docs/concepts/zero_trust_access.mdwith:Added
docs/how-to/cloudflare_tunnel.mdwith:docker-compose.cloudflare.ymloverride, Django settingsAdded
docs/how-to/zero_trust_admin.mdwith:Updated
mkdocs.yml:zero_trust_access.mdplaced under Conceptscloudflare_tunnel.mdandzero_trust_admin.mdplaced under How-to GuidesBackground
The existing docs had no guidance for self-hosters who need remote team access without a public IP or open firewall ports. This PR fills that gap with a three-document set: a conceptual overview, a developer setup guide, and an admin operations guide targeting NGO administrators managing day-to-day access.
Review Notes
docker-compose.cloudflare.ymlis strictly opt-in; the main stack is unchanged