docker-documentation/images/docker-mariadb.md

title
mariadb

linuxserver/mariadb

Mariadb is one of the most popular database servers. Made by the original developers of MySQL.

Supported Architectures

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling lscr.io/linuxserver/mariadb:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Architecture	Available	Tag
x86-64	✅	amd64-<version tag>
arm64	✅	arm64v8-<version tag>
armhf	✅	arm32v7-<version tag>

Application Setup

If you didn't set a password during installation, (see logs for warning) use mysqladmin -u root password <PASSWORD> to set one at the docker prompt...

NOTE changing the MYSQL_ROOT_PASSWORD variable after the container has set up the initial databases has no effect, use the mysqladmin tool to change your mariadb password.

NOTE if you want to use (MYSQL_DATABASE MYSQL_USER MYSQL_PASSWORD) all three of these variables need to be set you cannot pick and choose.

Unraid users, it is advisable to edit the template/webui after setup and remove reference to this variable.

Find custom.cnf in /config for config changes (restart container for them to take effect) , the databases in /config/databases and the log in /config/log/myqsl

Loading passwords and users from files

The MYSQL_ROOT_PASSWORD MYSQL_DATABASE MYSQL_USER MYSQL_PASSWORD REMOTE_SQL env values can be set in a file:

/config/env

Using the following format:

MYSQL_ROOT_PASSWORD="ROOT_ACCESS_PASSWORD"
MYSQL_DATABASE="USER_DB_NAME"
MYSQL_USER="MYSQL_USER"
MYSQL_PASSWORD="DATABASE_PASSWORD"
REMOTE_SQL="http://URL1/your.sql,https://URL2/your.sql"

These settings can be mixed and matched with Docker ENV settings as you require, but the settings in the file will always take precedence.

Bootstrapping a new instance

We support a one time run of custom sql files on init. In order to use this place *.sql files in:

/config/initdb.d/

This will have the same effect as setting the REMOTE_SQL environment variable. The sql will only be run on the containers first boot and setup.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

docker-compose (recommended, click here for more info)

---
version: "2.1"
services:
  mariadb:
    image: lscr.io/linuxserver/mariadb:latest
    container_name: mariadb
    environment:
      - PUID=1000
      - PGID=1000
      - MYSQL_ROOT_PASSWORD=ROOT_ACCESS_PASSWORD
      - TZ=Europe/London
      - MYSQL_DATABASE=USER_DB_NAME #optional
      - MYSQL_USER=MYSQL_USER #optional
      - MYSQL_PASSWORD=DATABASE_PASSWORD #optional
      - REMOTE_SQL=http://URL1/your.sql,https://URL2/your.sql #optional
    volumes:
      - path_to_data:/config
    ports:
      - 3306:3306
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=mariadb \
  -e PUID=1000 \
  -e PGID=1000 \
  -e MYSQL_ROOT_PASSWORD=ROOT_ACCESS_PASSWORD \
  -e TZ=Europe/London \
  -e MYSQL_DATABASE=USER_DB_NAME `#optional` \
  -e MYSQL_USER=MYSQL_USER `#optional` \
  -e MYSQL_PASSWORD=DATABASE_PASSWORD `#optional` \
  -e REMOTE_SQL=http://URL1/your.sql,https://URL2/your.sql `#optional` \
  -p 3306:3306 \
  -v path_to_data:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/mariadb:latest

Parameters

Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (-p)

Parameter	Function
3306	Mariadb listens on this port.

Environment Variables (-e)

Env	Function
PUID=1000	for UserID - see below for explanation
PGID=1000	for GroupID - see below for explanation
MYSQL_ROOT_PASSWORD=ROOT_ACCESS_PASSWORD	Set this to root password for installation (minimum 4 characters).
TZ=Europe/London	Specify a timezone to use EG Europe/London.
MYSQL_DATABASE=USER_DB_NAME	Specify the name of a database to be created on image startup.
MYSQL_USER=MYSQL_USER	This user will have superuser access to the database specified by MYSQL_DATABASE (do not use root here).
MYSQL_PASSWORD=DATABASE_PASSWORD	Set this to the password you want to use for you MYSQL_USER (minimum 4 characters).
REMOTE_SQL=http://URL1/your.sql,https://URL2/your.sql	Set this to ingest sql files from an http/https endpoint (comma seperated array).

Volume Mappings (-v)

Volume	Function
/config	Contains the db itself and all assorted settings.

Miscellaneous Options

Parameter	Function

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__PASSWORD=/run/secrets/mysecretpassword

Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id user as below:

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Docker Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info

• Shell access whilst the container is running:
  • docker exec -it mariadb /bin/bash
• To monitor the logs of the container in realtime:
  • docker logs -f mariadb
• Container version number
  • docker inspect -f '{{ index .Config.Labels "build_version" }}' mariadb
• Image version number
  • docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/mariadb:latest

Versions

• 06.07.21: - Rebase master to alpine.
• 03.07.21: - Rebase to 3.14.
• 08.02.21: - Fix new installs.
• 08.02.21: - Rebase to alpine. Add mariadb-backup.
• 08.02.21: - Release alpine tag. The alpine release will replace the latest tag in the near future.
• 27.10.19: - Bump to 10.4, ability use custom sql on initial init ,defining root passwords via file.
• 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
• 07.03.19: - Add ability to setup a database and default user on first spinup.
• 26.01.19: - Add pipeline logic and multi arch.
• 10.09.18: - Rebase to ubuntu bionic and use 10.3 mariadb repository.
• 09.12.17: - Fix continuation lines.
• 12.09.17: - Gracefully shut down mariadb.
• 27.10.16: - Implement linting suggestions on database init script.
• 11.10.16: - Rebase to ubuntu xenial, add version labelling.
• 09.03.16: - Update to mariadb 10.1. Change to use custom.cnf over my.cnf in /config. Restructured init files to change config options on startup, rather than in the dockerfile.
• 26.01.16: - Change user of mysqld_safe script to abc, better unclean shutdown handling on restart.
• 23.12.15: - Remove autoupdating, between some version updates the container breaks.
• 12.08.15: - Initial Release.