# [linuxserver/mariadb](https://github.com/linuxserver/docker-mariadb) [![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-mariadb.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-mariadb) [![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-mariadb.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-mariadb/releases) [![GitHub Package Repository](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitHub%20Package&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-mariadb/packages) [![GitLab Container Registry](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab&logoColor=FFFFFF)](https://gitlab.com/Linuxserver.io/docker-mariadb/container_registry) [![Quay.io](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/mariadb) [![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/mariadb.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/mariadb "Get your own version badge on microbadger.com") [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/mariadb.svg?style=flat-square&color=E68523&label=pulls&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/mariadb) [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/mariadb.svg?style=flat-square&color=E68523&label=stars&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/mariadb) [![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-mariadb/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-mariadb/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/mariadb/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/mariadb/latest/index.html) [Mariadb](https://mariadb.org/) is one of the most popular database servers. Made by the original developers of MySQL. ## Supported Architectures Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). Simply pulling `linuxserver/mariadb` 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 | Tag | | :----: | --- | | x86-64 | amd64-latest | | arm64 | arm64v8-latest | | armhf | arm32v7-latest | ## Usage Here are some example snippets to help you get started creating a container from this image. ### docker ``` docker create \ --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 \ linuxserver/mariadb ``` ### docker-compose Compatible with docker-compose v2 schemas. ```yaml --- version: "2" services: mariadb: image: linuxserver/mariadb 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 ``` ## Parameters Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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. | ## 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) ``` ## Application Setup If you didn't set a password during installation, (see logs for warning) use `mysqladmin -u root 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. ## 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" }}' linuxserver/mariadb` ## Versions * **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.