Portainer Templates logo

Portainer Templates

Dolibarr Dolibarr

Stack

FinanceProductivity

ERP and CRM for small businesses and freelancers: contacts, quotes, orders, invoices and payments, stock, projects, expense reports, HR and accounting. You switch on just the parts you need. Source: https://github.com/Dolibarr/dolibarr

Source details

Stars: 8k
Forks: 4k
Language: PHP
License: GPL-3.0
Updated: 1 hour ago

Configuration

Type
Compose
Platform
linux
Env vars
DOLIBARR_ADMIN_PASSWORD=''DOLIBARR_SECRET_KEY=''DOLIBARR_DB_PASSWORD=''DOLIBARR_PORT=8480DOLIBARR_URL=http://localhost:8480
Restart
unless-stopped
Source

Notes

Fill in the admin password, secret key and database password before you deploy (openssl rand -hex 32 makes good secrets), since the stack won't start without them, and keep the key and database password the same when you redeploy. The first start takes a few minutes while it fills the database, so the page won't load straight away. Then open http://<your-host>:8480 (or whichever port you picked) and log in as admin with your password. It sends you to Setup first: add your company's name, country and currency (it starts in euros), then switch on the modules you want under Setup --> Modules. There are no sign-ups, you add everyone else under Users & Groups. Put the address you'll actually type in the browser in the address field too, since shared document links and links in emails use it, and they point at localhost until you do. To change it later, edit the address in the stack's environment variables and redeploy. To update, redeploy with the image re-pulled: it backs up the database into the documents volume and upgrades it on start. The first time the home page loads after an install or update, your browser sends Dolibarr an anonymous ping (a hashed id, versions, database type and country). Uploads, generated PDFs and backups live in the dolibarr-documents volume, add-on modules in dolibarr-custom, everything else in db-data. Docs: wiki.dolibarr.org

Services

dolibarr

Configuration

Image
dolibarr/dolibarr:24
Entrypoint
sh,-c,rm -f /var/www/documents/install.lock && exec docker-run.sh apache2-foreground
Ports
${DOLIBARR_PORT:-8480}:80
Volumes
/var/www/documents : dolibarr-documents/var/www/html/custom : dolibarr-custom
Env vars
DOLI_URL_ROOT=${DOLIBARR_URL:-http://localhost:8480}DOLI_ADMIN_LOGIN=adminDOLI_ADMIN_PASSWORD=${DOLIBARR_ADMIN_PASSWORD:?Set an admin password}DOLI_INSTANCE_UNIQUE_ID=${DOLIBARR_SECRET_KEY:?Set a secret key}DOLI_DB_HOST=dbDOLI_DB_NAME=dolibarrDOLI_DB_USER=dolibarrDOLI_DB_PASSWORD=${DOLIBARR_DB_PASSWORD:?Set a database password}
Restart
unless-stopped

Image details

Pulls: 1.2M
User: creekorful
Created: Aug 09, 2024
Updated: 9 hours ago
Status: active

db

Configuration

Image
mariadb:11.4
Volumes
/var/lib/mysql : db-data
Env vars
MARIADB_DATABASE=dolibarrMARIADB_USER=dolibarrMARIADB_PASSWORD=${DOLIBARR_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: 3 hours ago
Status: active

Standalone Install

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

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 Dolibarr, 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:
  dolibarr:
    image: dolibarr/dolibarr:24
    restart: unless-stopped
    entrypoint: ["sh", "-c", "rm -f /var/www/documents/install.lock && exec docker-run.sh apache2-foreground"]
    ports:
      - "${DOLIBARR_PORT:-8480}:80"
    environment:
      DOLI_URL_ROOT: ${DOLIBARR_URL:-http://localhost:8480}
      DOLI_ADMIN_LOGIN: admin
      DOLI_ADMIN_PASSWORD: ${DOLIBARR_ADMIN_PASSWORD:?Set an admin password}
      DOLI_INSTANCE_UNIQUE_ID: ${DOLIBARR_SECRET_KEY:?Set a secret key}
      DOLI_DB_HOST: db
      DOLI_DB_NAME: dolibarr
      DOLI_DB_USER: dolibarr
      DOLI_DB_PASSWORD: ${DOLIBARR_DB_PASSWORD:?Set a database password}
    volumes:
      - dolibarr-documents:/var/www/documents
      - dolibarr-custom:/var/www/html/custom
    depends_on:
      db:
        condition: service_healthy

  db:
    image: mariadb:11.4
    restart: unless-stopped
    environment:
      MARIADB_DATABASE: dolibarr
      MARIADB_USER: dolibarr
      MARIADB_PASSWORD: ${DOLIBARR_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:
  dolibarr-documents:
  dolibarr-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/dolibarr/compose.yml up -d

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

Container Documentation

dolibarr Documentation

Docker image for Dolibarr ERP CRM Open source web suite.

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 dolibarr/dolibarr:24

  • "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

Dolibarr is a Compose stack, a set of containers (2 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 2 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • dolibarr runs dolibarr/dolibarr:24, starts after db
  • db runs mariadb:11.4

Volumes

A volume is where Dolibarr 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/documents kept in the dolibarr-documents volume Docker manages
  • /var/www/html/custom kept in the dolibarr-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. Dolibarr takes 12 of them, and 4 need a value before it'll start properly:

  • DOLI_URL_ROOT, defaults to http://localhost:8480
  • DOLI_ADMIN_LOGIN, defaults to admin
  • DOLI_ADMIN_PASSWORD, needs a value
  • DOLI_INSTANCE_UNIQUE_ID, needs a value
  • DOLI_DB_HOST, defaults to db
  • DOLI_DB_NAME, defaults to dolibarr
  • DOLI_DB_USER, defaults to dolibarr
  • DOLI_DB_PASSWORD, needs a value
  • MARIADB_DATABASE, defaults to dolibarr
  • MARIADB_USER, defaults to dolibarr
  • MARIADB_PASSWORD, needs a value
  • MARIADB_RANDOM_ROOT_PASSWORD, defaults to 1

Restart policy

The restart policy here is unless-stopped, so Docker restarts Dolibarr 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 dolibarr) 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

Dolibarr is open source, released under the GPL-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 Dolibarr up. Add the template list to Portainer once, then deploying Dolibarr is a click rather than a wall of config.