> For the complete documentation index, see [llms.txt](https://documentation.opencrvs.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](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.1 Install the required dependencies
### Install dependencies locally
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](https://learn.microsoft.com/en-us/windows/wsl/) or install a [virtual](https://www.virtualbox.org/) [Ubuntu](https://ubuntu.com/download/desktop) 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](https://github.com/) account and [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-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](https://www.docker.com/products/docker-desktop/)
* [ ] **NodeJS:** Install Node using the [Node Version Manager](https://nodejs.org/en/download/package-manager/#nvm). This tutorial: is quite good compared to the official documentation which is a little hard to follow. Node version: 18.19.0 is required.
* [ ] **Yarn:** Install the [Yarn Package Manager](https://classic.yarnpkg.com/en/docs/install) for Node
* [ ] **Chrome:** Install [Google Chrome](https://www.google.com/chrome). OpenCRVS is a [progressive web application](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Introduction) and PWA's work best in Chrome.
* [ ] **tmux:** Install [tmux](https://github.com/tmux/tmux/wiki). Multiple terminal windows are required to run 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.
---
# 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 that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://documentation.opencrvs.org/v1.5/setup/3.-installation/3.1-set-up-a-development-environment/3.1.1-install-the-required-dependencies.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
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.