kopia lustrzana https://github.com/linuxserver/docker-documentation
388 wiersze
16 KiB
Markdown
388 wiersze
16 KiB
Markdown
---
|
|
title: mariadb
|
|
---
|
|
<!-- DO NOT EDIT THIS FILE MANUALLY -->
|
|
<!-- Please read https://github.com/linuxserver/docker-mariadb/blob/master/.github/CONTRIBUTING.md -->
|
|
# [linuxserver/mariadb](https://github.com/linuxserver/docker-mariadb)
|
|
|
|
[](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fmariadb)
|
|
[](https://github.com/linuxserver/docker-mariadb)
|
|
[](https://github.com/linuxserver/docker-mariadb/releases)
|
|
[](https://github.com/linuxserver/docker-mariadb/packages)
|
|
[](https://gitlab.com/linuxserver.io/docker-mariadb/container_registry)
|
|
[](https://quay.io/repository/linuxserver.io/mariadb)
|
|
[](https://hub.docker.com/r/linuxserver/mariadb)
|
|
[](https://hub.docker.com/r/linuxserver/mariadb)
|
|
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-mariadb/job/master/)
|
|
[](https://ci-tests.linuxserver.io/linuxserver/mariadb/latest/index.html)
|
|
|
|
[Mariadb](https://mariadb.org/) is one of the most popular database servers. Made by the original developers of MySQL.
|
|
|
|
[](https://mariadb.org/)
|
|
|
|
## Supported Architectures
|
|
|
|
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 `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 | ❌ | |
|
|
|
|
## Application Setup
|
|
|
|
If you didn't set a password during installation, (see logs for warning) use
|
|
`mariadb-admin -u root -p<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:
|
|
|
|
```path
|
|
/config/env
|
|
```
|
|
|
|
Using the following format:
|
|
|
|
```env
|
|
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:
|
|
|
|
```path
|
|
/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:
|
|
|
|
```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
|
|
```
|
|
|
|
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
|
|
mariadb-upgrade -u root -p<PASSWORD>
|
|
```
|
|
|
|
## 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](https://docs.linuxserver.io/general/docker-compose))
|
|
|
|
```yaml
|
|
---
|
|
version: "2.1"
|
|
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
|
|
volumes:
|
|
- path_to_data:/config
|
|
ports:
|
|
- 3306:3306
|
|
restart: unless-stopped
|
|
```
|
|
|
|
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
|
|
|
|
```bash
|
|
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` \
|
|
-p 3306:3306 \
|
|
-v path_to_data:/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.
|
|
|
|
### 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 |
|
|
| `TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
|
|
| `MYSQL_ROOT_PASSWORD=ROOT_ACCESS_PASSWORD` | Set this to root password for installation (minimum 4 characters & non-alphanumeric passwords must be properly escaped). |
|
|
| `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 & non-alphanumeric passwords must be properly escaped). |
|
|
| `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:
|
|
|
|
```bash
|
|
-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](https://en.wikipedia.org/wiki/Umask) 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:
|
|
|
|
```bash
|
|
id your_user
|
|
```
|
|
|
|
Example output:
|
|
|
|
```text
|
|
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
|
|
```
|
|
|
|
## Docker Mods
|
|
|
|
[](https://mods.linuxserver.io/?mod=mariadb "view available mods for this container.") [](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
|
|
|
|
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.
|
|
|
|
## 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 (ie. nextcloud, plex), 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.
|
|
|
|
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
|
|
```
|
|
|
|
### Via Watchtower auto-updater (only use if you don't remember the original parameters)
|
|
|
|
* Pull the latest image at its tag and replace it with the same env variables in one run:
|
|
|
|
```bash
|
|
docker run --rm \
|
|
-v /var/run/docker.sock:/var/run/docker.sock \
|
|
containrrr/watchtower \
|
|
--run-once mariadb
|
|
```
|
|
|
|
* You can also remove the old dangling images: `docker image prune`
|
|
|
|
!!! warning
|
|
|
|
We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using [Docker Compose](https://docs.linuxserver.io/general/docker-compose).
|
|
|
|
### 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`.
|
|
|
|
## Versions
|
|
|
|
* **09.06.23:** - Update lc_messages 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 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.
|