Portainer Templates logo

Portainer Templates

EspoCRM EspoCRM

Stack

ProductivityEmail

CRM for keeping track of customers and sales: accounts, contacts, leads, opportunities, cases, meetings and calls, with a shared calendar, email inbox, reports and a no-code entity builder. Source: https://github.com/espocrm/espocrm

Source details

Repo: espocrm/espocrm
Stars: 4k
Forks: 1k
Language: PHP
License: AGPL-3.0
Latest: 10.0.11 · 1 day ago
Updated: 1 day ago
Website: www.espocrm.com/

Configuration

Type
Compose
Platform
linux
Env vars
ESPOCRM_ADMIN_PASSWORD=''ESPOCRM_DB_PASSWORD=''ESPOCRM_PORT=8680ESPOCRM_URL=http://localhost:8680
Restart
unless-stopped
Source
Repo

Template by NotAFlightRisk·Source

Report issue

Notes

Fill in the admin password and database password before you deploy (openssl rand -hex 16 makes a good one), since the stack won't start without them, and keep the database password the same when you redeploy. The first start takes a minute while it sets up the database. Then open http://<your-host>:8680 (or whichever port you picked) and log in as admin with your password. There are no sign-ups, you add everyone else under Administration --> Users. Put the address you'll actually type in the browser in the address field too, since links in emails and password resets use it, and they point at localhost until you do. It's set from the stack on every start, so to change it later edit the address in the stack's environment variables and redeploy, rather than in Settings. Nothing gets emailed until you add an SMTP server under Administration --> Outbound Emails. The daemon container runs the scheduled jobs (fetching email, reminders, clean-up), so leave it running. The Administration page shows a news panel from espocrm.com, which gets told your version and address, and a scheduled job asks espocrm.com for the latest version. To update, redeploy with the image re-pulled and it upgrades the database on start. Uploads and settings live in the espocrm-data volume, extensions and customisations in espocrm-custom and espocrm-client-custom, and your records in db-data. Docs: docs.espocrm.com

Services

espocrm

Configuration

Image
espocrm/espocrm:10
Ports
${ESPOCRM_PORT:-8680}:80
Volumes
/var/www/html/data : espocrm-data/var/www/html/custom : espocrm-custom/var/www/html/client/custom : espocrm-client-custom
Env vars
ESPOCRM_DATABASE_PLATFORM=MysqlESPOCRM_DATABASE_HOST=dbESPOCRM_DATABASE_NAME=espocrmESPOCRM_DATABASE_USER=espocrmESPOCRM_DATABASE_PASSWORD=${ESPOCRM_DB_PASSWORD:?Set a database password}ESPOCRM_ADMIN_USERNAME=adminESPOCRM_ADMIN_PASSWORD=${ESPOCRM_ADMIN_PASSWORD:?Set an admin password}ESPOCRM_SITE_URL=${ESPOCRM_URL:-http://localhost:8680}ESPOCRM_CONFIG_SITE_URL=${ESPOCRM_URL:-http://localhost:8680}
Restart
unless-stopped

Image details

Pulls: 3.0M
User: tmachyshyn
Created: Feb 08, 2021
Updated: 1 day ago
Status: active

daemon

Configuration

Image
espocrm/espocrm:10
Entrypoint
docker-daemon.sh
Volumes
/var/www/html/data : espocrm-data/var/www/html/custom : espocrm-custom/var/www/html/client/custom : espocrm-client-custom
Restart
unless-stopped

Image details

Pulls: 3.0M
User: tmachyshyn
Created: Feb 08, 2021
Updated: 1 day ago
Status: active

db

Configuration

Image
mariadb:11.4
Volumes
/var/lib/mysql : db-data
Env vars
MARIADB_DATABASE=espocrmMARIADB_USER=espocrmMARIADB_PASSWORD=${ESPOCRM_DB_PASSWORD:?Set a database password}MARIADB_RANDOM_ROOT_PASSWORD=1
Restart
unless-stopped

Image details

Pulls: 3.2B
User: stackbrew
Created: Nov 25, 2014
Updated: 1 day ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying EspoCRM

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select EspoCRM, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

services:
  espocrm:
    image: espocrm/espocrm:10
    restart: unless-stopped
    ports:
      - "${ESPOCRM_PORT:-8680}:80"
    environment:
      ESPOCRM_DATABASE_PLATFORM: Mysql
      ESPOCRM_DATABASE_HOST: db
      ESPOCRM_DATABASE_NAME: espocrm
      ESPOCRM_DATABASE_USER: espocrm
      ESPOCRM_DATABASE_PASSWORD: ${ESPOCRM_DB_PASSWORD:?Set a database password}
      ESPOCRM_ADMIN_USERNAME: admin
      ESPOCRM_ADMIN_PASSWORD: ${ESPOCRM_ADMIN_PASSWORD:?Set an admin password}
      ESPOCRM_SITE_URL: ${ESPOCRM_URL:-http://localhost:8680}
      ESPOCRM_CONFIG_SITE_URL: ${ESPOCRM_URL:-http://localhost:8680}
    volumes:
      - espocrm-data:/var/www/html/data
      - espocrm-custom:/var/www/html/custom
      - espocrm-client-custom:/var/www/html/client/custom
    depends_on:
      db:
        condition: service_healthy

  daemon:
    image: espocrm/espocrm:10
    restart: unless-stopped
    entrypoint: docker-daemon.sh
    volumes:
      - espocrm-data:/var/www/html/data
      - espocrm-custom:/var/www/html/custom
      - espocrm-client-custom:/var/www/html/client/custom
    depends_on:
      - espocrm

  db:
    image: mariadb:11.4
    restart: unless-stopped
    environment:
      MARIADB_DATABASE: espocrm
      MARIADB_USER: espocrm
      MARIADB_PASSWORD: ${ESPOCRM_DB_PASSWORD:?Set a database password}
      MARIADB_RANDOM_ROOT_PASSWORD: "1"
    volumes:
      - db-data:/var/lib/mysql
    healthcheck:
      test: ["CMD", "healthcheck.sh", "--connect", "--innodb_initialized"]
      interval: 5s
      timeout: 5s
      retries: 20

volumes:
  espocrm-data:
  espocrm-custom:
  espocrm-client-custom:
  db-data:

Or deploy it directly from the source:

git clone https://github.com/NotAFlightRisk/portainer-templates-extras
cd portainer-templates-extras
docker compose -f apps/espocrm/compose.yml up -d

More install options in our documentation, or see espocrm/espocrm for app-specific guidance.

Container Documentation

espocrm Documentation

LEGACY. Use the Docker Official Image: hub.docker.com/_/espocrm

daemon Documentation

LEGACY. Use the Docker Official Image: hub.docker.com/_/espocrm

db Documentation

MariaDB Server is a high performing open source relational database, forked from MySQL.

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Image won't pull

Test the pull directly on the host: docker pull espocrm/espocrm:10

  • "manifest unknown" means the tag no longer exists.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

EspoCRM is a Compose stack, a set of containers (3 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 3 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • espocrm runs espocrm/espocrm:10, starts after db
  • daemon runs espocrm/espocrm:10, starts after espocrm
  • db runs mariadb:11.4

Volumes

A volume is where EspoCRM keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /var/www/html/data kept in the espocrm-data volume Docker manages
  • /var/www/html/custom kept in the espocrm-custom volume Docker manages
  • /var/www/html/client/custom kept in the espocrm-client-custom volume Docker manages
  • /var/lib/mysql kept in the db-data volume Docker manages

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. EspoCRM takes 13 of them, and 3 need a value before it'll start properly:

  • ESPOCRM_DATABASE_PLATFORM, defaults to Mysql
  • ESPOCRM_DATABASE_HOST, defaults to db
  • ESPOCRM_DATABASE_NAME, defaults to espocrm
  • ESPOCRM_DATABASE_USER, defaults to espocrm
  • ESPOCRM_DATABASE_PASSWORD, needs a value
  • ESPOCRM_ADMIN_USERNAME, defaults to admin
  • ESPOCRM_ADMIN_PASSWORD, needs a value
  • ESPOCRM_SITE_URL, defaults to http://localhost:8680
  • ESPOCRM_CONFIG_SITE_URL, defaults to http://localhost:8680
  • MARIADB_DATABASE, defaults to espocrm
  • MARIADB_USER, defaults to espocrm
  • MARIADB_PASSWORD, needs a value
  • MARIADB_RANDOM_ROOT_PASSWORD, defaults to 1

Restart policy

The restart policy here is unless-stopped, so Docker restarts EspoCRM after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like espocrm) while only the ports above are open to you.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Open source license

EspoCRM is open source, released under the AGPL-3.0 license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set EspoCRM up. Add the template list to Portainer once, then deploying EspoCRM is a click rather than a wall of config.