Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bfren/docker-mariadb
Docker MariaDB image with automatic backups.
https://github.com/bfren/docker-mariadb
backup docker docker-mariadb mariadb mariadb-server mysql
Last synced: 4 months ago
JSON representation
Docker MariaDB image with automatic backups.
- Host: GitHub
- URL: https://github.com/bfren/docker-mariadb
- Owner: bfren
- License: mit
- Created: 2020-10-20T12:00:56.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-13T08:43:17.000Z (5 months ago)
- Last Synced: 2024-09-28T11:20:50.883Z (4 months ago)
- Topics: backup, docker, docker-mariadb, mariadb, mariadb-server, mysql
- Language: Nushell
- Homepage:
- Size: 443 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Docker MariaDB
   
[Docker Repository](https://hub.docker.com/r/bfren/mariadb) - [bfren ecosystem](https://github.com/bfren/docker)
[MariaDB](https://mariadb.org/) comes pre-installed (10.5 LTS, 10.6 LTS, 10.11 LTS, 11.1, 11.2, 11.4 LTS, 11.5 and 11.6) with automatic backups built-in.
**If you are upgrading to 7.x please read [this page](UPGRADE_FROM_6x_TO_7x.md).**
## Contents
* [Automatic Backups](#automatic-backups)
* [Ports](#ports)
* [Volumes](#volumes)
* [Environment Variables](#environment-variables)
* [Helper Functions](#helper-functions)
* [Licence / Copyright](#licence)
## Automatic Backups
Backups for every database (except `mysql`, `information_schema`, `performance_schema`, and `sys`) are stored:
* in the `/backup` volume
* in subfolders by date and time (yyMMddhhmm)
* every eight hours
See [For Backups](#for-backups) for configuration variables.
**It is strongly recommended that you run a backup before updating to a more recent version.**
## Ports
* 3306
## Volumes
| Volume | Purpose |
| --------- | ------------------------------------------------------------------------------------------------- |
| `/backup` | Backup files (also used for export / import scripts - see [helper functions](#helper-functions)). |
| `/data` | Data files. |
| `/ssl` | SSL certificates and files. |
## Environment Variables
### For Backups
| Variable | Values | Description | Default |
| --------------------------------- | ------------------------------------------------------------------------- | ----------------------------------------------------------------- | --------- |
| `BF_DB_BACKUP_COMPRESS_FILES` | 0 or 1 | Whether or not to compress backup files (using gzip). | 0 |
| `BF_DB_BACKUP_KEEP_FOR` | [Nu duration](https://www.nushell.sh/book/types_of_data.html#durations) | The period of time to keep backups before auto-deleting them. | 28day |
### For SSL
| Variable | Values | Description | Default |
| ----------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | --------- |
| `BF_DB_SSL_ENABLE` | 0 or 1 | Set to "1" to enable SSL support. | 0 |
| `BF_DB_SSL_EXPIRY` | [Nu duration](https://www.nushell.sh/book/types_of_data.html#durations) | The period of time before self-generated SSL certificates will expire. | 36500day |
| `BF_DB_SSL_CA_KEY_BITS` | integer | The size in bits of the CA SSL private key. | 4096 |
| `BF_DB_SSL_SERVER_KEY_BITS` | integer | The size in bits of the server SSL private key. | 4096 |
| `BF_DB_SSL_CLIENT_KEY_BITS` | integer | The size in bits of the client SSL private key. | 4096 |
### For Database
| Variable | Values | Description | Default |
| --------------------- | --------- | ----------------------------------------------------------------------------------------------------------------- | --------------------- |
| `BF_DB_ROOT_PASSWORD` | string | Password for root user. | *None* - **required** |
| `BF_DB_APPLICATION` | string | Application name - will be used as `BF_DB_DATABASE`, `BF_DB_PASSWORD` and `BF_DB_USERNAME` if they are not set. | *None* |
| `BF_DB_DATABASE` | string | Database name(s) - multiple databases can be separated by a comma. | *None* |
| `BF_DB_USERNAME` | string | Application username - required if `BF_DB_APPLICATION` is not used. | *None* |
| `BF_DB_PASSWORD` | string | Application password - required if `BF_DB_APPLICATION` is not used. | *None* |
| `BF_DB_SUPER_USER` | 0 or 1 | Grants the application user permission to **all** databases plus user management - **not** for production. | 0 |
| `BF_DB_CHARACTER_SET` | string | Sets [character_set_server](https://mariadb.com/kb/en/server-system-variables/#character_set_server). | utf8 |
| `BF_DB_COLLATION` | string | Sets [collation_server](https://mariadb.com/kb/en/server-system-variables/#collation_server). | utf8_general_ci |
| `BF_DB_LOG_WARNINGS` | string | Sets [log_warnings](https://mariadb.com/kb/en/server-system-variables/#log_warnings). | 2 |
## Helper Functions
| Function | Arguments | Purpose | Usage |
| ------------------------- | ----------------- | ------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| `db-backup` | *None* | Run backup manually. | `docker exec <> db-backup` |
| `db-export` | 1: Database name | Dumps the specified database as a SQL file to the root of the `/backup` volume. | `docker exec <> db-export <>` |
| `db-import` | 1: Database name | Executes all files in the root of the `/backup` volume. | `docker exec <> db-import <>` |
| `db-restore` | 1: Backup set | Deletes all files in `/data` volume, then restores from the specified backup dump. | `docker exec <> db-restore 202107180500` |
| `db-upgrade` | *None* | Run `mariadb-upgrade` manually - normally not necessary but performs various checks. | `docker exec <> db-upgrade` |
| `db-enable-super-user` | *None* | Give the application user permission to access all database and manage users. | `docker exec <> db-enable-super-user` |
| `db-disable-super-user` | *None* | Give the application user permission only to access application databases. | `docker exec <> db-disable-super-user` |
## Licence
> [MIT](https://mit.bfren.dev/2020)
## Copyright
> Copyright (c) 2020-2024 [bfren](https://bfren.dev) (unless otherwise stated)