Introducing our new CEO Don Johnson - Read More

bitnami/suitecrm

Verified Publisher

By VMware

Updated 2 days ago

Bitnami container image for SuiteCRM

Image
Content Management System
90

5M+

Bitnami package for SuiteCRM

What is SuiteCRM?

SuiteCRM is a completely open source, enterprise-grade Customer Relationship Management (CRM) application. SuiteCRM is a fork of the popular SugarCRM application.

Overview of SuiteCRM Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.

TL;DR

docker run --name suitecrm bitnami/suitecrm:latest

Warning: This quick setup is only intended for development environments. You are encouraged to change the insecure default credentials and check out the available configuration options in the Environment Variables section for a more secure deployment.

Why use Bitnami Images?

  • Bitnami closely tracks upstream source changes and promptly publishes new versions of this image using our automated systems.
  • With Bitnami images the latest bug fixes and features are available as soon as possible.
  • Bitnami containers, virtual machines and cloud images use the same components and configuration approach - making it easy to switch between formats based on your project needs.
  • All our images are based on minideb -a minimalist Debian based container image that gives you a small base container image and the familiarity of a leading Linux distribution- or scratch -an explicitly empty image-.
  • All Bitnami images available in Docker Hub are signed with Notation. Check this post to know how to verify the integrity of the images.
  • Bitnami container images are released on a regular basis with the latest distribution packages available.

Looking to use SuiteCRM in production? Try VMware Tanzu Application Catalog, the commercial edition of the Bitnami catalog.

Only latest stable branch maintained in the free Bitnami catalog

Starting December 10th 2024, only the latest stable branch of any container will receive updates in the free Bitnami catalog. To access up-to-date releases for all upstream-supported branches, consider upgrading to Bitnami Premium. Previous versions already released will not be deleted. They are still available to pull from DockerHub.

Please check the Bitnami Premium page in our partner Arrow Electronics for more information.

Supported tags and respective Dockerfile links

Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags in our documentation page.

You can see the equivalence between the different tags by taking a look at the tags-info.yaml file present in the branch folder, i.e bitnami/ASSET/BRANCH/DISTRO/tags-info.yaml.

Subscribe to project updates by watching the bitnami/containers GitHub repo.

Get this image

The recommended way to get the Bitnami SuiteCRM Docker Image is to pull the prebuilt image from the Docker Hub Registry.

docker pull bitnami/suitecrm:latest

To use a specific version, you can pull a versioned tag. You can view the list of available versions in the Docker Hub Registry.

docker pull bitnami/suitecrm:[TAG]

If you wish, you can also build the image yourself by cloning the repository, changing to the directory containing the Dockerfile and executing the docker build command. Remember to replace the APP, VERSION and OPERATING-SYSTEM path placeholders in the example command below with the correct values.

git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .

How to use this image

SuiteCRM requires access to a MySQL or MariaDB database to store information. We'll use the Bitnami Docker Image for MariaDB for the database requirements.

Using the Docker Command Line

Step 1: Create a network

docker network create suitecrm-network

Step 2: Create a volume for MariaDB persistence and create a MariaDB container

$ docker volume create --name mariadb_data
docker run -d --name mariadb \
  --env ALLOW_EMPTY_PASSWORD=yes \
  --env MARIADB_USER=bn_suitecrm \
  --env MARIADB_PASSWORD=bitnami \
  --env MARIADB_DATABASE=bitnami_suitecrm \
  --network suitecrm-network \
  --volume mariadb_data:/bitnami/mariadb \
  bitnami/mariadb:latest

Step 3: Create volumes for SuiteCRM persistence and launch the container

$ docker volume create --name suitecrm_data
docker run -d --name suitecrm \
  -p 8080:8080 -p 8443:8443 \
  --env ALLOW_EMPTY_PASSWORD=yes \
  --env SUITECRM_DATABASE_USER=bn_suitecrm \
  --env SUITECRM_DATABASE_PASSWORD=bitnami \
  --env SUITECRM_DATABASE_NAME=bitnami_suitecrm \
  --network suitecrm-network \
  --volume suitecrm_data:/bitnami/suitecrm \
  bitnami/suitecrm:latest

Access your application at http://your-ip/

Run the application using Docker Compose
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/suitecrm/docker-compose.yml > docker-compose.yml
docker-compose up -d

Please be aware this file has not undergone internal testing. Consequently, we advise its use exclusively for development or testing purposes. For production-ready deployments, we highly recommend utilizing its associated Bitnami Helm chart.

If you detect any issue in the docker-compose.yaml file, feel free to report it or contribute with a fix by following our Contributing Guidelines.

Persisting your application

If you remove the container all your data will be lost, and the next time you run the image the database will be reinitialized. To avoid this loss of data, you should mount a volume that will persist even after the container is removed.

For persistence you should mount a directory at the /bitnami/suitecrm path. If the mounted directory is empty, it will be initialized on the first run. Additionally you should mount a volume for persistence of the MariaDB data.

The above examples define the Docker volumes named mariadb_data and suitecrm_data. The SuiteCRM application state will persist as long as volumes are not removed.

To avoid inadvertent removal of volumes, you can mount host directories as data volumes. Alternatively you can make use of volume plugins to host the volume data.

Mount host directories as data volumes with Docker Compose

This requires a minor change to the docker-compose.yml file present in this repository:

   mariadb:
     ...
     volumes:
-      - 'mariadb_data:/bitnami/mariadb'
+      - /path/to/mariadb-persistence:/bitnami/mariadb
   ...
   suitecrm:
     ...
     volumes:
-      - 'suitecrm_data:/bitnami/suitecrm'
+      - /path/to/suitecrm-persistence:/bitnami/suitecrm
   ...
-volumes:
-  mariadb_data:
-    driver: local
-  suitecrm_data:
-    driver: local
Restoring persisted SuiteCRM installation

The entire directory of the SuiteCRM application will be persisted. To update the application, you will need to do it manualy. SuiteCRM does not offer any out-of-the-box tool to upgrade the database schema after an upgrade, so it will not be done automatically.

Mount host directories as data volumes using the Docker command line

Step 1: Create a network (if it does not exist)

docker network create suitecrm-network

Step 2. Create a MariaDB container with host volume

docker run -d --name mariadb \
  --env ALLOW_EMPTY_PASSWORD=yes \
  --env MARIADB_USER=bn_suitecrm \
  --env MARIADB_PASSWORD=bitnami \
  --env MARIADB_DATABASE=bitnami_suitecrm \
  --network suitecrm-network \
  --volume /path/to/mariadb-persistence:/bitnami/mariadb \
  bitnami/mariadb:latest

Step 3. Create the SuiteCRM container with host volumes

docker run -d --name suitecrm \
  -p 8080:8080 -p 8443:8443 \
  --env ALLOW_EMPTY_PASSWORD=yes \
  --env SUITECRM_DATABASE_USER=bn_suitecrm \
  --env SUITECRM_DATABASE_PASSWORD=bitnami \
  --env SUITECRM_DATABASE_NAME=bitnami_suitecrm \
  --network suitecrm-network \
  --volume /path/to/suitecrm-persistence:/bitnami/suitecrm \
  bitnami/suitecrm:latest

Configuration

Environment variables

Customizable environment variables

NameDescriptionDefault Value
SUITECRM_DATA_TO_PERSISTFiles to persist relative to the SuiteCRM installation directory. To provide multiple values, separate them with a whitespace.$SUITECRM_BASE_DIR
SUITECRM_SKIP_BOOTSTRAPWhether to perform initial bootstrapping for the application.nil
SUITECRM_USERNAMESuiteCRM user name.user
SUITECRM_PASSWORDSuiteCRM user password.bitnami
SUITECRM_EMAILSuiteCRM user e-mail address.user@example.com
SUITECRM_HOSTSuiteCRM server site URL.localhost
SUITECRM_ENABLE_HTTPSWhether to use HTTPS by default.no
SUITECRM_EXTERNAL_HTTP_PORT_NUMBERPort to used by SuiteCRM to generate URLs and links when accessing using HTTP.80
SUITECRM_EXTERNAL_HTTPS_PORT_NUMBERPort to used by SuiteCRM to generate URLs and links when accessing using HTTPS.443
SUITECRM_VALIDATE_USER_IPWhether or not to validate te user IP.true
SUITECRM_SMTP_HOSTSuiteCRM SMTP server host.nil
SUITECRM_SMTP_PORT_NUMBERSuiteCRM SMTP server port number.nil
SUITECRM_SMTP_USERSuiteCRM SMTP server user.nil
SUITECRM_SMTP_PASSWORDSuiteCRM SMTP server user password.nil
SUITECRM_SMTP_PROTOCOLSuiteCRM SMTP server protocol to use.nil
SUITECRM_SMTP_NOTIFY_ADDRESSSuiteCRM email address to use in notifications.${SUITECRM_EMAIL}
SUITECRM_SMTP_NOTIFY_NAMESuiteCRM name to use in notifications.SuiteCRM
SUITECRM_DATABASE_HOSTDatabase server host.$SUITECRM_DEFAULT_DATABASE_HOST
SUITECRM_DATABASE_PORT_NUMBERDatabase server port.3306
SUITECRM_DATABASE_NAMEDatabase name.bitnami_suitecrm
SUITECRM_DATABASE_USERDatabase user name.bn_suitecrm
SUITECRM_DATABASE_PASSWORDDatabase user password.nil

Read-only environment variables

NameDescriptionValue
SUITECRM_BASE_DIRSuiteCRM installation directory.${BITNAMI_ROOT_DIR}/suitecrm
SUITECRM_CONF_FILEConfiguration file for SuiteCRM.${SUITECRM_BASE_DIR}/public/legacy/config.php
SUITECRM_SILENT_INSTALL_CONF_FILEConfiguration file for the SuiteCRM silent installation wizard.${SUITECRM_BASE_DIR}/public/legacy/config_si.php
SUITECRM_VOLUME_DIRSuiteCRM directory for mounted configuration files.${BITNAMI_VOLUME_DIR}/suitecrm
SUITECRM_MOUNTED_CONF_FILEMounted configuration file for SuiteCRM. It will be copied to the SuiteCRM installation directory during the initialization process.${SUITECRM_VOLUME_DIR}/config_si.php
SUITECRM_DEFAULT_DATABASE_HOSTDefault database server host.mariadb
PHP_DEFAULT_MEMORY_LIMITDefault PHP memory limit.256M
PHP_DEFAULT_POST_MAX_SIZEDefault maximum size for PHP POST requests.60M
PHP_DEFAULT_UPLOAD_MAX_FILESIZEDefault maximum file size for PHP uploads.60M

When you start the SuiteCRM image, you can adjust the configuration of the instance by passing one or more environment variables either on the docker-compose file or on the docker run command line. If you want to add a new environment variable:

  • For docker-compose add the variable name and value under the application section in the docker-compose.yml file present in this repository:
suitecrm:
  ...
  environment:
    - SUITECRM_PASSWORD=my_password
  ...
  • For manual execution add a --env option with each variable and value:

    docker run -d --name suitecrm -p 80:8080 -p 443:8443 \
      --env SUITECRM_PASSWORD=my_password \
      --network suitecrm-tier \
      --volume /path/to/suitecrm-persistence:/bitnami \
      bitnami/suitecrm:latest
    
Example

This would be an example of SMTP configuration using a Gmail account:

  suitecrm:
    ...
    environment:
      - SUITECRM_DATABASE_USER=bn_suitecrm
      - SUITECRM_DATABASE_NAME=bitnami_suitecrm
      - ALLOW_EMPTY_PASSWORD=yes
      - SUITECRM_SMTP_HOST=smtp.gmail.com
      - SUITECRM_SMTP_PROTOCOL=tls
      - SUITECRM_SMTP_PORT=587
      - SUITECRM_SMTP_USER=your_email@gmail.com
      - SUITECRM_SMTP_PASSWORD=your_password
  ...
  • For manual execution:

    docker run -d --name suitecrm -p 80:8080 -p 443:8443 \
      --env SUITECRM_DATABASE_USER=bn_suitecrm \
      --env SUITECRM_DATABASE_NAME=bitnami_suitecrm \
      --env SUITECRM_SMTP_HOST=smtp.gmail.com \
      --env SUITECRM_SMTP_PORT=587 \
      --env SUITECRM_SMTP_PROTOCOL=tls \
      --env SUITECRM_SMTP_USER=your_email@gmail.com \
      --env SUITECRM_SMTP_PASSWORD=your_password \
      --network suitecrm-tier \
      --volume /path/to/suitecrm-persistence:/bitnami \
      bitnami/suitecrm:latest
    

Logging

The Bitnami SuiteCRM Docker image sends the container logs to stdout. To view the logs:

docker logs suitecrm

Or using Docker Compose:

docker-compose logs suitecrm

You can configure the containers logging driver using the --log-driver option if you wish to consume the container logs differently. In the default configuration docker uses the json-file driver.

Maintenance

Backing up your container

To backup your data, configuration and logs, follow these simple steps:

Step 1: Stop the currently running container

docker stop suitecrm

Or using Docker Compose:

docker-compose stop suitecrm

Step 2: Run the backup command

We need to mount two volumes in a container we will use to create the backup: a directory on your host to store the backup in, and the volumes from the container we just stopped so we can access the data.

docker run --rm -v /path/to/suitecrm-backups:/backups --volumes-from suitecrm busybox \
  cp -a /bitnami/suitecrm /backups/latest
Restoring a backup

Restoring a backup is as simple as mounting the backup as volumes in the containers.

For the MariaDB database container:

 $ docker run -d --name mariadb \
   ...
-  --volume /path/to/mariadb-persistence:/bitnami/mariadb \
+  --volume /path/to/mariadb-backups/latest:/bitnami/mariadb \
   bitnami/mariadb:latest

For the SuiteCRM container:

 $ docker run -d --name suitecrm \
   ...
-  --volume /path/to/suitecrm-persistence:/bitnami/suitecrm \
+  --volume /path/to/suitecrm-backups/latest:/bitnami/suitecrm \
   bitnami/suitecrm:latest
Upgrade this image

Bitnami provides up-to-date versions of MariaDB and SuiteCRM, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. We will cover here the upgrade of the SuiteCRM container. For the MariaDB upgrade see: https://github.com/bitnami/containers/tree/main/bitnami/mariadb#upgrade-this-image

Step 1: Get the updated image

docker pull bitnami/suitecrm:latest

Step 2: Stop the running container

Stop the currently running container using the command

docker-compose stop suitecrm

Step 3: Take a snapshot of the application state

Follow the steps in Backing up your container to take a snapshot of the current application state.

Step 4: Remove the currently running container

Remove the currently running container by executing the following command:

docker-compose rm -v suitecrm

Step 5: Run the new image

Update the image tag in docker-compose.yml and re-create your container with the new image:

docker-compose up -d

Customize this image

The Bitnami SuiteCRM Docker image is designed to be extended so it can be used as the base image for your custom web applications.

Extend this image

Before extending this image, please note there are certain configuration settings you can modify using the original image:

If your desired customizations cannot be covered using the methods mentioned above, extend the image. To do so, create your own image using a Dockerfile with the format below:

FROM bitnami/suitecrm
## Put your customizations below
...

Example 1

Here is an example of extending the image with the following modifications:

  • Install the vim editor
  • Modify the Apache configuration file
  • Modify the ports used by Apache
FROM bitnami/suitecrm

## Install 'vim'
RUN install_packages vim

## Enable mod_ratelimit module
RUN sed -i -r 's/#LoadModule ratelimit_module/LoadModule ratelimit_module/' /opt/bitnami/apache/conf/httpd.conf

## Modify the ports used by Apache by default
# It is also possible to change these environment variables at runtime
ENV APACHE_HTTP_PORT_NUMBER=8181
ENV APACHE_HTTPS_PORT_NUMBER=8143
EXPOSE 8181 8143

Based on the extended image, you can update the docker-compose.yml file present in this repository to add other features:

   suitecrm:
-    image: bitnami/suitecrm:latest
+    build: .
     ports:
-      - '80:8080'
-      - '443:8443'
+      - '80:8181'
+      - '443:8143'
     environment:
+      - PHP_MEMORY_LIMIT=512m
     ...

Example 2: Add SuiteCRM API support

FROM bitnami/suitecrm
## Install keys
RUN openssl genrsa -out /opt/bitnami/suitecrm/Api/V8/OAuth2/private.key 2048 && \
    openssl rsa -in /opt/bitnami/suitecrm/Api/V8/OAuth2/private.key -pubout -out /opt/bitnami/suitecrm/Api/V8/OAuth2/public.key && \
    chmod 640 /opt/bitnami/suitecrm/Api/V8/OAuth2/private.key && \
    chgrp daemon /opt/bitnami/suitecrm/Api/V8/OAuth2/private.key /opt/bitnami/suitecrm/Api/V8/OAuth2/public.key

Notable Changes

7.11.18-debian-10-r13
  • The size of the container image has been decreased.
  • The configuration logic is now based on Bash scripts in the rootfs/ folder.
  • SUITECRM_HTTP_TIMEOUT environment variable has been removed.
  • The SuiteCRM container now supports the "non-root" user approach, but it still runs as the root user by default. When running as a

Note: the README for this container is longer than the DockerHub length limit of 25000, so it has been trimmed. The full README can be found at https://github.com/bitnami/containers/blob/main/bitnami/suitecrm/README.md

Docker Pull Command

docker pull bitnami/suitecrm
Bitnami