Docs › Setup guides
Frappe CRM Setup Guide
Frappe CRM setup, step by step: install the app, invite users, lead and deal statuses, Kanban views, email accounts, assignment rules, lead syncing and ERPNext.
Frappe CRM is a separate app with its own fast interface, opened at /crm on your site. This Frappe CRM setup guide takes you from installation to a working sales pipeline connected to email and, if you use it, ERPNext. For an overview of features, see Frappe CRM explained.
Before you start
- Decide where it will run: a new Frappe Cloud site, an app added to your existing site, or a self-hosted bench.
- List the people who will use it and whether each is a sales user or a manager.
- Write down your lead stages and deal stages as your team uses them today.
- Have the email address you want to connect, and an app password if it is Gmail or Outlook.
- If you use ERPNext, know whether it is on the same site or a different site.
Step-by-step setup
- Install the app. On Frappe Cloud, add Frappe CRM to your site from the Marketplace. On your own bench run bench get-app crm and then bench --site yoursite install-app crm. Check the README for which Frappe and ERPNext versions your CRM branch supports.
- Open the CRM. Go to yoursite/crm and log in. Settings open from the dropdown in the top-left corner.
- Settings > Defaults. Set the currency. The docs note that currency can only be set once, so choose carefully.
- Settings > Invite User. Invite each person by email with a role: Sales User, Manager or Admin. Give manager rights only to people who need to see and change everyone's records.
- Lead and deal statuses. The default lead statuses are New, Contacted, Nurture, Qualified, Unqualified and Junk. Deal stages run Qualification, Demo/Making, Proposal/Quotation, Negotiation, Ready to Close, then Won or Lost. They are stored as CRM Lead Status and CRM Deal Status records, so you can rename, reorder or add stages to match your process. Keep the list short.
- Kanban and custom views. In the Leads or Deals list, switch to the Kanban view and group by status to get a drag-and-drop pipeline. Save custom views with your own filters, columns and sort order, for example "My open deals" or "Leads not contacted".
- Settings > Email > Accounts. Add a new account. Enable incoming and outgoing, and set it as default for both. Optionally turn on creating leads from incoming emails if enquiries arrive at a shared address. Add reusable replies under Settings > Email > Templates.
- Settings > Assignment Rules. Create a rule so new leads are shared out automatically, either in turn or to the person with the fewest open leads. Add conditions if different sources should go to different people.
- SLA (optional). The app includes a CRM Service Level Agreement DocType with priorities and a holiday list, used to track first-response time on leads and deals. Set it up only if your team has a promised response time; check where your version shows it in settings.
- Settings > Lead Syncing. To pull leads from Facebook and Instagram lead ads, click New, choose Facebook as the source, give it a name, set the sync frequency and paste your Meta access token. After creating, select the page and lead form and map each form field to a CRM field, then click Update. Failed leads appear in a failure log with a retry option. The docs mark this feature as beta.
- Settings > ERPNext. If ERPNext is on the same site, turn on Enable, select the company and click Update. If it is on a different site, enter the ERPNext site URL and the API key and secret of a user there, click Verify Connection and select the company. On the ERPNext site you may need to enable Frappe CRM Data Synchronization in CRM Settings. Set Auto Create Customer and choose the deal status (for example Won) that should create the customer.
What syncs with ERPNext
| From CRM | Into ERPNext | When |
|---|---|---|
| Deal organization or contact | Customer (Company or Individual type) | When the deal reaches the chosen status |
| Deal contacts and address | Linked to the new Customer | Same time |
| Territory, currency, industry, website | Customer fields | Same time, skipped if not found in ERPNext |
| Deal | Quotation or Sales Order | Created by the user from the deal |
Check your work
- Send a test email to the connected address and confirm it appears (and creates a lead, if enabled).
- Create two test leads and confirm the assignment rule gives them to the right people.
- Drag a deal across the Kanban board and check the status changes on the deal page.
- Mark a test deal as Won and confirm the customer appears in ERPNext with its contact.
- Submit a test Facebook lead form and confirm the lead arrives with mapped fields.
Common mistakes
- Using the normal email password for Gmail or Outlook instead of an app password.
- Too many pipeline stages. Sales people stop updating them.
- Setting the wrong currency at the start, which cannot easily be changed later.
- Giving everyone Admin rights.
- Turning on ERPNext customer creation before territories and customer groups are cleaned up in ERPNext.
After go-live
- Review the pipeline with the team once a week for the first month. Ask which fields nobody fills and remove them from the form.
- Look at lost deals and their reasons. If the reasons are vague, make the lost reason list clearer.
- Check the lead syncing failure log regularly; a Meta access token that expires stops new leads quietly.
- Keep sales templates up to date, and retire ones nobody uses.
Need support tickets too? See setting up Frappe Helpdesk.
Sources
Written from the official documentation and source code below. Menus and fields can differ between versions, so check the docs for your version.
Planning ERPNext or a Frappe app for your business? See our ERPNext implementation and Frappe development services, or talk to us.
ERPWork: ERPNext on your phoneFree Android app for your ERPNext site: check in with location, approve documents, see sales and stock dashboards and get notifications.
