---
title: "3. Prerequisites & Installation"
space: "CAMS Biometric Integration"
url: "https://docs.navari.co.ke/cams-biometric/prerequisites-installation"
updated: "2026-05-27"
---

## 3.0 Prerequisites

Before installing, ensure the following are in place:

### Software Requirements


| Dependency       | Minimum Version | Notes                                        |
| ---------------- | --------------- | -------------------------------------------- |
| Frappe Framework | v14 or v15+     | v15 recommended                              |
| ERPNext          | v14 or v15+     | Must be installed on the same bench          |
| FrappeHR (HRMS)  | v14 or v15+     | Core dependency for Employee Checkin doctype |
| Python           | 3.10+           | Comes with modern Frappe installs            |
| MariaDB          | 10.6+           | Standard Frappe database                     |
| Redis            | Any recent      | Standard Frappe queue dependency             |


### External Requirements


| Requirement                 | Details                                                                                                                                         |
| --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| CAMS API Account            | Sign up at [camsbiometrics.com](https://camsbiometrics.com/). You need a paid subscription.                                                     |
| Service Tag ID              | Issued by CAMS per device. Found in your API Monitor account.                                                                                   |
| AuthToken                   | 32-character token issued by CAMS per device. Found in API Monitor.                                                                             |
| Public HTTPS URL            | Your FrappeHR site must be reachable over the public internet on port 80 or 443. Self-hosted sites behind NAT require a tunnel or port forward. |
| Compatible biometric device | Any CAMS-native or CAMS-verified device. Third-party devices (ZKTeco, eSSL, etc.) work via Hybrid Push mode.                                    |


## 3.1 Installation

### 3.1.1 Manual / Self-Hosted Installation

This method applies to benches you control directly (cloud VMs, on-premise servers, etc.).



**Step 1: Install Frappe bench** (skip if already installed)



```bash
pip install frappe-bench
bench init frappe-bench --frappe-branch version-15
cd frappe-bench

```



**Step 2: Install ERPNext** (skip if already installed)



```bash
bench get-app --branch version-15 erpnext
bench --site yoursite.example.com install-app erpnext

```



**Step 3: Install FrappeHR / HRMS** (skip if already installed)



```bash
bench get-app --branch version-15 hrms
bench --site yoursite.example.com install-app hrms

```



**Step 4: Add navari_cams_biometric to your bench**



```bash
bench get-app --branch develop https://github.com/navariltd/navari_cams_biometric.git

```



> **Branch naming:** The default active development branch is `develop`. For production use, pin to the tagged release commit or a stable branch if one is created. Always ensure compatibility with your Frappe/ERPNext/HRMS version before pulling.



**Step 5: Install the app on your site**



```bash
bench --site yoursite.example.com install-app navari_cams_biometric

```



**Step 6: Run migrations**

```bash
bench --site yoursite.example.com migrate

```



**Step 7: Restart bench**

```bash
bench restart
```



### 3.1.2 Frappe Cloud Installation

This is the easiest path for organisations that don't want to manage their own server.

1. Sign up at [frappecloud.com](https://frappecloud.com/)
2. Create a new bench and choose **Frappe Version-14** or **Version-15**
3. Create a new site
4. During site creation, in the **Apps to Install** section, select:
  - ERPNext
  - Frappe HR
  - **Cams Biometric** (listed in the marketplace)
5. Complete the setup wizard. The site will be live within minutes.

### 3.1.3 Verifying the Installation

After installation, confirm the app registered correctly:

```bash
bench --site yoursite.example.com list-apps
# Should include: navari_cams_biometric
```



In the browser, navigate to **Settings > CAMS Biometric Settings**. If the doctype appears, the app is installed correctly.