bitnami/matomo
Bitnami container image for Matomo
10M+
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.
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.
Looking to use Matomo in production? Try VMware Tanzu Application Catalog, the commercial edition of the Bitnami catalog.
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.
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.
Dockerfile
linksLearn 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.
To run this application you need Docker Engine >= 1.10.0
. Docker Compose is recommended with a version 1.6.0
or later.
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 .
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.
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: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/
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.
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:
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
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 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
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
Get the updated images:
docker pull bitnami/matomo:latest
Stop your container
$ docker-compose stop matomo
$ 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
$ docker-compose rm -v matomo
$ docker rm -v matomo
Run the new image
$ docker-compose up matomo
docker run --name matomo bitnami/matomo:latest
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_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 | 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:
docker-compose.yml
file present in this repository:application:
...
environment:
- MATOMO_PASSWORD=my_password
...
-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:
docker-compose.yml
file present in this repository: application:
...
environment:
- MATOMO_PROXY_CLIENT_HEADER=HTTP_X_FORWARDED_FOR
- MATOMO_ENABLE_FORCE_SSL=yes
- MATOMO_ENABLE_ASSUME_SECURE_PROTOCOL=yes
...
$ 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:
docker-compose.yml
file present in this repository: 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
...
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
The Bitnami Matomo Docker image is designed to be extended so it can be used as the base image for your custom web applications.
Before extending this image, please note there are certain configuration settings you can modify using the original image:
APACHE_HTTP_PORT_NUMBER
and APACHE_HTTPS_PORT_NUMBER
respectively.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:
vim
editorFROM 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
_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/matomo/README.md_