MariaDB Package Repository Setup and Usage

Overview

If you are looking to set up MariaDB Server, it is often easiest to use a repository. MariaDB Corporation provides two convenient shell scripts to configure access to their MariaDB Package Repositories:

• mariadb_es_repo_setup for MariaDB Enterprise Server, which can be downloaded from:

  • https://dlm.mariadb.com/enterprise-release-helpers/mariadb_es_repo_setup

• mariadb_repo_setup for MariaDB Community Server, which can be downloaded from:

  • https://r.mariadb.com/downloads/mariadb_repo_setup

Using MariaDB Corporation's Repository Setup Scripts

Downloading and Verifying the Scripts

The scripts can be downloaded and verified in the following ways:

curl -LsSO https://dlm.mariadb.com/enterprise-release-helpers/mariadb_es_repo_setup

echo "${checksum} mariadb_es_repo_setup" | sha256sum -c -

curl -LsSO https://r.mariadb.com/downloads/mariadb_repo_setup

echo "${checksum} mariadb_repo_setup" | sha256sum -c -

Script Prerequisites

For the scripts to work, the curl package needs to be installed on your system. Additionally, on Debian and Ubuntu, the apt-transport-https package needs to be installed. The script will check if these are installed and let you know before it attempts to create the repository configuration on your system.

They can be installed on your system as follows:

Running the Scripts

After the script you are using is downloaded, you need to run it with root user permissions. This is normally accomplished using the sudo command:

Repositories

Supported Distributions

The MariaDB Package Repository setup scripts are designed for Linux distributions that meet MariaDB's current platform support policy. Supported platforms may vary over time and can differ across different MariaDB release series.

For a comprehensive and current list of supported platforms, refer to:

• MariDB Engineering Policy

• The MariaDB Downloads page for your specific version

If the setup script does not support your distribution, you can install MariaDB using the MariaDB Foundation's Repository Configuration Tool or check your distribution's native repositories for MariaDB packages.

Options

Using Options with Curl One-line usage

If you are running the script by piping the curl command to bash and you want to provide options to the script, you must tell it to expect them by executing bash with the options -s --, for example, to run the script with the --help option:

Full List of Options

The --mariadb-server-version Option

By default, the script will configure your system to install from the repository of the latest GA version of MariaDB. If a new major GA release occurs and you would like to upgrade to it, then you will need to either manually edit the repository configuration file to point to the new version or run the script again.

The script can also configure your system to install from the repository of a different version of MariaDB by using the --mariadb-server-version option.

Usage Example

Current Supported Major Versions

Pinning the Repository to a Specific Minor Release

The --mariadb-maxscale-version Option

By default, the script will configure your system to install from the repository of the latest GA version of MariaDB MaxScale.

If you would like to pin the repository to a specific version of MariaDB MaxScale, then you will need to either manually edit the repository configuration file to point to the desired version or use the --mariadb-maxscale-version option.

For example, to configure your system to install from the repository of MariaDB MaxScale 6.1, that would be:

The following MariaDB MaxScale versions are supported:

• MaxScale 25.10

• MaxScale 25.01

• MaxScale 24.02

• MaxScale 23.08

• MaxScale 23.02

• MaxScale 22.08

The special identifiers latest (for the latest GA release) and beta (for the latest beta release) are also supported. By default, the mariadb_repo_setup script uses latest as the version.

The --os-type and --os-version Options

If you want to run this script on an unsupported OS that you believe to be package-compatible with an OS that is supported, then you can use the --os-type and --os-version options to override the script's OS detection. If you use either option, then you must use both options.

The supported values for --os-type are:

• rhel

• debian

• ubuntu

• sles

If you use a non-supported value, then the script will fail, just as it would fail if you ran the script on an unsupported OS.

The supported values for --os-version are entirely dependent on the OS type.

For Red Hat Enterprise Linux (RHEL): 8, 9, and 10 are valid options.

For Debian and Ubuntu, the version must be specified as the codename of the specific release. For example, Debian 13 must be specified as trixie, and Ubuntu 24.04 must be specified as noble.

These options can be useful if your distribution is a fork of another distribution. As an example, Pop!_OS 24.04 LTS is based on and is fully compatible with Ubuntu 24.04 LTS (noble). Therefore, if you are using Pop!_OS, then you can configure your system to install from the repository of Ubuntu 24.04 LTS (noble) by specifying --os-type=ubuntu`` ``--os-version=noble to the MariaDB Package Repository setup script.

For example, to manually set the --os-type and --os-version to RHEL 10, you could do:

The --apply and --write-to-stdout Options

The mariadb_repo_setup and mariadb_es_repo_setup scripts generally behave the same but there are some key differences. One of the major ones relates to the options --apply and --write-to-stdout.

The --apply option is only for mariadb_es_repo_setup. It directs the script to apply the changes to the system, including creating the repository configuration file, importing the repository GPG keys, and updating the package cache. mariadb_repo_setup does this by default, so it does not have the --apply option and instead has the --write-to-stdout option to flip the behavior.

The --write-to-stdout option is only for mariadb_repo_setup. It will prevent the script from modifying anything on the system. The repository configuration will not be written to the repository configuration file, GPG keys will not be imported, and the package cache will not be updated. Instead, the repository configuration will be printed to standard output (stdout). This allows the configuration to be reviewed, redirected elsewhere, consumed by another script, or used in some other way. mariadb_es_repo_setup does this by default, so it does not have the --write-to-stdout option, and instead has the --apply option to flip the behavior.

The --write-to-stdout option automatically enables --skip-key-import.

For example:

Both scripts will ignore unknown options so it is safe to, for example, always pass --apply to both scripts so that their behavior is the same.

Platform-Specific Behavior

Locations of the repository configuration file the scripts will create on various Linux distributions and other tasks the scripts do on those distributions.

Installing Packages With the MariaDB Package Repository

After setting up the MariaDB Package Repository, you can install the software packages in the supported repositories.

Versions

The version number of each script is a date, which you can find by running the script with the --version option, or by opening the script in a text editor and looking at line 4, version="...". The tables below list the released versions of each script and their sha256sum checksums.

_{This page is licensed: CC BY-SA / Gnu FDL}