Entropy CRM Docs

Installation

Entropy CRM can be installed in multiple ways, depending on your requirements. You can either use Entropy Cloud for a fully managed experience or install CRM on your own server.

The following sections explain each installation method in detail.


Managed Hosting (Entropy Cloud)

You can install Entropy CRM with a single click using Entropy Cloud, the managed hosting platform for Entropy applications.

If you already have a Entropy Cloud site, you can install Entropy CRM directly from the Entropy Cloud Marketplace.

:::tip Recommendation: We strongly recommend trying Entropy Cloud before opting for self-hosting. :::


Self Hosting

Production Setup

Follow these steps to set up Entropy CRM in production:

Step 1: Download the easy install script

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

Step 2: Run the deployment command

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

Replace the following parameters with your values:

The script will set up a production-ready instance of Entropy CRM with all the necessary configurations in about 5 minutes.

:::note If hosting on a public server, make sure your DNS A record points to your server's IP and if hosting locally, map your domain to 127.0.0.1 in your /etc/hosts file to avoid 404 Page Not Found error. :::


Development Setup

Docker Setup

To run CRM using Docker, ensure the following are installed:

Refer to Docker documentation. After that, follow the steps below:

Step 1: Create a directory and download the required files

mkdir frappe-crm
cd frappe-crm

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

# Download the setup script
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 the application.

The site http://crm.localhost:8000/crm should now be available. The default credentials are:

Username: Administrator
Password: admin

:::tip Security note: Recommend changing the default password after login. :::

Local Setup (Bench)

  1. Setup Bench.
  2. In the frappe-bench directory, run bench start and keep it running.
  3. Open a new terminal session and cd into frappe-bench directory and run following commands: $ bench get-app crm $ bench new-site sitename.localhost --install-app crm $ bench browse sitename.localhost --user Administrator
  4. Access the crm page at sitename.localhost:8000/crm in your web browser.

For Frontend Development

  1. Open a new terminal session and cd into frappe-bench/apps/crm, and run the following commands: ``` yarn install yarn dev

`` 2. Now, you can access the site on the Vite dev server athttp://sitename.localhost:8080`

Note: You'll find all the code related to Entropy CRM's frontend inside frappe-bench/apps/crm/frontend

Entropy CRM Documentation← Docs home