github.com/tiredofit/docker-mariadb

About

This will build a Docker image for MariaDB. A relational database forked from MySQL.

• Configuration tweaked to use all around settings for general usage - Can be changed
• Can use official Mysql/MariaDB environment variables (MYSQL_USER, MYSQL_PASSWORD, MYSQL_ROOT_PASSWORD)
• Allows for automatically creating multiple databases on container initialization and subsequent reboots
• Automatic Table/DB Upgrade support if MariaDB version has changed
• Includes MySQL Tuner inside image to optimize your configuration
• Logging with automatic rotation
• Zabbix Monitoring for metrics

Also has the capability of backing up embedded in the container based on the tiredofit/dbbackup image which includes the following features:

• dump to local filesystem
• Backup all databases
• choose to have an MD5?SHA sum after backup for verification
• delete old backups after specific amount of time
• choose compression type (none, gz, bz, xz,zstd)
• select how often to run a dump
• select when to start the first dump, whether time of day or relative to container start time

Maintainer

• Dave Conroy

Table of Contents

• About
• Maintainer
• Table of Contents
• Installation
  • Build from Source
  • Prebuilt Images
    • Multi Architecture
• Configuration
  • Quick Start
  • Persistent Storage
  • Environment Variables
    • Base Images used
    • Container Options
    • MariaDB Options
    • Database Options
    • Logging Options
    • Backup Options
      • Database Options
      • Scheduling Options
      • Other Backup Options
    • Backing Up to S3 Compatible Services
    • Upload to a Azure storage account by blobxfer
  • Networking
• Maintenance
  • Shell Access
  • Mysql Tuner
  • Manual Backups
• Contributions
• Support
  • Usage
  • Bugfixes
  • Feature Requests
  • Updates
• License
• References

Installation

Build from Source

Clone this repository and build the image with docker build <arguments> (imagename) .

Prebuilt Images

Builds of the image are available on Docker Hub

docker pull docker.io/tiredofdit/mariadb:(imagetag)

Builds of the image are also available on the Github Container Registry

docker pull ghcr.io/tiredofit/docker-mariadb:(imagetag)

The following image tags are available along with their tagged release based on what's written in the Changelog:

Multi Architecture

Images are built primarily for amd64 architecture, and may also include builds for arm/v7, arm64 and others. These variants are all unsupported. Consider sponsoring my work so that I can work with various hardware. To see if this image supports multiple architecures, type docker manifest (image):(tag)

Configuration

Quick Start

• The quickest way to get started is using docker-compose. See the examples folder for a working compose.yml that can be modified for development or production use.

• Set various environment variables to understand the capabilities of this image.

• Map persistent storage for access to configuration and data files for backup.

• Make networking ports available for public access if necessary

Persistent Storage

The following directories are used for configuration and can be mapped for persistent storage.

Environment Variables

Base Images used

This image relies on an Alpine Linux base image that relies on an init system for added capabilities. Outgoing SMTP capabilities are handlded via msmtp. Individual container performance monitoring is performed by zabbix-agent. Additional tools include: bash,curl,less,logrotate,nano,vim.

Be sure to view the following repositories to understand all the customizable options:

Container Options

MariaDB Options

• With regards to DB_CONFIGURATION
  • default - Means the default my.cnf file from MariaDB
  • standard - My own settings that I find work for my own DB servers.

Database Options

Automatically create user databases on startup. This can be done on each container start, and then removed on subsequent starts if desired.

OR

Create multiple databases and different usernames and passwords to access. You can share usernames and passwords for multiple databases by using the same user and password in each entry.

Logging Options

Backup Options

The backup functionality is a subset of the tiredofit/db-backup image. Please have a peek at the README to understand ways to use. All features have been carried over with the exception of being able to backup remote systems - It is hardcoded to connect to the MariaDB socket not requiring DB_HOST/DB_PORT variables.

Database Options

Scheduling Options

Other Backup Options

Backing Up to S3 Compatible Services

If DB_BACKUP_LOCATION = S3 then the following options are used.

• When DB_BACKUP_S3_KEY_ID and/or DB_BACKUP_S3_KEY_SECRET is not set, will try to use IAM role assigned (if any) for uploading the backup files to S3 bucket.

Upload to a Azure storage account by blobxfer

Support to upload backup files with blobxfer to the Azure fileshare storage.

If DB_BACKUP_BACKUP_LOCATION = blobxfer then the following options are used.

This service uploads files from backup targed directory DB_BACKUP_DUMP_TARGET. If the a cleanup configuration in DB_BACKUP_CLEANUP_TIME is defined, the remote directory on Azure storage will also be cleaned automatically.

Networking

The following ports are exposed.

Maintenance

Inside the image are tools to perform modification on how the image runs.

Shell Access

For debugging and maintenance purposes you may want access the containers shell.

docker exec -it (whatever your container name is) bash

Mysql Tuner

This image comes with Mysql Tuner. Simply enter inside the container and execute mysql-tuner along with your arguments.

Manual Backups

Manual Backups can be perforemd by entering the container and typing backup-now

Contributions

Welcomed. Please fork the repository and submit a pull request for any bug fixes, features or additions you propose to be included in the image. If it does not impact my intended usage case, it will be merged into the tree, tagged as a release and credit to the contributor in the CHANGELOG.

Support

These images were built to serve a specific need in a production environment and gradually have had more functionality added based on requests from the community.

Usage

• The Discussions board is a great place for working with the community on tips and tricks of using this image.
• Sponsor me for personalized support

Bugfixes

• Please, submit a Bug Report if something isn't working as expected. I'll do my best to issue a fix in short order.

Feature Requests

• Feel free to submit a feature request, however there is no guarantee that it will be added, or at what timeline.
• Sponsor me regarding development of features.

Updates

• Best effort to track upstream changes, More priority if I am actively using the image in a production environment.
• Sponsor me for up to date releases.

License

MIT. See LICENSE for more details.

References

• https://mariadb.org