Install Frappe Helpdesk

Frappe Helpdesk can be installed using different deployment methods depending on your requirements. You can either use Frappe Cloud for a fully managed experience or install it on your own server for greater control and customization.

Choose the installation method that best suits your infrastructure, technical expertise, and maintenance preferences.

Installation Options

Frappe Helpdesk supports two installation methods:

• Managed Hosting — Install using Frappe Cloud.
• Self Hosting — Install on your own server for production or development.

Managed Hosting (Frappe Cloud)

Frappe Cloud is the easiest way to deploy Frappe Helpdesk. It provides a fully managed hosting environment where installation, updates, backups, and maintenance are handled automatically.

With one-click deployment, your Helpdesk instance can be ready within a few minutes.

Install a New Instance

1. Visit the Frappe Cloud Helpdesk signup page.
2. Create a Frappe Cloud account or sign in.
3. Choose your deployment options.
4. Create your Helpdesk instance.

Install on an Existing Frappe Cloud Site

If you already have a Frappe Cloud site, you can install Frappe Helpdesk directly from the Frappe Cloud Marketplace.

Self Hosting

If you prefer complete control over your infrastructure, you can install Frappe Helpdesk on your own server.

Production Installation

Follow these steps to deploy a production-ready instance.

Step 1: Download the Installation Script

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

Step 2: Run the Installation Command

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

Before running the command, replace the following values:

• your_email.example.com — Your email address.
• subdomain.domain.tld — Your website or server domain.

The installation process typically completes in approximately five minutes, after which your Frappe Helpdesk instance is ready to use.

Development Installation

If you want to contribute to Frappe Helpdesk or set up a local development environment, follow the development setup instructions available in the official GitHub repository.

Install on an Existing ERPNext Site

If you already have a self-hosted ERPNext or Frappe Framework installation, you can install Frappe Helpdesk as a standard Frappe application.

bench get-app helpdesk --branch main
bench --site your_site_name install-app helpdesk

These commands download the Helpdesk application and install it on your existing site.

Frequently Asked Questions

Can I install Frappe Helpdesk on an existing ERPNext site?

Yes. Frappe Helpdesk can be installed like any other Frappe application using Bench commands.

What should I do if the installation fails?

If you encounter installation issues:

• Review the installation logs for error messages.
• Verify that all prerequisites are installed correctly.
• Confirm that your server meets the required system requirements.
• Report the issue on the official GitHub repository with the complete error message and installation steps.

Choosing the Right Installation Method

Best Practices

• Use Frappe Cloud for the fastest deployment experience.
• Choose self-hosting if you require infrastructure customization.
• Replace placeholder values before executing installation commands.
• Keep your installation updated to the latest stable version.
• Test upgrades in a staging environment before applying them to production.