docker-documentation/docs/images/docker-mariadb.md

371 wiersze
16 KiB
Markdown
Czysty Zwykły widok Historia

2021-02-11 19:47:38 +00:00
---
title: mariadb
---
2023-10-10 07:44:26 +00:00
<!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read https://github.com/linuxserver/docker-mariadb/blob/master/.github/CONTRIBUTING.md -->
2020-07-04 14:11:04 +00:00
# [linuxserver/mariadb](https://github.com/linuxserver/docker-mariadb)
2021-12-18 05:47:33 +00:00
[![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Fmariadb?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fmariadb)
2020-07-04 14:11:04 +00:00
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-mariadb.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-mariadb)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-mariadb.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-mariadb/releases)
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-mariadb/packages)
2020-12-16 18:15:26 +00:00
[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-mariadb/container_registry)
2021-10-02 05:47:21 +00:00
[![Quay.io](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/mariadb)
2020-07-04 14:11:04 +00:00
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/mariadb.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/mariadb)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/mariadb.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/mariadb)
[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-mariadb%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-mariadb/job/master/)
2020-11-02 14:54:40 +00:00
[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fmariadb%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/mariadb/latest/index.html)
2019-02-09 15:11:39 +00:00
2019-02-12 14:41:08 +00:00
[Mariadb](https://mariadb.org/) is one of the most popular database servers. Made by the original developers of MySQL.
2021-04-24 05:53:51 +00:00
2023-10-10 07:44:26 +00:00
[![mariadb](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/mariadb-git.png)](https://mariadb.org/)
2019-02-12 14:41:08 +00:00
## Supported Architectures
2019-02-09 15:11:39 +00:00
2023-11-21 07:42:24 +00:00
We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://distribution.github.io/distribution/spec/manifest-v2-2/#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
2019-02-12 14:41:08 +00:00
2022-04-30 05:48:02 +00:00
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.
2019-02-12 14:41:08 +00:00
The architectures supported by this image are:
2022-04-30 05:48:02 +00:00
| Architecture | Available | Tag |
| :----: | :----: | ---- |
| x86-64 | ✅ | amd64-\<version tag\> |
| arm64 | ✅ | arm64v8-\<version tag\> |
2023-05-28 00:09:00 +00:00
| armhf | ❌ | |
2019-02-09 15:11:39 +00:00
2021-04-17 05:54:07 +00:00
## Application Setup
If you didn't set a password during installation, (see logs for warning) use
2023-01-22 18:19:49 +00:00
`mariadb-admin -u root -p<PASSWORD>`
2021-04-17 05:54:07 +00:00
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:
2023-05-29 16:03:17 +00:00
```path
2021-04-17 05:54:07 +00:00
/config/env
```
Using the following format:
2023-05-29 16:03:17 +00:00
```env
2021-04-17 05:54:07 +00:00
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:
2023-05-29 16:03:17 +00:00
```path
2021-04-17 05:54:07 +00:00
/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.
2023-05-29 16:03:17 +00:00
### Check and Repair
2023-01-22 18:19:49 +00:00
2023-05-29 16:03:17 +00:00
If user databases are not in a healthy state (sometimes caused by a failed upgrade), it may be remedied by running:
2023-01-22 18:19:49 +00:00
2023-05-29 16:03:17 +00:00
```shell
mariadb-check -u root -p<PASSWORD> -c -A # check all databases for errors
mariadb-check -u root -p<PASSWORD> -r -A # repair all databases
mariadb-check -u root -p<PASSWORD> -a -A # analyze all databases
mariadb-check -u root -p<PASSWORD> -o -A # optimize all databases
2023-01-22 18:19:49 +00:00
```
2023-05-29 16:03:17 +00:00
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:
```shell
2023-01-22 18:19:49 +00:00
mariadb-upgrade -u root -p<PASSWORD>
```
2019-02-09 15:11:39 +00:00
## Usage
2021-07-03 05:47:55 +00:00
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
2019-02-12 14:41:08 +00:00
2021-07-03 05:47:55 +00:00
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
2019-02-12 14:41:08 +00:00
```yaml
---
services:
mariadb:
2022-04-30 05:48:02 +00:00
image: lscr.io/linuxserver/mariadb:latest
2019-02-12 14:41:08 +00:00
container_name: mariadb
environment:
2019-03-02 15:10:46 +00:00
- PUID=1000
- PGID=1000
2023-02-11 05:47:26 +00:00
- TZ=Etc/UTC
2019-10-29 03:35:45 +00:00
- 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
2019-02-12 14:41:08 +00:00
volumes:
2024-01-26 17:33:29 +00:00
- /path/to/mariadb/config:/config
2019-02-12 14:41:08 +00:00
ports:
- 3306:3306
restart: unless-stopped
2019-02-09 15:11:39 +00:00
```
2021-07-03 05:47:55 +00:00
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
2020-10-03 14:11:08 +00:00
2021-04-17 05:54:07 +00:00
```bash
2020-10-03 14:11:08 +00:00
docker run -d \
--name=mariadb \
-e PUID=1000 \
-e PGID=1000 \
2023-02-11 05:47:26 +00:00
-e TZ=Etc/UTC \
2020-10-03 14:11:08 +00:00
-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` \
-p 3306:3306 \
2024-01-26 17:33:29 +00:00
-v /path/to/mariadb/config:/config \
2020-10-03 14:11:08 +00:00
--restart unless-stopped \
2022-04-30 05:48:02 +00:00
lscr.io/linuxserver/mariadb:latest
2020-10-03 14:11:08 +00:00
```
2019-02-09 15:11:39 +00:00
## Parameters
2023-10-10 07:44:26 +00:00
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.
2019-02-12 14:41:08 +00:00
2020-07-04 14:11:04 +00:00
### Ports (`-p`)
2019-02-09 15:11:39 +00:00
2019-02-12 14:41:08 +00:00
| Parameter | Function |
2020-07-04 14:11:04 +00:00
| :----: | --- |
2019-02-12 14:41:08 +00:00
| `3306` | Mariadb listens on this port. |
2019-02-09 15:11:39 +00:00
2020-07-04 14:11:04 +00:00
### Environment Variables (`-e`)
2019-02-09 15:11:39 +00:00
2019-02-12 14:41:08 +00:00
| Env | Function |
2020-07-04 14:11:04 +00:00
| :----: | --- |
2019-03-02 15:10:46 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2023-02-11 05:47:26 +00:00
| `TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
2022-10-11 22:11:33 +00:00
| `MYSQL_ROOT_PASSWORD=ROOT_ACCESS_PASSWORD` | Set this to root password for installation (minimum 4 characters & non-alphanumeric passwords must be properly escaped). |
2019-10-29 03:35:45 +00:00
| `MYSQL_DATABASE=USER_DB_NAME` | Specify the name of a database to be created on image startup. |
2020-07-04 14:11:04 +00:00
| `MYSQL_USER=MYSQL_USER` | This user will have superuser access to the database specified by MYSQL_DATABASE (do not use root here). |
2022-10-11 22:11:33 +00:00
| `MYSQL_PASSWORD=DATABASE_PASSWORD` | Set this to the password you want to use for you MYSQL_USER (minimum 4 characters & non-alphanumeric passwords must be properly escaped). |
2020-07-04 14:11:04 +00:00
| `REMOTE_SQL=http://URL1/your.sql,https://URL2/your.sql` | Set this to ingest sql files from an http/https endpoint (comma seperated array). |
2019-02-09 15:11:39 +00:00
2020-07-04 14:11:04 +00:00
### Volume Mappings (`-v`)
2019-02-09 15:11:39 +00:00
2019-02-12 14:41:08 +00:00
| Volume | Function |
2020-07-04 14:11:04 +00:00
| :----: | --- |
2024-01-26 17:33:29 +00:00
| `/config` | Persistent config files |
2019-02-12 14:41:08 +00:00
2021-10-02 05:47:21 +00:00
#### Miscellaneous Options
| Parameter | Function |
| :-----: | --- |
2020-07-04 14:11:04 +00:00
## Environment variables from files (Docker secrets)
2020-05-30 14:10:49 +00:00
You can set any environment variable from a file by using a special prepend `FILE__`.
As an example:
2021-04-17 05:54:07 +00:00
```bash
2023-10-10 07:44:26 +00:00
-e FILE__MYVAR=/run/secrets/mysecretvariable
2020-05-30 14:10:49 +00:00
```
2023-10-10 07:44:26 +00:00
Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` file.
2020-05-30 14:10:49 +00:00
## Umask for running applications
2020-07-04 14:11:04 +00:00
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](https://en.wikipedia.org/wiki/Umask) before asking for support.
2019-02-12 14:41:08 +00:00
## User / Group Identifiers
2020-07-04 14:11:04 +00:00
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`.
2019-02-12 14:41:08 +00:00
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
2023-10-10 07:44:26 +00:00
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id your_user` as below:
2019-02-09 15:11:39 +00:00
2021-04-17 05:54:07 +00:00
```bash
2023-10-10 07:44:26 +00:00
id your_user
```
Example output:
```text
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
2019-02-09 15:11:39 +00:00
```
2020-04-11 14:11:01 +00:00
## Docker Mods
2021-04-17 05:54:07 +00:00
2020-10-03 14:11:08 +00:00
[![Docker Mods](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)](https://mods.linuxserver.io/?mod=mariadb "view available mods for this container.") [![Docker Universal Mods](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)](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
2020-04-11 14:11:01 +00:00
2020-10-03 14:11:08 +00:00
We publish various [Docker Mods](https://github.com/linuxserver/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.
2020-04-11 14:11:01 +00:00
2019-02-12 14:41:08 +00:00
## Support Info
2019-02-09 15:11:39 +00:00
2019-09-07 14:11:39 +00:00
* Shell access whilst the container is running:
2023-10-10 07:44:26 +00:00
```bash
docker exec -it mariadb /bin/bash
```
2019-09-07 14:11:39 +00:00
* To monitor the logs of the container in realtime:
2023-10-10 07:44:26 +00:00
```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
2024-01-16 07:44:37 +00:00
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](#application-setup) section above to see if it is recommended for the image.
2023-10-10 07:44:26 +00:00
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](https://crazymax.dev/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:
```bash
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 x86_64 hardware using `multiarch/qemu-user-static`
```bash
docker run --rm --privileged multiarch/qemu-user-static:register --reset
```
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
2019-02-09 15:11:39 +00:00
## Versions
2024-01-26 17:33:29 +00:00
* **23.12.23:** - Rebase to Alpine 3.19.
2023-06-11 15:44:48 +00:00
* **09.06.23:** - Update lc_messages path in shipped custom.cnf to match upstream.
2023-05-28 00:09:00 +00:00
* **25.05.23:** - Rebase to Alpine 3.18, deprecate armhf.
2023-02-04 17:21:10 +00:00
* **04.02.23:** - Minor updates to defaults in custom.cnf.
2023-02-01 19:10:09 +00:00
* **31.01.23:** - Rebase to 3.17.
2023-01-22 18:19:49 +00:00
* **09.12.22:** - Add upgrade check warning.
2022-10-11 22:11:33 +00:00
* **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.
2021-08-25 15:08:20 +00:00
* **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.
2021-02-11 19:47:38 +00:00
* **08.02.21:** - Release alpine tag. The alpine release will replace the latest tag in the near future.
2019-10-29 03:35:45 +00:00
* **27.10.19:** - Bump to 10.4, ability use custom sql on initial init ,defining root passwords via file.
2019-03-24 22:17:44 +00:00
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
2019-03-11 03:38:20 +00:00
* **07.03.19:** - Add ability to setup a database and default user on first spinup.
2019-02-12 14:41:08 +00:00
* **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.
2020-07-04 14:11:04 +00:00
* **26.01.16:** - Change user of mysqld_safe script to abc, better unclean shutdown handling on restart.
2019-02-12 14:41:08 +00:00
* **23.12.15:** - Remove autoupdating, between some version updates the container breaks.
* **12.08.15:** - Initial Release.