What is Matomo?

Matomo is a free and open source web analytics application written by a team of international developers that runs on a PHP/MySQL webserver. It tracks online visits to one or more websites and displays reports on these visits for analysis. As of September 2015, Matomo was used by nearly 900 thousand websites, or 1.3% of all websites, and has been translated to more than 45 languages. New versions are regularly released every few weeks.

https://www.matomo.org/

TL;DR;

Docker Compose

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

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 (DTC). 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.

How to deploy Matomo in Kubernetes?

You can find an example for testing in the file test.yaml. To launch this sample file run:

$ kubectl apply -f test.yaml

NOTE: If you are pulling from a private containers registry, replace the image name with the full URL to the docker image. E.g.

image: 'your-registry/image-name:your-version'

Supported tags and respective `Dockerfile` links

NOTE: Debian 8 images have been deprecated in favor of Debian 9 images. Bitnami will not longer publish new Docker images based on Debian 8.

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

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

docker build -t bitnami/matomo:latest 'https://github.com/bitnami/bitnami-docker-matomo.git#master:3/debian-9'

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/bitnami-docker-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-matomo/master/docker-compose.yml > docker-compose.yml
$ docker-compose up -d

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:

Create a new network for the application and the database:

$ docker network create matomo_network

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

Create volumes for Matomo persistence and launch the container

$ docker volume create --name matomo_data
$ 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 matomo_data:/bitnami \
  bitnami/matomo:latest

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

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

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:

Create a network (if it does not exist):

$ docker network create matomo_network

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

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

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/bitnami-docker-mariadb/blob/master/README.md#upgrade-this-image

Get the updated images:

$ docker pull bitnami/matomo:latest

Stop your container

For docker-compose: $ docker-compose stop matomo
For manual execution: $ docker stop matomo

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.

Remove the currently running container

For docker-compose: $ docker-compose rm -v matomo
For manual execution: $ docker rm -v matomo

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

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.

User and Site configuration

MATOMO_USERNAME: Matomo application username. Default: User
MATOMO_HOST: Matomo application host. Default: 127.0.0.1
MATOMO_PASSWORD: Matomo application password. Default: bitnami
MATOMO_EMAIL: Matomo application email. Default: user@example.com
MATOMO_WEBSITE_NAME: Name of a website to track in Matomo. Default: example
MATOMO_WEBSITE_HOST: Website's host or domain to track in Matomo. Default: https://example.org
MATOMO_ENABLE_PROXY_URI_HEADER: Enable 'proxy_uri_header' in Matomo configuration file. Default: no

Use an existing database

MARIADB_HOST: Hostname for MariaDB server. Default: mariadb
MARIADB_PORT_NUMBER: Port used by MariaDB server. Default: 3306
MATOMO_DATABASE_NAME: Database name that Matomo will use to connect with the database. Default: bitnami_matomo
MATOMO_DATABASE_USER: Database user that Matomo will use to connect with the database. Default: bn_matomo
MATOMO_DATABASE_PASSWORD: Database password that Matomo 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 Matomo using mysql-client

MARIADB_HOST: Hostname for MariaDB server. Default: mariadb
MARIADB_PORT_NUMBER: Port used by MariaDB server. Default: 3306
MARIADB_ROOT_USER: Database admin user. Default: root
MARIADB_ROOT_PASSWORD: Database password for the MARIADB_ROOT_USER 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.
ALLOW_EMPTY_PASSWORD: It can be used to allow blank passwords. Default: no

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

SMTP Configuration

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

SMTP_HOST: Matomo SMTP host.
SMTP_PORT: Matomo SMTP port.
SMTP_USER: Matomo SMTP account user.
SMTP_PASSWORD: Matomo SMTP account password.
SMTP_PROTOCOL: Matomo SMTP protocol to use.

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

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

  application:
  ...
    environment:
      - SMTP_HOST=smtp.gmail.com
      - SMTP_USER=your_email@gmail.com
      - SMTP_PASSWORD=your_password
      - SMTP_PROTOCOL=tls
      - SMTP_PORT=587
  ...

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 SMTP_HOST=smtp.gmail.com \
   -e SMTP_PROTOCOL=TLS \
   -e SMTP_PORT=587 \
   -e SMTP_USER=your_email@gmail.com \
   -e SMTP_PASSWORD=your_password \
   -v /your/local/path/bitnami/matomo:/bitnami \
 bitnami/matomo:latest

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:

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/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
LABEL maintainer "Bitnami <containers@bitnami.com>"

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

version: '2'
services:
  mariadb:
    image: 'bitnami/mariadb:10.3'
    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

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 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 (echo $BITNAMI_IMAGE_VERSION inside the container)
The command you used to run the container, and any relevant output you saw (masking any sensitive information)

License

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.

Name		Name	Last commit message	Last commit date
Latest commit History 922 Commits
.github		.github
3		3
.env.example		.env.example
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
docker-compose.yml		docker-compose.yml
test.yaml		test.yaml

License

irabudev/matomo

Folders and files

Latest commit

History

Repository files navigation

What is Matomo?

TL;DR;

Docker Compose

Why use Bitnami Images?

How to deploy Matomo in Kubernetes?

Supported tags and respective Dockerfile links

Prerequisites

How to get this image

How to use this image

Run the application using Docker Compose

Run the application using the Docker Command Line

Persisting your application

Mount host directories as data volumes with Docker Compose

Mount host directories as data volumes using the Docker command line

Upgrading Matomo

Configuration

Environment variables

User and Site configuration

Use an existing database

Create a database for Matomo using mysql-client

SMTP Configuration

Customize this image

Extend this image

Notable Changes

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

Contributing

Issues

License

About

Topics

Resources

License

Stars

Watchers

Forks

Languages

Supported tags and respective `Dockerfile` links