Skip to content

Commit d29db95

Browse files
committed
mariadb: doc contents
Place manditory environment variables first. Add missing MARIADB_ROOT_HOST. Document .sql.xz files for initialization. Note .sh files without execute permission are sourced.
1 parent 055c8b0 commit d29db95

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

mariadb/content.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -103,23 +103,23 @@ This specifies the password that will be set for the MariaDB `root` superuser ac
103103

104104
Set to a non-empty value, like `yes`, to allow the container to be started with a blank password for the root user. *NOTE*: Setting this variable to `yes` is not recommended unless you really know what you are doing, since this will leave your MariaDB instance completely unprotected, allowing anyone to gain complete superuser access.
105105

106-
### `MARIADB_DATABASE` / `MYSQL_DATABASE`
106+
### `MARIADB_RANDOM_ROOT_PASSWORD` / `MYSQL_RANDOM_ROOT_PASSWORD`
107107

108-
This variable is optional and allows you to specify the name of a database to be created on image startup. If a user/password was supplied (see below) then that user will be granted superuser access ([corresponding to `GRANT ALL`](https://mariadb.com/kb/en/grant/#the-all-privileges-privilege)) to this database.
108+
Set to a non-empty value, like `yes`, to generate a random initial password for the root user. The generated root password will be printed to stdout (`GENERATED ROOT PASSWORD: .....`).
109109

110-
### `MARIADB_USER` / `MYSQL_USER`, `MARIADB_PASSWORD` / `MYSQL_PASSWORD`
110+
### `MARIADB_ROOT_HOST` / `MYSQL_ROOT_HOST`
111111

112-
These variables are optional, used in conjunction to create a new user and to set that user's password. This user will be granted superuser permissions (see above) for the database specified by the `MARIADB_DATABASE` / `MYSQL_DATABASE` variable. Both user and password variables are required for a user to be created.
112+
This is hostname part of the root user created. By default this is `%`, however it can be set to any default [MariaDB allowed hostname component](https://mariadb.com/kb/en/create-user/#host-name-component).
113113

114-
Do note that there is no need to use this mechanism to create the root superuser, that user gets created by default with the password specified by the `MARIADB_ROOT_PASSWORD` / `MYSQL_ROOT_PASSWORD` variable.
114+
### `MARIADB_DATABASE` / `MYSQL_DATABASE`
115115

116-
### `MARIADB_ALLOW_EMPTY_PASSWORD` / `MYSQL_ALLOW_EMPTY_PASSWORD`
116+
This variable allows you to specify the name of a database to be created on image startup.
117117

118-
This is an optional variable. Set to a non-empty value, like `yes`, to allow the container to be started with a blank password for the root user. *NOTE*: Setting this variable to `yes` is not recommended unless you really know what you are doing, since this will leave your MariaDB instance completely unprotected, allowing anyone to gain complete superuser access.
118+
### `MARIADB_USER` / `MYSQL_USER`, `MARIADB_PASSWORD` / `MYSQL_PASSWORD`
119119

120-
### `MARIADB_ROOT_PASSWORD` / `MYSQL_RANDOM_ROOT_PASSWORD`
120+
These are used in conjunction to create a new user and to set that user's password. Both user and password variables are required for a user to be created. This user will be granted all access ([corresponding to `GRANT ALL`](https://mariadb.com/kb/en/grant/#the-all-privileges-privilege)) to the `MARIADB_DATABASE` database.
121121

122-
This is an optional variable. Set to a non-empty value, like `yes`, to generate a random initial password for the root user. The generated root password will be printed to stdout (`GENERATED ROOT PASSWORD: .....`).
122+
Do note that there is no need to use this mechanism to create the root superuser, that user gets created by default with the password specified by the `MARIADB_ROOT_PASSWORD` / `MYSQL_ROOT_PASSWORD` variable.
123123

124124
### `MARIADB_INITDB_SKIP_TZINFO` / `MYSQL_INITDB_SKIP_TZINFO`
125125

0 commit comments

Comments
 (0)