docker-documentation/images/docker-mariadb.md

148 wiersze
6.6 KiB
Markdown
Czysty Zwykły widok Historia

2019-03-30 10:58:18 +00:00
# linuxserver/mariadb
2019-02-09 15:11:39 +00:00
2019-03-30 10:58:18 +00:00
[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/mariadb.svg)](https://microbadger.com/images/linuxserver/mariadb) [![](https://images.microbadger.com/badges/image/linuxserver/mariadb.svg)](https://microbadger.com/images/linuxserver/mariadb) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/mariadb.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/mariadb.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-mariadb/master)](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)
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.
2019-02-09 15:11:39 +00:00
2019-02-12 14:41:08 +00:00
## Supported Architectures
2019-02-09 15:11:39 +00:00
2019-03-30 10:58:18 +00:00
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/).
2019-02-12 14:41:08 +00:00
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 |
2019-03-30 10:58:18 +00:00
| :---: | :--- |
2019-02-12 14:41:08 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
2019-03-24 22:17:44 +00:00
| armhf | arm32v7-latest |
2019-02-09 15:11:39 +00:00
## Usage
2019-02-12 14:41:08 +00:00
Here are some example snippets to help you get started creating a container from this image.
### docker
2019-03-30 10:58:18 +00:00
```text
2019-02-09 15:11:39 +00:00
docker create \
2019-02-12 14:41:08 +00:00
--name=mariadb \
2019-03-02 15:10:46 +00:00
-e PUID=1000 \
-e PGID=1000 \
2019-02-12 14:41:08 +00:00
-e MYSQL_ROOT_PASSWORD=<DATABASE PASSWORD> \
-e TZ=Europe/London \
2019-03-11 03:38:20 +00:00
-e MYSQL_DATABASE=<USER DB NAME> `#optional` \
-e MYSQL_USER=<MYSQL USER> `#optional` \
-e MYSQL_PASSWORD=<DATABASE PASSWORD> `#optional` \
2019-02-12 14:41:08 +00:00
-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:
2019-03-02 15:10:46 +00:00
- PUID=1000
- PGID=1000
2019-02-12 14:41:08 +00:00
- MYSQL_ROOT_PASSWORD=<DATABASE PASSWORD>
- TZ=Europe/London
2019-03-11 03:38:20 +00:00
- MYSQL_DATABASE=<USER DB NAME> #optional
- MYSQL_USER=<MYSQL USER> #optional
- MYSQL_PASSWORD=<DATABASE PASSWORD> #optional
2019-02-12 14:41:08 +00:00
volumes:
- <path to data>:/config
ports:
- 3306:3306
restart: unless-stopped
2019-02-09 15:11:39 +00:00
```
## Parameters
2019-03-30 10:58:18 +00:00
Docker images 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
2019-03-30 10:58:18 +00:00
### Ports \(`-p`\)
2019-02-09 15:11:39 +00:00
2019-02-12 14:41:08 +00:00
| Parameter | Function |
2019-03-30 10:58:18 +00:00
| :---: | :--- |
2019-02-12 14:41:08 +00:00
| `3306` | Mariadb listens on this port. |
2019-02-09 15:11:39 +00:00
2019-03-30 10:58:18 +00:00
### Environment Variables \(`-e`\)
2019-02-09 15:11:39 +00:00
2019-02-12 14:41:08 +00:00
| Env | Function |
2019-03-30 10:58:18 +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 |
2019-03-30 10:58:18 +00:00
| `MYSQL_ROOT_PASSWORD=<DATABASE PASSWORD>` | Set this to root password for installation \(minimum 4 characters\). |
2019-02-12 14:41:08 +00:00
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
2019-03-11 03:38:20 +00:00
| `MYSQL_DATABASE=<USER DB NAME>` | Specify the name of a database to be created on image startup. |
2019-03-30 10:58:18 +00:00
| `MYSQL_USER=<MYSQL USER>` | This user will have superuser access to the database specified by MYSQL\_DATABASE. |
| `MYSQL_PASSWORD=<DATABASE PASSWORD>` | Set this to the password you want to use for you MYSQL\_USER \(minimum 4 characters\). |
2019-02-09 15:11:39 +00:00
2019-03-30 10:58:18 +00:00
### Volume Mappings \(`-v`\)
2019-02-09 15:11:39 +00:00
2019-02-12 14:41:08 +00:00
| Volume | Function |
2019-03-30 10:58:18 +00:00
| :---: | :--- |
2019-02-12 14:41:08 +00:00
| `/config` | Contains the db itself and all assorted settings. |
## User / Group Identifiers
2019-03-30 10:58:18 +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.
2019-03-02 15:10:46 +00:00
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
2019-02-09 15:11:39 +00:00
2019-03-30 10:58:18 +00:00
```text
2019-02-12 14:41:08 +00:00
$ id username
2019-03-02 15:10:46 +00:00
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
2019-02-09 15:11:39 +00:00
```
2019-02-12 14:41:08 +00:00
## Application Setup
2019-02-09 15:11:39 +00:00
2019-03-30 10:58:18 +00:00
If you didn't set a password during installation, \(see logs for warning\) use `mysqladmin -u root password <PASSWORD>` to set one at the docker prompt...
2019-02-09 15:11:39 +00:00
2019-03-30 10:58:18 +00:00
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.
2019-02-09 15:11:39 +00:00
2019-03-30 10:58:18 +00:00
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.
2019-03-11 03:38:20 +00:00
2019-02-09 15:11:39 +00:00
Unraid users, it is advisable to edit the template/webui after setup and remove reference to this variable.
2019-03-30 10:58:18 +00:00
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
2019-02-09 15:11:39 +00:00
2019-02-12 14:41:08 +00:00
## Support Info
2019-02-09 15:11:39 +00:00
2019-02-12 14:41:08 +00:00
* 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`
2019-02-09 15:11:39 +00:00
## Versions
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.
2019-03-30 10:58:18 +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.
2019-03-30 10:58:18 +00:00