# OpenCRVS ## v1.9 - [Welcome!](https://documentation.opencrvs.org/readme.md) - [Understanding CRVS](https://documentation.opencrvs.org/crvs-systems/understanding-crvs.md): Provides useful links to documentation about CRVS - [Effective digital CRVS systems](https://documentation.opencrvs.org/crvs-systems/effective-digital-crvs-systems.md): Setting realistic business expectations of CRVS digitisation - [OpenCRVS within a government systems architecture](https://documentation.opencrvs.org/crvs-systems/opencrvs-within-a-government-systems-architecture.md): How to think about the use of OpenCRVS as an interoperable system within a government's digital landscape - [OpenCRVS Value Proposition](https://documentation.opencrvs.org/crvs-systems/opencrvs-value-proposition.md) - [Legal Compliance](https://documentation.opencrvs.org/crvs-systems/opencrvs-value-proposition/legal-compliance.md) - [Functional Architecture](https://documentation.opencrvs.org/product-specifications/functional-architecture.md) - [Workflow management](https://documentation.opencrvs.org/product-specifications/workflow-management.md) - [Status Flow Diagram](https://documentation.opencrvs.org/product-specifications/status-flow-diagram.md) - [User roles & scopes](https://documentation.opencrvs.org/product-specifications/users.md) - [Examples](https://documentation.opencrvs.org/product-specifications/users/examples.md) - [Core functions](https://documentation.opencrvs.org/product-specifications/core-functions.md): Overview of core functions - [1. Notify event](https://documentation.opencrvs.org/product-specifications/core-functions/1.-notify-event.md) - [2. Declare event](https://documentation.opencrvs.org/product-specifications/core-functions/2.-declare-event.md) - [3. Validate event](https://documentation.opencrvs.org/product-specifications/core-functions/3.-validate-event.md) - [4. Register event](https://documentation.opencrvs.org/product-specifications/core-functions/4.-register-event.md) - [5. Print certificate](https://documentation.opencrvs.org/product-specifications/core-functions/5.-print-certificate.md) - [6. Search for a record](https://documentation.opencrvs.org/product-specifications/core-functions/6.-search-for-a-record.md) - [7. View record](https://documentation.opencrvs.org/product-specifications/core-functions/7.-view-record.md) - [9. Correct record](https://documentation.opencrvs.org/product-specifications/core-functions/8.-correct-record.md) - [10. Archive record](https://documentation.opencrvs.org/product-specifications/core-functions/10.-archive-record.md) - [11. Vital statistics export](https://documentation.opencrvs.org/product-specifications/core-functions/11.-vital-statistics-export.md) - [Support functions](https://documentation.opencrvs.org/product-specifications/support-functions.md): Overview of functionality that enables users to conduct civil registration services safely, securely, and most effectively. - [12. Login](https://documentation.opencrvs.org/product-specifications/support-functions/10.-login.md) - [14. Audit](https://documentation.opencrvs.org/product-specifications/support-functions/11.-audit.md) - [14. Deduplication](https://documentation.opencrvs.org/product-specifications/support-functions/12.-deduplication.md) - [15. Performance management](https://documentation.opencrvs.org/product-specifications/support-functions/13.-performance-management.md) - [16. Payment](https://documentation.opencrvs.org/product-specifications/support-functions/14.-payment.md) - [17. Learning](https://documentation.opencrvs.org/product-specifications/support-functions/15.-learning.md) - [18. User support](https://documentation.opencrvs.org/product-specifications/support-functions/16.-user-support.md) - [19. User onboarding](https://documentation.opencrvs.org/product-specifications/support-functions/20.-user-onboarding.md) - [Admin functions](https://documentation.opencrvs.org/product-specifications/admin-functions.md): Overview of functionality for a system administrator to effectively manage and maintain the OpenCRVS product. - [20. User management](https://documentation.opencrvs.org/product-specifications/admin-functions/17.-user-management.md) - [21. Comms management](https://documentation.opencrvs.org/product-specifications/admin-functions/18.-comms-management.md) - [22. Content management](https://documentation.opencrvs.org/product-specifications/admin-functions/19.-content-management.md) - [23. Config management](https://documentation.opencrvs.org/product-specifications/admin-functions/20.-config-management.md) - [Data functions](https://documentation.opencrvs.org/product-specifications/data-functions.md): Overview of functionality that transforms legacy data. - [24. Legacy data import](https://documentation.opencrvs.org/product-specifications/data-functions/21.-legacy-data-import.md) - [25. Legacy paper import](https://documentation.opencrvs.org/product-specifications/data-functions/22.-legacy-paper-import.md) - [Architecture](https://documentation.opencrvs.org/technology/architecture.md) - [Performance tests](https://documentation.opencrvs.org/technology/architecture/performance-tests.md): Overview of results from performance tests conducted on OpenCRVS - [Standards](https://documentation.opencrvs.org/technology/standards.md): Overview of how OpenCRVS uses best-practice technology standards - [Security](https://documentation.opencrvs.org/technology/security.md) - [Interoperability](https://documentation.opencrvs.org/technology/interoperability.md): An introduction describing how OpenCRVS interoperates - [APIs requiring OAuth credentials](https://documentation.opencrvs.org/technology/interoperability/apis-requiring-oauth-credentials.md) - [Authenticate a client](https://documentation.opencrvs.org/technology/interoperability/apis-requiring-oauth-credentials/authenticate-a-client.md): Authenticating with your client details to retrieve an access token using OAuth 2.0 - [Event Notification clients](https://documentation.opencrvs.org/technology/interoperability/apis-requiring-oauth-credentials/event-notification-clients.md): Submitting full or partial event applications into OpenCRVS from an external service such as a health institution or public portal. - [Record Search clients](https://documentation.opencrvs.org/technology/interoperability/apis-requiring-oauth-credentials/record-search-clients.md): Perform an advanced search of civil registration records from a trusted, external e-Gov service - [APIs for system administrators](https://documentation.opencrvs.org/technology/interoperability/fhir-location-rest-api.md) - [National ID](https://documentation.opencrvs.org/technology/interoperability/national-id.md) - [Registration integration](https://documentation.opencrvs.org/technology/interoperability/national-id/registration-integration.md) - [In-form authentication / verification](https://documentation.opencrvs.org/technology/interoperability/national-id/in-form-authentication-verification.md): Authenticating and verifying the identity of informants and parents during the event application process both offline and online. - [MOSIP](https://documentation.opencrvs.org/technology/interoperability/national-id/mosip.md) - [Configuration](https://documentation.opencrvs.org/technology/interoperability/national-id/mosip/configuration.md) - [Registration integration](https://documentation.opencrvs.org/technology/interoperability/national-id/mosip/registration-integration.md) - [In-form authentication / verification with E-Signet](https://documentation.opencrvs.org/technology/interoperability/national-id/mosip/in-form-authentication-verification-with-e-signet.md) - [Deployment](https://documentation.opencrvs.org/technology/interoperability/national-id/mosip/deployment.md) - [Intro to Farajaland](https://documentation.opencrvs.org/default-configuration/intro-to-farajaland.md): Provides details of the OpenCRVS default configuration - [Civil registration in Farajaland](https://documentation.opencrvs.org/default-configuration/civil-registration-in-farajaland.md): Provides details of how civil registration is organised and administered in Farajaland - [OpenCRVS configuration in Farajaland](https://documentation.opencrvs.org/default-configuration/opencrvs-configuration-in-farajaland.md): Provides details on how OpenCRVS has been configured to meet the Farajaland context - [Application settings](https://documentation.opencrvs.org/default-configuration/opencrvs-configuration-in-farajaland/application-settings.md) - [User roles](https://documentation.opencrvs.org/default-configuration/opencrvs-configuration-in-farajaland/user-role-mapping.md) - [Declaration forms](https://documentation.opencrvs.org/default-configuration/opencrvs-configuration-in-farajaland/declaration-forms.md) - [Certified Copies templates](https://documentation.opencrvs.org/default-configuration/opencrvs-configuration-in-farajaland/certificate-templates.md) - [Business process flows in Farajaland](https://documentation.opencrvs.org/default-configuration/business-process-flows-in-farajaland.md): Provides an overview of the Farajaland business processes digitally enabled by OpenCRVS - [1. Planning an OpenCRVS Implementation](https://documentation.opencrvs.org/setup/1.-planning-an-opencrvs-implementation.md) - [2. Establish project and team](https://documentation.opencrvs.org/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/setup/2.-gather-requirements.md): Prepare all the inputs required for product configuration. - [3.1 Mapping business processes](https://documentation.opencrvs.org/setup/2.-gather-requirements/3.1-mapping-business-processes.md) - [3.2 Mapping offices and user types](https://documentation.opencrvs.org/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/setup/2.-gather-requirements/3.3-define-your-application-settings.md) - [3.4 Designing event declaration forms](https://documentation.opencrvs.org/setup/2.-gather-requirements/3.4-designing-event-declaration-forms.md) - [3.5 Designing a certified copy](https://documentation.opencrvs.org/setup/2.-gather-requirements/3.5-designing-a-certificate-template.md) - [4. Installation](https://documentation.opencrvs.org/setup/3.-installation.md): Installation steps for OpenCRVS - [4.1 Quick start: Set-up a local development environment](https://documentation.opencrvs.org/setup/3.-installation/3.1-set-up-a-development-environment.md) - [4.1.1 Install the required dependencies](https://documentation.opencrvs.org/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/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/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/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/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/setup/3.-installation/3.1-set-up-a-development-environment/3.1.5-tooling/4.1.5.1-wsl-support.md) - [4.2 Configure: Set-up your own, local, country configuration](https://documentation.opencrvs.org/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/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/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/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/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/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/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/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/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/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 user roles](https://documentation.opencrvs.org/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/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/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/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.6 Configure events](https://documentation.opencrvs.org/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.7-configure-declaration-forms.md) - [4.2.6.1 Working with events](https://documentation.opencrvs.org/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.6.2 Configure an event declaration form](https://documentation.opencrvs.org/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.7-configure-declaration-forms/4.2.6.2-configure-an-event-declaration-form.md): Configuring an event declaration form requires you to: - [4.2.6.3 Configure certificate templates](https://documentation.opencrvs.org/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.7-configure-declaration-forms/3.2.6-configure-certificate-templates.md) - [4.2.7 Configure Metabase Analytics](https://documentation.opencrvs.org/setup/3.-installation/3.2-set-up-your-own-country-configuration/4.2.5.2-configuring-metabase-dashboards.md) - [4.2.8 Seeding & clearing your local databases](https://documentation.opencrvs.org/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.8-seeding-your-local-database.md) - [4.2.9 Other configurable countryconfig API endpoints explained](https://documentation.opencrvs.org/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.9-countryconfig-apis-explained.md) - [4.2.9.1 Configurable workqueue API](https://documentation.opencrvs.org/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.9-countryconfig-apis-explained/4.2.9.1-configurable-workqueue-api.md) - [4.3 Deploy: Set-up a server-hosted environment](https://documentation.opencrvs.org/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/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 TLS / SSL & DNS](https://documentation.opencrvs.org/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.5-setup-dns-a-records.md) - [4.3.2.1 LetsEncrypt https challenge in development environments](https://documentation.opencrvs.org/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.5-setup-dns-a-records/4.3.2.1-letsencrypt-https-challenge-in-development-environments.md) - [4.3.2.2 LetsEncrypt DNS challenge in production](https://documentation.opencrvs.org/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.5-setup-dns-a-records/4.3.2.2-letsencrypt-dns-challenge-in-production.md) - [4.3.2.3 Static TLS certificates](https://documentation.opencrvs.org/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.5-setup-dns-a-records/4.3.2.3-static-tls-certificates.md) - [4.3.3 Configure inventory files](https://documentation.opencrvs.org/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.2-install-dependencies.md) - [4.3.4 Create a Github environment](https://documentation.opencrvs.org/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.4-create-a-github-environment.md) - [4.3.4.1 Environment secrets and variables explained](https://documentation.opencrvs.org/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.4-create-a-github-environment/4.3.4.1-environment-secrets-and-variables-explained.md) - [4.3.4.2 VPN Recipes](https://documentation.opencrvs.org/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.4-create-a-github-environment/4.3.4.2-vpn-recipes.md) - [4.3.5 Provisioning servers](https://documentation.opencrvs.org/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.5-provisioning-servers.md) - [4.3.5.1 SSH access](https://documentation.opencrvs.org/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.5-provisioning-servers/4.3.5.1-ssh-access.md) - [4.3.5.2 Building, pushing & releasing your countryconfig code](https://documentation.opencrvs.org/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.5-provisioning-servers/4.3.5.2-building-pushing-and-releasing-your-countryconfig-code.md) - [4.3.5.3 Ansible tasks when provisioning](https://documentation.opencrvs.org/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.5-provisioning-servers/4.3.5.3-ansible-tasks-when-provisioning.md) - [4.3.6 Deploy](https://documentation.opencrvs.org/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.6-deploy-automated-and-manual.md) - [4.3.6.1 Running a deployment](https://documentation.opencrvs.org/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.6-deploy-automated-and-manual/4.3.6.1-running-a-deployment.md) - [4.3.6.2 Seeding a server environment](https://documentation.opencrvs.org/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.6-deploy-automated-and-manual/4.3.6.2-seeding-a-server-environment.md) - [4.3.6.3 Login to an OpenCRVS server](https://documentation.opencrvs.org/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.6-deploy-automated-and-manual/4.3.6.3-login-to-an-opencrvs-server.md) - [4.3.6.5 Resetting a server environment](https://documentation.opencrvs.org/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.6-deploy-automated-and-manual/4.3.6.5-resetting-a-server-environment.md) - [4.3.7 Backup & Restore](https://documentation.opencrvs.org/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.7-backup-and-restore.md) - [4.3.7.1 Restoring a backup](https://documentation.opencrvs.org/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.7-backup-and-restore/4.3.7.1-restoring-a-backup.md) - [4.3.7.2 Off-boarding from OpenCRVS](https://documentation.opencrvs.org/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.7-backup-and-restore/4.3.7.2-off-boarding-from-opencrvs.md) - [5. Functional configuration](https://documentation.opencrvs.org/setup/5.-functional-configuration.md) - [5.1 Configure application settings](https://documentation.opencrvs.org/setup/5.-functional-configuration/5.1-configure-application-settings.md) - [5.2 Configure registration periods and fees](https://documentation.opencrvs.org/setup/5.-functional-configuration/5.2-configure-registration-periods-and-fees.md) - [5.3 Managing system users](https://documentation.opencrvs.org/setup/5.-functional-configuration/5.3-managing-system-users.md) - [6. Quality assurance testing](https://documentation.opencrvs.org/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/setup/6.-go-live.md) - [7.1 Pre-Deployment Checklist](https://documentation.opencrvs.org/setup/6.-go-live/3.3.4-set-up-an-smtp-server-for-opencrvs-monitoring-alerts.md) - [8. Operational Support](https://documentation.opencrvs.org/setup/8.-operational-support.md) - [9. Monitoring](https://documentation.opencrvs.org/setup/7.-monitoring.md) - [9.1 Application logs](https://documentation.opencrvs.org/setup/7.-monitoring/7.1-application-logs.md) - [9.2 Infrastructure health](https://documentation.opencrvs.org/setup/7.-monitoring/7.2-infrastructure-health.md) - [9.3 Routine monitoring checklist](https://documentation.opencrvs.org/setup/7.-monitoring/7.3-routine-monitoring-checklist.md) - [9.4 Setting up alerts](https://documentation.opencrvs.org/setup/7.-monitoring/7.4-setting-up-alerts.md) - [9.5 Managing a Docker Swarm](https://documentation.opencrvs.org/setup/7.-monitoring/7.5-managing-a-docker-swarm.md) - [Community](https://documentation.opencrvs.org/general/community.md) - [Contributing](https://documentation.opencrvs.org/general/contributing.md): How to contribute to the Digital Public Good for CRVS - [Migration notes](https://documentation.opencrvs.org/general/migration-notes.md) - [Release notes](https://documentation.opencrvs.org/general/release-notes.md) - [Releases and upgrades](https://documentation.opencrvs.org/general/releases-and-upgrades.md) - [Roadmap](https://documentation.opencrvs.org/general/product-roadmap.md) - [Infrastructure](https://documentation.opencrvs.org/developers/infrastructure.md) - [Local Setup](https://documentation.opencrvs.org/developers/infrastructure/local-setup.md) - [Country configuration](https://documentation.opencrvs.org/developers/country-configuration.md) - [Events](https://documentation.opencrvs.org/developers/country-configuration/events.md) - [Events](https://documentation.opencrvs.org/developers/country-configuration/events-1.md) - [Events](https://documentation.opencrvs.org/developers/country-configuration/events-2.md) - [Events](https://documentation.opencrvs.org/developers/country-configuration/events-3.md) - [Events](https://documentation.opencrvs.org/developers/country-configuration/events-4.md) - [Events](https://documentation.opencrvs.org/developers/country-configuration/events-5.md) - [Events](https://documentation.opencrvs.org/developers/country-configuration/events-6.md) - [Events](https://documentation.opencrvs.org/developers/country-configuration/events-7.md) - [Certificate templates](https://documentation.opencrvs.org/developers/country-configuration/certificate-templates.md) - [Variables & functions](https://documentation.opencrvs.org/developers/country-configuration/certificate-templates/variables-and-functions.md) ## v1.8 - [Welcome!](https://documentation.opencrvs.org/v1.8/readme.md) - [Understanding CRVS](https://documentation.opencrvs.org/v1.8/crvs-systems/understanding-crvs.md): Provides useful links to documentation about CRVS - [Effective digital CRVS systems](https://documentation.opencrvs.org/v1.8/crvs-systems/effective-digital-crvs-systems.md): Setting realistic business expectations of CRVS digitisation - [OpenCRVS within a government systems architecture](https://documentation.opencrvs.org/v1.8/crvs-systems/opencrvs-within-a-government-systems-architecture.md): How to think about the use of OpenCRVS as an interoperable system within a government's digital landscape - [OpenCRVS Value Proposition](https://documentation.opencrvs.org/v1.8/crvs-systems/opencrvs-value-proposition.md) - [Functional Architecture](https://documentation.opencrvs.org/v1.8/product-specifications/functional-architecture.md) - [Workflow management](https://documentation.opencrvs.org/v1.8/product-specifications/workflow-management.md) - [Status Flow Diagram](https://documentation.opencrvs.org/v1.8/product-specifications/status-flow-diagram.md) - [User roles & scopes](https://documentation.opencrvs.org/v1.8/product-specifications/users.md) - [Examples](https://documentation.opencrvs.org/v1.8/product-specifications/users/examples.md) - [Core functions](https://documentation.opencrvs.org/v1.8/product-specifications/core-functions.md): Overview of core functions - [1. Notify event](https://documentation.opencrvs.org/v1.8/product-specifications/core-functions/1.-notify-event.md) - [2. Declare event](https://documentation.opencrvs.org/v1.8/product-specifications/core-functions/2.-declare-event.md) - [3. Validate event](https://documentation.opencrvs.org/v1.8/product-specifications/core-functions/3.-validate-event.md) - [4. Register event](https://documentation.opencrvs.org/v1.8/product-specifications/core-functions/4.-register-event.md) - [5. Print certificate](https://documentation.opencrvs.org/v1.8/product-specifications/core-functions/5.-print-certificate.md) - [6. Issue certificate](https://documentation.opencrvs.org/v1.8/product-specifications/core-functions/5.-issue-certificate.md) - [7. Search for a record](https://documentation.opencrvs.org/v1.8/product-specifications/core-functions/6.-search-for-a-record.md) - [8. View record](https://documentation.opencrvs.org/v1.8/product-specifications/core-functions/7.-view-record.md) - [9. Correct record](https://documentation.opencrvs.org/v1.8/product-specifications/core-functions/8.-correct-record.md) - [10. Verify record](https://documentation.opencrvs.org/v1.8/product-specifications/core-functions/9.-verify-record.md) - [11. Archive record](https://documentation.opencrvs.org/v1.8/product-specifications/core-functions/10.-archive-record.md) - [12. Vital statistics export](https://documentation.opencrvs.org/v1.8/product-specifications/core-functions/11.-vital-statistics-export.md) - [Support functions](https://documentation.opencrvs.org/v1.8/product-specifications/support-functions.md): Overview of functionality that enables users to conduct civil registration services safely, securely, and most effectively. - [13. Login](https://documentation.opencrvs.org/v1.8/product-specifications/support-functions/10.-login.md) - [14. Audit](https://documentation.opencrvs.org/v1.8/product-specifications/support-functions/11.-audit.md) - [15. Deduplication](https://documentation.opencrvs.org/v1.8/product-specifications/support-functions/12.-deduplication.md) - [16. Performance management](https://documentation.opencrvs.org/v1.8/product-specifications/support-functions/13.-performance-management.md) - [17. Payment](https://documentation.opencrvs.org/v1.8/product-specifications/support-functions/14.-payment.md) - [18. Learning](https://documentation.opencrvs.org/v1.8/product-specifications/support-functions/15.-learning.md) - [19. User support](https://documentation.opencrvs.org/v1.8/product-specifications/support-functions/16.-user-support.md) - [20. User onboarding](https://documentation.opencrvs.org/v1.8/product-specifications/support-functions/20.-user-onboarding.md) - [Admin functions](https://documentation.opencrvs.org/v1.8/product-specifications/admin-functions.md): Overview of functionality for a system administrator to effectively manage and maintain the OpenCRVS product. - [21. User management](https://documentation.opencrvs.org/v1.8/product-specifications/admin-functions/17.-user-management.md) - [22. Comms management](https://documentation.opencrvs.org/v1.8/product-specifications/admin-functions/18.-comms-management.md) - [23. Content management](https://documentation.opencrvs.org/v1.8/product-specifications/admin-functions/19.-content-management.md) - [24. Config management](https://documentation.opencrvs.org/v1.8/product-specifications/admin-functions/20.-config-management.md) - [Data functions](https://documentation.opencrvs.org/v1.8/product-specifications/data-functions.md): Overview of functionality that transforms legacy data. - [25. Legacy data import](https://documentation.opencrvs.org/v1.8/product-specifications/data-functions/21.-legacy-data-import.md) - [26. Legacy paper import](https://documentation.opencrvs.org/v1.8/product-specifications/data-functions/22.-legacy-paper-import.md) - [Architecture](https://documentation.opencrvs.org/v1.8/technology/architecture.md) - [Performance tests](https://documentation.opencrvs.org/v1.8/technology/architecture/performance-tests.md): Overview of results from performance tests conducted on OpenCRVS - [Standards](https://documentation.opencrvs.org/v1.8/technology/standards.md): Overview of how OpenCRVS uses best-practice technology standards - [FHIR Documents](https://documentation.opencrvs.org/v1.8/technology/standards/fhir-documents.md) - [Event Composition](https://documentation.opencrvs.org/v1.8/technology/standards/fhir-documents/event-composition.md) - [Person](https://documentation.opencrvs.org/v1.8/technology/standards/fhir-documents/person.md) - [Registration Task](https://documentation.opencrvs.org/v1.8/technology/standards/fhir-documents/registration-task.md) - [Event Observations](https://documentation.opencrvs.org/v1.8/technology/standards/fhir-documents/event-observations.md) - [Locations](https://documentation.opencrvs.org/v1.8/technology/standards/fhir-documents/locations.md) - [Security](https://documentation.opencrvs.org/v1.8/technology/security.md) - [Interoperability](https://documentation.opencrvs.org/v1.8/technology/interoperability.md): An introduction describing how OpenCRVS interoperates - [APIs requiring OAuth credentials](https://documentation.opencrvs.org/v1.8/technology/interoperability/create-a-client.md): In order to interoperate with OpenCRVS' record search, event notification and webhooks, you must first create an OAuth client. - [Authenticate a client](https://documentation.opencrvs.org/v1.8/technology/interoperability/create-a-client/authenticate-a-client.md): Authenticating with your client details to retrieve an access token using OAuth 2.0 - [Event Notification clients](https://documentation.opencrvs.org/v1.8/technology/interoperability/create-a-client/event-notification-clients.md): Submitting full or partial event applications into OpenCRVS from an external service such as a health institution or public portal. - [Record Search clients](https://documentation.opencrvs.org/v1.8/technology/interoperability/create-a-client/record-search-clients.md): Perform an advanced search of civil registration records from a trusted, external e-Gov service - [Webhook clients](https://documentation.opencrvs.org/v1.8/technology/interoperability/create-a-client/webhook-clients.md): Business functionality and API endpoints available to a "Webhook" client. - [APIs for system administrators](https://documentation.opencrvs.org/v1.8/technology/interoperability/fhir-location-rest-api.md): Create, read, update or archive administrative areas, civil registration offices or health facilities using FHIR. - [National ID](https://documentation.opencrvs.org/v1.8/technology/interoperability/national-id-client.md) - [Registration integration](https://documentation.opencrvs.org/v1.8/technology/interoperability/national-id-client/registration-integration.md): Interoperating with a National ID system at the point of registration, both synchronously and asynchronously. - [In-form authentication / verification](https://documentation.opencrvs.org/v1.8/technology/interoperability/national-id-client/in-form-authentication-verification.md): Authenticating and verifying the identity of informants and parents during the event application process both offline and online. - [MOSIP](https://documentation.opencrvs.org/v1.8/technology/interoperability/national-id-client/mosip.md): Interoperating with MOSIP and E-Signet, OpenSource DPG solutions for National ID and digital identity verification - [Registration integration](https://documentation.opencrvs.org/v1.8/technology/interoperability/national-id-client/mosip/registration-integration.md): Using MOSIP's Packet Manager API for asynchronous integration at the point of registration - [In-form authentication / verification & E-Signet](https://documentation.opencrvs.org/v1.8/technology/interoperability/national-id-client/mosip/in-form-authentication-verification-using-e-signet.md) - [Deployment](https://documentation.opencrvs.org/v1.8/technology/interoperability/national-id-client/mosip/deployment.md): Deployment process for the technical components and modules required to integrate with MOSIP & E-Signet - [Intro to Farajaland](https://documentation.opencrvs.org/v1.8/default-configuration/intro-to-farajaland.md): Provides details of the OpenCRVS default configuration - [Civil registration in Farajaland](https://documentation.opencrvs.org/v1.8/default-configuration/civil-registration-in-farajaland.md): Provides details of how civil registration is organised and administered in Farajaland - [OpenCRVS configuration in Farajaland](https://documentation.opencrvs.org/v1.8/default-configuration/opencrvs-configuration-in-farajaland.md): Provides details on how OpenCRVS has been configured to meet the Farajaland context - [Application settings](https://documentation.opencrvs.org/v1.8/default-configuration/opencrvs-configuration-in-farajaland/application-settings.md) - [User roles](https://documentation.opencrvs.org/v1.8/default-configuration/opencrvs-configuration-in-farajaland/user-role-mapping.md) - [Declaration forms](https://documentation.opencrvs.org/v1.8/default-configuration/opencrvs-configuration-in-farajaland/declaration-forms.md) - [Certified Copies templates](https://documentation.opencrvs.org/v1.8/default-configuration/opencrvs-configuration-in-farajaland/certificate-templates.md) - [Business process flows in Farajaland](https://documentation.opencrvs.org/v1.8/default-configuration/business-process-flows-in-farajaland.md): Provides an overview of the Farajaland business processes digitally enabled by OpenCRVS - [1. Planning an OpenCRVS Implementation](https://documentation.opencrvs.org/v1.8/setup/1.-planning-an-opencrvs-implementation.md) - [2. Establish project and team](https://documentation.opencrvs.org/v1.8/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.8/setup/2.-gather-requirements.md): Prepare all the inputs required for product configuration. - [3.1 Mapping business processes](https://documentation.opencrvs.org/v1.8/setup/2.-gather-requirements/3.1-mapping-business-processes.md) - [3.2 Mapping offices and user types](https://documentation.opencrvs.org/v1.8/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.8/setup/2.-gather-requirements/3.3-define-your-application-settings.md) - [3.4 Designing event declaration forms](https://documentation.opencrvs.org/v1.8/setup/2.-gather-requirements/3.4-designing-event-declaration-forms.md) - [3.5 Designing a certified copy](https://documentation.opencrvs.org/v1.8/setup/2.-gather-requirements/3.5-designing-a-certificate-template.md) - [4. Installation](https://documentation.opencrvs.org/v1.8/setup/3.-installation.md): Installation steps for OpenCRVS - [4.1 Quick start: Set-up a local development environment](https://documentation.opencrvs.org/v1.8/setup/3.-installation/3.1-set-up-a-development-environment.md) - [4.1.1 Install the required dependencies](https://documentation.opencrvs.org/v1.8/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.8/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.8/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.8/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.8/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.8/setup/3.-installation/3.1-set-up-a-development-environment/3.1.5-tooling/4.1.5.1-wsl-support.md) - [4.2 Configure: Set-up your own, local, country configuration](https://documentation.opencrvs.org/v1.8/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.8/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.8/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.8/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.8/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.8/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.8/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.8/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 employee users, and scopes, for testing or production](https://documentation.opencrvs.org/v1.8/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.8/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 roles and scopes](https://documentation.opencrvs.org/v1.8/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.8/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.8/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.8/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.8/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.8/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.8/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.8/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.8/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.8/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.9-countryconfig-apis-explained.md) - [4.3 Deploy: Set-up a server-hosted environment](https://documentation.opencrvs.org/v1.8/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.8/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 TLS / SSL & DNS](https://documentation.opencrvs.org/v1.8/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.5-setup-dns-a-records.md) - [4.3.2.1 LetsEncrypt https challenge in development environments](https://documentation.opencrvs.org/v1.8/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.5-setup-dns-a-records/4.3.2.1-letsencrypt-https-challenge-in-development-environments.md) - [4.3.2.2 LetsEncrypt DNS challenge in production](https://documentation.opencrvs.org/v1.8/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.5-setup-dns-a-records/4.3.2.2-letsencrypt-dns-challenge-in-production.md) - [4.3.2.3 Static TLS certificates](https://documentation.opencrvs.org/v1.8/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.5-setup-dns-a-records/4.3.2.3-static-tls-certificates.md) - [4.3.3 Configure inventory files](https://documentation.opencrvs.org/v1.8/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.2-install-dependencies.md) - [4.3.4 Create a Github environment](https://documentation.opencrvs.org/v1.8/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.4-create-a-github-environment.md) - [4.3.4.1 Environment secrets and variables explained](https://documentation.opencrvs.org/v1.8/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.4-create-a-github-environment/4.3.4.1-environment-secrets-and-variables-explained.md) - [4.3.4.2 VPN Recipes](https://documentation.opencrvs.org/v1.8/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.4-create-a-github-environment/4.3.4.2-vpn-recipes.md) - [4.3.5 Provisioning servers](https://documentation.opencrvs.org/v1.8/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.5-provisioning-servers.md) - [4.3.5.1 SSH access](https://documentation.opencrvs.org/v1.8/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.5-provisioning-servers/4.3.5.1-ssh-access.md) - [4.3.5.2 Building, pushing & releasing your countryconfig code](https://documentation.opencrvs.org/v1.8/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.5-provisioning-servers/4.3.5.2-building-pushing-and-releasing-your-countryconfig-code.md) - [4.3.5.3 Ansible tasks when provisioning](https://documentation.opencrvs.org/v1.8/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.5-provisioning-servers/4.3.5.3-ansible-tasks-when-provisioning.md) - [4.3.6 Deploy](https://documentation.opencrvs.org/v1.8/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.6-deploy-automated-and-manual.md) - [4.3.6.1 Running a deployment](https://documentation.opencrvs.org/v1.8/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.6-deploy-automated-and-manual/4.3.6.1-running-a-deployment.md) - [4.3.6.2 Seeding a server environment](https://documentation.opencrvs.org/v1.8/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.6-deploy-automated-and-manual/4.3.6.2-seeding-a-server-environment.md) - [4.3.6.3 Login to an OpenCRVS server](https://documentation.opencrvs.org/v1.8/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.6-deploy-automated-and-manual/4.3.6.3-login-to-an-opencrvs-server.md) - [4.3.6.5 Resetting a server environment](https://documentation.opencrvs.org/v1.8/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.6-deploy-automated-and-manual/4.3.6.5-resetting-a-server-environment.md) - [4.3.7 Backup & Restore](https://documentation.opencrvs.org/v1.8/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.7-backup-and-restore.md) - [4.3.7.1 Restoring a backup](https://documentation.opencrvs.org/v1.8/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.7-backup-and-restore/4.3.7.1-restoring-a-backup.md) - [4.3.7.2 Off-boarding from OpenCRVS](https://documentation.opencrvs.org/v1.8/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.7-backup-and-restore/4.3.7.2-off-boarding-from-opencrvs.md) - [5. Quality assurance testing](https://documentation.opencrvs.org/v1.8/setup/5.-testing.md): How to ensure your OpenCRVS configuration is fully tested and ready for live use? - [6. Go-live](https://documentation.opencrvs.org/v1.8/setup/6.-go-live.md) - [6.1 Pre-Deployment Checklist](https://documentation.opencrvs.org/v1.8/setup/6.-go-live/3.3.4-set-up-an-smtp-server-for-opencrvs-monitoring-alerts.md) - [7. Operational Support](https://documentation.opencrvs.org/v1.8/setup/8.-operational-support.md) - [8. Monitoring](https://documentation.opencrvs.org/v1.8/setup/7.-monitoring.md) - [8.1 Application logs](https://documentation.opencrvs.org/v1.8/setup/7.-monitoring/7.1-application-logs.md) - [8.2 Infrastructure health](https://documentation.opencrvs.org/v1.8/setup/7.-monitoring/7.2-infrastructure-health.md) - [8.3 Routine monitoring checklist](https://documentation.opencrvs.org/v1.8/setup/7.-monitoring/7.3-routine-monitoring-checklist.md) - [8.4 Setting up alerts](https://documentation.opencrvs.org/v1.8/setup/7.-monitoring/7.4-setting-up-alerts.md) - [8.5 Managing a Docker Swarm](https://documentation.opencrvs.org/v1.8/setup/7.-monitoring/7.5-managing-a-docker-swarm.md) - [Community](https://documentation.opencrvs.org/v1.8/general/community.md) - [Contributing](https://documentation.opencrvs.org/v1.8/general/contributing.md): How to contribute to the Digital Public Good for CRVS - [Migration notes](https://documentation.opencrvs.org/v1.8/general/migration-notes.md) - [Releases and upgrades](https://documentation.opencrvs.org/v1.8/general/releases.md) - [Release notes](https://documentation.opencrvs.org/v1.8/general/v1.8-release-notes.md): In OpenCRVS v1.8.0, alongside numerous technical improvements and bug fixes, we have enhanced form configuration flexibility. Signatures inputs are now part of the form configuration. - [Product roadmap](https://documentation.opencrvs.org/v1.8/general/product-roadmap.md) - [Contributing](https://documentation.opencrvs.org/v1.8/developer/contributing.md) - [Submitting a hotfix](https://documentation.opencrvs.org/v1.8/developer/contributing/submitting-a-hotfix.md) - [Infrastructure](https://documentation.opencrvs.org/v1.8/developer/infrastructure.md) - [Local Setup](https://documentation.opencrvs.org/v1.8/developer/infrastructure/local-setup.md) - [Workflows](https://documentation.opencrvs.org/v1.8/developer/workflows.md) - [Releasing](https://documentation.opencrvs.org/v1.8/developer/workflows/releasing.md) ## v1.7 - [Welcome!](https://documentation.opencrvs.org/v1.7/readme.md) - [Understanding CRVS](https://documentation.opencrvs.org/v1.7/crvs-systems/understanding-crvs.md): Provides useful links to documentation about CRVS - [Effective digital CRVS systems](https://documentation.opencrvs.org/v1.7/crvs-systems/effective-digital-crvs-systems.md): Setting realistic business expectations of CRVS digitisation - [OpenCRVS within a government systems architecture](https://documentation.opencrvs.org/v1.7/crvs-systems/opencrvs-within-a-government-systems-architecture.md): How to think about the use of OpenCRVS as an interoperable system within a government's digital landscape - [OpenCRVS Value Proposition](https://documentation.opencrvs.org/v1.7/crvs-systems/opencrvs-value-proposition.md) - [Functional Architecture](https://documentation.opencrvs.org/v1.7/product-specifications/functional-architecture.md) - [Workflow management](https://documentation.opencrvs.org/v1.7/product-specifications/workflow-management.md) - [Status Flow Diagram](https://documentation.opencrvs.org/v1.7/product-specifications/status-flow-diagram.md) - [User roles & scopes](https://documentation.opencrvs.org/v1.7/product-specifications/users.md) - [Examples](https://documentation.opencrvs.org/v1.7/product-specifications/users/examples.md) - [Core functions](https://documentation.opencrvs.org/v1.7/product-specifications/core-functions.md): Overview of core functions - [1. Notify event](https://documentation.opencrvs.org/v1.7/product-specifications/core-functions/1.-notify-event.md) - [2. Declare event](https://documentation.opencrvs.org/v1.7/product-specifications/core-functions/2.-declare-event.md) - [3. Validate event](https://documentation.opencrvs.org/v1.7/product-specifications/core-functions/3.-validate-event.md) - [4. Register event](https://documentation.opencrvs.org/v1.7/product-specifications/core-functions/4.-register-event.md) - [5. Print certificate](https://documentation.opencrvs.org/v1.7/product-specifications/core-functions/5.-print-certificate.md) - [6. Issue certificate](https://documentation.opencrvs.org/v1.7/product-specifications/core-functions/5.-issue-certificate.md) - [7. Search for a record](https://documentation.opencrvs.org/v1.7/product-specifications/core-functions/6.-search-for-a-record.md) - [8. View record](https://documentation.opencrvs.org/v1.7/product-specifications/core-functions/7.-view-record.md) - [9. Correct record](https://documentation.opencrvs.org/v1.7/product-specifications/core-functions/8.-correct-record.md) - [10. Verify record](https://documentation.opencrvs.org/v1.7/product-specifications/core-functions/9.-verify-record.md) - [11. Archive record](https://documentation.opencrvs.org/v1.7/product-specifications/core-functions/10.-archive-record.md) - [12. Vital statistics export](https://documentation.opencrvs.org/v1.7/product-specifications/core-functions/11.-vital-statistics-export.md) - [Support functions](https://documentation.opencrvs.org/v1.7/product-specifications/support-functions.md): Overview of functionality that enables users to conduct civil registration services safely, securely, and most effectively. - [13. Login](https://documentation.opencrvs.org/v1.7/product-specifications/support-functions/10.-login.md) - [14. Audit](https://documentation.opencrvs.org/v1.7/product-specifications/support-functions/11.-audit.md) - [15. Deduplication](https://documentation.opencrvs.org/v1.7/product-specifications/support-functions/12.-deduplication.md) - [16. Performance management](https://documentation.opencrvs.org/v1.7/product-specifications/support-functions/13.-performance-management.md) - [17. Payment](https://documentation.opencrvs.org/v1.7/product-specifications/support-functions/14.-payment.md) - [18. Learning](https://documentation.opencrvs.org/v1.7/product-specifications/support-functions/15.-learning.md) - [19. User support](https://documentation.opencrvs.org/v1.7/product-specifications/support-functions/16.-user-support.md) - [20. User onboarding](https://documentation.opencrvs.org/v1.7/product-specifications/support-functions/20.-user-onboarding.md) - [Admin functions](https://documentation.opencrvs.org/v1.7/product-specifications/admin-functions.md): Overview of functionality for a system administrator to effectively manage and maintain the OpenCRVS product. - [21. User management](https://documentation.opencrvs.org/v1.7/product-specifications/admin-functions/17.-user-management.md) - [22. Comms management](https://documentation.opencrvs.org/v1.7/product-specifications/admin-functions/18.-comms-management.md) - [23. Content management](https://documentation.opencrvs.org/v1.7/product-specifications/admin-functions/19.-content-management.md) - [24. Config management](https://documentation.opencrvs.org/v1.7/product-specifications/admin-functions/20.-config-management.md) - [Data functions](https://documentation.opencrvs.org/v1.7/product-specifications/data-functions.md): Overview of functionality that transforms legacy data. - [25. Legacy data import](https://documentation.opencrvs.org/v1.7/product-specifications/data-functions/21.-legacy-data-import.md) - [26. Legacy paper import](https://documentation.opencrvs.org/v1.7/product-specifications/data-functions/22.-legacy-paper-import.md) - [Architecture](https://documentation.opencrvs.org/v1.7/technology/architecture.md) - [Performance tests](https://documentation.opencrvs.org/v1.7/technology/architecture/performance-tests.md): Overview of results from performance tests conducted on OpenCRVS - [Standards](https://documentation.opencrvs.org/v1.7/technology/standards.md): Overview of how OpenCRVS uses best-practice technology standards - [FHIR Documents](https://documentation.opencrvs.org/v1.7/technology/standards/fhir-documents.md) - [Event Composition](https://documentation.opencrvs.org/v1.7/technology/standards/fhir-documents/event-composition.md) - [Person](https://documentation.opencrvs.org/v1.7/technology/standards/fhir-documents/person.md) - [Registration Task](https://documentation.opencrvs.org/v1.7/technology/standards/fhir-documents/registration-task.md) - [Event Observations](https://documentation.opencrvs.org/v1.7/technology/standards/fhir-documents/event-observations.md) - [Locations](https://documentation.opencrvs.org/v1.7/technology/standards/fhir-documents/locations.md) - [Security](https://documentation.opencrvs.org/v1.7/technology/security.md) - [Interoperability](https://documentation.opencrvs.org/v1.7/technology/interoperability.md): An introduction describing how OpenCRVS interoperates - [Create a client](https://documentation.opencrvs.org/v1.7/technology/interoperability/create-a-client.md): How to create and manage access to OpenCRVS' interoperability functionality - [Authenticate a client](https://documentation.opencrvs.org/v1.7/technology/interoperability/authenticate-a-client.md): Authenticating with your client details to retrieve an access token using OAuth 2.0 - [Event Notification clients](https://documentation.opencrvs.org/v1.7/technology/interoperability/event-notification-clients.md): Submitting full or partial event applications into OpenCRVS from an external service such as a health institution or public portal. - [Record Search clients](https://documentation.opencrvs.org/v1.7/technology/interoperability/record-search-clients.md): Perform an advanced search of civil registration records from a trusted, external e-Gov service - [Webhook clients](https://documentation.opencrvs.org/v1.7/technology/interoperability/webhook-clients.md): Business functionality and API endpoints available to a "Webhook" client. - [National ID client](https://documentation.opencrvs.org/v1.7/technology/interoperability/national-id-client.md) - [FHIR Location REST API](https://documentation.opencrvs.org/v1.7/technology/interoperability/fhir-location-rest-api.md): Create, read, update or archive administrative areas, civil registration offices or health facilities using FHIR. - [Other ways to interoperate](https://documentation.opencrvs.org/v1.7/technology/interoperability/other-ways-to-interoperate.md): Direct interoperability with OpenHIM - [Intro to Farajaland](https://documentation.opencrvs.org/v1.7/default-configuration/intro-to-farajaland.md): Provides details of the OpenCRVS default configuration - [Civil registration in Farajaland](https://documentation.opencrvs.org/v1.7/default-configuration/civil-registration-in-farajaland.md): Provides details of how civil registration is organised and administered in Farajaland - [OpenCRVS configuration in Farajaland](https://documentation.opencrvs.org/v1.7/default-configuration/opencrvs-configuration-in-farajaland.md): Provides details on how OpenCRVS has been configured to meet the Farajaland context - [Application settings](https://documentation.opencrvs.org/v1.7/default-configuration/opencrvs-configuration-in-farajaland/application-settings.md) - [User roles](https://documentation.opencrvs.org/v1.7/default-configuration/opencrvs-configuration-in-farajaland/user-role-mapping.md) - [Declaration forms](https://documentation.opencrvs.org/v1.7/default-configuration/opencrvs-configuration-in-farajaland/declaration-forms.md) - [Certified Copies templates](https://documentation.opencrvs.org/v1.7/default-configuration/opencrvs-configuration-in-farajaland/certificate-templates.md) - [Business process flows in Farajaland](https://documentation.opencrvs.org/v1.7/default-configuration/business-process-flows-in-farajaland.md): Provides an overview of the Farajaland business processes digitally enabled by OpenCRVS - [1. Planning an OpenCRVS Implementation](https://documentation.opencrvs.org/v1.7/setup/1.-planning-an-opencrvs-implementation.md) - [2. Establish project and team](https://documentation.opencrvs.org/v1.7/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.7/setup/2.-gather-requirements.md): Prepare all the inputs required for product configuration. - [3.1 Mapping business processes](https://documentation.opencrvs.org/v1.7/setup/2.-gather-requirements/3.1-mapping-business-processes.md) - [3.2 Mapping offices and user types](https://documentation.opencrvs.org/v1.7/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.7/setup/2.-gather-requirements/3.3-define-your-application-settings.md) - [3.4 Designing event declaration forms](https://documentation.opencrvs.org/v1.7/setup/2.-gather-requirements/3.4-designing-event-declaration-forms.md) - [3.5 Designing a certified copy](https://documentation.opencrvs.org/v1.7/setup/2.-gather-requirements/3.5-designing-a-certificate-template.md) - [4. Installation](https://documentation.opencrvs.org/v1.7/setup/3.-installation.md): Installation steps for OpenCRVS - [4.1 Quick start: Set-up a local development environment](https://documentation.opencrvs.org/v1.7/setup/3.-installation/3.1-set-up-a-development-environment.md) - [4.1.1 Install the required dependencies](https://documentation.opencrvs.org/v1.7/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.7/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.7/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.7/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.7/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.7/setup/3.-installation/3.1-set-up-a-development-environment/3.1.5-tooling/4.1.5.1-wsl-support.md) - [4.2 Configure: Set-up your own, local, country configuration](https://documentation.opencrvs.org/v1.7/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.7/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.7/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.7/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.7/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.7/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.7/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.7/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 employee users, and scopes, for testing or production](https://documentation.opencrvs.org/v1.7/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.7/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 roles and scopes](https://documentation.opencrvs.org/v1.7/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.7/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.7/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.7/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.7/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.7/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.7/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.7/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.7/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.7/setup/3.-installation/3.2-set-up-your-own-country-configuration/3.2.9-countryconfig-apis-explained.md) - [4.3 Deploy: Set-up a server-hosted environment](https://documentation.opencrvs.org/v1.7/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.7/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 TLS / SSL & DNS](https://documentation.opencrvs.org/v1.7/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.5-setup-dns-a-records.md) - [4.3.2.1 LetsEncrypt https challenge in development environments](https://documentation.opencrvs.org/v1.7/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.5-setup-dns-a-records/4.3.2.1-letsencrypt-https-challenge-in-development-environments.md) - [4.3.2.2 LetsEncrypt DNS challenge in production](https://documentation.opencrvs.org/v1.7/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.5-setup-dns-a-records/4.3.2.2-letsencrypt-dns-challenge-in-production.md) - [4.3.2.3 Static TLS certificates](https://documentation.opencrvs.org/v1.7/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.5-setup-dns-a-records/4.3.2.3-static-tls-certificates.md) - [4.3.3 Configure inventory files](https://documentation.opencrvs.org/v1.7/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.2-install-dependencies.md) - [4.3.4 Create a Github environment](https://documentation.opencrvs.org/v1.7/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.4-create-a-github-environment.md) - [4.3.4.1 Environment secrets and variables explained](https://documentation.opencrvs.org/v1.7/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.4-create-a-github-environment/4.3.4.1-environment-secrets-and-variables-explained.md) - [4.3.4.2 VPN Recipes](https://documentation.opencrvs.org/v1.7/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.4-create-a-github-environment/4.3.4.2-vpn-recipes.md) - [4.3.5 Provisioning servers](https://documentation.opencrvs.org/v1.7/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.5-provisioning-servers.md) - [4.3.5.1 SSH access](https://documentation.opencrvs.org/v1.7/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.5-provisioning-servers/4.3.5.1-ssh-access.md) - [4.3.5.2 Building, pushing & releasing your countryconfig code](https://documentation.opencrvs.org/v1.7/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.5-provisioning-servers/4.3.5.2-building-pushing-and-releasing-your-countryconfig-code.md) - [4.3.5.3 Ansible tasks when provisioning](https://documentation.opencrvs.org/v1.7/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.5-provisioning-servers/4.3.5.3-ansible-tasks-when-provisioning.md) - [4.3.6 Deploy](https://documentation.opencrvs.org/v1.7/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.6-deploy-automated-and-manual.md) - [4.3.6.1 Running a deployment](https://documentation.opencrvs.org/v1.7/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.6-deploy-automated-and-manual/4.3.6.1-running-a-deployment.md) - [4.3.6.2 Seeding a server environment](https://documentation.opencrvs.org/v1.7/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.6-deploy-automated-and-manual/4.3.6.2-seeding-a-server-environment.md) - [4.3.6.3 Login to an OpenCRVS server](https://documentation.opencrvs.org/v1.7/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.6-deploy-automated-and-manual/4.3.6.3-login-to-an-opencrvs-server.md) - [4.3.6.5 Resetting a server environment](https://documentation.opencrvs.org/v1.7/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.6-deploy-automated-and-manual/4.3.6.5-resetting-a-server-environment.md) - [4.3.7 Backup & Restore](https://documentation.opencrvs.org/v1.7/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.7-backup-and-restore.md) - [4.3.7.1 Restoring a backup](https://documentation.opencrvs.org/v1.7/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.7-backup-and-restore/4.3.7.1-restoring-a-backup.md) - [4.3.7.2 Off-boarding from OpenCRVS](https://documentation.opencrvs.org/v1.7/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.7-backup-and-restore/4.3.7.2-off-boarding-from-opencrvs.md) - [5. Quality assurance testing](https://documentation.opencrvs.org/v1.7/setup/5.-testing.md): How to ensure your OpenCRVS configuration is fully tested and ready for live use? - [6. Go-live](https://documentation.opencrvs.org/v1.7/setup/6.-go-live.md) - [6.1 Pre-Deployment Checklist](https://documentation.opencrvs.org/v1.7/setup/6.-go-live/3.3.4-set-up-an-smtp-server-for-opencrvs-monitoring-alerts.md) - [7. Operational Support](https://documentation.opencrvs.org/v1.7/setup/8.-operational-support.md) - [8. Monitoring](https://documentation.opencrvs.org/v1.7/setup/7.-monitoring.md) - [8.1 Application logs](https://documentation.opencrvs.org/v1.7/setup/7.-monitoring/7.1-application-logs.md) - [8.2 Infrastructure health](https://documentation.opencrvs.org/v1.7/setup/7.-monitoring/7.2-infrastructure-health.md) - [8.3 Routine monitoring checklist](https://documentation.opencrvs.org/v1.7/setup/7.-monitoring/7.3-routine-monitoring-checklist.md) - [8.4 Setting up alerts](https://documentation.opencrvs.org/v1.7/setup/7.-monitoring/7.4-setting-up-alerts.md) - [8.5 Managing a Docker Swarm](https://documentation.opencrvs.org/v1.7/setup/7.-monitoring/7.5-managing-a-docker-swarm.md) - [Community](https://documentation.opencrvs.org/v1.7/general/community.md) - [Contributing](https://documentation.opencrvs.org/v1.7/general/contributing.md): How to contribute to the Digital Public Good for CRVS - [Migration notes](https://documentation.opencrvs.org/v1.7/general/migration-notes.md) - [Releases and upgrades](https://documentation.opencrvs.org/v1.7/general/releases.md) - [Release notes](https://documentation.opencrvs.org/v1.7/general/v1.7-release-notes.md) - [v1.7.4: Release notes](https://documentation.opencrvs.org/v1.7/general/v1.7-release-notes/v1.7.4-release-notes.md): OpenCRVS 1.7.4 is a hotfix release that introduces minor improvements and bug fixes based on the identified needs of countries using OpenCRVS. - [v1.7.3: Release notes](https://documentation.opencrvs.org/v1.7/general/v1.7-release-notes/v1.7.3-release-notes.md): OpenCRVS 1.7.3 is a hotfix release that introduces minor improvements and bug fixes based on the identified needs of countries using OpenCRVS. - [v1.7.2: Release notes](https://documentation.opencrvs.org/v1.7/general/v1.7-release-notes/v1.7.2-release-notes.md): OpenCRVS 1.7.2 is a hotfix release that introduces minor improvements and bug fixes based on the identified needs of countries using OpenCRVS. - [v1.7.1: Release notes](https://documentation.opencrvs.org/v1.7/general/v1.7-release-notes/v1.7.1-release-notes.md): OpenCRVS 1.7.1 is a hotfix release that introduces minor improvements and bug fixes based on the identified needs of countries using OpenCRVS. - [v1.7.0: Release notes](https://documentation.opencrvs.org/v1.7/general/v1.7-release-notes/v1.7.0-release-notes.md): In OpenCRVS v1.7.0, alongside numerous technical improvements and bug fixes, we have enhanced form configuration flexibility. Signatures inputs are now part of the form configuration. - [Product roadmap](https://documentation.opencrvs.org/v1.7/general/product-roadmap.md) - [Contributing](https://documentation.opencrvs.org/v1.7/developer/contributing.md) - [Submitting a hotfix](https://documentation.opencrvs.org/v1.7/developer/contributing/submitting-a-hotfix.md) ## v1.6 - [Welcome!](https://documentation.opencrvs.org/v1.6/readme.md) - [Understanding CRVS](https://documentation.opencrvs.org/v1.6/crvs-systems/understanding-crvs.md): Provides useful links to documentation about CRVS - [Effective digital CRVS systems](https://documentation.opencrvs.org/v1.6/crvs-systems/effective-digital-crvs-systems.md): Setting realistic business expectations of CRVS digitisation - [OpenCRVS within a government systems architecture](https://documentation.opencrvs.org/v1.6/crvs-systems/opencrvs-within-a-government-systems-architecture.md): How to think about the use of OpenCRVS as an interoperable system within a government's digital landscape - [OpenCRVS Value Proposition](https://documentation.opencrvs.org/v1.6/crvs-systems/opencrvs-value-proposition.md) - [Functional Architecture](https://documentation.opencrvs.org/v1.6/product-specifications/functional-architecture.md) - [Workflow management](https://documentation.opencrvs.org/v1.6/product-specifications/workflow-management.md) - [Status Flow Diagram](https://documentation.opencrvs.org/v1.6/product-specifications/status-flow-diagram.md) - [Users](https://documentation.opencrvs.org/v1.6/product-specifications/users.md) - [Examples](https://documentation.opencrvs.org/v1.6/product-specifications/users/examples.md) - [Core functions](https://documentation.opencrvs.org/v1.6/product-specifications/core-functions.md): Overview of core functions - [1. Notify event](https://documentation.opencrvs.org/v1.6/product-specifications/core-functions/1.-notify-event.md) - [2. Declare event](https://documentation.opencrvs.org/v1.6/product-specifications/core-functions/2.-declare-event.md) - [3. Validate event](https://documentation.opencrvs.org/v1.6/product-specifications/core-functions/3.-validate-event.md) - [4. Register event](https://documentation.opencrvs.org/v1.6/product-specifications/core-functions/4.-register-event.md) - [5. Print certificate](https://documentation.opencrvs.org/v1.6/product-specifications/core-functions/5.-print-certificate.md) - [6. Issue certificate](https://documentation.opencrvs.org/v1.6/product-specifications/core-functions/5.-issue-certificate.md) - [7. Search for a record](https://documentation.opencrvs.org/v1.6/product-specifications/core-functions/6.-search-for-a-record.md) - [8. View record](https://documentation.opencrvs.org/v1.6/product-specifications/core-functions/7.-view-record.md) - [9. Correct record](https://documentation.opencrvs.org/v1.6/product-specifications/core-functions/8.-correct-record.md) - [10. Verify record](https://documentation.opencrvs.org/v1.6/product-specifications/core-functions/9.-verify-record.md) - [11. Archive record](https://documentation.opencrvs.org/v1.6/product-specifications/core-functions/10.-archive-record.md) - [12. Vital statistics export](https://documentation.opencrvs.org/v1.6/product-specifications/core-functions/11.-vital-statistics-export.md) - [Support functions](https://documentation.opencrvs.org/v1.6/product-specifications/support-functions.md): Overview of functionality that enables users to conduct civil registration services safely, securely, and most effectively. - [13. Login](https://documentation.opencrvs.org/v1.6/product-specifications/support-functions/10.-login.md) - [14. Audit](https://documentation.opencrvs.org/v1.6/product-specifications/support-functions/11.-audit.md) - [15. Deduplication](https://documentation.opencrvs.org/v1.6/product-specifications/support-functions/12.-deduplication.md) - [16. Performance management](https://documentation.opencrvs.org/v1.6/product-specifications/support-functions/13.-performance-management.md) - [17. Payment](https://documentation.opencrvs.org/v1.6/product-specifications/support-functions/14.-payment.md) - [18. Learning](https://documentation.opencrvs.org/v1.6/product-specifications/support-functions/15.-learning.md) - [19. User support](https://documentation.opencrvs.org/v1.6/product-specifications/support-functions/16.-user-support.md) - [20. User onboarding](https://documentation.opencrvs.org/v1.6/product-specifications/support-functions/20.-user-onboarding.md) - [Admin functions](https://documentation.opencrvs.org/v1.6/product-specifications/admin-functions.md): Overview of functionality for a system administrator to effectively manage and maintain the OpenCRVS product. - [21. User management](https://documentation.opencrvs.org/v1.6/product-specifications/admin-functions/17.-user-management.md) - [22. Comms management](https://documentation.opencrvs.org/v1.6/product-specifications/admin-functions/18.-comms-management.md) - [23. Content management](https://documentation.opencrvs.org/v1.6/product-specifications/admin-functions/19.-content-management.md) - [24. Config management](https://documentation.opencrvs.org/v1.6/product-specifications/admin-functions/20.-config-management.md) - [Data functions](https://documentation.opencrvs.org/v1.6/product-specifications/data-functions.md): Overview of functionality that transforms legacy data. - [25. Legacy data import](https://documentation.opencrvs.org/v1.6/product-specifications/data-functions/21.-legacy-data-import.md) - [26. Legacy paper import](https://documentation.opencrvs.org/v1.6/product-specifications/data-functions/22.-legacy-paper-import.md) - [Architecture](https://documentation.opencrvs.org/v1.6/technology/architecture.md) - [Performance tests](https://documentation.opencrvs.org/v1.6/technology/architecture/performance-tests.md): Overview of results from performance tests conducted on OpenCRVS - [Standards](https://documentation.opencrvs.org/v1.6/technology/standards.md): Overview of how OpenCRVS uses best-practice technology standards - [FHIR Documents](https://documentation.opencrvs.org/v1.6/technology/standards/fhir-documents.md) - [Event Composition](https://documentation.opencrvs.org/v1.6/technology/standards/fhir-documents/event-composition.md) - [Person](https://documentation.opencrvs.org/v1.6/technology/standards/fhir-documents/person.md) - [Registration Task](https://documentation.opencrvs.org/v1.6/technology/standards/fhir-documents/registration-task.md) - [Event Observations](https://documentation.opencrvs.org/v1.6/technology/standards/fhir-documents/event-observations.md) - [Locations](https://documentation.opencrvs.org/v1.6/technology/standards/fhir-documents/locations.md) - [Security](https://documentation.opencrvs.org/v1.6/technology/security.md) - [Interoperability](https://documentation.opencrvs.org/v1.6/technology/interoperability.md): An introduction describing how OpenCRVS interoperates - [Create a client](https://documentation.opencrvs.org/v1.6/technology/interoperability/create-a-client.md): How to create and manage access to OpenCRVS' interoperability functionality - [Authenticate a client](https://documentation.opencrvs.org/v1.6/technology/interoperability/authenticate-a-client.md): Authenticating with your client details to retrieve an access token using OAuth 2.0 - [Event Notification clients](https://documentation.opencrvs.org/v1.6/technology/interoperability/event-notification-clients.md): Submitting full or partial event applications into OpenCRVS from an external service such as a health institution or public portal. - [Record Search clients](https://documentation.opencrvs.org/v1.6/technology/interoperability/record-search-clients.md): Perform an advanced search of civil registration records from a trusted, external e-Gov service - [Webhook clients](https://documentation.opencrvs.org/v1.6/technology/interoperability/webhook-clients.md): Business functionality and API endpoints available to a "Webhook" client. - [National ID client](https://documentation.opencrvs.org/v1.6/technology/interoperability/national-id-client.md): Business functionality associated with a National ID client and instructions to setup a MOSIP enabled National ID integration. - [FHIR Location REST API](https://documentation.opencrvs.org/v1.6/technology/interoperability/fhir-location-rest-api.md): Create, read, update or archive administrative areas, civil registration offices or health facilities using FHIR. - [Other ways to interoperate](https://documentation.opencrvs.org/v1.6/technology/interoperability/other-ways-to-interoperate.md): Direct interoperability with OpenHIM - [Intro to Farajaland](https://documentation.opencrvs.org/v1.6/default-configuration/intro-to-farajaland.md): Provides details of the OpenCRVS default configuration - [Civil registration in Farajaland](https://documentation.opencrvs.org/v1.6/default-configuration/civil-registration-in-farajaland.md): Provides details of how civil registration is organised and administered in Farajaland - [OpenCRVS configuration in Farajaland](https://documentation.opencrvs.org/v1.6/default-configuration/opencrvs-configuration-in-farajaland.md): Provides details on how OpenCRVS has been configured to meet the Farajaland context - [Application settings](https://documentation.opencrvs.org/v1.6/default-configuration/opencrvs-configuration-in-farajaland/application-settings.md) - [User / role mapping](https://documentation.opencrvs.org/v1.6/default-configuration/opencrvs-configuration-in-farajaland/user-role-mapping.md) - [Declaration forms](https://documentation.opencrvs.org/v1.6/default-configuration/opencrvs-configuration-in-farajaland/declaration-forms.md) - [Certificate templates](https://documentation.opencrvs.org/v1.6/default-configuration/opencrvs-configuration-in-farajaland/certificate-templates.md) - [Business process flows in Farajaland](https://documentation.opencrvs.org/v1.6/default-configuration/business-process-flows-in-farajaland.md): Provides an overview of the Farajaland business processes digitally enabled by OpenCRVS - [1. Planning an OpenCRVS Implementation](https://documentation.opencrvs.org/v1.6/setup/1.-planning-an-opencrvs-implementation.md) - [2. Establish project and team](https://documentation.opencrvs.org/v1.6/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.6/setup/2.-gather-requirements.md): Prepare all the inputs required for product configuration. - [3.1 Mapping business processes](https://documentation.opencrvs.org/v1.6/setup/2.-gather-requirements/3.1-mapping-business-processes.md) - [3.2 Mapping offices and user types](https://documentation.opencrvs.org/v1.6/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.6/setup/2.-gather-requirements/3.3-define-your-application-settings.md) - [3.4 Designing event declaration forms](https://documentation.opencrvs.org/v1.6/setup/2.-gather-requirements/3.4-designing-event-declaration-forms.md) - [3.5 Designing a certificate template](https://documentation.opencrvs.org/v1.6/setup/2.-gather-requirements/3.5-designing-a-certificate-template.md) - [4. Installation](https://documentation.opencrvs.org/v1.6/setup/3.-installation.md): Installation steps for OpenCRVS - [4.1 Set-up a local development environment](https://documentation.opencrvs.org/v1.6/setup/3.-installation/3.1-set-up-a-development-environment.md) - [4.1.1 Install the required dependencies](https://documentation.opencrvs.org/v1.6/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.6/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.6/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.6/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.6/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.6/setup/3.-installation/3.1-set-up-a-development-environment/3.1.5-tooling/4.1.5.1-wsl-support.md) - [4.2 Set-up your own, local, country configuration](https://documentation.opencrvs.org/v1.6/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.6/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.6/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.6/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.6/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.6/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.6/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.6/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.6/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.6/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.6/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.6/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.6/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.6/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.6/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.6/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.6/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.6/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.6/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.6/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.6/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.6/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 TLS / SSL & DNS](https://documentation.opencrvs.org/v1.6/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.5-setup-dns-a-records.md) - [4.3.2.1 LetsEncrypt https challenge in development environments](https://documentation.opencrvs.org/v1.6/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.5-setup-dns-a-records/4.3.2.1-letsencrypt-https-challenge-in-development-environments.md) - [4.3.2.2 LetsEncrypt DNS challenge in production](https://documentation.opencrvs.org/v1.6/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.5-setup-dns-a-records/4.3.2.2-letsencrypt-dns-challenge-in-production.md) - [4.3.2.3 Static TLS certificates](https://documentation.opencrvs.org/v1.6/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.5-setup-dns-a-records/4.3.2.3-static-tls-certificates.md) - [4.3.3 Configure inventory files](https://documentation.opencrvs.org/v1.6/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.2-install-dependencies.md) - [4.3.4 Create a Github environment](https://documentation.opencrvs.org/v1.6/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.4-create-a-github-environment.md) - [4.3.4.1 Environment secrets and variables explained](https://documentation.opencrvs.org/v1.6/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.4-create-a-github-environment/4.3.4.1-environment-secrets-and-variables-explained.md) - [4.3.4.2 VPN Recipes](https://documentation.opencrvs.org/v1.6/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.4-create-a-github-environment/4.3.4.2-vpn-recipes.md) - [4.3.5 Provisioning servers](https://documentation.opencrvs.org/v1.6/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.5-provisioning-servers.md) - [4.3.5.1 SSH access](https://documentation.opencrvs.org/v1.6/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.5-provisioning-servers/4.3.5.1-ssh-access.md) - [4.3.5.2 Building, pushing & releasing your countryconfig code](https://documentation.opencrvs.org/v1.6/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.5-provisioning-servers/4.3.5.2-building-pushing-and-releasing-your-countryconfig-code.md) - [4.3.5.3 Ansible tasks when provisioning](https://documentation.opencrvs.org/v1.6/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.5-provisioning-servers/4.3.5.3-ansible-tasks-when-provisioning.md) - [4.3.6 Deploy](https://documentation.opencrvs.org/v1.6/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.6-deploy-automated-and-manual.md) - [4.3.6.1 Running a deployment](https://documentation.opencrvs.org/v1.6/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.6-deploy-automated-and-manual/4.3.6.1-running-a-deployment.md) - [4.3.6.2 Seeding a server environment](https://documentation.opencrvs.org/v1.6/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.6-deploy-automated-and-manual/4.3.6.2-seeding-a-server-environment.md) - [4.3.6.3 Login to an OpenCRVS server](https://documentation.opencrvs.org/v1.6/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.6-deploy-automated-and-manual/4.3.6.3-login-to-an-opencrvs-server.md) - [4.3.6.5 Resetting a server environment](https://documentation.opencrvs.org/v1.6/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.6-deploy-automated-and-manual/4.3.6.5-resetting-a-server-environment.md) - [4.3.7 Backup & Restore](https://documentation.opencrvs.org/v1.6/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.7-backup-and-restore.md) - [4.3.7.1 Restoring a backup](https://documentation.opencrvs.org/v1.6/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.7-backup-and-restore/4.3.7.1-restoring-a-backup.md) - [4.3.7.2 Off-boarding from OpenCRVS](https://documentation.opencrvs.org/v1.6/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.7-backup-and-restore/4.3.7.2-off-boarding-from-opencrvs.md) - [5. Functional configuration](https://documentation.opencrvs.org/v1.6/setup/4.-functional-configuration.md) - [5.1 Configure application settings](https://documentation.opencrvs.org/v1.6/setup/4.-functional-configuration/4.1-configure-application-settings.md) - [5.2 Configure registration periods and fees](https://documentation.opencrvs.org/v1.6/setup/4.-functional-configuration/4.2-configure-registration-periods-and-fees.md) - [5.3 Managing system users](https://documentation.opencrvs.org/v1.6/setup/4.-functional-configuration/4.5-create-system-users.md) - [6. Quality assurance testing](https://documentation.opencrvs.org/v1.6/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.6/setup/6.-go-live.md) - [7.1 Pre-Deployment Checklist](https://documentation.opencrvs.org/v1.6/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.6/setup/8.-operational-support.md) - [9. Monitoring](https://documentation.opencrvs.org/v1.6/setup/7.-monitoring.md) - [9.1 Application logs](https://documentation.opencrvs.org/v1.6/setup/7.-monitoring/7.1-application-logs.md) - [9.2 Infrastructure health](https://documentation.opencrvs.org/v1.6/setup/7.-monitoring/7.2-infrastructure-health.md) - [9.3 Routine monitoring checklist](https://documentation.opencrvs.org/v1.6/setup/7.-monitoring/7.3-routine-monitoring-checklist.md) - [9.4 Setting up alerts](https://documentation.opencrvs.org/v1.6/setup/7.-monitoring/7.4-setting-up-alerts.md) - [9.5 Managing a Docker Swarm](https://documentation.opencrvs.org/v1.6/setup/7.-monitoring/7.5-managing-a-docker-swarm.md) - [Community](https://documentation.opencrvs.org/v1.6/general/community.md) - [Contributing](https://documentation.opencrvs.org/v1.6/general/contributing.md): How to contribute to the Digital Public Good for CRVS - [Releases](https://documentation.opencrvs.org/v1.6/general/releases.md) - [Migration notes](https://documentation.opencrvs.org/v1.6/general/releases/migration-notes.md) - [v1.6.4: Release notes](https://documentation.opencrvs.org/v1.6/general/releases/v1.6.4-release-notes.md): OpenCRVS 1.6.4 is a hotfix release that introduces minor improvements and bug fixes based on the identified needs of countries using OpenCRVS. - [v1.6.3: Release notes](https://documentation.opencrvs.org/v1.6/general/releases/v1.6.3-release-notes.md): OpenCRVS 1.6.3 is a hotfix release that introduces minor improvements and bug fixes based on the identified needs of countries using OpenCRVS. - [v1.6.2: Release notes](https://documentation.opencrvs.org/v1.6/general/releases/v1.6.2-release-notes.md): OpenCRVS 1.6.2 is a hotfix release that introduces minor improvements and bug fixes based on the identified needs of countries using OpenCRVS. - [v1.6.1: Release notes](https://documentation.opencrvs.org/v1.6/general/releases/v1.6.1-release-notes.md): OpenCRVS 1.6.1 is a hotfix release that introduces minor improvements and bug fixes based on the identified needs of countries using OpenCRVS. - [v1.6.0: Release notes](https://documentation.opencrvs.org/v1.6/general/releases/v1.6.0-release-notes.md): In OpenCRVS v1.6.0, alongside numerous technical improvements and bug fixes, we have enhanced form configuration flexibility. Signatures inputs are now part of the form configuration, giving you great - [v1.5.1: Release notes](https://documentation.opencrvs.org/v1.6/general/releases/v1.5.1-release-notes.md): OpenCRVS v1.5.1 is a patch release which includes a hotfix to the previous OpenCRVS v1.5.0 release. It is to be used in conjunction with a forked country configuration release v1.5.1 - [v1.5.0: Release notes](https://documentation.opencrvs.org/v1.6/general/releases/v1.5.0-release-notes.md): In OpenCRVS v1.5.0 we have refactored the "workflow" microservice and deprecated the backend dependency on OpenHIM. This has vastly improved the performance of the platform. - [v1.4.1: Release notes](https://documentation.opencrvs.org/v1.6/general/releases/v1.4.1-release-notes.md) - [v1.4.0 Release notes](https://documentation.opencrvs.org/v1.6/general/releases/v1.4.0-release-notes.md): In OpenCRVS v1.4.0 we have entirely refactored infrastructure provisioning in opencrvs-countryconfig. There are no changes to opencrvs-core. - [v1.3.5: Release notes](https://documentation.opencrvs.org/v1.6/general/releases/v1.3.5-release-notes.md) - [v1.3.4: Release notes](https://documentation.opencrvs.org/v1.6/general/releases/v1.3.4-release-notes.md) - [v1.3.3: Release notes](https://documentation.opencrvs.org/v1.6/general/releases/v1.3.3-release-notes.md) - [v1.3.1: Release notes](https://documentation.opencrvs.org/v1.6/general/releases/v1.3.1-release-notes.md) - [v1.3.0: Release notes](https://documentation.opencrvs.org/v1.6/general/releases/v1.3.0-beta-release-notes.md) - [v1.2.1: Release notes](https://documentation.opencrvs.org/v1.6/general/releases/v1.2.1-release-notes.md) - [Patch: Elasticsearch 7.10.2](https://documentation.opencrvs.org/v1.6/general/releases/patch-elasticsearch-7.10.2.md): An Elasticseach downgrade, patch to demonstrate OpenCRVS' base configuration supports OSI standard licenses. - [v1.2.0: Release notes](https://documentation.opencrvs.org/v1.6/general/releases/v1.2.0-release-notes.md): OpenCRVS v1.2.0 is a stable release of OpenCRVS. - [v.1.1.2: Release notes](https://documentation.opencrvs.org/v1.6/general/releases/v.1.1.2-release-notes.md) - [v.1.1.1: Release notes](https://documentation.opencrvs.org/v1.6/general/releases/v.1.1.1-release-notes.md) - [v1.1.0: Release notes](https://documentation.opencrvs.org/v1.6/general/releases/v1.1.0-release-notes.md) - [Roadmap](https://documentation.opencrvs.org/v1.6/general/product-roadmap.md) ## v1.5 - [Welcome!](https://documentation.opencrvs.org/v1.5/readme.md) - [Understanding CRVS](https://documentation.opencrvs.org/v1.5/crvs-systems/understanding-crvs.md): Provides useful links to documentation about CRVS - [Effective digital CRVS systems](https://documentation.opencrvs.org/v1.5/crvs-systems/effective-digital-crvs-systems.md): Setting realistic business expectations of CRVS digitisation - [OpenCRVS within a government systems architecture](https://documentation.opencrvs.org/v1.5/crvs-systems/opencrvs-within-a-government-systems-architecture.md): How to think about the use of OpenCRVS as an interoperable system within a government's digital landscape - [OpenCRVS Value Proposition](https://documentation.opencrvs.org/v1.5/crvs-systems/opencrvs-value-proposition.md) - [Functional Architecture](https://documentation.opencrvs.org/v1.5/product-specifications/functional-architecture.md) - [Workflow management](https://documentation.opencrvs.org/v1.5/product-specifications/workflow-management.md) - [Status Flow Diagram](https://documentation.opencrvs.org/v1.5/product-specifications/status-flow-diagram.md) - [Users](https://documentation.opencrvs.org/v1.5/product-specifications/users.md) - [Examples](https://documentation.opencrvs.org/v1.5/product-specifications/users/examples.md) - [Core functions](https://documentation.opencrvs.org/v1.5/product-specifications/core-functions.md): Overview of core functions - [1. Notify event](https://documentation.opencrvs.org/v1.5/product-specifications/core-functions/1.-notify-event.md) - [2. Declare event](https://documentation.opencrvs.org/v1.5/product-specifications/core-functions/2.-declare-event.md) - [3. Validate event](https://documentation.opencrvs.org/v1.5/product-specifications/core-functions/3.-validate-event.md) - [4. Register event](https://documentation.opencrvs.org/v1.5/product-specifications/core-functions/4.-register-event.md) - [5. Print certificate](https://documentation.opencrvs.org/v1.5/product-specifications/core-functions/5.-print-certificate.md) - [6. Issue certificate](https://documentation.opencrvs.org/v1.5/product-specifications/core-functions/5.-issue-certificate.md) - [7. Search for a record](https://documentation.opencrvs.org/v1.5/product-specifications/core-functions/6.-search-for-a-record.md) - [8. View record](https://documentation.opencrvs.org/v1.5/product-specifications/core-functions/7.-view-record.md) - [9. Correct record](https://documentation.opencrvs.org/v1.5/product-specifications/core-functions/8.-correct-record.md) - [10. Verify record](https://documentation.opencrvs.org/v1.5/product-specifications/core-functions/9.-verify-record.md) - [11. Archive record](https://documentation.opencrvs.org/v1.5/product-specifications/core-functions/10.-archive-record.md) - [12. Vital statistics export](https://documentation.opencrvs.org/v1.5/product-specifications/core-functions/11.-vital-statistics-export.md) - [Support functions](https://documentation.opencrvs.org/v1.5/product-specifications/support-functions.md): Overview of functionality that enables users to conduct civil registration services safely, securely, and most effectively. - [13. Login](https://documentation.opencrvs.org/v1.5/product-specifications/support-functions/10.-login.md) - [14. Audit](https://documentation.opencrvs.org/v1.5/product-specifications/support-functions/11.-audit.md) - [15. Deduplication](https://documentation.opencrvs.org/v1.5/product-specifications/support-functions/12.-deduplication.md) - [16. Performance management](https://documentation.opencrvs.org/v1.5/product-specifications/support-functions/13.-performance-management.md) - [17. Payment](https://documentation.opencrvs.org/v1.5/product-specifications/support-functions/14.-payment.md) - [18. Learning](https://documentation.opencrvs.org/v1.5/product-specifications/support-functions/15.-learning.md) - [19. User support](https://documentation.opencrvs.org/v1.5/product-specifications/support-functions/16.-user-support.md) - [20. User onboarding](https://documentation.opencrvs.org/v1.5/product-specifications/support-functions/20.-user-onboarding.md) - [Admin functions](https://documentation.opencrvs.org/v1.5/product-specifications/admin-functions.md): Overview of functionality for a system administrator to effectively manage and maintain the OpenCRVS product. - [21. User management](https://documentation.opencrvs.org/v1.5/product-specifications/admin-functions/17.-user-management.md) - [22. Comms management](https://documentation.opencrvs.org/v1.5/product-specifications/admin-functions/18.-comms-management.md) - [23. Content management](https://documentation.opencrvs.org/v1.5/product-specifications/admin-functions/19.-content-management.md) - [24. Config management](https://documentation.opencrvs.org/v1.5/product-specifications/admin-functions/20.-config-management.md) - [Data functions](https://documentation.opencrvs.org/v1.5/product-specifications/data-functions.md): Overview of functionality that transforms legacy data. - [25. Legacy data import](https://documentation.opencrvs.org/v1.5/product-specifications/data-functions/21.-legacy-data-import.md) - [26. Legacy paper import](https://documentation.opencrvs.org/v1.5/product-specifications/data-functions/22.-legacy-paper-import.md) - [Architecture](https://documentation.opencrvs.org/v1.5/technology/architecture.md) - [Performance tests](https://documentation.opencrvs.org/v1.5/technology/architecture/performance-tests.md): Overview of results from performance tests conducted on OpenCRVS - [Standards](https://documentation.opencrvs.org/v1.5/technology/standards.md): Overview of how OpenCRVS uses best-practice technology standards - [FHIR Documents](https://documentation.opencrvs.org/v1.5/technology/standards/fhir-documents.md) - [Event Composition](https://documentation.opencrvs.org/v1.5/technology/standards/fhir-documents/event-composition.md) - [Person](https://documentation.opencrvs.org/v1.5/technology/standards/fhir-documents/person.md) - [Registration Task](https://documentation.opencrvs.org/v1.5/technology/standards/fhir-documents/registration-task.md) - [Event Observations](https://documentation.opencrvs.org/v1.5/technology/standards/fhir-documents/event-observations.md) - [Locations](https://documentation.opencrvs.org/v1.5/technology/standards/fhir-documents/locations.md) - [Security](https://documentation.opencrvs.org/v1.5/technology/security.md) - [Interoperability](https://documentation.opencrvs.org/v1.5/technology/interoperability.md): An introduction describing how OpenCRVS interoperates - [Create a client](https://documentation.opencrvs.org/v1.5/technology/interoperability/create-a-client.md): How to create and manage access to OpenCRVS' interoperability functionality - [Authenticate a client](https://documentation.opencrvs.org/v1.5/technology/interoperability/authenticate-a-client.md): Authenticating with your client details to retrieve an access token using OAuth 2.0 - [Event Notification clients](https://documentation.opencrvs.org/v1.5/technology/interoperability/event-notification-clients.md): Submitting full or partial event applications into OpenCRVS from an external service such as a health institution or public portal. - [Record Search clients](https://documentation.opencrvs.org/v1.5/technology/interoperability/record-search-clients.md): Perform an advanced search of civil registration records from a trusted, external e-Gov service - [Webhook clients](https://documentation.opencrvs.org/v1.5/technology/interoperability/webhook-clients.md): Business functionality and API endpoints available to a "Webhook" client. - [National ID client](https://documentation.opencrvs.org/v1.5/technology/interoperability/national-id-client.md): Business functionality associated with a National ID client and instructions to setup a MOSIP enabled National ID integration. - [FHIR Location REST API](https://documentation.opencrvs.org/v1.5/technology/interoperability/fhir-location-rest-api.md): Create, read, update or archive administrative areas, civil registration offices or health facilities using FHIR. - [Other ways to interoperate](https://documentation.opencrvs.org/v1.5/technology/interoperability/other-ways-to-interoperate.md): Direct interoperability with OpenHIM - [Intro to Farajaland](https://documentation.opencrvs.org/v1.5/default-configuration/intro-to-farajaland.md): Provides details of the OpenCRVS default configuration - [Civil registration in Farajaland](https://documentation.opencrvs.org/v1.5/default-configuration/civil-registration-in-farajaland.md): Provides details of how civil registration is organised and administered in Farajaland - [OpenCRVS configuration in Farajaland](https://documentation.opencrvs.org/v1.5/default-configuration/opencrvs-configuration-in-farajaland.md): Provides details on how OpenCRVS has been configured to meet the Farajaland context - [Application settings](https://documentation.opencrvs.org/v1.5/default-configuration/opencrvs-configuration-in-farajaland/application-settings.md) - [User / role mapping](https://documentation.opencrvs.org/v1.5/default-configuration/opencrvs-configuration-in-farajaland/user-role-mapping.md) - [Declaration forms](https://documentation.opencrvs.org/v1.5/default-configuration/opencrvs-configuration-in-farajaland/declaration-forms.md) - [Certificate templates](https://documentation.opencrvs.org/v1.5/default-configuration/opencrvs-configuration-in-farajaland/certificate-templates.md) - [Business process flows in Farajaland](https://documentation.opencrvs.org/v1.5/default-configuration/business-process-flows-in-farajaland.md): Provides an overview of the Farajaland business processes digitally enabled by OpenCRVS - [1. Planning an OpenCRVS Implementation](https://documentation.opencrvs.org/v1.5/setup/1.-planning-an-opencrvs-implementation.md) - [2. Establish project and team](https://documentation.opencrvs.org/v1.5/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.5/setup/2.-gather-requirements.md): Prepare all the inputs required for product configuration. - [3.1 Mapping business processes](https://documentation.opencrvs.org/v1.5/setup/2.-gather-requirements/3.1-mapping-business-processes.md) - [3.2 Mapping offices and user types](https://documentation.opencrvs.org/v1.5/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.5/setup/2.-gather-requirements/3.3-define-your-application-settings.md) - [3.4 Designing event declaration forms](https://documentation.opencrvs.org/v1.5/setup/2.-gather-requirements/3.4-designing-event-declaration-forms.md) - [3.5 Designing a certificate template](https://documentation.opencrvs.org/v1.5/setup/2.-gather-requirements/3.5-designing-a-certificate-template.md) - [4. Installation](https://documentation.opencrvs.org/v1.5/setup/3.-installation.md): Installation steps for OpenCRVS - [4.1 Set-up a local development environment](https://documentation.opencrvs.org/v1.5/setup/3.-installation/3.1-set-up-a-development-environment.md) - [4.1.1 Install the required dependencies](https://documentation.opencrvs.org/v1.5/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.5/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.5/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.5/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.5/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.5/setup/3.-installation/3.1-set-up-a-development-environment/3.1.5-tooling/4.1.5.1-wsl-support.md) - [4.2 Set-up your own, local, country configuration](https://documentation.opencrvs.org/v1.5/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.5/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.5/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.5/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.5/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.5/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.5/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.5/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.5/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.5/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.5/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.5/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.5/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.5/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.5/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.5/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.5/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.5/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.5/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.5/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.5/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.5/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 TLS / SSL & DNS](https://documentation.opencrvs.org/v1.5/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.5-setup-dns-a-records.md) - [4.3.2.1 LetsEncrypt https challenge in development environments](https://documentation.opencrvs.org/v1.5/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.5-setup-dns-a-records/4.3.2.1-letsencrypt-https-challenge-in-development-environments.md) - [4.3.2.2 LetsEncrypt DNS challenge in production](https://documentation.opencrvs.org/v1.5/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.5-setup-dns-a-records/4.3.2.2-letsencrypt-dns-challenge-in-production.md) - [4.3.2.3 Static TLS certificates](https://documentation.opencrvs.org/v1.5/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.5-setup-dns-a-records/4.3.2.3-static-tls-certificates.md) - [4.3.3 Configure inventory files](https://documentation.opencrvs.org/v1.5/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.2-install-dependencies.md) - [4.3.4 Create a Github environment](https://documentation.opencrvs.org/v1.5/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.4-create-a-github-environment.md) - [4.3.4.1 Environment secrets and variables explained](https://documentation.opencrvs.org/v1.5/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.4-create-a-github-environment/4.3.4.1-environment-secrets-and-variables-explained.md) - [4.3.4.2 VPN Recipes](https://documentation.opencrvs.org/v1.5/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.4-create-a-github-environment/4.3.4.2-vpn-recipes.md) - [4.3.5 Provisioning servers](https://documentation.opencrvs.org/v1.5/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.5-provisioning-servers.md) - [4.3.5.1 SSH access](https://documentation.opencrvs.org/v1.5/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.5-provisioning-servers/4.3.5.1-ssh-access.md) - [4.3.5.2 Building, pushing & releasing your countryconfig code](https://documentation.opencrvs.org/v1.5/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.5-provisioning-servers/4.3.5.2-building-pushing-and-releasing-your-countryconfig-code.md) - [4.3.5.3 Ansible tasks when provisioning](https://documentation.opencrvs.org/v1.5/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.5-provisioning-servers/4.3.5.3-ansible-tasks-when-provisioning.md) - [4.3.6 Deploy](https://documentation.opencrvs.org/v1.5/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.6-deploy-automated-and-manual.md) - [4.3.6.1 Running a deployment](https://documentation.opencrvs.org/v1.5/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.6-deploy-automated-and-manual/4.3.6.1-running-a-deployment.md) - [4.3.6.2 Seeding a server environment](https://documentation.opencrvs.org/v1.5/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.6-deploy-automated-and-manual/4.3.6.2-seeding-a-server-environment.md) - [4.3.6.3 Login to an OpenCRVS server](https://documentation.opencrvs.org/v1.5/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.6-deploy-automated-and-manual/4.3.6.3-login-to-an-opencrvs-server.md) - [4.3.6.5 Resetting a server environment](https://documentation.opencrvs.org/v1.5/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.6-deploy-automated-and-manual/4.3.6.5-resetting-a-server-environment.md) - [4.3.7 Backup & Restore](https://documentation.opencrvs.org/v1.5/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.7-backup-and-restore.md) - [4.3.7.1 Restoring a backup](https://documentation.opencrvs.org/v1.5/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.7-backup-and-restore/4.3.7.1-restoring-a-backup.md) - [4.3.7.2 Off-boarding from OpenCRVS](https://documentation.opencrvs.org/v1.5/setup/3.-installation/3.3-set-up-a-server-hosted-environment/4.3.7-backup-and-restore/4.3.7.2-off-boarding-from-opencrvs.md) - [5. Functional configuration](https://documentation.opencrvs.org/v1.5/setup/4.-functional-configuration.md) - [5.1 Configure application settings](https://documentation.opencrvs.org/v1.5/setup/4.-functional-configuration/4.1-configure-application-settings.md) - [5.2 Configure registration periods and fees](https://documentation.opencrvs.org/v1.5/setup/4.-functional-configuration/4.2-configure-registration-periods-and-fees.md) - [5.3 Managing system users](https://documentation.opencrvs.org/v1.5/setup/4.-functional-configuration/4.5-create-system-users.md) - [6. Quality assurance testing](https://documentation.opencrvs.org/v1.5/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.5/setup/6.-go-live.md) - [7.1 Pre-Deployment Checklist](https://documentation.opencrvs.org/v1.5/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.5/setup/8.-operational-support.md) - [9. Monitoring](https://documentation.opencrvs.org/v1.5/setup/7.-monitoring.md) - [9.1 Application logs](https://documentation.opencrvs.org/v1.5/setup/7.-monitoring/7.1-application-logs.md) - [9.2 Infrastructure health](https://documentation.opencrvs.org/v1.5/setup/7.-monitoring/7.2-infrastructure-health.md) - [9.3 Routine monitoring checklist](https://documentation.opencrvs.org/v1.5/setup/7.-monitoring/7.3-routine-monitoring-checklist.md) - [9.4 Setting up alerts](https://documentation.opencrvs.org/v1.5/setup/7.-monitoring/7.4-setting-up-alerts.md) - [9.5 Managing a Docker Swarm](https://documentation.opencrvs.org/v1.5/setup/7.-monitoring/7.5-managing-a-docker-swarm.md) - [Community](https://documentation.opencrvs.org/v1.5/general/community.md) - [Contributing](https://documentation.opencrvs.org/v1.5/general/contributing.md): How to contribute to the Digital Public Good for CRVS - [Releases](https://documentation.opencrvs.org/v1.5/general/releases.md) - [v1.5.1: Release notes](https://documentation.opencrvs.org/v1.5/general/releases/v1.5.1-release-notes.md): OpenCRVS v1.5.1 is a patch release which includes a hotfix to the previous OpenCRVS v1.5.0 release. It is to be used in conjunction with a forked country configuration release v1.5.1 - [v1.5.0: Release notes](https://documentation.opencrvs.org/v1.5/general/releases/v1.5.0-release-notes.md): In OpenCRVS v1.5.0 we have refactored the "workflow" microservice and deprecated the backend dependency on OpenHIM. This has vastly improved the performance of the platform. - [v1.4.1: Release notes](https://documentation.opencrvs.org/v1.5/general/releases/v1.4.1-release-notes.md) - [v1.4.0 to v1.4.1 Migration notes](https://documentation.opencrvs.org/v1.5/general/releases/v1.4.0-to-v1.4.1-migration-notes.md) - [v1.4.0 Release notes](https://documentation.opencrvs.org/v1.5/general/releases/v1.4.0-release-notes.md): In OpenCRVS v1.4.0 we have entirely refactored infrastructure provisioning in opencrvs-countryconfig. There are no changes to opencrvs-core. - [v1.3.\* to v1.4.\* Migration notes](https://documentation.opencrvs.org/v1.5/general/releases/v1.3.-to-v1.4.-migration-notes.md) - [v1.3.5: Release notes](https://documentation.opencrvs.org/v1.5/general/releases/v1.3.5-release-notes.md) - [v1.3.4: Release notes](https://documentation.opencrvs.org/v1.5/general/releases/v1.3.4-release-notes.md) - [v1.3.3: Release notes](https://documentation.opencrvs.org/v1.5/general/releases/v1.3.3-release-notes.md) - [v1.3.1: Release notes](https://documentation.opencrvs.org/v1.5/general/releases/v1.3.1-release-notes.md) - [v1.3.0: Release notes](https://documentation.opencrvs.org/v1.5/general/releases/v1.3.0-beta-release-notes.md) - [v1.2.1: Release notes](https://documentation.opencrvs.org/v1.5/general/releases/v1.2.1-release-notes.md) - [Patch: Elasticsearch 7.10.2](https://documentation.opencrvs.org/v1.5/general/releases/patch-elasticsearch-7.10.2.md): An Elasticseach downgrade, patch to demonstrate OpenCRVS' base configuration supports OSI standard licenses. - [v1.2.0: Release notes](https://documentation.opencrvs.org/v1.5/general/releases/v1.2.0-release-notes.md): OpenCRVS v1.2.0 is a stable release of OpenCRVS. - [v.1.1.2: Release notes](https://documentation.opencrvs.org/v1.5/general/releases/v.1.1.2-release-notes.md) - [v.1.1.1: Release notes](https://documentation.opencrvs.org/v1.5/general/releases/v.1.1.1-release-notes.md) - [v1.1.0: Release notes](https://documentation.opencrvs.org/v1.5/general/releases/v1.1.0-release-notes.md) - [Roadmap](https://documentation.opencrvs.org/v1.5/general/product-roadmap.md) ## v1.4 - [Welcome!](https://documentation.opencrvs.org/v1.4/readme.md) - [Understanding CRVS](https://documentation.opencrvs.org/v1.4/crvs-systems/understanding-crvs.md): Provides useful links to documentation about CRVS - [Effective digital CRVS systems](https://documentation.opencrvs.org/v1.4/crvs-systems/effective-digital-crvs-systems.md): Setting realistic business expectations of CRVS digitisation - [OpenCRVS within a government systems architecture](https://documentation.opencrvs.org/v1.4/crvs-systems/opencrvs-within-a-government-systems-architecture.md): How to think about the use of OpenCRVS as an interoperable system within a government's digital landscape - [OpenCRVS Value Proposition](https://documentation.opencrvs.org/v1.4/crvs-systems/opencrvs-value-proposition.md) - [Functional Architecture](https://documentation.opencrvs.org/v1.4/product-specifications/functional-architecture.md) - [Workflow management](https://documentation.opencrvs.org/v1.4/product-specifications/workflow-management.md) - [Status Flow Diagram](https://documentation.opencrvs.org/v1.4/product-specifications/status-flow-diagram.md) - [Users](https://documentation.opencrvs.org/v1.4/product-specifications/users.md) - [Examples](https://documentation.opencrvs.org/v1.4/product-specifications/users/examples.md) - [Core functions](https://documentation.opencrvs.org/v1.4/product-specifications/core-functions.md): Overview of core functions - [1. Notify event](https://documentation.opencrvs.org/v1.4/product-specifications/core-functions/1.-notify-event.md) - [2. Declare event](https://documentation.opencrvs.org/v1.4/product-specifications/core-functions/2.-declare-event.md) - [3. Validate event](https://documentation.opencrvs.org/v1.4/product-specifications/core-functions/3.-validate-event.md) - [4. Register event](https://documentation.opencrvs.org/v1.4/product-specifications/core-functions/4.-register-event.md) - [5. Print certificate](https://documentation.opencrvs.org/v1.4/product-specifications/core-functions/5.-print-certificate.md) - [6. Issue certificate](https://documentation.opencrvs.org/v1.4/product-specifications/core-functions/5.-issue-certificate.md) - [7. Search for a record](https://documentation.opencrvs.org/v1.4/product-specifications/core-functions/6.-search-for-a-record.md) - [8. View record](https://documentation.opencrvs.org/v1.4/product-specifications/core-functions/7.-view-record.md) - [9. Correct record](https://documentation.opencrvs.org/v1.4/product-specifications/core-functions/8.-correct-record.md) - [10. Verify record](https://documentation.opencrvs.org/v1.4/product-specifications/core-functions/9.-verify-record.md) - [11. Archive record](https://documentation.opencrvs.org/v1.4/product-specifications/core-functions/10.-archive-record.md) - [12. Vital statistics export](https://documentation.opencrvs.org/v1.4/product-specifications/core-functions/11.-vital-statistics-export.md) - [Support functions](https://documentation.opencrvs.org/v1.4/product-specifications/support-functions.md): Overview of functionality that enables users to conduct civil registration services safely, securely, and most effectively. - [13. Login](https://documentation.opencrvs.org/v1.4/product-specifications/support-functions/10.-login.md) - [14. Audit](https://documentation.opencrvs.org/v1.4/product-specifications/support-functions/11.-audit.md) - [15. Deduplication](https://documentation.opencrvs.org/v1.4/product-specifications/support-functions/12.-deduplication.md) - [16. Performance management](https://documentation.opencrvs.org/v1.4/product-specifications/support-functions/13.-performance-management.md) - [17. Payment](https://documentation.opencrvs.org/v1.4/product-specifications/support-functions/14.-payment.md) - [18. Learning](https://documentation.opencrvs.org/v1.4/product-specifications/support-functions/15.-learning.md) - [19. User support](https://documentation.opencrvs.org/v1.4/product-specifications/support-functions/16.-user-support.md) - [20. User onboarding](https://documentation.opencrvs.org/v1.4/product-specifications/support-functions/20.-user-onboarding.md) - [Admin functions](https://documentation.opencrvs.org/v1.4/product-specifications/admin-functions.md): Overview of functionality for a system administrator to effectively manage and maintain the OpenCRVS product. - [21. User management](https://documentation.opencrvs.org/v1.4/product-specifications/admin-functions/17.-user-management.md) - [22. Comms management](https://documentation.opencrvs.org/v1.4/product-specifications/admin-functions/18.-comms-management.md) - [23. Content management](https://documentation.opencrvs.org/v1.4/product-specifications/admin-functions/19.-content-management.md) - [24. Config management](https://documentation.opencrvs.org/v1.4/product-specifications/admin-functions/20.-config-management.md) - [Data functions](https://documentation.opencrvs.org/v1.4/product-specifications/data-functions.md): Overview of functionality that transforms legacy data. - [25. Legacy data import](https://documentation.opencrvs.org/v1.4/product-specifications/data-functions/21.-legacy-data-import.md) - [26. Legacy paper import](https://documentation.opencrvs.org/v1.4/product-specifications/data-functions/22.-legacy-paper-import.md) - [Architecture](https://documentation.opencrvs.org/v1.4/technology/architecture.md) - [Performance tests](https://documentation.opencrvs.org/v1.4/technology/architecture/performance-tests.md): Overview of results from performance tests conducted on OpenCRVS - [Standards](https://documentation.opencrvs.org/v1.4/technology/standards.md): Overview of how OpenCRVS uses best-practice technology standards - [FHIR Documents](https://documentation.opencrvs.org/v1.4/technology/standards/fhir-documents.md) - [Event Composition](https://documentation.opencrvs.org/v1.4/technology/standards/fhir-documents/event-composition.md) - [Person](https://documentation.opencrvs.org/v1.4/technology/standards/fhir-documents/person.md) - [Registration Task](https://documentation.opencrvs.org/v1.4/technology/standards/fhir-documents/registration-task.md) - [Event Observations](https://documentation.opencrvs.org/v1.4/technology/standards/fhir-documents/event-observations.md) - [Locations](https://documentation.opencrvs.org/v1.4/technology/standards/fhir-documents/locations.md) - [Security](https://documentation.opencrvs.org/v1.4/technology/security.md) - [Interoperability](https://documentation.opencrvs.org/v1.4/technology/interoperability.md): An introduction describing how OpenCRVS interoperates - [Create a client](https://documentation.opencrvs.org/v1.4/technology/interoperability/create-a-client.md): How to create and manage access to OpenCRVS' interoperability functionality - [Authenticate a client](https://documentation.opencrvs.org/v1.4/technology/interoperability/authenticate-a-client.md): Authenticating with your client details to retrieve an access token using OAuth 2.0 - [Event Notification clients](https://documentation.opencrvs.org/v1.4/technology/interoperability/event-notification-clients.md): Submitting full or partial event applications into OpenCRVS from an external service such as a health institution or public portal. - [Record Search clients](https://documentation.opencrvs.org/v1.4/technology/interoperability/record-search-clients.md): Perform an advanced search of civil registration records from a trusted, external e-Gov service - [Webhook clients](https://documentation.opencrvs.org/v1.4/technology/interoperability/webhook-clients.md): Business functionality and API endpoints available to a "Webhook" client. - [National ID client](https://documentation.opencrvs.org/v1.4/technology/interoperability/national-id-client.md): Business functionality associated with a National ID client and instructions to setup a MOSIP enabled National ID integration. - [FHIR Location REST API](https://documentation.opencrvs.org/v1.4/technology/interoperability/fhir-location-rest-api.md): Create, read, update or archive administrative areas, civil registration offices or health facilities using FHIR. - [Other ways to interoperate](https://documentation.opencrvs.org/v1.4/technology/interoperability/other-ways-to-interoperate.md): Direct interoperability with OpenHIM - [Intro to Farajaland](https://documentation.opencrvs.org/v1.4/default-configuration/intro-to-farajaland.md): Provides details of the OpenCRVS default configuration - [Civil registration in Farajaland](https://documentation.opencrvs.org/v1.4/default-configuration/civil-registration-in-farajaland.md): Provides details of how civil registration is organised and administered in Farajaland - [OpenCRVS configuration in Farajaland](https://documentation.opencrvs.org/v1.4/default-configuration/opencrvs-configuration-in-farajaland.md): Provides details on how OpenCRVS has been configured to meet the Farajaland context - [Application settings](https://documentation.opencrvs.org/v1.4/default-configuration/opencrvs-configuration-in-farajaland/application-settings.md) - [User / role mapping](https://documentation.opencrvs.org/v1.4/default-configuration/opencrvs-configuration-in-farajaland/user-role-mapping.md) - [Declaration forms](https://documentation.opencrvs.org/v1.4/default-configuration/opencrvs-configuration-in-farajaland/declaration-forms.md) - [Certificate templates](https://documentation.opencrvs.org/v1.4/default-configuration/opencrvs-configuration-in-farajaland/certificate-templates.md) - [Business process flows in Farajaland](https://documentation.opencrvs.org/v1.4/default-configuration/business-process-flows-in-farajaland.md): Provides an overview of the Farajaland business processes digitally enabled by OpenCRVS - [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) - [Community](https://documentation.opencrvs.org/v1.4/general/community.md) - [Contributing](https://documentation.opencrvs.org/v1.4/general/contributing.md): How to contribute to the Digital Public Good for CRVS - [Releases](https://documentation.opencrvs.org/v1.4/general/releases.md) - [v1.4.1: Release notes](https://documentation.opencrvs.org/v1.4/general/releases/v1.4.1-release-notes.md) - [v1.4.0 to v1.4.1 Migration notes](https://documentation.opencrvs.org/v1.4/general/releases/v1.4.0-to-v1.4.1-migration-notes.md) - [v1.4.0 Release notes](https://documentation.opencrvs.org/v1.4/general/releases/v1.4.0-release-notes.md): In OpenCRVS v1.4.0 we have entirely refactored infrastructure provisioning in opencrvs-countryconfig. There are no changes to opencrvs-core. - [v1.3.\* to v1.4.\* Migration notes](https://documentation.opencrvs.org/v1.4/general/releases/v1.3.-to-v1.4.-migration-notes.md) - [v1.3.5: Release notes](https://documentation.opencrvs.org/v1.4/general/releases/v1.3.5-release-notes.md) - [v1.3.4: Release notes](https://documentation.opencrvs.org/v1.4/general/releases/v1.3.4-release-notes.md) - [v1.3.3: Release notes](https://documentation.opencrvs.org/v1.4/general/releases/v1.3.3-release-notes.md) - [v1.3.1: Release notes](https://documentation.opencrvs.org/v1.4/general/releases/v1.3.1-release-notes.md) - [v1.3.\* to v1.3.\* Migration notes](https://documentation.opencrvs.org/v1.4/general/releases/v1.3.-to-v1.3.-migration-notes.md) - [v1.3.0: Release notes](https://documentation.opencrvs.org/v1.4/general/releases/v1.3.0-beta-release-notes.md) - [v1.2.\* to v1.3.\* Migration notes](https://documentation.opencrvs.org/v1.4/general/releases/v1.2.-to-v1.3.-migration-notes.md) - [v1.2 to v1.3: Form migration](https://documentation.opencrvs.org/v1.4/general/releases/v1.2.-to-v1.3.-migration-notes/v1.2-to-v1.3-form-migration.md) - [v1.2.1: Release notes](https://documentation.opencrvs.org/v1.4/general/releases/v1.2.1-release-notes.md) - [Patch: Elasticsearch 7.10.2](https://documentation.opencrvs.org/v1.4/general/releases/patch-elasticsearch-7.10.2.md): An Elasticseach downgrade, patch to demonstrate OpenCRVS' base configuration supports OSI standard licenses. - [v1.2.0: Release notes](https://documentation.opencrvs.org/v1.4/general/releases/v1.2.0-release-notes.md): OpenCRVS v1.2.0 is a stable release of OpenCRVS. - [v1.1.\* to v1.2.\* Migration notes](https://documentation.opencrvs.org/v1.4/general/releases/v1.1.-to-v1.2.-migration-notes.md) - [v.1.1.2: Release notes](https://documentation.opencrvs.org/v1.4/general/releases/v.1.1.2-release-notes.md) - [v.1.1.1: Release notes](https://documentation.opencrvs.org/v1.4/general/releases/v.1.1.1-release-notes.md) - [v1.1.0: Release notes](https://documentation.opencrvs.org/v1.4/general/releases/v1.1.0-release-notes.md) - [Interoperability roadmap](https://documentation.opencrvs.org/v1.4/general/interoperability-roadmap.md) - [Product roadmap](https://documentation.opencrvs.org/v1.4/general/product-roadmap.md) ## v1.3 - [Introduction](https://documentation.opencrvs.org/v1.3/readme.md) - [Functional Architecture](https://documentation.opencrvs.org/v1.3/product-specifications/functional-architecture.md) - [Workflow management](https://documentation.opencrvs.org/v1.3/product-specifications/workflow-management.md) - [Status Flow Diagram](https://documentation.opencrvs.org/v1.3/product-specifications/status-flow-diagram.md) - [Users](https://documentation.opencrvs.org/v1.3/product-specifications/users.md) - [Examples](https://documentation.opencrvs.org/v1.3/product-specifications/users/examples.md) - [Core functions](https://documentation.opencrvs.org/v1.3/product-specifications/core-functions.md): Overview of core functions - [1. Notify event](https://documentation.opencrvs.org/v1.3/product-specifications/core-functions/1.-notify-event.md) - [2. Declare event](https://documentation.opencrvs.org/v1.3/product-specifications/core-functions/2.-declare-event.md) - [3. Validate event](https://documentation.opencrvs.org/v1.3/product-specifications/core-functions/3.-validate-event.md) - [4. Register event](https://documentation.opencrvs.org/v1.3/product-specifications/core-functions/4.-register-event.md) - [5. Print certificate](https://documentation.opencrvs.org/v1.3/product-specifications/core-functions/5.-print-certificate.md) - [5. Issue certificate](https://documentation.opencrvs.org/v1.3/product-specifications/core-functions/5.-issue-certificate.md) - [6. Search for a record](https://documentation.opencrvs.org/v1.3/product-specifications/core-functions/6.-search-for-a-record.md) - [7. View record](https://documentation.opencrvs.org/v1.3/product-specifications/core-functions/7.-view-record.md) - [8. Correct record](https://documentation.opencrvs.org/v1.3/product-specifications/core-functions/8.-correct-record.md) - [9. Verify record](https://documentation.opencrvs.org/v1.3/product-specifications/core-functions/9.-verify-record.md) - [10. Archive record](https://documentation.opencrvs.org/v1.3/product-specifications/core-functions/10.-archive-record.md) - [11. Vital statistics export](https://documentation.opencrvs.org/v1.3/product-specifications/core-functions/11.-vital-statistics-export.md) - [Support functions](https://documentation.opencrvs.org/v1.3/product-specifications/support-functions.md): Overview of functionality that enables users to conduct civil registration services safely, securely, and most effectively. - [10. Login](https://documentation.opencrvs.org/v1.3/product-specifications/support-functions/10.-login.md) - [11. Audit](https://documentation.opencrvs.org/v1.3/product-specifications/support-functions/11.-audit.md) - [12. Deduplication](https://documentation.opencrvs.org/v1.3/product-specifications/support-functions/12.-deduplication.md) - [13. Performance management](https://documentation.opencrvs.org/v1.3/product-specifications/support-functions/13.-performance-management.md) - [14. Payment](https://documentation.opencrvs.org/v1.3/product-specifications/support-functions/14.-payment.md) - [15. Learning](https://documentation.opencrvs.org/v1.3/product-specifications/support-functions/15.-learning.md) - [16. User support](https://documentation.opencrvs.org/v1.3/product-specifications/support-functions/16.-user-support.md) - [Admin functions](https://documentation.opencrvs.org/v1.3/product-specifications/admin-functions.md): Overview of functionality for a system administrator to effectively manage and maintain the OpenCRVS product. - [17. User management](https://documentation.opencrvs.org/v1.3/product-specifications/admin-functions/17.-user-management.md) - [18. Comms management](https://documentation.opencrvs.org/v1.3/product-specifications/admin-functions/18.-comms-management.md) - [19. Content management](https://documentation.opencrvs.org/v1.3/product-specifications/admin-functions/19.-content-management.md) - [20. Config management](https://documentation.opencrvs.org/v1.3/product-specifications/admin-functions/20.-config-management.md) - [Data functions](https://documentation.opencrvs.org/v1.3/product-specifications/data-functions.md): Overview of functionality that transforms legacy data. - [21. Legacy data import](https://documentation.opencrvs.org/v1.3/product-specifications/data-functions/21.-legacy-data-import.md) - [22. Legacy paper import](https://documentation.opencrvs.org/v1.3/product-specifications/data-functions/22.-legacy-paper-import.md) - [Architecture](https://documentation.opencrvs.org/v1.3/technology/architecture.md) - [Performance tests](https://documentation.opencrvs.org/v1.3/technology/architecture/performance-tests.md): Overview of results from performance tests conducted on OpenCRVS - [Standards](https://documentation.opencrvs.org/v1.3/technology/standards.md): Overview of how OpenCRVS uses best-practice technology standards - [FHIR Documents](https://documentation.opencrvs.org/v1.3/technology/standards/fhir-documents.md) - [Event Composition](https://documentation.opencrvs.org/v1.3/technology/standards/fhir-documents/event-composition.md) - [Person](https://documentation.opencrvs.org/v1.3/technology/standards/fhir-documents/person.md) - [Registration Task](https://documentation.opencrvs.org/v1.3/technology/standards/fhir-documents/registration-task.md) - [Event Observations](https://documentation.opencrvs.org/v1.3/technology/standards/fhir-documents/event-observations.md) - [Locations](https://documentation.opencrvs.org/v1.3/technology/standards/fhir-documents/locations.md) - [Security](https://documentation.opencrvs.org/v1.3/technology/security.md) - [Interoperability](https://documentation.opencrvs.org/v1.3/technology/interoperability.md): An introduction describing how OpenCRVS interoperates - [Create a client](https://documentation.opencrvs.org/v1.3/technology/interoperability/create-a-client.md): How to create and manage access to OpenCRVS' interoperability functionality - [Authenticate a client](https://documentation.opencrvs.org/v1.3/technology/interoperability/authenticate-a-client.md): Authenticating with your client details to retrieve an access token using OAuth 2.0 - [Event Notification clients](https://documentation.opencrvs.org/v1.3/technology/interoperability/event-notification-clients.md): Submitting full or partial event applications into OpenCRVS from an external service such as a health institution or public portal. - [Record Search clients](https://documentation.opencrvs.org/v1.3/technology/interoperability/record-search-clients.md): Perform an advanced search of civil registration records from a trusted, external e-Gov service - [Webhook clients](https://documentation.opencrvs.org/v1.3/technology/interoperability/webhook-clients.md): Business functionality and API endpoints available to a "Webhook" client. - [National ID client](https://documentation.opencrvs.org/v1.3/technology/interoperability/national-id-client.md): Business functionality associated with a National ID client and instructions to setup a MOSIP enabled National ID integration. - [FHIR Location REST API](https://documentation.opencrvs.org/v1.3/technology/interoperability/fhir-location-rest-api.md): Create, read, update or archive administrative areas, civil registration offices or health facilities using FHIR. - [Other ways to interoperate](https://documentation.opencrvs.org/v1.3/technology/interoperability/other-ways-to-interoperate.md): Direct interoperability with OpenHIM - [Intro to Farajaland](https://documentation.opencrvs.org/v1.3/default-configuration/intro-to-farajaland.md): Provides details of the OpenCRVS default configuration - [Civil registration in Farajaland](https://documentation.opencrvs.org/v1.3/default-configuration/civil-registration-in-farajaland.md): Provides details of how civil registration is organised and administered in Farajaland - [OpenCRVS configuration in Farajaland](https://documentation.opencrvs.org/v1.3/default-configuration/opencrvs-configuration-in-farajaland.md): Provides details on how OpenCRVS has been configured to meet the Farajaland context - [User / role mapping](https://documentation.opencrvs.org/v1.3/default-configuration/opencrvs-configuration-in-farajaland/user-role-mapping.md) - [Application settings](https://documentation.opencrvs.org/v1.3/default-configuration/opencrvs-configuration-in-farajaland/application-settings.md) - [Declaration forms](https://documentation.opencrvs.org/v1.3/default-configuration/opencrvs-configuration-in-farajaland/declaration-forms.md) - [Certificate templates](https://documentation.opencrvs.org/v1.3/default-configuration/opencrvs-configuration-in-farajaland/certificate-templates.md) - [Business process flows in Farajaland](https://documentation.opencrvs.org/v1.3/default-configuration/business-process-flows-in-farajaland.md): Provides an overview of the Farajaland business processes digitally enabled by OpenCRVS - [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) - [Contributing](https://documentation.opencrvs.org/v1.3/general/contributing.md): How to contribute to the Digital Public Good for CRVS - [Releases](https://documentation.opencrvs.org/v1.3/general/releases.md) - [v1.3.5: Release notes](https://documentation.opencrvs.org/v1.3/general/releases/v1.3.5-release-notes.md) - [v1.3.4: Release notes](https://documentation.opencrvs.org/v1.3/general/releases/v1.3.4-release-notes.md) - [v1.3.2: Release notes](https://documentation.opencrvs.org/v1.3/general/releases/v1.3.2-release-notes.md) - [v1.3.1: Release notes](https://documentation.opencrvs.org/v1.3/general/releases/v1.3.1-release-notes.md) - [v1.3.\* to v1.3.\* Migration notes](https://documentation.opencrvs.org/v1.3/general/releases/v1.3.-to-v1.3.-migration-notes.md) - [v1.3.0: Release notes](https://documentation.opencrvs.org/v1.3/general/releases/v1.3.0-beta-release-notes.md) - [v1.2.\* to v1.3.\* Migration notes](https://documentation.opencrvs.org/v1.3/general/releases/v1.2.-to-v1.3.-migration-notes.md) - [v1.2 to v1.3: Form migration](https://documentation.opencrvs.org/v1.3/general/releases/v1.2.-to-v1.3.-migration-notes/v1.2-to-v1.3-form-migration.md) - [v1.2.1: Release notes](https://documentation.opencrvs.org/v1.3/general/releases/v1.2.1-release-notes.md) - [Patch: Elasticsearch 7.10.2](https://documentation.opencrvs.org/v1.3/general/releases/patch-elasticsearch-7.10.2.md): An Elasticseach downgrade, patch to demonstrate OpenCRVS' base configuration supports OSI standard licenses. - [v1.2.0: Release notes](https://documentation.opencrvs.org/v1.3/general/releases/v1.2.0-release-notes.md): OpenCRVS v1.2.0 is a stable release of OpenCRVS. - [v1.1.\* to v1.2.\* Migration notes](https://documentation.opencrvs.org/v1.3/general/releases/v1.1.-to-v1.2.-migration-notes.md) - [v.1.1.2: Release notes](https://documentation.opencrvs.org/v1.3/general/releases/v.1.1.2-release-notes.md) - [v.1.1.1: Release notes](https://documentation.opencrvs.org/v1.3/general/releases/v.1.1.1-release-notes.md) - [v1.1.0: Release notes](https://documentation.opencrvs.org/v1.3/general/releases/v1.1.0-release-notes.md) - [Interoperability roadmap](https://documentation.opencrvs.org/v1.3/general/interoperability-roadmap.md) - [Product roadmap](https://documentation.opencrvs.org/v1.3/general/product-roadmap.md) ## v2.0 - BETA - [Welcome](https://documentation.opencrvs.org/v2.0/readme.md) - [CRVS Systems](https://documentation.opencrvs.org/v2.0/general/crvs-systems.md) - [Understanding CRVS](https://documentation.opencrvs.org/v2.0/general/crvs-systems/quickstart.md) - [Effective digital CRVS systems](https://documentation.opencrvs.org/v2.0/general/crvs-systems/publish-your-docs.md) - [OpenCRVS](https://documentation.opencrvs.org/v2.0/general/opencrvs.md) - [Why OpenCRVS?](https://documentation.opencrvs.org/v2.0/general/opencrvs/why-opencrvs.md) - [Value proposition](https://documentation.opencrvs.org/v2.0/general/opencrvs/value-proposition.md) - [Design principles](https://documentation.opencrvs.org/v2.0/general/opencrvs/design-principles.md) - [Glossary](https://documentation.opencrvs.org/v2.0/general/opencrvs/glossary.md) - [Functional Architecture](https://documentation.opencrvs.org/v2.0/functional/markdown.md) - [Events](https://documentation.opencrvs.org/v2.0/functional/markdown/events.md) - [Type](https://documentation.opencrvs.org/v2.0/functional/markdown/events/type.md) - [Business Rules](https://documentation.opencrvs.org/v2.0/functional/markdown/events/business-rules.md) - [Forms](https://documentation.opencrvs.org/v2.0/functional/markdown/events/forms.md) - [UINs](https://documentation.opencrvs.org/v2.0/functional/markdown/events/uins.md) - [Records](https://documentation.opencrvs.org/v2.0/functional/markdown/records.md) - [Statuses](https://documentation.opencrvs.org/v2.0/functional/markdown/records/statuses.md) - [Flags](https://documentation.opencrvs.org/v2.0/functional/markdown/records/flags.md) - [Data](https://documentation.opencrvs.org/v2.0/functional/markdown/records/data.md) - [Certificates](https://documentation.opencrvs.org/v2.0/functional/markdown/records/certificates.md) - [Verifiable Credentials](https://documentation.opencrvs.org/v2.0/functional/markdown/records/verifiable-credentials.md) - [Audit](https://documentation.opencrvs.org/v2.0/functional/markdown/records/audit.md) - [Protected data (backlog)](https://documentation.opencrvs.org/v2.0/functional/markdown/records/protected-data-backlog.md) - [Workflows](https://documentation.opencrvs.org/v2.0/functional/markdown/workflows.md) - [Administrative structure](https://documentation.opencrvs.org/v2.0/functional/markdown/workflows/administrative-structure.md) - [Users](https://documentation.opencrvs.org/v2.0/functional/markdown/workflows/users.md) - [Jurisdictions](https://documentation.opencrvs.org/v2.0/functional/markdown/workflows/jurisdictions.md) - [Actions](https://documentation.opencrvs.org/v2.0/functional/markdown/workflows/actions.md) - [Workqueues](https://documentation.opencrvs.org/v2.0/functional/markdown/workflows/workqueues.md) - [Offline working](https://documentation.opencrvs.org/v2.0/functional/markdown/workflows/offline-working.md) - [Deduplication](https://documentation.opencrvs.org/v2.0/functional/markdown/workflows/deduplication.md) - [Communications](https://documentation.opencrvs.org/v2.0/functional/markdown/workflows/communications.md) - [Search](https://documentation.opencrvs.org/v2.0/functional/markdown/search.md) - [Quick search](https://documentation.opencrvs.org/v2.0/functional/markdown/search/quick-search.md) - [Advanced search](https://documentation.opencrvs.org/v2.0/functional/markdown/search/advanced-search.md) - [Aggregated Data](https://documentation.opencrvs.org/v2.0/functional/markdown/aggregated-data.md) - [Performance dashboards](https://documentation.opencrvs.org/v2.0/functional/markdown/aggregated-data/performance-dashboards.md) - [Vital statistics export](https://documentation.opencrvs.org/v2.0/functional/markdown/aggregated-data/vital-statistics-export.md) - [Person centricity](https://documentation.opencrvs.org/v2.0/functional/markdown/aggregated-data/person-centricity.md) - [Access](https://documentation.opencrvs.org/v2.0/functional/markdown/access.md) - [Applications](https://documentation.opencrvs.org/v2.0/functional/markdown/access/applications.md) - [Security](https://documentation.opencrvs.org/v2.0/functional/markdown/access/security.md) - [User management](https://documentation.opencrvs.org/v2.0/functional/markdown/access/user-management.md) - [Interoperability](https://documentation.opencrvs.org/v2.0/functional/markdown/interoperability.md) - [APIs](https://documentation.opencrvs.org/v2.0/functional/markdown/interoperability/apis.md) - [Action triggers](https://documentation.opencrvs.org/v2.0/functional/markdown/interoperability/action-triggers.md) - [MOSIP ID Integration](https://documentation.opencrvs.org/v2.0/functional/markdown/interoperability/mosip-id-integration.md) - [Legacy data](https://documentation.opencrvs.org/v2.0/functional/markdown/legacy-data.md) - [Data migration](https://documentation.opencrvs.org/v2.0/functional/markdown/legacy-data/data-migration.md) - [Digitise paper records](https://documentation.opencrvs.org/v2.0/functional/markdown/legacy-data/digitise-paper-records.md) - [Example: Farajaland](https://documentation.opencrvs.org/v2.0/implementation/example-farajaland.md) - [Background & goals](https://documentation.opencrvs.org/v2.0/implementation/example-farajaland/background-and-goals.md) - [Requirements](https://documentation.opencrvs.org/v2.0/implementation/example-farajaland/requirements.md) - [Birth Requirements — Farajaland](https://documentation.opencrvs.org/v2.0/implementation/example-farajaland/requirements/birth-requirements-farajaland.md) - [Birth Journeys — Farajaland](https://documentation.opencrvs.org/v2.0/implementation/example-farajaland/requirements/birth-journeys-farajaland.md) - [Demo](https://documentation.opencrvs.org/v2.0/implementation/example-farajaland/demo.md) - [Your OpenCRVS Project](https://documentation.opencrvs.org/v2.0/implementation/your-opencrvs-project.md) - [Project planning](https://documentation.opencrvs.org/v2.0/implementation/your-opencrvs-project/project-planning.md) - [Establish project & team](https://documentation.opencrvs.org/v2.0/implementation/your-opencrvs-project/establish-project-and-team.md) - [Gathering requirements](https://documentation.opencrvs.org/v2.0/implementation/your-opencrvs-project/gathering-requirements.md): Collect and prepare all the inputs required for optimal product configuration. - [Desk research & planning](https://documentation.opencrvs.org/v2.0/implementation/your-opencrvs-project/gathering-requirements/desk-research-and-planning.md): Desktop research and planning before any fieldwork - [Field Research & discovery](https://documentation.opencrvs.org/v2.0/implementation/your-opencrvs-project/gathering-requirements/field-research-and-discovery.md): Context immersion and primary research - [Co-Design & validation](https://documentation.opencrvs.org/v2.0/implementation/your-opencrvs-project/gathering-requirements/co-design-and-validation.md): Collaborative workshops for alignment in solution development - [Design & specification](https://documentation.opencrvs.org/v2.0/implementation/your-opencrvs-project/gathering-requirements/design-and-specification.md): Creating implementation-ready deliverables - [Guides](https://documentation.opencrvs.org/v2.0/implementation/your-opencrvs-project/gathering-requirements/design-and-specification/guides.md) - [Guide: Event configuration](https://documentation.opencrvs.org/v2.0/implementation/your-opencrvs-project/gathering-requirements/design-and-specification/guides/guide-event-configuration.md) - [Name change](https://documentation.opencrvs.org/v2.0/implementation/your-opencrvs-project/gathering-requirements/design-and-specification/guides/guide-event-configuration/name-change.md) - [Guide: Form configuration](https://documentation.opencrvs.org/v2.0/implementation/your-opencrvs-project/gathering-requirements/design-and-specification/guides/guide-form-configuration.md) - [Guide: Certificate configuration](https://documentation.opencrvs.org/v2.0/implementation/your-opencrvs-project/gathering-requirements/design-and-specification/guides/guide-certificate-configuration.md) - [Guide: Mapping offices and users](https://documentation.opencrvs.org/v2.0/implementation/your-opencrvs-project/gathering-requirements/design-and-specification/guides/guide-mapping-offices-and-users.md) - [Solution architecture](https://documentation.opencrvs.org/v2.0/implementation/your-opencrvs-project/solution-architecture.md) - [Configuration](https://documentation.opencrvs.org/v2.0/implementation/your-opencrvs-project/configuration.md) - [Deployment](https://documentation.opencrvs.org/v2.0/implementation/your-opencrvs-project/deployment.md) - [Migrate legacy data](https://documentation.opencrvs.org/v2.0/implementation/your-opencrvs-project/migrate-legacy-data.md) - [Quality assurance](https://documentation.opencrvs.org/v2.0/implementation/your-opencrvs-project/quality-assurance.md) - [Go-live](https://documentation.opencrvs.org/v2.0/implementation/your-opencrvs-project/go-live.md) - [Operational support](https://documentation.opencrvs.org/v2.0/implementation/your-opencrvs-project/operational-support.md) - [Monitoring](https://documentation.opencrvs.org/v2.0/implementation/your-opencrvs-project/monitoring.md) - [Version upgrades](https://documentation.opencrvs.org/v2.0/implementation/your-opencrvs-project/version-upgrades.md) - [Architecture](https://documentation.opencrvs.org/v2.0/technical/architecture.md) - [Technical stack](https://documentation.opencrvs.org/v2.0/technical/architecture/technical-stack.md) - [Data architecture](https://documentation.opencrvs.org/v2.0/technical/architecture/data-architecture.md) - [Integration architecture](https://documentation.opencrvs.org/v2.0/technical/architecture/integration-architecture.md) - [Standards](https://documentation.opencrvs.org/v2.0/technical/architecture/standards.md) - [Infrastructure](https://documentation.opencrvs.org/v2.0/technical/architecture/infrastructure.md) - [Security](https://documentation.opencrvs.org/v2.0/technical/architecture/security.md) - [Performance](https://documentation.opencrvs.org/v2.0/technical/architecture/performance.md) - [Guides](https://documentation.opencrvs.org/v2.0/technical/guides.md) - [Installation](https://documentation.opencrvs.org/v2.0/technical/guides/installation.md) - [Quick Start](https://documentation.opencrvs.org/v2.0/technical/guides/installation/quick-start.md) - [Deploy: Set-up a server-hosted environment](https://documentation.opencrvs.org/v2.0/technical/guides/installation/deploy-set-up-a-server-hosted-environment.md) - [Preparation steps](https://documentation.opencrvs.org/v2.0/technical/guides/installation/deploy-set-up-a-server-hosted-environment/preparation-steps.md) - [Setup infrastructure](https://documentation.opencrvs.org/v2.0/technical/guides/installation/deploy-set-up-a-server-hosted-environment/preparation-steps/setup-infrastructure.md) - [Configure DNS](https://documentation.opencrvs.org/v2.0/technical/guides/installation/deploy-set-up-a-server-hosted-environment/preparation-steps/configure-dns.md) - [Issue SSL Certificates](https://documentation.opencrvs.org/v2.0/technical/guides/installation/deploy-set-up-a-server-hosted-environment/preparation-steps/issue-ssl-certificates.md) - [Create prerequisite accounts and repositories](https://documentation.opencrvs.org/v2.0/technical/guides/installation/deploy-set-up-a-server-hosted-environment/preparation-steps/create-prerequisite-accounts-and-repositories.md) - [Create a Github environment](https://documentation.opencrvs.org/v2.0/technical/guides/installation/deploy-set-up-a-server-hosted-environment/create-a-github-environment.md) - [Approval Process for Production Environments](https://documentation.opencrvs.org/v2.0/technical/guides/installation/deploy-set-up-a-server-hosted-environment/create-a-github-environment/approval-process-for-production-environments.md) - [Environment secrets and variables explained](https://documentation.opencrvs.org/v2.0/technical/guides/installation/deploy-set-up-a-server-hosted-environment/create-a-github-environment/environment-secrets-and-variables-explained.md) - [Bootstrap servers](https://documentation.opencrvs.org/v2.0/technical/guides/installation/deploy-set-up-a-server-hosted-environment/bootstrap-servers.md) - [Provisioning servers](https://documentation.opencrvs.org/v2.0/technical/guides/installation/deploy-set-up-a-server-hosted-environment/provisioning-servers.md) - [Provision settings](https://documentation.opencrvs.org/v2.0/technical/guides/installation/deploy-set-up-a-server-hosted-environment/provisioning-servers/provision-settings.md) - [Ansible tasks when provisioning](https://documentation.opencrvs.org/v2.0/technical/guides/installation/deploy-set-up-a-server-hosted-environment/provisioning-servers/ansible-tasks-when-provisioning.md) - [Deploy](https://documentation.opencrvs.org/v2.0/technical/guides/installation/deploy-set-up-a-server-hosted-environment/deploy.md) - [Running Dependencies deployment](https://documentation.opencrvs.org/v2.0/technical/guides/installation/deploy-set-up-a-server-hosted-environment/deploy/running-a-dependencies-deployment.md) - [Running an OpenCRVS deployment](https://documentation.opencrvs.org/v2.0/technical/guides/installation/deploy-set-up-a-server-hosted-environment/deploy/running-a-opencrvs-deployment.md) - [Login to an OpenCRVS server](https://documentation.opencrvs.org/v2.0/technical/guides/installation/deploy-set-up-a-server-hosted-environment/deploy/login-to-an-opencrvs-server.md) - [Migration from Docker swarm guide](https://documentation.opencrvs.org/v2.0/technical/guides/installation/deploy-set-up-a-server-hosted-environment/migration-from-docker-swarm-guide.md) - [OpenCRVS maintenance tasks](https://documentation.opencrvs.org/v2.0/technical/guides/installation/opencrvs-maintenance-tasks.md) - [Seeding a server environment](https://documentation.opencrvs.org/v2.0/technical/guides/installation/opencrvs-maintenance-tasks/seeding-a-server-environment.md) - [Resetting a server environment](https://documentation.opencrvs.org/v2.0/technical/guides/installation/opencrvs-maintenance-tasks/resetting-a-server-environment.md) - [Backup & Restore](https://documentation.opencrvs.org/v2.0/technical/guides/installation/opencrvs-maintenance-tasks/backup-and-restore.md) - [Automated backup configuration](https://documentation.opencrvs.org/v2.0/technical/guides/installation/opencrvs-maintenance-tasks/backup-and-restore/automated-backup-configuration.md) - [Manual backup creation](https://documentation.opencrvs.org/v2.0/technical/guides/installation/opencrvs-maintenance-tasks/backup-and-restore/manual-backup-creation.md) - [Automated restore configuration](https://documentation.opencrvs.org/v2.0/technical/guides/installation/opencrvs-maintenance-tasks/backup-and-restore/restoring-a-backup.md) - [Manual restore / Disaster recovery](https://documentation.opencrvs.org/v2.0/technical/guides/installation/opencrvs-maintenance-tasks/backup-and-restore/manual-restore-disaster-recovery.md) - [Off-boarding from OpenCRVS](https://documentation.opencrvs.org/v2.0/technical/guides/installation/opencrvs-maintenance-tasks/off-boarding-from-opencrvs.md) - [Advanced topics](https://documentation.opencrvs.org/v2.0/technical/guides/installation/advanced-topics.md) - [Ubuntu Firewall configuration](https://documentation.opencrvs.org/v2.0/technical/guides/installation/advanced-topics/ubuntu-firewall-configuration.md) - [Ubuntu unattended-upgrades](https://documentation.opencrvs.org/v2.0/technical/guides/installation/advanced-topics/ubuntu-unattended-upgrades.md) - [TLS/SSL Configuration for traefik](https://documentation.opencrvs.org/v2.0/technical/guides/installation/advanced-topics/tls-ssl-configuration-for-traefik.md) - [LetsEncrypt https challenge in development environments](https://documentation.opencrvs.org/v2.0/technical/guides/installation/advanced-topics/tls-ssl-configuration-for-traefik/letsencrypt-https-challenge-in-development-environments.md) - [LetsEncrypt DNS challenge in production](https://documentation.opencrvs.org/v2.0/technical/guides/installation/advanced-topics/tls-ssl-configuration-for-traefik/letsencrypt-dns-challenge-in-production.md) - [Static TLS certificates](https://documentation.opencrvs.org/v2.0/technical/guides/installation/advanced-topics/tls-ssl-configuration-for-traefik/static-tls-certificates.md) - [SSH access](https://documentation.opencrvs.org/v2.0/technical/guides/installation/advanced-topics/ssh-access.md) - [Kubernetes cluster access](https://documentation.opencrvs.org/v2.0/technical/guides/installation/advanced-topics/kubernetes-cluster-access.md) - [Add Custom GitHub secrets to Kubernetes](https://documentation.opencrvs.org/v2.0/technical/guides/installation/advanced-topics/add-custom-github-secrets-to-kubernetes.md) - [Disk space management](https://documentation.opencrvs.org/v2.0/technical/guides/installation/advanced-topics/disk-space-management.md) - [Deploy OpenCRVS with external data stores](https://documentation.opencrvs.org/v2.0/technical/guides/installation/advanced-topics/deploy-opencrvs-with-external-data-stores.md) - [Configuration](https://documentation.opencrvs.org/v2.0/technical/guides/configuration.md) - [General](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/general.md) - [Administrative hierarchy](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/administrative-hierarchy.md) - [Administrative areas](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/administrative-hierarchy/administrative-areas.md) - [Locations](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/administrative-hierarchy/locations.md) - [How to populate administrative hierarchy](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/administrative-hierarchy/how-to-populate-administrative-hierarchy.md) - [How to configure place of event](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/administrative-hierarchy/how-to-configure-place-of-event.md) - [How to limit location and administrative area options in event declaration](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/administrative-hierarchy/how-to-limit-location-and-administrative-area-options-in-event-declaration.md) - [Users](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/users.md) - [Roles and scopes](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/users/roles-and-scopes.md) - [How to configure scopes](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/users/how-to-configure-scopes.md) - [How "user scope" options map to user details?](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/users/how-user-scope-options-map-to-user-details.md) - [How "record scope" options map to event declaration?](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/users/how-record-scope-options-map-to-event-declaration.md) - [Events](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/events.md): How to configure life events - [Declaration & Forms](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/events/declaration-and-forms.md): How to configure the declaration and action forms - [Form fields](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/events/declaration-and-forms/form-fields.md): Configuring form fields - [Form validations](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/events/declaration-and-forms/form-validations.md): Configuring form field validations - [Actions](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/events/actions.md): Configuring actions for your event - [Core actions](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/events/actions/core-actions.md): Configuring core actions - [Custom actions](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/events/actions/custom-actions.md): Configuring custom actions - [Flags](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/events/flags.md): Configuring custom flags - [Conditionals](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/events/conditionals.md): Configuring conditionals - [Workqueues](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/workqueues.md): Configuring workqueues - [Certificates](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/certificates.md): Configuring your printable PDF documents - [Built-in helpers and template variables](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/certificates/built-in-helpers-and-template-variables.md): How to use the built-in certificate helpers - [Custom Handlebars.js helpers](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/certificates/custom-handlebars.js-helpers.md): How to add custom certificate helpers - [Multi-Page Certificate Templates](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/certificates/multi-page-certificate-templates.md): Configuring multi-page PDF certificates - [Action triggers](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/action-triggers.md) - [Email notifications](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/action-triggers/email-notifications.md): Configuring email notifications - [Dashboards](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/dashboards.md): Configuring your analytics dashboards - [Translations](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/translations.md) - [Integrations](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/integrations.md) - [Authenticate a client](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/integrations/authenticate-a-client.md): Authenticating with your client details to retrieve an access token using OAuth 2.0 - [Integration: ID systems](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/integrations/integration-id-systems.md) - [MOSIP Overview](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/integrations/mosip-overview.md) - [MOSIP Deployment](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/integrations/mosip-deployment.md) - [MOSIP Form Authentication](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/integrations/mosip-form-authentication.md) - [MOSIP Registration Integration](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/integrations/mosip-registration-integration.md) - [Verifiable Credentials](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/integrations/verifiable-credentials.md) - [Monitoring](https://documentation.opencrvs.org/v2.0/technical/guides/monitoring.md) - [Data migration](https://documentation.opencrvs.org/v2.0/technical/guides/data-migration.md) - [Version upgrades](https://documentation.opencrvs.org/v2.0/technical/guides/version-upgrades.md): Step-by-step guide for upgrading the version of your OpenCRVS deployment - [Contributing](https://documentation.opencrvs.org/v2.0/technical/guides/contributing.md) - [Core development](https://documentation.opencrvs.org/v2.0/technical/guides/contributing/core-development.md) - [APIs](https://documentation.opencrvs.org/v2.0/technical/apis.md) - [Core APIs](https://documentation.opencrvs.org/v2.0/technical/apis/core-apis.md): Core OpenAPI spec - [Events](https://documentation.opencrvs.org/v2.0/technical/apis/core-apis/events.md) - [Search](https://documentation.opencrvs.org/v2.0/technical/apis/core-apis/search.md) - [Locations](https://documentation.opencrvs.org/v2.0/technical/apis/core-apis/locations.md) - [Integrations](https://documentation.opencrvs.org/v2.0/technical/apis/core-apis/integrations.md) - [Attachments](https://documentation.opencrvs.org/v2.0/technical/apis/core-apis/attachments.md) - [Models](https://documentation.opencrvs.org/v2.0/technical/apis/core-apis/models.md) - [Country-config APIs](https://documentation.opencrvs.org/v2.0/technical/apis/country-config-apis.md): Country-config OpenAPI spec - [Events](https://documentation.opencrvs.org/v2.0/technical/apis/country-config-apis/events.md) - [Models](https://documentation.opencrvs.org/v2.0/technical/apis/country-config-apis/models.md) - [Toolkit](https://documentation.opencrvs.org/v2.0/technical/apis/toolkit.md) - [Configuration](https://documentation.opencrvs.org/v2.0/technical/apis/toolkit/configuration.md) - [Advanced search](https://documentation.opencrvs.org/v2.0/technical/apis/toolkit/configuration/advanced-search.md) - [Conditionals](https://documentation.opencrvs.org/v2.0/technical/apis/toolkit/conditionals.md): All conditional builders return a JSONSchema object. Combine them with and, or, and not. Use them in field or action conditionals arrays. - [Deduplication](https://documentation.opencrvs.org/v2.0/technical/apis/toolkit/deduplication.md) - [API Client](https://documentation.opencrvs.org/v2.0/technical/apis/toolkit/api-client.md) - [Roadmap](https://documentation.opencrvs.org/v2.0/releases/roadmap.md) - [Release notes](https://documentation.opencrvs.org/v2.0/releases/release-notes.md) - [Use case inventory](https://documentation.opencrvs.org/v2.0/releases/editor.md) --- # 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, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://documentation.opencrvs.org/readme.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.