Install Frappe Insights

Frappe Insights can be installed using managed hosting on Frappe Cloud or deployed on your own infrastructure. Choose the installation method that best matches your requirements and technical preferences.

Recommendation

If you’re getting started with Frappe Insights, use Frappe Cloud. It handles installation, updates, and maintenance automatically so you can begin analyzing data within minutes.

Managed Hosting (Frappe Cloud)

Frappe Cloud provides a fully managed environment for Frappe Insights, eliminating the need to manage servers or perform manual installations.

Visit the Frappe Cloud Insights Signup page.
Create a new Frappe Cloud account or sign in with your existing account.
Complete the signup process.
Your Frappe Insights instance will be provisioned automatically and ready to use within a few minutes.

Tip

If you already have a Frappe Cloud account, you can install Frappe Insights directly from the Frappe Cloud Marketplace without creating a new environment.

Self-Hosting

Self-hosting gives you complete control over your infrastructure and deployment. This option is suitable for organizations managing their own servers.

Production Installation

Download the installation script:
```
wget https://frappe.io/easy-install.py
```

Run the deployment command:

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

Replace your_email.example.com with your email address.
Replace subdomain.domain.tld with the domain name you want to use for your Frappe Insights instance.
Wait approximately 5 minutes for the installation to complete.
Once finished, your Frappe Insights instance is ready to use.

Tip

Verify that your server meets the required system prerequisites before running the installation script to avoid deployment issues.

Development Setup

If you are contributing to Frappe Insights or building custom features, follow the Development Setup guide available in the official GitHub repository for detailed instructions.

Install on an Existing ERPNext Site

If you already have a self-hosted ERPNext or Frappe site, Frappe Insights can be installed like any other Frappe application.

Download the Insights app:

bench get-app insights --branch version-3

Install the app on your site:

bench --site your_site_name install-app insights

Troubleshooting

Installation Issues

If the installation fails or you encounter unexpected errors:

- Verify that all installation prerequisites have been completed.
- Ensure the installation command has been entered correctly.
- Review the installation logs to identify the cause of the error.

If the issue persists, create an issue in the official Frappe Insights GitHub repository and include the complete error message along with the installation steps you followed.

Note

For most users, managed hosting on Frappe Cloud is the simplest installation option. Self-hosting is recommended only if you require complete control over your deployment environment or need to integrate with existing infrastructure.

Best Practices

Use the latest stable release for production deployments.
Keep your Frappe Framework and Frappe Insights versions up to date.
Back up your server before performing major upgrades or configuration changes.
Use managed hosting if you want automatic maintenance, updates, and infrastructure management.

Rating: 0 / 5 (0 votes)