library/mariadb

Quick reference

• Maintained by:
  [] [] with contributions from our https://github.com/MariaDB/mariadb-docker

• Where to get help:
  https://dba.stackexchange.com/questions/tagged/docker+mariadb, https://mariadb.com/kb/en/docker-and-mariadb/ (https://mariadb.com/kb/en/docker-and-mariadb/ask).

Also see the https://mariadb.com/kb/en/getting-help-with-mariadb/.

Supported tags and respective Dockerfile links

Note: the description for this image is longer than the Hub length limit of 25000, so the "Supported tags" list has been trimmed to compensate. See also https://github.com/docker/hub-feedback/issues/238 and https://github.com/docker/roadmap/issues/475.

• See https://github.com/docker-library/docs/tree/master/mariadb/README.md#supported-tags-and-respective-dockerfile-links

Quick reference (cont.)

• Where to file issues:
  Issues can be filed on https://jira.mariadb.org/ under the "MDEV" Project and "Docker" Component, or on https://github.com/MariaDB/mariadb-docker/issues

• Supported architectures: (https://github.com/docker-library/official-images#architectures-other-than-amd64)
  https://hub.docker.com/r/amd64/mariadb/, https://hub.docker.com/r/arm64v8/mariadb/, https://hub.docker.com/r/ppc64le/mariadb/, https://hub.docker.com/r/s390x/mariadb/

• Published image artifact details:
  https://github.com/docker-library/repo-info/blob/master/repos/mariadb (https://github.com/docker-library/repo-info/commits/master/repos/mariadb)
  (image metadata, transfer size, etc)

• Image updates:
  https://github.com/docker-library/official-images/issues?q=label%3Alibrary%2Fmariadb
  https://github.com/docker-library/official-images/blob/master/library/mariadb (https://github.com/docker-library/official-images/commits/master/library/mariadb)

• Source of this description:
  https://github.com/docker-library/docs/tree/master/mariadb (https://github.com/docker-library/docs/commits/master/mariadb)

What is MariaDB?

MariaDB Server is one of the most popular database servers in the world. It's made by the original developers of MySQL and guaranteed to stay open source. Notable users include ***, DBS Bank, and ServiceNow.

The intent is also to maintain high compatibility with MySQL, ensuring a library binary equivalency and exact matching with MySQL APIs and commands. MariaDB developers continue to develop new features and improve performance to better serve its users.

How to use this image

The mariadb has a number of tags, and of note is latest, as the latest stable version, and lts, as the last long term support release.

Image architecture requirements:

Running the container

Configuration

Port binding

By default, the database running within the container will listen on port 3306. You can expose the container port 3306 to the host port 3306 with the -p 3306:3306 argument to docker run, like the command below:

console
$ docker run --name some-mariadb -p 3306:3306 mariadb:latest

Starting using a minimal configuration

The environment variables required to use this image involves the setting of the root user password:

console
$ docker run --detach --name some-mariadb --env MARIADB_ROOT_PASSWORD=my-secret-pw mariadb:latest

or:

console
$ docker run --detach --name some-mariadb --env MARIADB_ALLOW_EMPTY_ROOT_PASSWORD=1 mariadb:latest

or:

console
$ docker run --detach --name some-mariadb --env MARIADB_RANDOM_ROOT_PASSWORD=1 mariadb:latest

... where the container logs will contain the generated root password.

... via https://github.com/docker/compose

Example compose.yaml for mariadb:

yaml
# Use root/example as user/password credentials

services:

  db:
    image: mariadb
    restart: always
    environment:
      MARIADB_ROOT_PASSWORD: example

  adminer:
    image: adminer
    restart: always
    ports:
      - 8080:8080

Run docker compose up, wait for it to initialize completely, and visit http://localhost:8080 or http://host-ip:8080 (as appropriate).

Start a mariadb server instance with user, password and database

Starting a MariaDB instance with a user, password, and a database:

console
$ docker run --detach --name some-mariadb --env MARIADB_USER=example-user --env MARIADB_PASSWORD=my_cool_secret --env MARIADB_DATABASE=exmple-database --env MARIADB_ROOT_PASSWORD=my-secret-pw mariadb:latest

Start a mariadb server instance in a network

As applications talk to MariaDB, MariaDB needs to start in the same network as the application:

console
$ docker network create some-network 
$ docker run --detach --network some-network --name some-mariadb --env MARIADB_USER=example-user --env MARIADB_PASSWORD=my_cool_secret --env MARIADB_ROOT_PASSWORD=my-secret-pw mariadb:latest
$ docker run --detach --network some-network --name some-application --env APP_DB_HOST=some-mariadb --env APP_DB_USER=example-user --env APP_DB_PASSWD=my_cool_secret some-application

... where some-network is a newly created network (other than bridge as the default network), some-mariadb is the name you want to assign to your container, my-secret-pw is the password to be set for the MariaDB root user. See the list above for relevant tags to match your needs and environment. some-application and then environment variable APP_DB_HOST, APP_DB_USER and APP_DB_PASSWD are the application's configuration for its database connection.

Connect to MariaDB from the MariaDB command line client

The following command starts another mariadb container instance and runs the mariadb command line client against your original mariadb container, allowing you to execute SQL statements against your database instance:

console
$ docker run -it --network some-network --rm mariadb mariadb -h some-mariadb -u example-user

... where some-mariadb is the name of your original mariadb container (connected to the some-network Docker network).

This image can also be used as a client for non-Docker or remote instances:

console
$ docker run -it --rm mariadb mariadb --host <server container IP> --user example-user --password --database test

That will give you a standard MariaDB prompt. You can test it with:

console
MariaDB [test]> \s
--------------
mariadb from 12.3.3-MariaDB, client 15.2 for debian-linux-gnu (x86_64) using  EditLine wrapper

Connection id:		5
Current database:	test
Current user:		example-user@10.89.0.5
SSL:			Cipher in use is TLS_AES_256_GCM_SHA384, cert is OK
Current pager:		stdout
Using outfile:		''
Using delimiter:	;
Server:			MariaDB
Server version:		12.3.3-MariaDB-ubu2404 mariadb.org binary distribution
Protocol version:	10
Connection:		m via TCP/IP
Server characterset:	utf8mb4
Db     characterset:	utf8mb4
Client characterset:	utf8mb4
Conn.  characterset:	utf8mb4
TCP port:		3306
Uptime:			3 min 7 sec

Threads: 1  Questions: 12  Slow queries: 0  Opens: 17  Open tables: 10  Queries per second avg: 0.064
--------------

... which will give you the version and connection information. You can then use exit to leave the MariaDB command line client and the client container.

More information about the MariaDB command-line client can be found in the https://mariadb.com/docs/server/clients-and-utilities/mariadb-client/mariadb-command-line-client.

Container shell access

The docker exec command allows you to run commands inside the running container. The following command line will give you a bash shell inside your mariadb container:

console
$ docker exec -it some-mariadb bash

MariaDB-Backup

As MariaDB-Backup is highly coupled with the server version, it can be useful to use the mariadb-backup in the mariadb container of an explicit version:

console
$ docker run --volume /backup-volume:/backup --rm mariadb:10.6.15 mariadb-backup --help

Container viewing MariaDB logs

The log is available through Docker's container log:

console
$ docker logs some-mariadb

Using a custom MariaDB configuration file

Custom configuration files should end in .cnf and be mounted read only at the directory /etc/mysql/conf.d. These files should contain the minimal changes from the MariaDB workload required for your application/environment. A MariaDB configuration file will have a [mariadb] group followed by variable = value settings per https://mariadb.com/kb/en/server-system-variables/#setting-server-system-variables or https://mariadb.com/kb/en/configuring-mariadb-with-option-files/#option-prefixes.

The mariadb image configuration contains the Ubuntu MariaDB variables with two custom changes for the container:

• https://mariadb.com/kb/en/server-system-variables/#host_cache_size
• https://mariadb.com/kb/en/server-system-variables/#skip_name_resolve

These disable the authentication of user@hostname users. To re-enable the skip-name-resolve use disable-skip-name-resolve as variable or argument. When enabled, the host-cache-size should be sufficient for the number of containers connecting to the mariadb.

To view the resulting configuration of your mariadb container:

console
$ docker run --name some-mariadb -v /my/custom:/etc/mysql/conf.d --rm mariadb:latest my_print_defaults --mariadbd

Configuration without a cnf file

Many configuration options can be passed as flags to mariadbd. This will give you the flexibility to customize the container without needing a cnf file. For example, if you want to run on port 3808 just run the following:

console
$ docker run --name some-mariadb -e MARIADB_ROOT_PASSWORD=my-secret-pw -d mariadb:latest --port 3808

If you would like to see a complete list of available options, just run:

console
$ docker run --rm mariadb:latest --verbose --help

Environment Variables

When you start the mariadb image, you can adjust the initialization of the MariaDB instance by passing one or more environment variables on the docker run command line. Do note that all of the variables, except MARIADB_AUTO_UPGRADE, will have no effect if you start the container with a data directory that already contains a database. I.e. any pre-existing database will always be left untouched on container startup.

One of MARIADB_RANDOM_ROOT_PASSWORD, MARIADB_ROOT_PASSWORD_HASH, MARIADB_ROOT_PASSWORD or MARIADB_ALLOW_EMPTY_ROOT_PASSWORD (or equivalents, including *_FILE), is required. The other environment variables are optional.

There is a large list of environment variables and the complete list is documented on https://mariadb.com/kb/en/mariadb-server-docker-official-image-environment-variables/.

MARIADB_AUTO_UPGRADE

When this environment variable is set, this will run the https://mariadb.com/kb/en/mariadb-upgrade/, if needed, so any changes in the MariaDB system tables required to expose new features will be made. This may impeed some https://mariadb.com/kb/en/downgrading-between-major-versions-of-mariadb/. Unless the environment variable MARIADB_DISABLE_UPGRADE_BACKUP is set, there will be a backup of the system tables created as system_mysql_backup_*.sql.zst in the top level of the data directory to assist in the downgrade if needed.

Secrets

As an alternative to passing sensitive information via environment variables, _FILE may be appended to the previously listed environment variables, causing the initialization script to load the values for those variables from files present in the container. In particular, this can be used to load passwords from Docker secrets stored in /run/secrets/<secret_name> files. For example:

console
$ docker run --name some-mysql -e MARIADB_ROOT_PASSWORD_FILE=/run/secrets/mariadb-root -d mariadb:latest

Initializing the database contents

When a container is started for the first time, a new database with the specified name will be created and initialized with the provided configuration variables. Furthermore, it will execute files with extensions .sh, .sql, .sql.gz, .sql.xz and .sql.zst that are found in /docker-entrypoint-initdb.d. Files will be executed in alphabetical order. .sh files without file execute permission are sourced rather than executed. You can easily populate your mariadb services by https://docs.docker.com/storage/bind-mounts/ and provide https://docs.docker.com/reference/dockerfile/ with contributed data. SQL files will be imported by default to the database specified by the MARIADB_DATABASE variable.

Caveats

Where to Store Data

Important note: There are several ways to store data used by applications that run in Docker containers. We encourage users of the mariadb images to familiarize themselves with the options available, including:

• Use a named volume using the container manager to manage the storage of your database data https://docs.docker.com/storage/volumes/. This is the default and is easy and fairly transparent to the user. The downside is that the files may be hard to locate for tools and applications that run directly on the host system, i.e. outside containers.
• Create a data directory on the host system (outside the container) and https://docs.docker.com/storage/bind-mounts/. This places the database files in a known location on the host system, and makes it easy for tools and applications on the host system to access the files. The downside is that the user needs to make sure that the directory exists, and that e.g. directory permissions and other security mechanisms on the host system are set up correctly.

The Docker documentation is a good starting point for understanding the different storage options and variations, and there are multiple blogs and forum postings that discuss and give advice in this area. We will simply show the basic procedure here for the latter option above:

1. Create a data directory on a suitable volume on your host system, e.g. /my/own/datadir.

2. Start your mariadb container like this:

   console
   $ docker run --name some-mariadb -v /my/own/datadir:/var/lib/mysql:Z -e MARIADB_ROOT_PASSWORD=my-secret-pw -d mariadb:latest
   

The -v /my/own/datadir:/var/lib/mysql:Z part of the command mounts the /my/own/datadir directory from the underlying host system as /var/lib/mysql inside the container, where MariaDB by default will write its data files.

No connections until MariaDB init completes

If there is no database initialized when the container starts, then a default database will be created. While this is the expected behavior, this means that it will not accept incoming connections until such initialization completes. This may cause issues when using automation tools, such as docker compose, which start several containers simultaneously.

Health/Liveness/Readiness Checking

See https://github.com/docker-library/faq#healthcheck for why there is no default HEALTHCHECK directive. However, you can use the healthcheck.sh script to choose from a (non-exhaustive) list of tests to check for whatever you *** health/liveness/readiness. Refer to the https://mariadb.com/docs/server/server-management/automated-mariadb-deployment-and-administration/docker-and-mariadb/using-healthcheck-sh to learn about how to use it and which exact tests are provided.

Usage against an existing database

If you start your mariadb container instance with a data directory that already contains a database (specifically, a mysql subdirectory), no environment variables that control initialization will be needed or examined, and no pre-existing databases will be changed. The only exception is the non-default MARIADB_AUTO_UPGRADE environment variable, that might cause mysql_upgrade/mariadb-upgrade to run, which might change the system tables.

Backups and Restores

Backing up and restoring databases is important in containers too. The documentation on how to do this can be found on the https://mariadb.com/docs/server/server-management/automated-mariadb-deployment-and-administration/docker-and-mariadb/container-backup-and-restoration.

Frequently Asked Questions / How to reset root and user passwords

This is documented on https://mariadb.com/docs/server/server-management/automated-mariadb-deployment-and-administration/docker-and-mariadb/docker-official-image-frequently-asked-questions#how-to-reset-passwords.

How to install MariaDB plugins

This is documented on https://mariadb.com/docs/server/server-management/automated-mariadb-deployment-and-administration/docker-and-mariadb/adding-plugins-to-the-mariadb-docker-official-image.

Related Images

• https://hub.docker.com/r/mariadb/maxscale/tags

Compose File Examples

Example compose files using this mariadb are located in https://github.com/MariaDB/mariadb-docker in the /examples folder.

License

View https://mariadb.com/kb/en/library/licensing-faq/ for the software contained in this image.

As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

Some additional license information which was able to be auto-detected might be found in https://github.com/docker-library/repo-info/tree/master/repos/mariadb.

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.