</span></code></pre></div><p>Using the following format:</p><divclass="language-text highlight"><pre><span></span><code><spanid=__span-1-1><aid=__codelineno-1-1name=__codelineno-1-1href=#__codelineno-1-1></a>MYSQL_ROOT_PASSWORD="ROOT_ACCESS_PASSWORD"
</span></code></pre></div><p>These settings can be mixed and matched with Docker ENV settings as you require, but the settings in the file will always take precedence.</p><h3id=bootstrapping-a-new-instance>Bootstrapping a new instance<aclass=headerlinkhref=#bootstrapping-a-new-instancetitle="Permanent link">¶</a></h3><p>We support a one time run of custom sql files on init. In order to use this place <code>*.sql</code> files in:</p><p><divclass="language-text highlight"><pre><span></span><code><spanid=__span-2-1><aid=__codelineno-2-1name=__codelineno-2-1href=#__codelineno-2-1></a>/config/initdb.d/
</span></code></pre></div> This will have the same effect as setting the <code>REMOTE_SQL</code> environment variable. The sql will only be run on the containers first boot and setup.</p><h3id=check-and-repair>Check and Repair<aclass=headerlinkhref=#check-and-repairtitle="Permanent link">¶</a></h3><p>If user databases are not in a healthy state (sometimes caused by a failed upgrade), it may be remedied by running:</p><divclass="language-shell highlight"><pre><span></span><code><spanid=__span-3-1><aid=__codelineno-3-1name=__codelineno-3-1href=#__codelineno-3-1></a>mariadb-check<spanclass=w></span>-u<spanclass=w></span>root<spanclass=w></span>-p<PASSWORD><spanclass=w></span>-c<spanclass=w></span>-A<spanclass=w></span><spanclass=c1># check all databases for errors</span>
</span><spanid=__span-3-2><aid=__codelineno-3-2name=__codelineno-3-2href=#__codelineno-3-2></a>mariadb-check<spanclass=w></span>-u<spanclass=w></span>root<spanclass=w></span>-p<PASSWORD><spanclass=w></span>-r<spanclass=w></span>-A<spanclass=w></span><spanclass=c1># repair all databases</span>
</span><spanid=__span-3-3><aid=__codelineno-3-3name=__codelineno-3-3href=#__codelineno-3-3></a>mariadb-check<spanclass=w></span>-u<spanclass=w></span>root<spanclass=w></span>-p<PASSWORD><spanclass=w></span>-a<spanclass=w></span>-A<spanclass=w></span><spanclass=c1># analyze all databases</span>
</span><spanid=__span-3-4><aid=__codelineno-3-4name=__codelineno-3-4href=#__codelineno-3-4></a>mariadb-check<spanclass=w></span>-u<spanclass=w></span>root<spanclass=w></span>-p<PASSWORD><spanclass=w></span>-o<spanclass=w></span>-A<spanclass=w></span><spanclass=c1># optimize all databases</span>
</span></code></pre></div><p>After running the above commands, you may need to run the upgrade command again.</p><h3id=upgrading>Upgrading<aclass=headerlinkhref=#upgradingtitle="Permanent link">¶</a></h3><p>When this container initializes, if <code>MYSQL_ROOT_PASSWORD</code> 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:</p><divclass="language-shell highlight"><pre><span></span><code><spanid=__span-4-1><aid=__codelineno-4-1name=__codelineno-4-1href=#__codelineno-4-1></a>mariadb-upgrade<spanclass=w></span>-u<spanclass=w></span>root<spanclass=w></span>-p<PASSWORD>
</span></code></pre></div><h2id=usage>Usage<aclass=headerlinkhref=#usagetitle="Permanent link">¶</a></h2><p>To help you get started creating a container from this image you can either use docker-compose or the docker cli.</p><h3id=docker-compose-recommended-click-here-for-more-info>docker-compose (recommended, <ahref=https://docs.linuxserver.io/general/docker-compose>click here for more info</a>)<aclass=headerlinkhref=#docker-compose-recommended-click-here-for-more-infotitle="Permanent link">¶</a></h3><divclass="language-yaml highlight"><pre><span></span><code><spanid=__span-5-1><aid=__codelineno-5-1name=__codelineno-5-1href=#__codelineno-5-1></a><spanclass=nn>---</span>
</span></code></pre></div><h3id=docker-cli-click-here-for-more-info>docker cli (<ahref=https://docs.docker.com/engine/reference/commandline/cli/>click here for more info</a>)<aclass=headerlinkhref=#docker-cli-click-here-for-more-infotitle="Permanent link">¶</a></h3><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-6-1><aid=__codelineno-6-1name=__codelineno-6-1href=#__codelineno-6-1></a>docker<spanclass=w></span>run<spanclass=w></span>-d<spanclass=w></span><spanclass=se>\</span>
</span></code></pre></div><h2id=parameters>Parameters<aclass=headerlinkhref=#parameterstitle="Permanent link">¶</a></h2><p>Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <code><external>:<internal></code> respectively. For example, <code>-p 8080:80</code> would expose port <code>80</code> from inside the container to be accessible from the host's IP on port <code>8080</code> outside the container.</p><h3id=ports-p>Ports (<code>-p</code>)<aclass=headerlinkhref=#ports-ptitle="Permanent link">¶</a></h3><table><thead><tr><thstyle="text-align: center;">Parameter</th><th>Function</th></tr></thead><tbody><tr><tdstyle="text-align: center;"><code>3306</code></td><td>MariaDB listens on this port.</td></tr></tbody></table><h3id=environment-variables-e>Environment Variables (<code>-e</code>)<aclass=headerlinkhref=#environment-variables-etitle="Permanent link">¶</a></h3><table><thead><tr><thstyle="text-align: center;">Env</th><th>Function</th></tr></thead><tbody><tr><tdstyle="text-align: center;"><code>PUID=1000</code></td><td>for UserID - see below for explanation</td></tr><tr><tdstyle="text-align: center;"><code>PGID=1000</code></td><td>for GroupID - see below for explanation</td></tr><tr><tdstyle="text-align: center;"><code>TZ=Etc/UTC</code></td><td>specify a timezone to use, see this <ahref=https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List>list</a>.</td></tr><tr><tdstyle="text-align: center;"><code>MYSQL_ROOT_PASSWORD=ROOT_ACCESS_PASSWORD</code></td><td>Set this to root password for installation (minimum 4 characters & non-alphanumeric passwords must be properly escaped).</td></tr><tr><tdstyle="text-align: center;"><code>MYSQL_DATABASE=USER_DB_NAME</code></td><td>Specify the name of a database to be created on image startup.</td></tr><tr><tdstyle="text-align: center;"><code>MYSQL_USER=MYSQL_USER</code></td><td>This user will have superuser access to the database specified by MYSQL_DATABASE (do not use root here).</td></tr><tr><tdstyle="text-align: center;"><code>MYSQL_PASSWORD=DATABASE_PASSWORD</code></td><td>Set this to the password you want to use for you MYSQL_USER (minimum 4 characters & non-alphanumeric passwords must be properly escaped).</td></tr><tr><tdstyle="text-align: center;"><code>REMOTE_SQL=http://URL1/your.sql,https://URL2/your.sql</code></td><td>Set this to ingest sql files from an http/https endpoint (comma seperated array).</td></tr></tbody></table><h3id=volume-mappings-v>Volume Mappings (<code>-v</code>)<aclass=headerlinkhref=#volume-mappings-vtitle="Permanent link">¶</a></h3><table><thead><tr><thstyle="text-align: center;">Volume</th><th>Function</th></tr></thead><tbody><tr><tdstyle="text-align: center;"><code>/config</code></td><td>Persistent config files</td></tr></tbody></table><h4id=miscellaneous-options>Miscellaneous Options<aclass=headerlinkhref=#miscellaneous-optionstitle="Permanent link">¶</a></h4><table><thead><tr><thstyle="text-align: center;">Parameter</th><th>Function</th></tr></thead><tbody><tr><td></td><td></td></tr></tbody></table><h2id=environment-variables-from-files-docker-secrets>Environment variables from files (Docker secrets)<aclass=headerlinkhref=#environment-variables-from-files-docker-secretstitle="Permanent link">¶</a></h2><p>You can set any environment variable from a file by using a special prepend <code>FILE__</code>.</p><p>As an example:</p><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-7-1><aid=__codelineno-7-1name=__codelineno-7-1href=#__codelineno-7-1></a>-e<spanclass=w></span><spanclass=nv>FILE__MYVAR</span><spanclass=o>=</span>/run/secrets/mysecretvariable
</span></code></pre></div><p>Will set the environment variable <code>MYVAR</code> based on the contents of the <code>/run/secrets/mysecretvariable</code> file.</p><h2id=umask-for-running-applications>Umask for running applications<aclass=headerlinkhref=#umask-for-running-applicationstitle="Permanent link">¶</a></h2><p>For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional <code>-e UMASK=022</code> setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up <ahref=https://en.wikipedia.org/wiki/Umask>here</a> before asking for support.</p><h2id=user-group-identifiers>User / Group Identifiers<aclass=headerlinkhref=#user-group-identifierstitle="Permanent link">¶</a></h2><p>When using volumes (<code>-v</code> flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user <code>PUID</code> and group <code>PGID</code>.</p><p>Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.</p><p>In this instance <code>PUID=1000</code> and <code>PGID=1000</code>, to find yours use <code>id your_user</code> as below:</p><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-8-1><aid=__codelineno-8-1name=__codelineno-8-1href=#__codelineno-8-1></a>id<spanclass=w></span>your_user
</span></code></pre></div><h2id=docker-mods>Docker Mods<aclass=headerlinkhref=#docker-modstitle="Permanent link">¶</a></h2><p><ahref="https://mods.linuxserver.io/?mod=mariadb"title="view available mods for this container."><imgalt="Docker Mods"src="https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=mariadb&query=%24.mods%5B%27mariadb%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml"></a><ahref="https://mods.linuxserver.io/?mod=universal"title="view available universal mods."><imgalt="Docker Universal Mods"src="https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml"></a></p><p>We publish various <ahref=https://github.com/linuxserver/docker-mods>Docker Mods</a> 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.</p><h2id=support-info>Support Info<aclass=headerlinkhref=#support-infotitle="Permanent link">¶</a></h2><ul><li><p>Shell access whilst the container is running:</p><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-10-1><aid=__codelineno-10-1name=__codelineno-10-1href=#__codelineno-10-1></a>docker<spanclass=w></span><spanclass=nb>exec</span><spanclass=w></span>-it<spanclass=w></span>mariadb<spanclass=w></span>/bin/bash
</span></code></pre></div></li><li><p>To monitor the logs of the container in realtime:</p><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-11-1><aid=__codelineno-11-1name=__codelineno-11-1href=#__codelineno-11-1></a>docker<spanclass=w></span>logs<spanclass=w></span>-f<spanclass=w></span>mariadb
</span></code></pre></div></li><li><p>Container version number:</p><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-12-1><aid=__codelineno-12-1name=__codelineno-12-1href=#__codelineno-12-1></a>docker<spanclass=w></span>inspect<spanclass=w></span>-f<spanclass=w></span><spanclass=s1>'{{ index .Config.Labels "build_version" }}'</span><spanclass=w></span>mariadb
</span></code></pre></div></li><li><p>Image version number:</p><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-13-1><aid=__codelineno-13-1name=__codelineno-13-1href=#__codelineno-13-1></a>docker<spanclass=w></span>inspect<spanclass=w></span>-f<spanclass=w></span><spanclass=s1>'{{ index .Config.Labels "build_version" }}'</span><spanclass=w></span>lscr.io/linuxserver/mariadb:latest
</span></code></pre></div></li></ul><h2id=updating-info>Updating Info<aclass=headerlinkhref=#updating-infotitle="Permanent link">¶</a></h2><p>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 <ahref=#application-setup>Application Setup</a> section above to see if it is recommended for the image.</p><p>Below are the instructions for updating containers:</p><h3id=via-docker-compose>Via Docker Compose<aclass=headerlinkhref=#via-docker-composetitle="Permanent link">¶</a></h3><ul><li><p>Update images:</p><ul><li><p>All images:</p><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-14-1><aid=__codelineno-14-1name=__codelineno-14-1href=#__codelineno-14-1></a>docker-compose<spanclass=w></span>pull
</span></code></pre></div></li></ul></li><li><p>You can also remove the old dangling images:</p><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-18-1><aid=__codelineno-18-1name=__codelineno-18-1href=#__codelineno-18-1></a>docker<spanclass=w></span>image<spanclass=w></span>prune
</span></code></pre></div></li></ul><h3id=via-docker-run>Via Docker Run<aclass=headerlinkhref=#via-docker-runtitle="Permanent link">¶</a></h3><ul><li><p>Update the image:</p><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-19-1><aid=__codelineno-19-1name=__codelineno-19-1href=#__codelineno-19-1></a>docker<spanclass=w></span>pull<spanclass=w></span>lscr.io/linuxserver/mariadb:latest
</span></code></pre></div></li><li><p>Stop the running container:</p><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-20-1><aid=__codelineno-20-1name=__codelineno-20-1href=#__codelineno-20-1></a>docker<spanclass=w></span>stop<spanclass=w></span>mariadb
</span></code></pre></div></li><li><p>Delete the container:</p><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-21-1><aid=__codelineno-21-1name=__codelineno-21-1href=#__codelineno-21-1></a>docker<spanclass=w></span>rm<spanclass=w></span>mariadb
</span></code></pre></div></li><li><p>Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your <code>/config</code> folder and settings will be preserved)</p></li><li><p>You can also remove the old dangling images:</p><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-22-1><aid=__codelineno-22-1name=__codelineno-22-1href=#__codelineno-22-1></a>docker<spanclass=w></span>image<spanclass=w></span>prune
</span></code></pre></div></li></ul><h3id=image-update-notifications-diun-docker-image-update-notifier>Image Update Notifications - Diun (Docker Image Update Notifier)<aclass=headerlinkhref=#image-update-notifications-diun-docker-image-update-notifiertitle="Permanent link">¶</a></h3><divclass="admonition tip"><pclass=admonition-title>Tip</p><p>We recommend <ahref=https://crazymax.dev/diun/>Diun</a> for update notifications. Other tools that automatically update containers unattended are not recommended or supported.</p></div><h2id=building-locally>Building locally<aclass=headerlinkhref=#building-locallytitle="Permanent link">¶</a></h2><p>If you want to make local modifications to these images for development purposes or just to customize the logic:</p><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-23-1><aid=__codelineno-23-1name=__codelineno-23-1href=#__codelineno-23-1></a>git<spanclass=w></span>clone<spanclass=w></span>https://github.com/linuxserver/docker-mariadb.git
</span></code></pre></div><p>The ARM variants can be built on x86_64 hardware using <code>multiarch/qemu-user-static</code></p><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-24-1><aid=__codelineno-24-1name=__codelineno-24-1href=#__codelineno-24-1></a>docker<spanclass=w></span>run<spanclass=w></span>--rm<spanclass=w></span>--privileged<spanclass=w></span>multiarch/qemu-user-static:register<spanclass=w></span>--reset
</span></code></pre></div><p>Once registered you can define the dockerfile to use with <code>-f Dockerfile.aarch64</code>.</p><h2id=versions>Versions<aclass=headerlinkhref=#versionstitle="Permanent link">¶</a></h2><ul><li><strong>31.05.24:</strong> - Rebase to Alpine 3.20.</li><li><strong>23.12.23:</strong> - Rebase to Alpine 3.19.</li><li><strong>09.06.23:</strong> - Update lc_messages path in shipped custom.cnf to match upstream.</li><li><strong>25.05.23:</strong> - Rebase to Alpine 3.18, deprecate armhf.</li><li><strong>04.02.23:</strong> - Minor updates to defaults in custom.cnf.</li><li><strong>31.01.23:</strong> - Rebase to 3.17.</li><li><strong>09.12.22:</strong> - Add upgrade check warning.</li><li><strong>11.10.22:</strong> - Rebase master to Alpine 3.16, migrate to s6v3, remove password escape logic which caused problems for a small subset of users.</li><li><strong>06.07.21:</strong> - Rebase master to alpine.</li><li><strong>03.07.21:</strong> - Rebase to 3.14.</li><li><strong>08.02.21:</strong> - Fix new installs.</li><li><strong>08.02.21:</strong> - Rebase to alpine. Add mariadb-backup.</li><li><strong>08.02.21:</strong> - Release alpine tag. The alpine release will replace the latest tag in the near future.</li><li><strong>27.10.19:</strong> - Bump to 10.4, ability use custom sql on initial init ,defining root passwords via file.</li><li><strong>23.03.19:</strong> - Switching to new Base images, shift to arm32v7 tag.</li><li><strong>07.03.19:</strong> - Add ability to setup a database and default user on first spinup.</li><li><strong>26.01.19:</strong> - Add pipeline logic and multi arch.</li><li><strong>10.09.18:</strong> - Rebase to ubuntu bionic and use 10.3 MariaDB repository.</li><li><strong>09.12.17:</strong> - Fix continuation lines.</li><li><strong>12.09.17:</strong> - Gracefully shut down MariaDB.</li><li><strong>27.10.16:</strong> - Implement linting suggestions on database init script.</li><li><strong>11.10.16:</strong> - Rebase to ubuntu xenial, add version labelling.</li><li><strong>09.03.16:</strong> - 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.</li><li><strong>26.01.16:</strong> - Change user of mysqld_safe script to abc, better unclean shutdown handling on restart.</li><li><strong>23.12.15:</strong> - Remove autoupdating, between some version updates the container breaks.</li><li><strong>12.08.15:</strong> - Initial Release.</li></ul><asideclass=md-source-file><spanclass=md-source-file__fact><spanclass=md-icontitle="Last update"><svgxmlns=http://www.w3.org/2000/svgviewbox="0 0 24 24"><pathd="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg></span><spanclass="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 10, 2024</span></span><spanclass=md-source-file__fact><spanclass=md-icontitle=Created><svgxmlns=http://www.w3.org/2000/svgviewbox="0 0 24 24"><pathd="M14.47 15.08 11 13V7h1.5v5.25l3.08 1.83c-.41.28-.79.62-1.11 1m-1.39 4.84c-.36.05-.71.08-1.08.08-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8c0 .37-.03.72-.08 1.08.69.1 1.33.32 1.92.64.1-.56.16-1.13.16-1.72 0-5.5-4.5-10-10-10S2 6.5 2 12s4.47 10 10 10c.59 0 1.16-.06 1.72-.16-.32-.59-.54-1.23-.64-1.92M18 15v3h-3v2h3v3h2v-3h3v-2h-3v-3z"/></svg></span><spanclass="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">February 9, 2019</span></span></aside></article></div><script>vartarget=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script></div><buttontype=buttonclass="md-top md-icon"data-md-component=tophidden><svgxmlns=http://www.w3.org/2000/svgviewbox="0024