diff --git a/images/docker-mariadb.md b/images/docker-mariadb.md index f8c0a9197..9aabec564 100755 --- a/images/docker-mariadb.md +++ b/images/docker-mariadb.md @@ -1,67 +1,116 @@ -[linuxserverurl]: https://linuxserver.io -[forumurl]: https://forum.linuxserver.io -[ircurl]: https://www.linuxserver.io/irc/ -[podcasturl]: https://www.linuxserver.io/podcast/ -[appurl]: https://mariadb.org/ -[hub]: https://hub.docker.com/r/linuxserver/mariadb/ +# [linuxserver/mariadb](https://github.com/linuxserver/docker-mariadb) -[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl] +[![](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 "Get your own version badge on microbadger.com") +[![](https://images.microbadger.com/badges/image/linuxserver/mariadb.svg)](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) +![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) -The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at: -* [forum.linuxserver.io][forumurl] -* [IRC][ircurl] on freenode at `#linuxserver.io` -* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation! +[Mariadb](https://mariadb.org/) is one of the most popular database servers. Made by the original developers of MySQL. -# linuxserver/mariadb -[![](https://images.microbadger.com/badges/version/linuxserver/mariadb.svg)](https://microbadger.com/images/linuxserver/mariadb "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/mariadb.svg)](https://microbadger.com/images/linuxserver/mariadb "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/mariadb.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/mariadb.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-mariadb)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-mariadb/) +## Supported Architectures -One of the most popular database servers. Made by the original developers of MySQL +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). + +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 | arm32v6-latest | -[![mariadb](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/mariadb-git.png)][appurl] ## Usage +Here are some example snippets to help you get started creating a container from this image. + +### docker + ``` docker create \ ---name=mariadb \ --p 3306:3306 \ --e PUID= \ --e PGID= \ --e MYSQL_ROOT_PASSWORD= \ --e TZ= \ --v :/config \ -linuxserver/mariadb + --name=mariadb \ + -e PUID=1001 \ + -e PGID=1001 \ + -e MYSQL_ROOT_PASSWORD= \ + -e TZ=Europe/London \ + -p 3306:3306 \ + -v :/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=1001 + - PGID=1001 + - MYSQL_ROOT_PASSWORD= + - TZ=Europe/London + volumes: + - :/config + ports: + - 3306:3306 + mem_limit: 4096m + restart: unless-stopped ``` ## Parameters -`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. -For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container. -So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 -http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.` +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. | -* `-p 3306` - mysql port -* `-v /config` - Contains the db itself and all assorted settings. -* `-e MYSQL_ROOT_PASSWORD` - set this to root password for installation (minimum 4 characters) -* `-e PGID` for GroupID - see below for explanation -* `-e PUID` for UserID - see below for explanation -* `-e TZ` - for timezone information *eg Europe/London, etc* +### Environment Variables (`-e`) -It is based on ubuntu xenial with s6 overlay, for shell access whilst the container is running do `docker exec -it mariadb /bin/bash`. +| Env | Function | +| :----: | --- | +| `PUID=1001` | for UserID - see below for explanation | +| `PGID=1001` | for GroupID - see below for explanation | +| `MYSQL_ROOT_PASSWORD=` | Set this to root password for installation (minimum 4 characters). | +| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. | -### User / Group Identifiers +### Volume Mappings (`-v`) -Sometimes when using data 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 the data volume directory on the host is owned by the same user you specify and it will "just work" ™. +| Volume | Function | +| :----: | --- | +| `/config` | Contains the db itself and all assorted settings. | -In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below: + + +## 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=1001` and `PGID=1001`, to find yours use `id user` as below: ``` - $ id + $ id username uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) ``` -## Setting up the application +## Application Setup If you didn't set a password during installation, (see logs for warning) use `mysqladmin -u root password ` @@ -74,28 +123,28 @@ Unraid users, it is advisable to edit the template/webui after setup and remove 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 -## 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 +## Support Info -`docker inspect -f '{{ index .Config.Labels "build_version" }}' mariadb` - -* image version number - -`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/mariadb` +* 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 -+ **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. +* **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.