Installation

Frappe Mpesa Payments can be installed on a managed Frappe Cloud instance or on a self-hosted Frappe bench.

Frappe Cloud (Managed Hosting)

If you are using Frappe Cloud, the installation process is handled through the dashboard.

1. Log in to your Frappe Cloud account.
2. Navigate to your Sites or Bench Groups dashboard.
3. Open the Apps tab for the relevant bench.
4. Click + Install App or + Add App.
5. Search for Frappe Mpesa Payments in the Marketplace, or select Add from GitHub and enter the repository URL:

https://github.com/navariltd/frappe-mpsa-payments.git

6. Click Install Application or Fetch Branches to proceed.

Self-Hosted Installation

For self-hosted Frappe instances, installation is done using the bench command-line tool.

Step 1: Confirm Your Environment

Ensure you have a working Frappe and ERPNext instance running. You should be able to access your site in the browser and log in without errors.

Step 2: Fetch the App

From your bench directory, run:

bench get-app https://github.com/navariltd/frappe-mpsa-payments.git

This clones the repository into the apps/ directory of your bench.

Step 3: Install on Your Site

Replace [your-site-name] with the actual name of your Frappe site:

bench --site [your-site-name] install-app frappe_mpsa_payments

Step 4: Restart the Bench

Restart all bench processes to apply the changes:

bench restart

After the restart, log in to your ERPNext site. You should see the Mpesa workspace in the sidebar.

Verifying the Installation

After installation, confirm the app is active by navigating to:

Settings > Installed Apps

Frappe Mpesa Payments should appear in the list. You can also use the Awesome Bar (press Ctrl + G or Cmd + G) and search for Mpesa Settings — if the DocType appears, the installation was successful.

Next Step

Proceed to Configuration to enter your Daraja API credentials and prepare the app for use.