bitnami-containers/bitnami/matomo
Juan José Martos debbf7dffa
[bitnami/*] Modify containers' READMEs title (#87908)
[bitnami/*][TNZ-62332] Modify containers' READMEs title

Signed-off-by: Jota Martos <jota.martos@broadcom.com>
2025-10-27 11:32:47 +01:00
..
5/debian-12
README.md [bitnami/*] Modify containers' READMEs title (#87908) 2025-10-27 11:32:47 +01:00
docker-compose.yml

README.md

Bitnami Secure Image for Matomo

What is Matomo?

Matomo, formerly known as Piwik, is a real time web analytics program. It provides detailed reports on website visitors.

Overview of Matomo 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 matomo bitnami/matomo: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 d eployment.

⚠️ Important Notice: Upcoming changes to the Bitnami Catalog

Beginning August 28th, 2025, Bitnami will evolve its public catalog to offer a curated set of hardened, security-focused images under the new Bitnami Secure Images initiative. As part of this transition:

  • Granting community users access for the first time to security-optimized versions of popular container images.
  • Bitnami will begin deprecating support for non-hardened, Debian-based software images in its free tier and will gradually remove non-latest tags from the public catalog. As a result, community users will have access to a reduced number of hardened images. These images are published only under the “latest” tag and are intended for development purposes
  • Starting August 28th, over two weeks, all existing container images, including older or versioned tags (e.g., 2.50.0, 10.6), will be migrated from the public catalog (docker.io/bitnami) to the “Bitnami Legacy” repository (docker.io/bitnamilegacy), where they will no longer receive updates.
  • For production workloads and long-term support, users are encouraged to adopt Bitnami Secure Images, which include hardened containers, smaller attack surfaces, CVE transparency (via VEX/KEV), SBOMs, and enterprise support.

These changes aim to improve the security posture of all Bitnami users by promoting best practices for software supply chain integrity and up-to-date deployments. For more details, visit the Bitnami Secure Images announcement.

Why use Bitnami Secure Images?

  • Bitnami Secure Images and Helm charts are built to make open source more secure and enterprise ready.
  • Triage security vulnerabilities faster, with transparency into CVE risks using industry standard Vulnerability Exploitability Exchange (VEX), KEV, and EPSS scores.
  • Our hardened images use a minimal OS (Photon Linux), which reduces the attack surface while maintaining extensibility through the use of an industry standard package format.
  • Stay more secure and compliant with continuously built images updated within hours of upstream patches.
  • 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.
  • Hardened images come with attestation signatures (Notation), SBOMs, virus scan reports and other metadata produced in an SLSA-3 compliant software factory.

Only a subset of BSI applications are available for free. Looking to access the entire catalog of applications as well as enterprise support? Try the commercial edition of Bitnami Secure Images today.

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.

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.

Prerequisites

To run this application you need Docker Engine >= 1.10.0. Docker Compose is recommended with a version 1.6.0 or later.

How to get this image

The recommended way to get the Bitnami Matomo Docker Image is to pull the prebuilt image from the Docker Hub Registry. To use a specific version, you can pull a versioned tag. Find the [list of available versions] (https://hub.docker.com/r/bitnami/matomo/tags/) in the Docker Hub Registry.

docker pull bitnami/matomo:[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

Matomo requires access to a MySQL database or MariaDB database to store information. It uses our [MariaDB image] (https://github.com/bitnami/containers/blob/main/bitnami/mariadb) for the database requirements.

Run the application 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:

  1. Create a new network for the application and the database:

    docker network create matomo_network
    
  2. Create a volume for MariaDB persistence and create a MariaDB container

    docker volume create --name mariadb_data
    docker run -d --name mariadb \
      -e ALLOW_EMPTY_PASSWORD=yes \
      -e MARIADB_USER=bn_matomo \
      -e MARIADB_DATABASE=bitnami_matomo \
      --net matomo_network \
      --volume mariadb_data:/bitnami \
      bitnami/mariadb:latest
    
  3. Create volumes for Matomo persistence and launch the container

    docker volume create --name matomo_data
    docker run -d --name matomo -p 80:8080 -p 443:8443 \
      -e ALLOW_EMPTY_PASSWORD=yes \
      -e MATOMO_DATABASE_USER=bn_matomo \
      -e MATOMO_DATABASE_NAME=bitnami_matomo \
      --net matomo_network \
      --volume matomo_data:/bitnami \
      bitnami/matomo:latest
    

Then you can access your application at http://your-ip/

Run the application using Docker Compose

curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/matomo/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 and configurations 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 volume at the /bitnami path. Additionally you should mount a volume for persistence of the MariaDB data.

The above examples define docker volumes namely mariadb_data and matomo_data. The Matomo application state will persist as long as these volumes are not removed.

To avoid inadvertent removal of these 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:

services:
  mariadb:
  ...
    volumes:
      - /path/to/mariadb-persistence:/bitnami
  ...
  matomo:
  ...
    volumes:
      - /path/to/matomo-persistence:/bitnami
  ...

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

Mount host directories as data volumes using the Docker command line

In this case you need to specify the directories to mount on the run command. The process is the same than the one previously shown:

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

    docker network create matomo_network
    
  2. Create a MariaDB container with host volume:

     docker run -d --name mariadb
      -e ALLOW_EMPTY_PASSWORD=yes \
      -e MARIADB_USER=bn_matomo \
      -e MARIADB_DATABASE=bitnami_matomo \
      --net matomo_network \
      --volume /path/to/mariadb-persistence:/bitnami \
      bitnami/mariadb:latest
    

    Note: You need to give the container a name in order to Matomo to resolve the host

  3. Create the Matomo container with host volumes:

    docker run -d --name matomo -p 80:80 -p 443:443 \
      -e ALLOW_EMPTY_PASSWORD=yes \
      -e MATOMO_DATABASE_USER=bn_matomo \
      -e MATOMO_DATABASE_NAME=bitnami_matomo \
      --net matomo_network \
      --volume /path/to/matomo-persistence:/bitnami \
      bitnami/matomo:latest
    

Backing up your container

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

Step 1: Stop the currently running container

docker stop matomo

Or using Docker Compose:

docker-compose stop matomo

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/matomo-backups:/backups --volumes-from matomo busybox \
  cp -a /bitnami/matomo /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 Matomo container:

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

Upgrading Matomo

Bitnami provides up-to-date versions of MariaDB and Matomo, 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 Matomo container. For the MariaDB upgrade you can take a look at https://github.com/bitnami/containers/tree/main/bitnami/mariadb#upgrade-this-image

  1. Get the updated images:

    docker pull bitnami/matomo:latest
    
  2. Stop your container

    • For docker-compose: $ docker-compose stop matomo
    • For manual execution: $ docker stop matomo
  3. Take a snapshot of the application state

    rsync -a /path/to/matomo-persistence /path/to/matomo-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
    

    Additionally, snapshot the MariaDB data

    You can use these snapshots to restore the application state should the upgrade fail.

  4. Remove the currently running container

    • For docker-compose: $ docker-compose rm -v matomo
    • For manual execution: $ docker rm -v matomo
  5. Run the new image

    • For docker-compose: $ docker-compose up matomo
    • For manual execution (mount the directories if needed): docker run --name matomo bitnami/matomo:latest

Configuration

Environment variables

Customizable environment variables

Name Description Default Value
MATOMO_DATA_TO_PERSIST Files to persist relative to the Matomo installation directory. To provide multiple values, separate them with a whitespace. $MATOMO_BASE_DIR
MATOMO_EXCLUDED_DATA_FROM_UPDATE Files to exclude from being updated relative to the Matomo installation directory (same as config.ini.php). To provide multiple values, separate them with a whitespace. No defaults. nil
MATOMO_SKIP_BOOTSTRAP Whether to perform initial bootstrapping for the application. nil
MATOMO_PROXY_HOST_HEADER Specify the host IP HTTP Header. Usually HTTP_X_FORWARDED_HOST. No defaults. nil
MATOMO_PROXY_CLIENT_HEADER Specify the client IP HTTP Header. Usually HTTP_X_FORWARDED_FOR. nil
MATOMO_ENABLE_ASSUME_SECURE_PROTOCOL Enable assume_secure_protocol in Matomo configuration file. no
MATOMO_ENABLE_FORCE_SSL Enable force_ssl in Matomo configuration file. no
MATOMO_ENABLE_PROXY_URI_HEADER Enable proxy_uri_header in Matomo configuration file. no
MATOMO_USERNAME Matomo user name. user
MATOMO_PASSWORD Matomo user password. bitnami
MATOMO_EMAIL Matomo user e-mail address. user@example.com
MATOMO_HOST Name of a website to track in Matomo. 127.0.0.1
MATOMO_WEBSITE_NAME Name of a website to track in Matomo. example
MATOMO_WEBSITE_HOST Website host or domain to track in Matomo. https://example.org
MATOMO_ENABLE_TRUSTED_HOST_CHECK Enable trusted host check. no
MATOMO_ENABLE_DATABASE_SSL Whether to enable SSL for database connections in the Matomo configuration file. no
MATOMO_DATABASE_SSL_CA_FILE Path to the database server CA bundle file. nil
MATOMO_DATABASE_SSL_CERT_FILE Path to the database client certificate file. nil
MATOMO_DATABASE_SSL_KEY_FILE Path to the database client certificate key nil
MATOMO_VERIFY_DATABASE_SSL Whether to verify the database SSL certificate when SSL is enabled yes
MATOMO_SMTP_HOST Matomo SMTP server host. nil
MATOMO_SMTP_PORT_NUMBER Matomo SMTP server port number. nil
MATOMO_SMTP_USER Matomo SMTP server user. nil
MATOMO_SMTP_PASSWORD Matomo SMTP server user password. nil
MATOMO_SMTP_AUTH Matomo SMTP server auth type (Plain, Login or Cram-md5) nil
MATOMO_SMTP_PROTOCOL Matomo SMTP server protocol to use. nil
MATOMO_NOREPLY_NAME Matomo noreply name. nil
MATOMO_NOREPLY_ADDRESS Matomo noreply address. nil
MATOMO_DATABASE_HOST Database server host. $MATOMO_DEFAULT_DATABASE_HOST
MATOMO_DATABASE_PORT_NUMBER Database server port. 3306
MATOMO_DATABASE_NAME Database name. bitnami_matomo
MATOMO_DATABASE_USER Database user name. bn_matomo
MATOMO_DATABASE_PASSWORD Database user password. nil
MATOMO_DATABASE_TABLE_PREFIX Database table prefix. matomo_

Read-only environment variables

Name Description Value
MATOMO_BASE_DIR Matomo installation directory. ${BITNAMI_ROOT_DIR}/matomo
MATOMO_CONF_DIR Configuration dir for Matomo. ${MATOMO_BASE_DIR}/config
MATOMO_CONF_FILE Configuration file for Matomo. ${MATOMO_CONF_DIR}/config.ini.php
MATOMO_VOLUME_DIR Matomo directory for mounted configuration files. ${BITNAMI_VOLUME_DIR}/matomo
MATOMO_DEFAULT_DATABASE_HOST Default database server host. mariadb
PHP_DEFAULT_MEMORY_LIMIT Default PHP memory limit. 256M

When you start the Matomo 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:
application:
  ...
  environment:
    - MATOMO_PASSWORD=my_password
  ...
  • For manual execution add a -e option with each variable and value:
 docker run -d -e MATOMO_PASSWORD=my_password -p 80:80 --name matomo -v /your/local/path/bitnami/matomo:/bitnami --net=matomo_network bitnami/matomo

Reverse proxy configuration example

This would be an example of reverse proxy configuration:

  application:
  ...
    environment:
      - MATOMO_PROXY_CLIENT_HEADER=HTTP_X_FORWARDED_FOR
      - MATOMO_ENABLE_FORCE_SSL=yes
      - MATOMO_ENABLE_ASSUME_SECURE_PROTOCOL=yes
  ...
  • For manual execution:
 $ docker run -d --name matomo -p 80:80 -p 443:443 \
   --net matomo_network \
   -e MARIADB_HOST=mariadb \
   -e MARIADB_PORT_NUMBER=3306 \
   -e MATOMO_DATABASE_USER=bn_matomo \
   -e MATOMO_DATABASE_NAME=bitnami_matomo \
   -e MATOMO_PROXY_CLIENT_HEADER=HTTP_X_FORWARDED_FOR \
   -e MATOMO_ENABLE_FORCE_SSL=yes \
   -e MATOMO_ENABLE_ASSUME_SECURE_PROTOCOL=yes \
   -v /your/local/path/bitnami/matomo:/bitnami \
 bitnami/matomo:latest

SMTP example

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

  matomo:
    ...
    environment:
      - MATOMO_DATABASE_USER=bn_matomo
      - MATOMO_DATABASE_NAME=bitnami_matomo
      - ALLOW_EMPTY_PASSWORD=yes
      - MATOMO_SMTP_HOST=smtp.gmail.com
      - MATOMO_SMTP_PORT=587
      - MATOMO_SMTP_USER=your_email@gmail.com
      - MATOMO_SMTP_PASSWORD=your_password
  ...
  • For manual execution:
 docker run -d --name matomo -p 80:8080 -p 443:8443 \
    --env MATOMO_DATABASE_USER=bn_matomo \
    --env MATOMO_DATABASE_NAME=bitnami_matomo \
    --env MATOMO_SMTP_HOST=smtp.gmail.com \
    --env MATOMO_SMTP_PORT=587 \
    --env MATOMO_SMTP_USER=your_email@gmail.com \
    --env MATOMO_SMTP_PASSWORD=your_password \
    --network matomo-tier \
    --volume /path/to/matomo-persistence:/bitnami \
    bitnami/matomo:latest

FIPS configuration in Bitnami Secure Images

The Bitnami Matomo Docker image from the Bitnami Secure Images catalog includes extra features and settings to configure the container with FIPS capabilities. You can configure the next environment variables:

  • OPENSSL_FIPS: whether OpenSSL runs in FIPS mode or not. yes (default), no.

Customize this image

The Bitnami Matomo 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/matomo
### Put your customizations below
...

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/matomo

### Change user to perform privileged actions
USER 0

### 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

### Revert to the original non-root user
USER 1001

### 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 use a Docker Compose file like the one below to add other features:

version: '2'
services:
  mariadb:
    image: bitnami/mariadb:latest
    environment:
      - MARIADB_USER=bn_matomo
      - MARIADB_DATABASE=bitnami_matomo
      - ALLOW_EMPTY_PASSWORD=yes
    volumes:
      - mariadb_data:/bitnami
  matomo:
    build: .
    environment:
      - MARIADB_HOST=mariadb
      - MARIADB_PORT_NUMBER=3306
      - MATOMO_DATABASE_USER=bn_matomo
      - MATOMO_DATABASE_NAME=bitnami_matomo
      - ALLOW_EMPTY_PASSWORD=yes
    ports:
      - 80:8181
      - 443:8143
    depends_on:
      - mariadb
    volumes:
      - matomo_data:/bitnami
volumes:
  mariadb_data:
    driver: local
  matomo_data:
    driver: local

Notable Changes

4.15.0-debian-11-r20

From this version on, all Matomo files are persisted (MATOMO_DATA_TO_PERSIST env var). During the upgrade process, they will be replaced (except the config.ini.php file) as suggested in the official documentation

3.14.1-debian-10-r82

  • The size of the container image has been decreased.
  • The configuration logic is now based on Bash scripts in the rootfs/ folder.
  • The Matomo container image has been migrated to a "non-root" user approach. Previously the container ran as the root user and the Apache daemon was started as the daemon user. From now on, both the container and the Apache daemon run as user 1001. You can revert this behavior by changing USER 1001 to USER root in the Dockerfile, or user: root in docker-compose.yml. Consequences:
    • 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 Matomo site by exporting its content, and importing it on a new Matomo container. Follow the steps in Backing up your container and Restoring a backup to migrate the data between the old and new container.

To upgrade a previous Bitnami Matomo 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:

3.9.1-debian-9-r51 and 3.9.1-ol-7-r62

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

Contributing

We'd love for you to contribute to this container. You can request new features by creating an issue or submitting 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 fill the issue template.

License

Copyright © 2025 Broadcom. The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.

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.