> For the complete documentation index, see [llms.txt](https://documentation.opencrvs.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.opencrvs.org/technical/guides/configuration.md). # Configuration ## Country configuration options ### 1. Introduction OpenCRVS separates the core product from the country-specific configuration required to run it in a real national context. This means the same OpenCRVS Core can be used by different countries, while each implementation defines its own events, forms, reference data, content, certificates, integrations and deployment settings. This page provides a high-level overview of the configuration options enabled by the OpenCRVS country configuration and infrastructure repositories. The detailed implementation steps are covered in the following guides. **Where this sits:** Country configuration is defined during Design & Specification, implemented during Configuration, and deployed through the project’s infrastructure environments in [installation](/technical/guides/installation/deploy-set-up-a-server-hosted-environment.md). *** ### 2. What the country configuration repository enables The [country configuration](https://github.com/opencrvs/opencrvs-countryconfig) repository contains the country-specific logic, files and APIs required by OpenCRVS Core. At a high level, it enables configuration of: **Application settings** — general settings that control how the OpenCRVS application behaves for the country implementation. **Administrative structure and locations** — the country’s geographic and administrative hierarchy, including locations used for registration, reporting and dashboards. **Users and roles** — initial users, system administrators and role titles mapped to OpenCRVS user types. **Registration forms** — versioned form definitions for vital events, including birth, death and other supported event types. **Form validation and conditional logic** — country-specific rules that determine how form fields are validated and when questions or sections appear. **Language content** — translated and country-specific application content used across the OpenCRVS user interface. **Certificates** — certificate templates and related assets used to issue official documentation. **Statistics and reporting inputs** — population and vital statistics reference data used to calculate registration completeness and support dashboards. **Notifications** — integration points for sending messages to staff or citizens by SMS, email or other country-specific communication channels. **Event registration integrations** — business-critical integration points that can run at the point of legal registration, such as generating identifiers or communicating with external systems. **Hosted assets** — country logos, maps and other files required by the application, emails or dashboards. {% hint style="info" %} The country configuration repository contains an [infrastructure](https://github.com/opencrvs/opencrvs-countryconfig/tree/develop/infrastructure) folder which supports: **Backwards compatibility for OpenCRVS versions 1.9 and below still using DockerSwarm. Docker Swarm will be deprecated in 2.1.** [**MIGRATE TO KUBERNETES IN TIME!**](/technical/guides/installation/deploy-set-up-a-server-hosted-environment/migration-from-docker-swarm-guide.md) {% endhint %} *** ### 3. What the infrastructure repository enables The [infrastructure](https://github.com/opencrvs/infrastructure) repository supports the **OpenCRVS 2.0+ Kubernetes** deployment and operation of OpenCRVS across environments. Follow the [installation > deploy](/technical/guides/installation/deploy-set-up-a-server-hosted-environment.md) guides . At a high level, it enables configuration of: **Deployment environments** — development, test, staging and production environments used to run OpenCRVS. **Containerised services** — the Kubernetes and Helm configuration required to deploy OpenCRVS Core, dependencies and country configuration services. **Networking and routing** — ingress, routing and service exposure needed for users and systems to access OpenCRVS. **Environment-specific settings** — configuration values that differ between environments, such as image versions, domains, secrets and service endpoints. **Operational services** — supporting infrastructure required to run OpenCRVS reliably, including databases, search, logging and other platform dependencies. **Local development tooling** — developer environments that allow technical teams to build, test and iterate on country configuration safely before deploying it. *** ### 4. How the repositories work together The country configuration repository defines what makes OpenCRVS specific to a country. The infrastructure repository defines how OpenCRVS is deployed and operated in each environment. Together, they allow an implementation team to: * configure OpenCRVS without changing OpenCRVS Core * test country-specific changes in local and non-production environments * seed the system with the required reference data * deploy the validated configuration consistently across environments * maintain a clear separation between product code, country configuration and infrastructure This separation is important because it allows countries to tailor OpenCRVS to their legal, operational and technical context while still benefiting from upgrades to the shared OpenCRVS Core platform. *** ### 5. When country configuration is complete Country configuration is complete when: * [ ] the required application settings have been defined * [ ] administrative locations and reference data have been loaded * [ ] users, roles and scopes have been configured * [ ] event forms, validation rules and conditional logic have been implemented * [ ] language content and country assets have been added * [ ] certificate templates have been configured * [ ] notifications and required integrations have been implemented * [ ] infrastructure settings are ready for each environment * [ ] the complete configuration has been tested against the signed-off requirements *** ### 6. Resources and support For further guidance, see: * [**opencrvs-countryconfig**](https://github.com/opencrvs/opencrvs-countryconfig) — the template repository for defining country-specific configuration, APIs, forms, content and reference data. * [**opencrvs/infrastructure**](https://github.com/opencrvs/infrastructure) — the repository for deploying and operating OpenCRVS infrastructure using the supported deployment approach. * **Technical configuration guides** — step-by-step guidance **in this section** for implementing country configuration. * [**Installation**](/technical/guides/installation.md) — step-by-step guidance for deploying OpenCRVS into each environment. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://documentation.opencrvs.org/technical/guides/configuration.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.