Welcome to CommCare HQ Deployment’s documentation!

This documentation contains guides and reference material on how to self host CommCare HQ locally. It covers requirements to self host CommCare HQ, various deployment types, infrastrucutre and team requirements to host CommCare HQ, installation instructions for single and multi server deployment and how to manage CommCare HQ deployment through the entire hosting lifecycle.

• Getting Started
  • About CommCare HQ
  • About this Guide
  • A word of caution on Self Hosting
  • How to use this guide to self host CommCare HQ
• Prerequisites
  • Things to consider when Self Hosting
  • Architecture and Platform Overview
  • Roles And Responsibilities for Hosting CommCare
  • Hardware requirements and Deployment Options
  • Managing Hardware and the Physical Environment
  • Software and Tools requirements
  • CommCare Cloud Deployment Tool
• Deploy CommCare HQ
  • Quick Install on Single Server
  • Install Using Commcare-Cloud on one or more machines
  • Troubleshooting first time setup
  • Testing your new CommCare Environment
  • Migrating CommCare HQ
  • Go Live Checklist
• Operations and Maintenance
  • Managing The Deployment
  • Monitoring and Alerting
  • Set up Sentry for error logs
  • Expectations for Ongoing Maintenance
  • Supporting Your Users
• How to Scale
  • Performance Benchmarking for CommCare HQ using Locust
  • How to Estimate Infrastructure Sizing
• Service Guides
  • PostgreSQL
  • BlobDB
  • Nginx
  • Kafka
  • Pillowtop
  • RabbitMQ
  • Redis
  • Set up Bitly for generating app codes
  • Keepalived
• Backups and Disaster Recovery
  • Backup and Restore
  • ElasticSearch Backup on Swift API
  • Disaster Recovery
• Security
  • Introduction
  • Application Security
  • Host and Disk Security
  • Network and Physical Security
• Reference Material
  • CommCare Cloud Reference
  • User Access Management
  • Firefighting Production Issues
  • Specialized Howtos
  • Settings in public.yml
  • Ports Required for CommCare HQ
• Changelog
  • Changelog