From 98f6cb01fb17ca883ecb873061207e173396eb0b Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Sat, 2 May 2020 10:10:54 -0400 Subject: [PATCH] Bot Updating Documentation --- images/docker-mariadb.md | 79 ++++++++++++++++++++++++---------------- 1 file changed, 48 insertions(+), 31 deletions(-) diff --git a/images/docker-mariadb.md b/images/docker-mariadb.md index 3614c9f59e..a1fa73b3e2 100644 --- a/images/docker-mariadb.md +++ b/images/docker-mariadb.md @@ -1,6 +1,15 @@ -# linuxserver/mariadb +# [linuxserver/mariadb](https://github.com/linuxserver/docker-mariadb) -[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-mariadb.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-mariadb) [![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-mariadb.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-mariadb/releases) [![GitHub Package Repository](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitHub%20Package&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-mariadb/packages) [![GitLab Container Registry](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab&logoColor=FFFFFF)](https://gitlab.com/Linuxserver.io/docker-mariadb/container_registry) [![Quay.io](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/mariadb) [![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/mariadb.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/mariadb) [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/mariadb.svg?style=flat-square&color=E68523&label=pulls&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/mariadb) [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/mariadb.svg?style=flat-square&color=E68523&label=stars&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/mariadb) [![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-mariadb/job/master/badge/icon?style=flat-square)](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) +[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-mariadb.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-mariadb) +[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-mariadb.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-mariadb/releases) +[![GitHub Package Repository](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitHub%20Package&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-mariadb/packages) +[![GitLab Container Registry](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab&logoColor=FFFFFF)](https://gitlab.com/Linuxserver.io/docker-mariadb/container_registry) +[![Quay.io](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/mariadb) +[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/mariadb.svg?style=flat-square&color=E68523)](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?style=flat-square&color=E68523&label=pulls&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/mariadb) +[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/mariadb.svg?style=flat-square&color=E68523&label=stars&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/mariadb) +[![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-mariadb/job/master/badge/icon?style=flat-square)](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) [Mariadb](https://mariadb.org/) is one of the most popular database servers. Made by the original developers of MySQL. @@ -13,18 +22,19 @@ Simply pulling `linuxserver/mariadb` should retrieve the correct image for your The architectures supported by this image are: | Architecture | Tag | -| :---: | :--- | +| :----: | --- | | x86-64 | amd64-latest | | arm64 | arm64v8-latest | | armhf | arm32v7-latest | + ## Usage Here are some example snippets to help you get started creating a container from this image. ### docker -```text +``` docker create \ --name=mariadb \ -e PUID=1000 \ @@ -41,6 +51,7 @@ docker create \ linuxserver/mariadb ``` + ### docker-compose Compatible with docker-compose v2 schemas. @@ -70,69 +81,76 @@ services: ## Parameters -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. +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`\) +### Ports (`-p`) | Parameter | Function | -| :---: | :--- | +| :----: | --- | | `3306` | Mariadb listens on this port. | -### Environment Variables \(`-e`\) + +### Environment Variables (`-e`) | Env | Function | -| :---: | :--- | +| :----: | --- | | `PUID=1000` | for UserID - see below for explanation | | `PGID=1000` | for GroupID - see below for explanation | -| `MYSQL_ROOT_PASSWORD=ROOT_ACCESS_PASSWORD` | Set this to root password for installation \(minimum 4 characters\). | +| `MYSQL_ROOT_PASSWORD=ROOT_ACCESS_PASSWORD` | Set this to root password for installation (minimum 4 characters). | | `TZ=Europe/London` | Specify a timezone to use EG Europe/London. | | `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\). | -| `REMOTE_SQL=http://URL1/your.sql,https://URL2/your.sql` | Set this to ingest sql files from an http/https endpoint \(comma seperated array\). | +| `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). | +| `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 Mappings (`-v`) | Volume | Function | -| :---: | :--- | +| :----: | --- | | `/config` | Contains the db itself and all assorted settings. | + + + ## 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`. +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 user` as below: -```text +``` $ id username uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) ``` ## Application Setup -If you didn't set a password during installation, \(see logs for warning\) use `mysqladmin -u root password ` to set one at the docker prompt... +If you didn't set a password during installation, (see logs for warning) use +`mysqladmin -u root 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 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. +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 +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: +The `MYSQL_ROOT_PASSWORD MYSQL_DATABASE MYSQL_USER MYSQL_PASSWORD REMOTE_SQL` env values can be set in a file: -```text +``` /config/env ``` -Using the following format: +Using the following format: -```text +``` MYSQL_ROOT_PASSWORD="ROOT_ACCESS_PASSWORD" MYSQL_DATABASE="USER_DB_NAME" MYSQL_USER="MYSQL_USER" @@ -146,17 +164,17 @@ These settings can be mixed and matched with Docker ENV settings as you require, We support a one time run of custom sql files on init. In order to use this place `*.sql` files in: -```text +``` /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. + ## Docker Mods +[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?style=for-the-badge&color=E68523&label=mods&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 Mods](https://img.shields.io/badge/dynamic/yaml?style=for-the-badge&color=E68523&label=mods&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) +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) can be accessed via the dynamic badge above. -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\) can be accessed via the dynamic badge above. ## Support Info @@ -181,7 +199,6 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to * **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. +* **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. -