# Setup

- [1. Establish team](https://documentation.opencrvs.org/v1.3/setup/1.-establish-team.md): Create a team that has the skills to be able to setup your OpenCRVS instance.
- [2. Gather requirements](https://documentation.opencrvs.org/v1.3/setup/2.-gather-requirements.md): Prepare all the inputs required for product configuration.
- [3. Installation](https://documentation.opencrvs.org/v1.3/setup/3.-installation.md): Installation steps for OpenCRVS
- [3.1 Set-up a local development environment](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.1-set-up-a-development-environment.md)
- [3.1.1 Install the required dependencies](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.1-set-up-a-development-environment/3.1.1-install-the-required-dependencies.md)
- [3.1.2 Install OpenCRVS locally](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.1-set-up-a-development-environment/3.1.2-install-opencrvs-locally.md)
- [3.1.3 Starting and stopping OpenCRVS](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.1-set-up-a-development-environment/3.1.3-starting-and-stopping-opencrvs.md)
- [3.1.4 Log in to OpenCRVS locally](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.1-set-up-a-development-environment/3.1.4-log-in-to-opencrvs-locally.md)
- [3.1.5 Tooling](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.1-set-up-a-development-environment/3.1.5-tooling.md)
- [3.2 Set-up your own country configuration](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.2-set-up-your-own-country-configuration.md)
- [3.2.1 Fork your own country configuration repository](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.1-fork-your-own-country-configuration-repository.md)
- [3.2.2 Set up administrative address divisions](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.2-set-up-administrative-address-divisions.md)
- [3.2.2.1 Prepare source file for administrative structure](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.2-set-up-administrative-address-divisions/3.2.2.1-prepare-source-file-for-administrative-structure.md)
- [3.2.2.2 Prepare source file for statistics](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.2-set-up-administrative-address-divisions/3.2.2.2-prepare-source-file-for-statistics.md)
- [3.2.3 Set up CR offices and Health facilities](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.3-set-up-cr-offices-and-health-facilities.md)
- [3.2.3.1 Prepare source file for CRVS Office facilities](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.3-set-up-cr-offices-and-health-facilities/3.2.3.1-prepare-source-file-for-crvs-office-facilities.md)
- [3.2.3.2 Prepare source file for health facilities](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.3-set-up-cr-offices-and-health-facilities/3.2.3.2-prepare-source-file-for-health-facilities.md)
- [3.2.4 Set up employees & roles for testing or production](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.4-set-up-employees-for-testing-or-production.md)
- [3.2.3.1 Prepare source file for employees](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.4-set-up-employees-for-testing-or-production/3.2.3.1-prepare-source-file-for-test-employees.md)
- [3.2.3.2 Configure role titles](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.4-set-up-employees-for-testing-or-production/3.2.3.2-configure-role-titles.md)
- [3.2.5 Set up application settings](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.5-set-up-application-settings.md)
- [3.2.5.1 Configuring Metabase Dashboards](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.5-set-up-application-settings/3.2.5.1-configuring-metabase-dashboards.md)
- [3.2.6 Configure certificate templates](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.6-configure-certificate-templates.md)
- [3.2.7 Configure declaration forms](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.7-configure-declaration-forms.md)
- [3.2.7.1 Configuring an event form](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.7-configure-declaration-forms/3.2.7.1-configuring-an-event-form.md)
- [3.2.8 Seeding your local development environment database](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.8-seeding-your-local-database.md)
- [3.2.8.1 Clearing your local development environment database](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.8-seeding-your-local-database/3.2.8.1-clearing-and-restoring-a-local-environment-to-factory-reset-data.md)
- [3.2.9 Countryconfig APIs explained](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.9-countryconfig-apis-explained.md)
- [3.2.9.1 Managing language content](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.9-countryconfig-apis-explained/3.2.9.1-managing-language-content.md)
- [3.3 Set-up a server-hosted environment](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.3-set-up-a-server-hosted-environment.md)
- [3.3.1 Provision your server nodes with SSH access](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.1-provision-your-server-nodes-with-ssh-access.md)
- [3.3.2 Provision environment](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.2-install-dependencies.md)
- [3.3.3 Provision a comms gateway](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.3-provision-a-comms-gateway.md)
- [3.3.4 Set up an SMTP server for OpenCRVS monitoring alerts](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.4-set-up-an-smtp-server-for-opencrvs-monitoring-alerts.md)
- [3.3.5 Setup DNS A records](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.5-setup-dns-a-records.md)
- [3.3.6 Deploy (Automated & Manual)](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.6-deploy-automated-and-manual.md): Steps required to build your country configuration to a Docker Container Registry and Deploy your OpenCRVS to a server hosted environment.
- [3.3.7 Seeding & clearing data on a server](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.7-seeding-and-clearing-data-on-a-server.md)
- [3.3.8 Automated & manual backup and manual restore](https://documentation.opencrvs.org/v1.3/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.8-automated-and-manual-backup-and-manual-restore.md): Critical information required to understand how to regularly backup and restore your citizen registration data in case of a server problem.
- [4. Functional configuration](https://documentation.opencrvs.org/v1.3/setup/4.-functional-configuration.md)
- [4.1 Configure application settings](https://documentation.opencrvs.org/v1.3/setup/4.-functional-configuration/4.1-configure-application-settings.md)
- [4.2 Configure registration periods and fees](https://documentation.opencrvs.org/v1.3/setup/4.-functional-configuration/4.2-configure-registration-periods-and-fees.md)
- [4.3 Create new user roles](https://documentation.opencrvs.org/v1.3/setup/4.-functional-configuration/4.3-create-new-user-roles.md)
- [4.4 Managing system users](https://documentation.opencrvs.org/v1.3/setup/4.-functional-configuration/4.5-create-system-users.md)
- [5. Testing](https://documentation.opencrvs.org/v1.3/setup/5.-testing.md)
- [6. Go-live](https://documentation.opencrvs.org/v1.3/setup/6.-go-live.md)
- [7. Monitoring](https://documentation.opencrvs.org/v1.3/setup/7.-monitoring.md)
- [7.1 Application logs](https://documentation.opencrvs.org/v1.3/setup/7.-monitoring/7.1-application-logs.md)
- [7.2 Infrastructure health](https://documentation.opencrvs.org/v1.3/setup/7.-monitoring/7.2-infrastructure-health.md)
- [7.3 Routine monitoring checklist](https://documentation.opencrvs.org/v1.3/setup/7.-monitoring/7.3-routine-monitoring-checklist.md)
- [7.4 Setting up alerts](https://documentation.opencrvs.org/v1.3/setup/7.-monitoring/7.4-setting-up-alerts.md)
- [7.5 Managing a Docker Swarm](https://documentation.opencrvs.org/v1.3/setup/7.-monitoring/7.5-managing-a-docker-swarm.md)


---

# Agent Instructions: 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:

```
GET https://documentation.opencrvs.org/v1.3/setup.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
