OpenSource software is required to be installed on your local machine in order to run OpenCRVS. Ensure you have satisfied all of the following requirements before continuing:
Operation system: Linux or Unix operating system is required: OpenCRVS has been tested on Ubuntu 24.04 LTS and Mac OSX : If you do not have Ubuntu or MacOSX, use WSL or install a virtual Ubuntu environment on your computer and use that environment to continue.
Admin rights: You must have admin rights over your computer and a sudo password
Git: You must have a Git account and Git software
Disk space and RAM: A minimum of 50GB of hard drive space must be available and at least 16GB of RAM. At least 4CPU Cores and 16GB RAM ensure the best experience avoiding any start up errors with ElasticSearch. If you are using virtualisation, ensure this is dedicated to the environment.
Docker: Install Docker Desktop
NodeJS: Install Node using the Node Version Manager. This tutorial: https://www.linode.com/docs/guides/how-to-install-use-node-version-manager-nvm/ is quite good compared to the official documentation which is a little hard to follow. Node version: 22.15.1 is required.
Yarn: Install the Yarn Package Manager for Node
Chrome: Install Google Chrome. OpenCRVS is a progressive web application and PWA's work best in Chrome.
tmux (optional): Install tmux. Multiple terminal windows are required to run our optional local install script. OpenCRVS Core alongside the default country configuration. On Ubuntu run: sudo apt-get install tmux to install. On Mac, you can install tmux using Homebrew or MacPorts.
sudo apt-get install tmux
Last updated 8 months ago
