Install Frappe CRM

Frappe CRM can be deployed either on Frappe Cloud for a fully managed experience or on your own infrastructure for complete control. Choose the installation method that best fits your deployment requirements.

Managed Hosting (Frappe Cloud)

Frappe Cloud provides a fully managed hosting environment for Frappe CRM, allowing you to launch a production-ready instance within minutes.

• Sign up through the Frappe CRM signup page.
• Your CRM instance is automatically provisioned and ready to use.
• No server configuration or infrastructure management is required.

If you already have an existing Frappe Cloud account, you can install Frappe CRM directly from the Marketplace.

Self-Hosting

If you prefer managing your own infrastructure, Frappe CRM can be installed on your own server for production or development environments.

Production Setup

Follow these steps to deploy a production-ready Frappe CRM instance.

Step 1: Download the Installation Script

wget https://frappe.io/easy-install.py

Step 2: Deploy Frappe CRM

python3 ./easy-install.py deploy \
    --project=crm_prod_setup \
    --email=your_email.example.com \
    --image=ghcr.io/frappe/crm \
    --version=stable \
    --app=crm \
    --sitename=subdomain.domain.tld

Replace the following values before running the command:

• your_email.example.com — Your email address.
• subdomain.domain.tld — The domain where your CRM will be hosted.

The installation typically completes within approximately 5 minutes and provisions a production-ready CRM instance.

Development Setup

Docker Installation

Docker provides the quickest way to create a local development environment.

Prerequisites

• Docker
• Docker Compose
• Git

Step 1: Download the Required Files

mkdir frappe-crm
cd frappe-crm

wget -O docker-compose.yml https://raw.githubusercontent.com/frappe/crm/develop/docker/docker-compose.yml

wget -O init.sh https://raw.githubusercontent.com/frappe/crm/develop/docker/init.sh

Step 2: Start the Containers

docker compose up -d

Step 3: Access Frappe CRM

Once the containers finish starting, open:

http://crm.localhost:8000/crm

Default login credentials:

Username: Administrator
Password: admin

Local Development Using Bench

If you already use the Frappe Framework, you can install CRM directly into an existing Bench environment.

1. Install and configure Frappe Bench.
2. Navigate to your frappe-bench directory and start Bench.

bench start

Open a new terminal, move into the Bench directory, and run:

bench get-app crm
bench new-site sitename.localhost --install-app crm
bench browse sitename.localhost --user Administrator

After installation, access CRM at:

http://sitename.localhost:8000/crm

Frontend Development

To work on the CRM frontend, open a new terminal and navigate to the application’s directory:

cd frappe-bench/apps/crm

yarn install
yarn dev

The frontend development server will be available at:

http://sitename.localhost:8080

Choose the Right Installation Method

• Frappe Cloud — Best for production deployments with minimal maintenance.
• Production Self-Hosting — Best when you require complete infrastructure control.
• Docker — Ideal for testing, evaluation, and development.
• Bench — Recommended for Frappe application development and customization.