kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Documentation
LinuxServer-CI
rodzic
dc3ce905c6
commit
a50a06aac2
|
|
@ -1,6 +1,9 @@
|
|||
---
|
||||
title: mariadb
|
||||
---
|
||||
<!-- DO NOT EDIT THIS FILE MANUALLY -->
|
||||
<!-- Please read the https://github.com/linuxserver/docker-mariadb/blob/master/.github/CONTRIBUTING.md -->
|
||||
|
||||
# [linuxserver/mariadb](https://github.com/linuxserver/docker-mariadb)
|
||||
|
||||
[](https://github.com/linuxserver/docker-mariadb)
|
||||
|
|
@ -14,7 +17,6 @@ title: mariadb
|
|||
[](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.
|
||||
|
||||
## Supported Architectures
|
||||
|
||||
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/).
|
||||
|
|
@ -38,120 +40,6 @@ This image provides various versions that are available via tags. `latest` tag u
|
|||
| latest | Currently using Ubuntu base images. Will be moved to the Alpine base in the near future. |
|
||||
| alpine | Releases with an Alpine base. |
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container from this image.
|
||||
|
||||
### docker-compose ([recommended](https://docs.linuxserver.io/general/docker-compose))
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
||||
```yaml
|
||||
---
|
||||
version: "2.1"
|
||||
services:
|
||||
mariadb:
|
||||
image: ghcr.io/linuxserver/mariadb
|
||||
container_name: mariadb
|
||||
environment:
|
||||
- PUID=1000
|
||||
- PGID=1000
|
||||
- MYSQL_ROOT_PASSWORD=ROOT_ACCESS_PASSWORD
|
||||
- TZ=Europe/London
|
||||
- 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
|
||||
|
||||
```
|
||||
docker run -d \
|
||||
--name=mariadb \
|
||||
-e PUID=1000 \
|
||||
-e PGID=1000 \
|
||||
-e MYSQL_ROOT_PASSWORD=ROOT_ACCESS_PASSWORD \
|
||||
-e TZ=Europe/London \
|
||||
-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 \
|
||||
ghcr.io/linuxserver/mariadb
|
||||
```
|
||||
|
||||
|
||||
## Parameters
|
||||
|
||||
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.
|
||||
|
||||
### 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 |
|
||||
| `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). |
|
||||
|
||||
### Volume Mappings (`-v`)
|
||||
|
||||
| Volume | Function |
|
||||
| :----: | --- |
|
||||
| `/config` | Contains the db itself and all assorted settings. |
|
||||
|
||||
|
||||
|
||||
## Environment variables from files (Docker secrets)
|
||||
|
||||
You can set any environment variable from a file by using a special prepend `FILE__`.
|
||||
|
||||
As an example:
|
||||
|
||||
```
|
||||
-e FILE__PASSWORD=/run/secrets/mysecretpassword
|
||||
```
|
||||
|
||||
Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` 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 user` as below:
|
||||
|
||||
```
|
||||
$ 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
|
||||
|
|
@ -196,13 +84,121 @@ We support a one time run of custom sql files on init. In order to use this plac
|
|||
```
|
||||
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.
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container from this image.
|
||||
|
||||
### docker-compose ([recommended](https://docs.linuxserver.io/general/docker-compose))
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
||||
```yaml
|
||||
---
|
||||
version: "2.1"
|
||||
services:
|
||||
mariadb:
|
||||
image: ghcr.io/linuxserver/mariadb
|
||||
container_name: mariadb
|
||||
environment:
|
||||
- PUID=1000
|
||||
- PGID=1000
|
||||
- MYSQL_ROOT_PASSWORD=ROOT_ACCESS_PASSWORD
|
||||
- TZ=Europe/London
|
||||
- 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
|
||||
|
||||
```bash
|
||||
docker run -d \
|
||||
--name=mariadb \
|
||||
-e PUID=1000 \
|
||||
-e PGID=1000 \
|
||||
-e MYSQL_ROOT_PASSWORD=ROOT_ACCESS_PASSWORD \
|
||||
-e TZ=Europe/London \
|
||||
-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 \
|
||||
ghcr.io/linuxserver/mariadb
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
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.
|
||||
|
||||
### 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 |
|
||||
| `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). |
|
||||
|
||||
### Volume Mappings (`-v`)
|
||||
|
||||
| Volume | Function |
|
||||
| :----: | --- |
|
||||
| `/config` | Contains the db itself and all assorted settings. |
|
||||
|
||||
## 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__PASSWORD=/run/secrets/mysecretpassword
|
||||
```
|
||||
|
||||
Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` 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 user` as below:
|
||||
|
||||
```bash
|
||||
$ id username
|
||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||
```
|
||||
|
||||
## 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:
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue