Introducing our new CEO Don Johnson - Read More

bitnami/mariadb

Verified Publisher

By VMware

Updated 35 minutes ago

Bitnami container image for MariaDB

Image
Databases & Storage
Security
198

500M+

Bitnami package for MariaDB

What is MariaDB?

MariaDB is an open source, community-developed SQL database server that is widely in use around the world due to its enterprise features, flexibility, and collaboration with leading tech firms.

Overview of MariaDB 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 mariadb -e ALLOW_EMPTY_PASSWORD=yes bitnami/mariadb:latest

Warning: These quick setups are only intended for development environments. You are encouraged to change the insecure default credentials and check out the available configuration options in the Configuration section for a more secure deployment.

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 that gives you a small base container image and the familiarity of a leading Linux distribution- or scratch -an explicitly empty image-.
  • All Bitnami images available in Docker Hub are signed with Notation. Check this post to know how to verify the integrity of the images.
  • Bitnami container images are released on a regular basis with the latest distribution packages available.

Looking to use MariaDB in production? Try VMware Tanzu Application Catalog, the commercial edition of the Bitnami catalog.

How to deploy MariaDB 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 MariaDB Chart GitHub repository.

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

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.

Only latest stable branch maintained in the free Bitnami catalog

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.

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.

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.

Get this image

The recommended way to get the Bitnami MariaDB Docker Image is to pull the prebuilt image from the Docker Hub Registry.

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

Persisting your database

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/mariadb path. If the mounted directory is empty, it will be initialized on the first run.

docker run \
    -e ALLOW_EMPTY_PASSWORD=yes \
    -v /path/to/mariadb-persistence:/bitnami/mariadb \
    bitnami/mariadb:latest

or by modifying the docker-compose.yml file present in this repository:

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

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

Connecting to other containers

Using Docker container networking, a MariaDB server running inside a container can easily be accessed by your application containers.

Containers attached to the same network can communicate with each other using the container name as the hostname.

Using the Command Line

In this example, we will create a MariaDB client instance that will connect to the server instance that is running on the same docker network as the client.

Step 1: Create a network

docker network create app-tier --driver bridge

Step 2: Launch the MariaDB server instance

Use the --network app-tier argument to the docker run command to attach the MariaDB container to the app-tier network.

docker run -d --name mariadb-server \
    -e ALLOW_EMPTY_PASSWORD=yes \
    --network app-tier \
    bitnami/mariadb:latest

Step 3: Launch your MariaDB client instance

Finally we create a new container instance to launch the MariaDB client and connect to the server created in the previous step:

docker run -it --rm \
    --network app-tier \
    bitnami/mariadb:latest mysql -h mariadb-server -u root
Using a Docker Compose file

When not specified, Docker Compose automatically sets up a new network and attaches all deployed services to that network. However, we will explicitly define a new bridge network named app-tier. In this example we assume that you want to connect to the MariaDB server from your own custom application image which is identified in the following snippet by the service name myapp.

version: '2'

networks:
  app-tier:
    driver: bridge

services:
  mariadb:
    image: 'bitnami/mariadb:latest'
    environment:
      - ALLOW_EMPTY_PASSWORD=yes
    networks:
      - app-tier
  myapp:
    image: 'YOUR_APPLICATION_IMAGE'
    networks:
      - app-tier

IMPORTANT:

  1. Please update the YOUR_APPLICATION_IMAGE placeholder in the above snippet with your application image
  2. In your application container, use the hostname mariadb to connect to the MariaDB server

Launch the containers using:

docker-compose up -d

Configuration

Environment variables

Customizable environment variables

NameDescriptionDefault Value
ALLOW_EMPTY_PASSWORDAllow MariaDB access without any password.no
MARIADB_AUTHENTICATION_PLUGINMariaDB authentication plugin to configure during the first initialization.nil
MARIADB_ROOT_USERMariaDB database root user.root
MARIADB_ROOT_PASSWORDMariaDB database root user password.nil
MARIADB_USERMariaDB database user to create during the first initialization.nil
MARIADB_PASSWORDPassword for the MariaDB database user to create during the first initialization.nil
MARIADB_DATABASEMariaDB database to create during the first initialization.nil
MARIADB_MASTER_HOSTAddress for the MariaDB master node.nil
MARIADB_MASTER_PORT_NUMBERPort number for the MariaDB master node.3306
MARIADB_MASTER_ROOT_USERMariaDB database root user of the master host.root
MARIADB_MASTER_ROOT_PASSWORDPassword for the MariaDB database root user of the the master host.nil
MARIADB_MASTER_DELAYMariaDB database replication delay.0
MARIADB_REPLICATION_USERMariaDB replication database user.nil
MARIADB_REPLICATION_PASSWORDPassword for the MariaDB replication database user.nil
MARIADB_PORT_NUMBERPort number to use for the MariaDB Server service.nil
MARIADB_REPLICATION_MODEMariaDB replication mode.nil
MARIADB_REPLICATION_SLAVE_DUMPMake a dump on master and update slave MariaDB databasefalse
MARIADB_EXTRA_FLAGSExtra flags to be passed to start the MariaDB Server.nil
MARIADB_INIT_SLEEP_TIMESleep time when waiting for MariaDB init configuration operations to finish.nil
MARIADB_CHARACTER_SETMariaDB collation to use.nil
MARIADB_COLLATEMariaDB collation to use.nil
MARIADB_BIND_ADDRESSMariaDB bind address.nil
MARIADB_SQL_MODEMariaDB Server SQL modes to enable.nil
MARIADB_UPGRADEMariaDB upgrade option.AUTO
MARIADB_SKIP_TEST_DBWhether to skip creating the test database.no
MARIADB_CLIENT_ENABLE_SSLWhether to force SSL for connections to the MariaDB database.no
MARIADB_CLIENT_SSL_CA_FILEPath to CA certificate to use for SSL connections to the MariaDB database server.nil
MARIADB_CLIENT_SSL_CERT_FILEPath to client public key certificate to use for SSL connections to the MariaDB database server.nil
MARIADB_CLIENT_SSL_KEY_FILEPath to client private key to use for SSL connections to the MariaDB database server.nil
MARIADB_CLIENT_EXTRA_FLAGSWhether to force SSL connections with the "mysql" CLI tool. Useful for applications that rely on the CLI instead of APIs.no
MARIADB_STARTUP_WAIT_RETRIESNumber of retries waiting for the database to be running.300
MARIADB_STARTUP_WAIT_SLEEP_TIMESleep time between retries waiting for the database to be running.2
MARIADB_ENABLE_SLOW_QUERYWhether to enable slow query logs.0
MARIADB_LONG_QUERY_TIMEHow much time, in seconds, defines a slow query.10.0

Read-only environment variables

NameDescriptionValue
DB_FLAVORSQL database flavor. Valid values: mariadb or mysql.mariadb
DB_BASE_DIRBase path for MariaDB files.${BITNAMI_ROOT_DIR}/mariadb
DB_VOLUME_DIRMariaDB directory for persisted files.${BITNAMI_VOLUME_DIR}/mariadb
DB_DATA_DIRMariaDB directory for data files.${DB_VOLUME_DIR}/data
DB_BIN_DIRMariaDB directory where executable binary files are located.${DB_BASE_DIR}/bin
DB_SBIN_DIRMariaDB directory where service binary files are located.${DB_BASE_DIR}/sbin
DB_CONF_DIRMariaDB configuration directory.${DB_BASE_DIR}/conf
DB_DEFAULT_CONF_DIRMariaDB default configuration directory.${DB_BASE_DIR}/conf.default
DB_LOGS_DIRMariaDB logs directory.${DB_BASE_DIR}/logs
DB_TMP_DIRMariaDB directory for temporary files.${DB_BASE_DIR}/tmp
DB_CONF_FILEMain MariaDB configuration file.${DB_CONF_DIR}/my.cnf
DB_PID_FILEMariaDB PID file.${DB_TMP_DIR}/mysqld.pid
DB_SOCKET_FILEMariaDB Server socket file.${DB_TMP_DIR}/mysql.sock
DB_DAEMON_USERUsers that will execute the MariaDB Server process.mysql
DB_DAEMON_GROUPGroup that will execute the MariaDB Server process.mysql
MARIADB_DEFAULT_PORT_NUMBERDefault port number to use for the MariaDB Server service.3306
MARIADB_DEFAULT_CHARACTER_SETDefault MariaDB character set.utf8mb4
MARIADB_DEFAULT_BIND_ADDRESSDefault MariaDB bind address.0.0.0.0
Initializing a new instance

When the container is executed for the first time, it will execute the files with extensions .sh, .sql and .sql.gz located at /docker-entrypoint-startdb.d.

In order to have your custom files inside the docker image you can mount them as a volume.

Take into account those scripts are treated differently depending on the extension. While the .sh scripts are executed in all the nodes; the .sql and .sql.gz scripts are only executed in the master nodes. The reason behind this differentiation is that the .sh scripts allow adding conditions to determine what is the node running the script, while these conditions can't be set using .sql nor sql.gz files. This way it is possible to cover different use cases depending on their needs.

NOTE: If you are importing large databases, it is recommended to import them as .sql instead of .sql.gz, as the latter one needs to be decompressed on the fly and not allowing for additional optimizations to import large files.

Passing extra command-line flags to mysqld startup

Passing extra command-line flags to the mysqld service command is possible through the following env var:

  • MARIADB_EXTRA_FLAGS: Flags to be appended to the startup command. No defaults
docker run --name mariadb -e ALLOW_EMPTY_PASSWORD=yes -e MARIADB_EXTRA_FLAGS='--max-connect-errors=1000 --max_connections=155' bitnami/mariadb:latest

or by modifying the docker-compose.yml file present in this repository:

services:
  mariadb:
  ...
    environment:
      - ALLOW_EMPTY_PASSWORD=yes
      - MARIADB_EXTRA_FLAGS=--max-connect-errors=1000 --max_connections=155
  ...
Setting character set and collation

It is possible to configure the character set and collation used by default by the database with the following environment variables:

  • MARIADB_CHARACTER_SET: The default character set to use. Default: utf8
  • MARIADB_COLLATE: The default collation to use. Default: utf8_general_ci
Setting the root password on first run

The root user and password can easily be setup with the Bitnami MariaDB Docker image using the following environment variables:

  • MARIADB_ROOT_USER: The database admin user. Defaults to root.
  • MARIADB_ROOT_PASSWORD: The database admin user password. No defaults.
  • MARIADB_ROOT_PASSWORD_FILE: Path to a file that contains the admin user password. This will override the value specified in MARIADB_ROOT_PASSWORD. No defaults.

Passing the MARIADB_ROOT_PASSWORD environment variable when running the image for the first time will set the password of the MARIADB_ROOT_USER user to the value of MARIADB_ROOT_PASSWORD.

docker run --name mariadb -e MARIADB_ROOT_PASSWORD=password123 bitnami/mariadb:latest

or by modifying the docker-compose.yml file present in this repository:

services:
  mariadb:
  ...
    environment:
      - MARIADB_ROOT_PASSWORD=password123
  ...

Warning The MARIADB_ROOT_USER user is always created with remote access. It's suggested that the MARIADB_ROOT_PASSWORD env variable is always specified to set a password for the MARIADB_ROOT_USER user. In case you want to allow the MARIADB_ROOT_USER user to access the database without a password set the environment variable ALLOW_EMPTY_PASSWORD=yes. This is recommended only for development.

Allowing empty passwords

By default the MariaDB image expects all the available passwords to be set. In order to allow empty passwords, it is necessary to set the ALLOW_EMPTY_PASSWORD=yes env variable. This env variable is only recommended for testing or development purposes. We strongly recommend specifying the MARIADB_ROOT_PASSWORD for any other scenario.

docker run --name mariadb -e ALLOW_EMPTY_PASSWORD=yes bitnami/mariadb:latest

or by modifying the docker-compose.yml file present in this repository:

services:
  mariadb:
  ...
    environment:
      - ALLOW_EMPTY_PASSWORD=yes
  ...
Creating a database on first run

By passing the MARIADB_DATABASE environment variable when running the image for the first time, a database will be created. This is useful if your application requires that a database already exists, saving you from having to manually create the database using the MySQL client.

docker run --name mariadb \
    -e ALLOW_EMPTY_PASSWORD=yes \
    -e MARIADB_DATABASE=my_database \
    bitnami/mariadb:latest

or by modifying the docker-compose.yml file present in this repository:

services:
  mariadb:
  ...
    environment:
      - ALLOW_EMPTY_PASSWORD=yes
      - MARIADB_DATABASE=my_database
  ...
Creating a database user on first run

You can create a restricted database user that only has permissions for the database created with the MARIADB_DATABASE environment variable. To do this, provide the MARIADB_USER environment variable and to set a password for the database user provide the MARIADB_PASSWORD variable (alternatively, you can set the MARIADB_PASSWORD_FILE with the path to a file that contains the user password). MariaDB supports different authentication mechanisms, such as pam or mysql_native_password. To set it, use the MARIADB_AUTHENTICATION_PLUGIN variable.

docker run --name mariadb \
  -e ALLOW_EMPTY_PASSWORD=yes \
  -e MARIADB_USER=my_user \
  -e MARIADB_PASSWORD=my_password \
  -e MARIADB_DATABASE=my_database \
  bitnami/mariadb:latest

or by modifying the docker-compose.yml file present in this repository:

services:
  mariadb:
  ...
    environment:
      - ALLOW_EMPTY_PASSWORD=yes
      - MARIADB_USER=my_user
      - MARIADB_PASSWORD=my_password
      - MARIADB_DATABASE=my_database
  ...

Note! The root user will be created with remote access and without a password if ALLOW_EMPTY_PASSWORD is enabled. Please provide the MARIADB_ROOT_PASSWORD env variable instead if you want to set a password for the root user.

Disable creation of test database

By default MariaDB creates a test database. In order to disable the creation of this test database, the flag --skip-test-db can be passed to mysql_install_db. This function is only on MariaDB >= 10.5.

To disable the test database in the Bitnami MariaDB container, set the MARIADB_SKIP_TEST_DB environment variable to yes during the first boot of the container.

docker run --name mariadb \
    -e ALLOW_EMPTY_PASSWORD=yes \
    -e MARIADB_SKIP_TEST_DB=yes \
    bitnami/mariadb:latest

or by modifying the docker-compose.yml file present in this repository:

services:
  mariadb:
  ...
    enviro

_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/mariadb/README.md_

Docker Pull Command

docker pull bitnami/mariadb
Bitnami