Portainer Templates logo

Portainer Templates

Mariadb Mariadb

Container

Databases

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

Image details

Pulls: 417.9M
Architecture: amd64, arm64
Image size: 105 MB
Latest: 11.8.8
User: linuxserver
Created: Oct 13, 2015
Updated: 11 days ago
Status: active

Configuration

Type
Container
Platform
linux
Image
linuxserver/mariadb:latest
Ports
3306:3306/tcp
Volumes
/config : /srv/lsio/mariadb/config
Env vars
PUID=1000PGID=1000TZ=Etc/UTCMYSQL_ROOT_PASSWORD=ROOT_ACCESS_PASSWORDMYSQL_DATABASE=USER_DB_NAMEMYSQL_USER=MYSQL_USERMYSQL_PASSWORD=DATABASE_PASSWORDREMOTE_SQL=http://URL1/your.sql,https://URL2/your.sqlCLI_OPTS=
Restart
unless-stopped

Template by technorabilia

Notes

Portainer App Templates by Technorabilia, based on data provided by LinuxServer.io.

Ensure to create the following volume directories on the host file system, or modify the paths in the volume mapping section under the advanced options below, as needed.

mkdir -p /srv/lsio/mariadb/config

Standalone Install

Select an install method, to see config/commands for deploying Mariadb

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Mariadb, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo

More install options in our documentation.

linuxserver.io
Blog Discord Discourse GitHub Open Collective
The LinuxServer.io team brings you another container release featuring:
  • regular and timely application updates
  • easy user mappings (PGID, PUID)
  • custom base image with s6 overlay
  • weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
  • regular security updates

Find us at:
  • Blog - all the things you can do with our containers including How-To guides, opinions and much more!
  • Discord - realtime support / chat with the community and the team.
  • Discourse - post on our community forum.
  • GitHub - view the source for all of our repositories.
  • Open Collective - please consider helping us by either donating or contributing to our budget

linuxserver/mariadb

Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI
Mariadb is one of the most popular database servers. Made by the original developers of MySQL.
mariadb

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:
ArchitectureAvailableTag
x86-64amd64-\
arm64arm64v8-\

Application Setup

Root via localhost (docker exec) no longer requires a password according to upstream behavior, if you didn't set a root password for remote access during the initial start follow the instructions in the container log.
NOTE changing any of the MYSQL variables after the container has set up the initial databases has no effect, use the mysqladmin tool or cli to make changes.
NOTE if you want to use (MYSQL
DATABASE MYSQLUSER MYSQLPASSWORD) 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.

Check and Repair

If user databases are not in a healthy state (sometimes caused by a failed upgrade), it may be remedied by running:
mariadb-check -c -A # check all databases for errors
mariadb-check -r -A # repair all databases
mariadb-check -a -A # analyze all databases
mariadb-check -o -A # optimize all databases

After running the above commands, you may need to run the upgrade command again.

Upgrading

When this container initializes, if MYSQL_ROOT_PASSWORD is set an upgrade check will run. If an upgrade is required the log will indicate the need stop any services that are accessing databases in this container, and then run the command:
mariadb-upgrade

Read-Only Operation

This image can be run with a read-only container filesystem. For details please read the docs.

Caveats

  • /tmp must be mounted to tmpfs
  • Not supported on first run

Non-Root Operation

This image can be run with a non-root user. For details please read the docs.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.
>!NOTE >Unless a parameter is flagged as 'optional', it is mandatory and a value must be provided.

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

---
services:
  mariadb:
    image: lscr.io/linuxserver/mariadb:latest
    container_name: mariadb
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - MYSQL_ROOT_PASSWORD=ROOT_ACCESS_PASSWORD
      - 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
      - CLI_OPTS= #optional
    volumes:
      - /path/to/mariadb/config:/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 TZ=Etc/UTC \
  -e MYSQL_ROOT_PASSWORD=ROOT_ACCESS_PASSWORD \
  -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` \
  -e CLI_OPTS= `#optional` \
  -p 3306:3306 \
  -v /path/to/mariadb/config:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/mariadb:latest

Parameters

Containers 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.
ParameterFunction
-p 3306:3306MariaDB listens on this port.
-e PUID=1000for UserID - see below for explanation
-e PGID=1000for GroupID - see below for explanation
-e TZ=Etc/UTCspecify a timezone to use, see this list.
-e MYSQLROOTPASSWORD=ROOTACCESSPASSWORDSet this to root password for installation (minimum 4 characters & non-alphanumeric passwords must be properly escaped). (valid only for first run)
-e MYSQLDATABASE=USERDBNAMESpecify the name of a database to be created. (valid only for first run)
-e MYSQLUSER=MYSQLUSERThis user will have superuser access to the database specified by MYSQLDATABASE (do not use root here). (valid only for first run)
-e MYSQLPASSWORD=DATABASEPASSWORDSet this to the password you want to use for you MYSQLUSER (minimum 4 characters & non-alphanumeric passwords must be properly escaped). (valid only for first run)
-e REMOTESQL=http://URL1/your.sql,https://URL2/your.sqlSet this to ingest sql files from an http/https endpoint (comma seperated array).
-e CLIOPTS=Pass CLI options to mariadbd via mariadbd-safe. Use with caution as mariadbd option precedence is complex.
-v /configPersistent config files
--read-only=trueRun container with a read-only filesystem. Please read the docs.
--user=1000:1000Run container with a non-root user. Please read the docs.

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__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable 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 your_user as below:
id your_user

Example output:
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods

Docker Mods Docker Universal 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:
```bash
docker exec -it mariadb /bin/bash
```
  • To monitor the logs of the container in realtime:
```bash
docker logs -f mariadb
```
  • Container version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' mariadb
```
  • Image version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/mariadb:latest
```

Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.
Below are the instructions for updating containers:

Via Docker Compose

  • Update images:
* All images:

    ```bash
    docker-compose pull
    ```

* Single image:

    ```bash
    docker-compose pull mariadb
    ```
  • Update containers:
* All containers:

    ```bash
    docker-compose up -d
    ```

* Single container:

    ```bash
    docker-compose up -d mariadb
    ```
  • You can also remove the old dangling images:
```bash
docker image prune
```

Via Docker Run

  • Update the image:
```bash
docker pull lscr.io/linuxserver/mariadb:latest
```
  • Stop the running container:
```bash
docker stop mariadb
```
  • Delete the container:
```bash
docker rm mariadb
```
  • Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
  • You can also remove the old dangling images:
```bash
docker image prune
```

Image Update Notifications - Diun (Docker Image Update Notifier)

>!TIP >We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:
git clone https://github.com/linuxserver/docker-mariadb.git
cd docker-mariadb
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/mariadb:latest .

The ARM variants can be built on x8664 hardware and vice versa using lscr.io/linuxserver/qemu-static
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Versions

  • 05.07.26: - Rebase to Alpine 3.24.
  • 14.02.25: - Rebase to Alpine 3.23. Add ability to pass CLI options to mariadbd.
  • 09.07.25: - Rebase to Alpine 3.22.
  • 11.01.25: - Add log rotation, follow the instructions in the container log.
  • 06.01.25: - Rebase to Alpine 3.21.
  • 31.05.24: - Rebase to Alpine 3.20.
  • 23.12.23: - Rebase to Alpine 3.19.
  • 09.06.23: - Update lcmessages path in shipped custom.cnf to match upstream.
  • 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
  • 04.02.23: - Minor updates to defaults in custom.cnf.
  • 31.01.23: - Rebase to 3.17.
  • 09.12.22: - Add upgrade check warning.
  • 11.10.22: - Rebase master to Alpine 3.16, migrate to s6v3, remove password escape logic which caused problems for a small subset of users.
  • 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 mysqldsafe 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.

Serve Mariadb on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying mariadb.example.com to http://Mariadb:3306

Add this to your Caddyfile

mariadb.example.com {
	reverse_proxy http://Mariadb:3306
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs Mariadb
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:3306 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :3306
  • Stop the other service, or pick a different host port. In 3306:3306 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:3306. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, Mariadb can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 3306

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /srv/lsio/mariadb/config
  • Or set the PUID and PGID variables (defaults 1000:1000) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull linuxserver/mariadb:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect Mariadb --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Required settings are blank

CLI_OPTS has no default value, and Mariadb may crash or misbehave if left empty.

  • Fill it in on the deploy screen before hitting deploy.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A single container

Mariadb runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything Mariadb needs bundled into one download. This template pulls linuxserver/mariadb:latest, which Docker fetches once (about 105 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Mariadb's comes from Docker Hub, published by linuxserver.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is 11.8.8. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 3306:3306 means it's reachable on port 3306 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 3306:3306

Volumes

A volume is where Mariadb keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /config from /srv/lsio/mariadb/config on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Mariadb takes 9 of them, and one needs a value before it'll start properly:

  • PUID, defaults to 1000. Run 'id [USER]' for the owner of the host volume directories to get the UID to use here.
  • PGID, defaults to 1000. Run 'id [USER]' for the owner of the host volume directories to get the GID to use here.
  • TZ, defaults to Etc/UTC. Specify a timezone to use, see this list.
  • MYSQL_ROOT_PASSWORD, defaults to ROOT_ACCESS_PASSWORD. Set this to root password for installation (minimum 4 characters & non-alphanumeric passwords must be properly escaped). (valid only for first run)
  • MYSQL_DATABASE, defaults to USER_DB_NAME. Specify the name of a database to be created. (valid only for first run) [OPTIONAL]
  • MYSQL_USER, defaults to MYSQL_USER. This user will have superuser access to the database specified by MYSQLDATABASE (do not use root here). (valid only for first run) [OPTIONAL]
  • MYSQL_PASSWORD, defaults to DATABASE_PASSWORD. Set this to the password you want to use for you MYSQLUSER (minimum 4 characters & non-alphanumeric passwords must be properly escaped). (valid only for first run) [OPTIONAL]
  • REMOTE_SQL, defaults to http://URL1/your.sql,https://URL2/your.sql. Set this to ingest sql files from an http/https endpoint (comma seperated array). [OPTIONAL]
  • CLI_OPTS, needs a value. Pass CLI options to mariadbd via mariadbd-safe. Use with caution as mariadbd option precedence is complex. [OPTIONAL]

Restart policy

The restart policy here is unless-stopped, so Docker restarts Mariadb after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Users and permissions

The PUID and PGID settings tell it which user and group to act as on your host. Point them at your own account (find yours with id $USER) so the files it writes into your mounted folders come out owned by you rather than root.

Networking

Nothing custom is set, so Mariadb sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container Mariadb. That's what you'll spot in the containers list and use in commands like docker logs Mariadb.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Mariadb up. Add the template list to Portainer once, then deploying Mariadb is a click rather than a wall of config.