Bitnami Docker Image for SuiteCRM

What is SuiteCRM?

SuiteCRM is a completely open source enterprise-grade Customer Relationship Management (CRM) application. SuiteCRM is a software fork of the popular customer relationship management (CRM) system SugarCRM.

https://www.suitecrm.com/

TL;DR

$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-suitecrm/master/docker-compose.yml > docker-compose.yml
$ docker-compose up -d

You can find the default credentials and available configuration options in the Environment Variables section.

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 which gives you a small base container image and the familiarity of a leading Linux distribution.
• All Bitnami images available in Docker Hub are signed with Docker Content Trust (DCT). You can use DOCKER_CONTENT_TRUST=1 to verify the integrity of the images.
• Bitnami container images are released daily with the latest distribution packages available.

This CVE scan report contains a security report with all open CVEs. To get the list of actionable security issues, find the "latest" tag, click the vulnerability report link under the corresponding "Security scan" field and then select the "Only show fixable" filter on the next page.

Why use a non-root container?

Non-root container images add an extra layer of security and are generally recommended for production environments. However, because they run as a non-root user, privileged tasks are typically off-limits. Learn more about non-root containers in our docs.

How to deploy SuiteCRM in Kubernetes?

Deploying Bitnami applications as Helm Charts is the easiest way to get started with our applications on Kubernetes. Read more about the installation in the Bitnami SuiteCRM Chart GitHub repository.

Bitnami containers can be used with Kubeapps for deployment and management of Helm Charts in clusters.

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.

• 7, 7-debian-10, 7.11.18, 7.11.18-debian-10-r125, latest (7/debian-10/Dockerfile)

Subscribe to project updates by watching the bitnami/suitecrm 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.

$ docker build -t bitnami/suitecrm:latest 'https://github.com/bitnami/bitnami-docker-suitecrm.git#master:7/debian-10'

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.

Run the application using Docker Compose

The main folder of this repository contains a functional docker-compose.yml file. Run the application using it as shown below:

$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-suitecrm/master/docker-compose.yml > docker-compose.yml
$ docker-compose up -d

Using the Docker Command Line

If you want to run the application manually instead of using docker-compose, these are the basic steps you need to run:

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/

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](https://github.com/bitnami/bitnami-docker-mariadb#persisting-your-database).

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

NOTE: As this is a non-root container, the mounted files and directories must have the proper permissions for the UID 1001.

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 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 /path/to/mariadb-persistence:/bitnami/mariadb \
  bitnami/mariadb:latest

Step 3. Create the SuiteCRM the container with host volumes

$ 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 /path/to/suitecrm-persistence:/bitnami/suitecrm \
  bitnami/suitecrm:latest

Configuration

Environment variables

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

Available environment variables:

User and Site configuration

• APACHE_HTTP_PORT_NUMBER: Port used by Apache for HTTP. Default: 8080
• APACHE_HTTPS_PORT_NUMBER: Port used by Apache for HTTPS. Default: 8443
• SUITECRM_USERNAME: SuiteCRM application username. Default: user
• SUITECRM_PASSWORD: SuiteCRM application password. Default: bitnami
• SUITECRM_EMAIL: SuiteCRM application email. Default: [email protected]
• SUITECRM_SKIP_BOOTSTRAP: Whether to perform initial bootstrapping for the application. Default: no
• SUITECRM_HOST: Host where SuiteCRM will be running. Default:localhost.
• SUITECRM_ENABLE_HTTPS: Whether to use HTTPS by default. Default: no.
• SUITECRM_EXTERNAL_HTTP_PORT_NUMBER: Port to used by SuiteCRM to generate URLs and links when accessing using HTTP. Default 80.
• SUITECRM_EXTERNAL_HTTPS_PORT_NUMBER: Port to used by SuiteCRM to generate URLs and links when accessing using HTTPS. Default 443.

Use an existing database

• SUITECRM_DATABASE_HOST: Hostname for MariaDB server. Default: mariadb
• SUITECRM_DATABASE_PORT_NUMBER: Port used by MariaDB server. Default: 3306
• SUITECRM_DATABASE_NAME: Database name that SuiteCRM will use to connect with the database. Default: bitnami_suitecrm
• SUITECRM_DATABASE_USER: Database user that SuiteCRM will use to connect with the database. Default: bn_suitecrm
• SUITECRM_DATABASE_PASSWORD: Database password that SuiteCRM will use to connect with the database. No defaults.
• ALLOW_EMPTY_PASSWORD: It can be used to allow blank passwords. Default: no

Create a database for SuiteCRM using mysql-client

• MYSQL_CLIENT_DATABASE_HOST: Hostname for MariaDB server. Default: mariadb
• MYSQL_CLIENT_DATABASE_PORT_NUMBER: Port used by MariaDB server. Default: 3306
• MYSQL_CLIENT_DATABASE_ROOT_USER: Database admin user. Default: root
• MYSQL_CLIENT_DATABASE_ROOT_PASSWORD: Database password for the database admin user. No defaults.
• MYSQL_CLIENT_CREATE_DATABASE_NAME: New database to be created by the mysql client module. No defaults.
• MYSQL_CLIENT_CREATE_DATABASE_USER: New database user to be created by the mysql client module. No defaults.
• MYSQL_CLIENT_CREATE_DATABASE_PASSWORD: Database password for the MYSQL_CLIENT_CREATE_DATABASE_USER user. No defaults.
• MYSQL_CLIENT_CREATE_DATABASE_CHARACTER_SET: Character set to use for the new database. No defaults.
• MYSQL_CLIENT_CREATE_DATABASE_COLLATE: Database collation to use for the new database. No defaults.
• MYSQL_CLIENT_ENABLE_SSL_WRAPPER: Whether to force SSL connections to the database via the mysql CLI tool. Useful for applications that rely on the CLI instead of APIs. Default: no
• MYSQL_CLIENT_ENABLE_SSL: Whether to force SSL connections for the database. Default: no
• MYSQL_CLIENT_SSL_CA_FILE: Path to the SSL CA file for the new database. No defaults
• MYSQL_CLIENT_SSL_CERT_FILE: Path to the SSL CA file for the new database. No defaults
• MYSQL_CLIENT_SSL_KEY_FILE: Path to the SSL CA file for the new database. No defaults
• ALLOW_EMPTY_PASSWORD: It can be used to allow blank passwords. Default: no

SMTP Configuration

To configure SuiteCRM to send email using SMTP you can set the following environment variables:

• SUITECRM_SMTP_HOST: SMTP host.
• SUITECRM_SMTP_PORT: SMTP port.
• SUITECRM_SMTP_USER: SMTP account user.
• SUITECRM_SMTP_PASSWORD: SMTP account password.
• SUITECRM_SMTP_PROTOCOL: SMTP protocol to use.
• SUITECRM_SMTP_NOTIFY_NAME: Name to use in the SMTP notifications
• SUITECRM_SMTP_NOTIFY_ADDRESS: Notify address for SMTP notifications

PHP configuration

• PHP_EXPOSE_PHP: Enables HTTP header with PHP version. No default.
• PHP_MAX_EXECUTION_TIME: Maximum execution time for PHP scripts. No default.
• PHP_MAX_INPUT_TIME: Maximum input time for PHP scripts. No default.
• PHP_MAX_INPUT_VARS: Maximum amount of input variables for PHP scripts. No default.
• PHP_MEMORY_LIMIT: Memory limit for PHP scripts. Default: 256M
• PHP_POST_MAX_SIZE: Maximum size for PHP POST requests. 60M.
• PHP_UPLOAD_MAX_FILESIZE: Maximum file size for PHP uploads. 60M.

Example

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

• Modify the docker-compose.yml file present in this repository:

  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
      - [email protected]
      - 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=[email protected] \
  --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/bitnami-docker-mariadb/blob/master/README.md#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:

• Settings that can be adapted using environment variables. For instance, you can change the ports used by Apache for HTTP and HTTPS, by setting the environment variables APACHE_HTTP_PORT_NUMBER and APACHE_HTTPS_PORT_NUMBER respectively.
• Adding custom virtual hosts.
• Replacing the 'httpd.conf' file.
• Using custom SSL certificates.

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
LABEL maintainer "Bitnami <[email protected]>"

## Install 'vim'
USER 0 # Required to perform privileged actions
RUN install_packages vim
USER 1001 # Revert to the original non-root user

## 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
LABEL maintainer "Bitnami <[email protected]>"
## 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 non-root user, all services will be run under the same user and Cron jobs will be disabled as crond requires to be run as a superuser. To run as a non-root user, change USER root to USER 1001 in the Dockerfile, or use user: 1001 in docker-compose.yml. Related changes:
• The HTTP/HTTPS ports exposed by the container are now 8080/8443 instead of 80/443.
• Backwards compatibility is not guaranteed when data is persisted using docker or docker-compose. We highly recommend migrating the SuiteCRM site by exporting its content, and importing it on a new SuiteCRM container.

To upgrade a deployment with the previous Bitnami SuiteCRM container image, which did not support non-root, the easiest way is to start the new image as a root user and updating the port numbers. Modify your docker-compose.yml file as follows:

       - ALLOW_EMPTY_PASSWORD=yes
+    user: root
     ports:
-      - '80:80'
-      - '443:443'
+      - '80:8080'
+      - '443:8443'
     volumes:

7.11.4-debian-9-r21 and 7.11.4-ol-7-r32

• This image has been adapted so it's easier to customize. See the Customize this image section for more information.
• The Apache configuration volume (/bitnami/apache) has been deprecated, and support for this feature will be dropped in the near future. Until then, the container will enable the Apache configuration from that volume if it exists. By default, and if the configuration volume does not exist, the configuration files will be regenerated each time the container is created. Users wanting to apply custom Apache configuration files are advised to mount a volume for the configuration at /opt/bitnami/apache/conf, or mount specific configuration files individually.
• The PHP configuration volume (/bitnami/php) has been deprecated, and support for this feature will be dropped in the near future. Until then, the container will enable the PHP configuration from that volume if it exists. By default, and if the configuration volume does not exist, the configuration files will be regenerated each time the container is created. Users wanting to apply custom PHP configuration files are advised to mount a volume for the configuration at /opt/bitnami/php/conf, or mount specific configuration files individually.
• Enabling custom Apache certificates by placing them at /opt/bitnami/apache/certs has been deprecated, and support for this functionality will be dropped in the near future. Users wanting to enable custom certificates are advised to mount their certificate files on top of the preconfigured ones at /certs.

7.10.10-debian-9-r18 and 7.10.10-ol-7-r24

• Due to several broken SuiteCRM features and plugins, the entire htdocs directory is now being persisted (instead of a select number of files and directories). Because of this, upgrades will not work and a full migration needs to be performed. Upgrade instructions have been updated to reflect these changes.

Contributing

We'd love for you to contribute to this container. You can request new features by creating an issue, or submit a pull request with your contribution.

Issues

If you encountered a problem running this container, you can file an issue. For us to provide better support, be sure to include the following information in your issue:

• Host OS and version
• Docker version (docker version)
• Output of docker info
• Version of this container
• The command you used to run the container, and any relevant output you saw (masking any sensitive information)

License

Copyright (c) 2021 Bitnami

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.