Installation

Frappe Insights can be installed in several ways depending on your requirements. You can choose to install it on Frappe Cloud, the cloud version of Frappe Insights, or on your own server. The following sections describe the installation methods in detail.

Frappe Cloud

Frappe Insights can be installed in a single click on Frappe Cloud, a managed hosting platform that provides easy installation and maintenance. Try a hassle-free setup by signing up here. Your Insights instance will be ready to use in minutes. It is recommended to give it a try before you decide to self host.

If you already have an existing site on Frappe Cloud, you can install Frappe Insights on the same site from Frappe Cloud Marketplace

Self Hosted

If you prefer to host Frappe Insights on your own server, you can choose one of the following methods:

Docker (Recommended)

You need Docker, docker-compose and git setup on your machine. Refer Docker documentation. After that, follow below steps:

Step 1: Setup folder and download the required files

mkdir frappe-insights
cd frappe-insights

Step 2: Download the required files

Docker Compose File:

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

Frappe Insights bench setup script

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

Step 3: Run the container and daemonize it

docker compose up -d

Step 4: The site http://insights.localhost:8000/insights should now be available. The default credentials are:

username: administrator
password: admin

Local Setup

You can also install Frappe Insights manually on your server. This method requires more technical knowledge and may take longer to set up. Follow the instructions below to install Frappe Insights manually.

Install Frappe Bench on your machine by following the instructions here.
Create a new bench by running
```
bench init frappe-insights-bench
```
Start the server by running
```
bench start
```

In a new terminal, run

cd frappe-insights-bench
bench get-app insights

Create a new site by running
```
bench new-site insights.local
```

Map your site to localhost by running

bench --site insights.local add-to-hosts

Install the app on your site by running

bench --site insights.local install-app insights

Now you can access Frappe Insights at http://insights.local:8000/insights