OpenCRVS
v1.3
v1.3
  • 👋Introduction
  • Product Specifications
    • Functional Architecture
    • Workflow management
    • Status Flow Diagram
    • Users
      • Examples
    • Core functions
      • 1. Notify event
      • 2. Declare event
      • 3. Validate event
      • 4. Register event
      • 5. Print certificate
      • 5. Issue certificate
      • 6. Search for a record
      • 7. View record
      • 8. Correct record
      • 9. Verify record
      • 10. Archive record
      • 11. Vital statistics export
    • Support functions
      • 10. Login
      • 11. Audit
      • 12. Deduplication
      • 13. Performance management
      • 14. Payment
      • 15. Learning
      • 16. User support
    • Admin functions
      • 17. User management
      • 18. Comms management
      • 19. Content management
      • 20. Config management
    • Data functions
      • 21. Legacy data import
      • 22. Legacy paper import
  • Technology
    • Architecture
      • Performance tests
    • Standards
      • FHIR Documents
        • Event Composition
        • Person
        • Registration Task
        • Event Observations
        • Locations
    • Security
    • Interoperability
      • Create a client
      • Authenticate a client
      • Event Notification clients
      • Record Search clients
      • Webhook clients
      • National ID client
      • FHIR Location REST API
      • Other ways to interoperate
  • Default configuration
    • Intro to Farajaland
    • Civil registration in Farajaland
    • OpenCRVS configuration in Farajaland
      • User / role mapping
      • Application settings
      • Declaration forms
      • Certificate templates
    • Business process flows in Farajaland
  • Setup
    • 1. Establish team
    • 2. Gather requirements
    • 3. Installation
      • 3.1 Set-up a local development environment
        • 3.1.1 Install the required dependencies
        • 3.1.2 Install OpenCRVS locally
        • 3.1.3 Starting and stopping OpenCRVS
        • 3.1.4 Log in to OpenCRVS locally
        • 3.1.5 Tooling
      • 3.2 Set-up your own country configuration
        • 3.2.1 Fork your own country configuration repository
        • 3.2.2 Set up administrative address divisions
          • 3.2.2.1 Prepare source file for administrative structure
          • 3.2.2.2 Prepare source file for statistics
        • 3.2.3 Set up CR offices and Health facilities
          • 3.2.3.1 Prepare source file for CRVS Office facilities
          • 3.2.3.2 Prepare source file for health facilities
        • 3.2.4 Set up employees & roles for testing or production
          • 3.2.3.1 Prepare source file for employees
          • 3.2.3.2 Configure role titles
        • 3.2.5 Set up application settings
          • 3.2.5.1 Configuring Metabase Dashboards
        • 3.2.6 Configure certificate templates
        • 3.2.7 Configure declaration forms
          • 3.2.7.1 Configuring an event form
        • 3.2.8 Seeding your local development environment database
          • 3.2.8.1 Clearing your local development environment database
        • 3.2.9 Countryconfig APIs explained
          • 3.2.9.1 Managing language content
      • 3.3 Set-up a server-hosted environment
        • 3.3.1 Provision your server nodes with SSH access
        • 3.3.2 Provision environment
        • 3.3.3 Provision a comms gateway
        • 3.3.4 Set up an SMTP server for OpenCRVS monitoring alerts
        • 3.3.5 Setup DNS A records
        • 3.3.6 Deploy (Automated & Manual)
        • 3.3.7 Seeding & clearing data on a server
        • 3.3.8 Automated & manual backup and manual restore
    • 4. Functional configuration
      • 4.1 Configure application settings
      • 4.2 Configure registration periods and fees
      • 4.3 Create new user roles
      • 4.4 Managing system users
    • 5. Testing
    • 6. Go-live
    • 7. Monitoring
      • 7.1 Application logs
      • 7.2 Infrastructure health
      • 7.3 Routine monitoring checklist
      • 7.4 Setting up alerts
      • 7.5 Managing a Docker Swarm
  • General
    • Contributing
    • Releases
      • v1.3.5: Release notes
      • v1.3.4: Release notes
      • v1.3.2: Release notes
      • v1.3.1: Release notes
      • v1.3.* to v1.3.* Migration notes
      • v1.3.0: Release notes
      • v1.2.* to v1.3.* Migration notes
        • v1.2 to v1.3: Form migration
      • v1.2.1: Release notes
      • Patch: Elasticsearch 7.10.2
      • v1.2.0: Release notes
      • v1.1.* to v1.2.* Migration notes
      • v.1.1.2: Release notes
      • v.1.1.1: Release notes
      • v1.1.0: Release notes
    • Interoperability roadmap
    • Product roadmap
Powered by GitBook
On this page
  1. Setup
  2. 3. Installation
  3. 3.2 Set-up your own country configuration

3.2.1 Fork your own country configuration repository

Previous3.2 Set-up your own country configurationNext3.2.2 Set up administrative address divisions

Last updated 1 year ago

The first step towards configuring your own country configuration of OpenCRVS is to our existing country configuration based on our demonstration country . the following steps help you change the cloned Farajaland repo into your own country configuration fork.

  1. When you ran the bash setup.sh script in step , the country configuration repo for Farajaland was cloned into the same parent directory as opencrvs-core, as you are probably aware. The first thing that you want to do is to change the name of the cloned opencrvs-countryconfig directory to something like "opencrvs-<your country>".

  2. Next, we strongly recommend that you account on Github for storing your country configuration fork so that you can share access amongst your internal team safely.

  3. named the same as your new directory, ie: "opencrvs-<your country>" on your organisation's account on Github.

  4. Copy the Git URL to this repository, e.g. https://github.com/<your organisation>/opencrvs-<your country>.git

  5. In Terminal, cd inside your local directory for the country configuration, opencrvs-<your country>. If you run git remote -v inside this directory you should see that the origin Git URLs are still pointing to our Farajaland repo. We need to point these origin URLs to your repo. To do that, run this command:

git remote set-url origin https://github.com/<your organisation>/opencrvs-<your country>.git
  1. You can check that the origin URLs have changed successfully by running git remote -v again.

  2. Ensure that you are on the master branch of the country configuration folder: git checkout master

  3. Run git push to push the Farajaland code to your repo. Once the files are pushed you should see the country configuration code on your own Github repo.

It's up to your team to decide how you wish to manage pulling future release code from our countryconfig / "farajaland" repo. 2 example strategies are explained below.

Strategy 1:

  1. Add in our countryconfig repo as a new origin named "farajaland"

git remote add farajaland https://github.com:opencrvs/opencrvs-countryconfig.git
  1. Maintain a new branch that you use to pull in latest releases. You can use this to review changes in a pull request before fixing conflicts.

// when you are ready to upgrade

git checkout -b farajaland-master
git pull farajaland master
git push --set-upstream origin farajaland-master

// review conflicts on github
// fix conflicts and merge into develop for QA & Production

Strategy 2:

  1. Add in our countryconfig repo as a new origin named "farajaland"

git remote add farajaland git@github.com:opencrvs/opencrvs-countryconfig.git
  1. Set up dedicated default branches that you use, such as: master-<your country code>, develop-<your country code> .

git checkout -b master-<your-country-code>
git push --set-upstream origin master-<your-country-code>
git checkout -b develop-<your-country-code>
git push --set-upstream origin develop-<your-country-code>
// set your defaults to these branches with branch protection rules

// When you are ready to upgrade
git checkout master
git pull farajaland master
git push origin master

// open PRs from master into your develop-<your-country-code> branch
// fix conflicts and merge into develop-<your-country-code> for QA
// merge into your master-<your-country-code> branch for Production

We strongly recommend that you set up a branching strategy on your repo to ensure that you can develop features on feature branches, merge them into develop for testing and main or master for releases. Therefore create a companion develop branch that you will use for developing the rest of your configuration: git checkout -b develop & then push that code up to your new repository with git push

It is very important that you configure on your master, develop and main branches as these branches should not be able to be pushed to by any developer without a pull request for code review.

Following best practices, we recommend that you setup so that no developer can push code to your important branches without a pull request

Gitflow
branch protection rules
branch protection rules
fork
Farajaland - Repo: opencrvs-countryconfig
3.1.2 to install OpenCRVS locally
create or use an existing organisation
Create a new, private Git repository