# Setup - [1. Planning an OpenCRVS Implementation](https://documentation.opencrvs.org/v1.4/setup/1.-planning-an-opencrvs-implementation.md) - [2. Establish project and team](https://documentation.opencrvs.org/v1.4/setup/1.-establish-project-and-team.md): Create a team that has the skills to be able to setup, implement, manage and maintain your OpenCRVS instance. - [3. Gather requirements](https://documentation.opencrvs.org/v1.4/setup/2.-gather-requirements.md): Prepare all the inputs required for product configuration. - [3.1 Mapping business processes](https://documentation.opencrvs.org/v1.4/setup/2.-gather-requirements/3.1-mapping-business-processes.md) - [3.2 Mapping offices and user types](https://documentation.opencrvs.org/v1.4/setup/2.-gather-requirements/3.2-mapping-offices-and-user-types.md): Defining how your offices and users are mapped to OpenCRVS - [3.3 Define your application settings](https://documentation.opencrvs.org/v1.4/setup/2.-gather-requirements/3.3-define-your-application-settings.md) - [3.4 Designing event declaration forms](https://documentation.opencrvs.org/v1.4/setup/2.-gather-requirements/3.4-designing-event-declaration-forms.md) - [3.5 Designing a certificate template](https://documentation.opencrvs.org/v1.4/setup/2.-gather-requirements/3.5-designing-a-certificate-template.md) - [4. Installation](https://documentation.opencrvs.org/v1.4/setup/3.-installation.md): Installation steps for OpenCRVS - [4.1 Set-up a local development environment](https://documentation.opencrvs.org/v1.4/setup/3.-installation/3.1-set-up-a-development-environment.md) - [4.1.1 Install the required dependencies](https://documentation.opencrvs.org/v1.4/setup/3.-installation/3.1-set-up-a-development-environment/3.1.1-install-the-required-dependencies.md) - [4.1.2 Install OpenCRVS locally](https://documentation.opencrvs.org/v1.4/setup/3.-installation/3.1-set-up-a-development-environment/3.1.2-install-opencrvs-locally.md) - [4.1.3 Starting and stopping OpenCRVS](https://documentation.opencrvs.org/v1.4/setup/3.-installation/3.1-set-up-a-development-environment/3.1.3-starting-and-stopping-opencrvs.md) - [4.1.4 Log in to OpenCRVS locally](https://documentation.opencrvs.org/v1.4/setup/3.-installation/3.1-set-up-a-development-environment/3.1.4-log-in-to-opencrvs-locally.md) - [4.1.5 Tooling](https://documentation.opencrvs.org/v1.4/setup/3.-installation/3.1-set-up-a-development-environment/3.1.5-tooling.md) - [4.1.5.1 WSL support](https://documentation.opencrvs.org/v1.4/setup/3.-installation/3.1-set-up-a-development-environment/3.1.5-tooling/4.1.5.1-wsl-support.md): Windows Subsystem for Linux allows the development of OpenCRVS in Windows without having to run VirtualBox or other virtual machines. This page describes some common problems and solutions for them. - [4.2 Set-up your own, local, country configuration](https://documentation.opencrvs.org/v1.4/setup/3.-installation/3.2-set-up-your-own-country-configuration.md) - [4.2.1 Fork your own country configuration repository](https://documentation.opencrvs.org/v1.4/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.1-fork-your-own-country-configuration-repository.md) - [4.2.2 Set up administrative address divisions](https://documentation.opencrvs.org/v1.4/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.2-set-up-administrative-address-divisions.md) - [4.2.2.1 Prepare source file for administrative structure](https://documentation.opencrvs.org/v1.4/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) - [4.2.2.2 Prepare source file for statistics](https://documentation.opencrvs.org/v1.4/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) - [4.2.3 Set up CR offices and Health facilities](https://documentation.opencrvs.org/v1.4/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.3-set-up-cr-offices-and-health-facilities.md) - [4.2.3.1 Prepare source file for CRVS Office facilities](https://documentation.opencrvs.org/v1.4/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) - [4.2.3.2 Prepare source file for health facilities](https://documentation.opencrvs.org/v1.4/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) - [4.2.4 Set up employees & roles for testing or production](https://documentation.opencrvs.org/v1.4/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.4-set-up-employees-for-testing-or-production.md) - [4.2.3.1 Prepare source file for employees](https://documentation.opencrvs.org/v1.4/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) - [4.2.3.2 Configure role titles](https://documentation.opencrvs.org/v1.4/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.4-set-up-employees-for-testing-or-production/4.2.3.2-configure-role-titles.md) - [4.2.5 Set up application settings](https://documentation.opencrvs.org/v1.4/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.5-set-up-application-settings.md) - [4.2.5.1 Managing language content](https://documentation.opencrvs.org/v1.4/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.5-set-up-application-settings/3.2.9.1-managing-language-content.md) - [4.2.5.1.1 Informant and staff notifications](https://documentation.opencrvs.org/v1.4/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.5-set-up-application-settings/3.2.9.1-managing-language-content/3.3.3-provision-a-comms-gateway.md) - [4.2.5.2 Configuring Metabase Dashboards](https://documentation.opencrvs.org/v1.4/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.5-set-up-application-settings/4.2.5.2-configuring-metabase-dashboards.md) - [4.2.6 Configure certificate templates](https://documentation.opencrvs.org/v1.4/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.6-configure-certificate-templates.md) - [4.2.7 Configure declaration forms](https://documentation.opencrvs.org/v1.4/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.7-configure-declaration-forms.md) - [4.2.7.1 Configuring an event form](https://documentation.opencrvs.org/v1.4/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.7-configure-declaration-forms/4.2.7.1-configuring-an-event-form.md) - [4.2.8 Seeding & clearing your local databases](https://documentation.opencrvs.org/v1.4/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.8-seeding-your-local-database.md) - [4.2.9 Countryconfig API endpoints explained](https://documentation.opencrvs.org/v1.4/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.9-countryconfig-apis-explained.md) - [4.3 Set-up a server-hosted environment](https://documentation.opencrvs.org/v1.4/setup/3.-installation/3.3-set-up-a-server-hosted-environment.md) - [4.3.1 Verify servers & create a "provision" user](https://documentation.opencrvs.org/v1.4/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.1-provision-your-server-nodes-with-ssh-access.md) - [4.3.2 HTTPS & Networking](https://documentation.opencrvs.org/v1.4/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.5-setup-dns-a-records.md) - [4.3.3 Create a Github environment](https://documentation.opencrvs.org/v1.4/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.3-create-a-github-environment.md) - [4.3.3.1 Environment secrets and variables explained](https://documentation.opencrvs.org/v1.4/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.3-create-a-github-environment/4.3.3.1-environment-secrets-and-variables-explained.md) - [4.3.4 Provision environments](https://documentation.opencrvs.org/v1.4/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.2-install-dependencies.md) - [4.3.4.1 Building, pushing & releasing your countryconfig code](https://documentation.opencrvs.org/v1.4/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.2-install-dependencies/4.3.4.1-building-pushing-and-releasing-your-countryconfig-code.md) - [4.3.5 Deploy](https://documentation.opencrvs.org/v1.4/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.6-deploy-automated-and-manual.md) - [5. Functional configuration](https://documentation.opencrvs.org/v1.4/setup/4.-functional-configuration.md) - [5.1 Configure application settings](https://documentation.opencrvs.org/v1.4/setup/4.-functional-configuration/4.1-configure-application-settings.md) - [5.2 Configure registration periods and fees](https://documentation.opencrvs.org/v1.4/setup/4.-functional-configuration/4.2-configure-registration-periods-and-fees.md) - [5.3 Managing system users](https://documentation.opencrvs.org/v1.4/setup/4.-functional-configuration/4.5-create-system-users.md) - [6. Quality assurance testing](https://documentation.opencrvs.org/v1.4/setup/5.-testing.md): How to ensure your OpenCRVS configuration is fully tested and ready for live use? - [7. Go-live](https://documentation.opencrvs.org/v1.4/setup/6.-go-live.md) - [7.1 Pre-Deployment Checklist](https://documentation.opencrvs.org/v1.4/setup/6.-go-live/3.3.4-set-up-an-smtp-server-for-opencrvs-monitoring-alerts.md) - [8. Operational Support](https://documentation.opencrvs.org/v1.4/setup/8.-operational-support.md) - [9. Monitoring](https://documentation.opencrvs.org/v1.4/setup/7.-monitoring.md) - [9.1 Application logs](https://documentation.opencrvs.org/v1.4/setup/7.-monitoring/7.1-application-logs.md) - [9.2 Infrastructure health](https://documentation.opencrvs.org/v1.4/setup/7.-monitoring/7.2-infrastructure-health.md) - [9.3 Routine monitoring checklist](https://documentation.opencrvs.org/v1.4/setup/7.-monitoring/7.3-routine-monitoring-checklist.md) - [9.4 Setting up alerts](https://documentation.opencrvs.org/v1.4/setup/7.-monitoring/7.4-setting-up-alerts.md) - [9.5 Managing a Docker Swarm](https://documentation.opencrvs.org/v1.4/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.4/setup.md?ask= ``` 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.