> For the complete documentation index, see [llms.txt](https://mariadb.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://mariadb.com/docs/maxscale/maxscale-management.md).

# MaxScale Management

- [Deployment](https://mariadb.com/docs/maxscale/maxscale-management/deployment.md): Access essential guides for deploying MariaDB MaxScale including installation, configuration, upgrades, and using the MaxGUI browser-based interface for management and monitoring.
- [Installation & Configuration](https://mariadb.com/docs/maxscale/maxscale-management/deployment/installation-and-configuration.md): Choose the right installation method for MariaDB MaxScale. This section includes guides for building from source code and installing via tarballs for custom or non-standard deployments.
- [MaxScale Installation Guide](https://mariadb.com/docs/maxscale/maxscale-management/deployment/installation-and-configuration/maxscale-installation-guide.md): Install MariaDB MaxScale on Linux using official package repositories or RPM/DEB files. This guide details setup for RHEL, Debian, and SLES, plus essential memory and backup configuration.
- [MaxScale Dependencies](https://mariadb.com/docs/maxscale/maxscale-management/deployment/installation-and-configuration/maxscale-dependencies.md): How to obtain the complete list of MariaDB MaxScale runtime dependencies on Debian, Ubuntu, RHEL, Rocky Linux, Alma Linux, SLES, and container images.
- [Installing MaxScale Using a Tarball](https://mariadb.com/docs/maxscale/maxscale-management/deployment/installation-and-configuration/installing-maxscale-using-a-tarball.md): Install MariaDB MaxScale manually using generic tarball binaries. Learn the system requirements, directory setup, and configuration steps to run MaxScale without a package manager.
- [MaxScale Configuration Guide](https://mariadb.com/docs/maxscale/maxscale-management/deployment/installation-and-configuration/maxscale-configuration-guide.md): Complete MariaDB MaxScale configuration guide. Complete reference for listeners, servers, monitors, routers, and SSL settings with comprehensive examples and.
- [Deploy MaxScale with Docker](https://mariadb.com/docs/maxscale/maxscale-management/deployment/installation-and-configuration/deploy-maxscale-with-docker.md)
- [Upgrading MaxScale](https://mariadb.com/docs/maxscale/maxscale-management/deployment/upgrading-maxscale.md): Review critical information and procedures for upgrading MariaDB MaxScale versions. Learn about new features deprecated functionality and specific steps for each version transition.
- [Upgrade to MaxScale 25.01](https://mariadb.com/docs/maxscale/maxscale-management/deployment/upgrading-maxscale/upgrade-to-maxscale-25.01.md): Follow the specific steps to upgrade MariaDB MaxScale to version 25.01. This guide covers new package structures, removed features, and critical configuration changes for this release.
- [MaxScale MaxGUI Guide](https://mariadb.com/docs/maxscale/maxscale-management/deployment/maxscale-maxgui-guide.md): Learn to use MaxGUI, the browser-based interface for MariaDB MaxScale. Discover how to enable the GUI, secure access, visualize clusters, and execute queries directly from your dashboard.
- [Configuring MaxScale's REST API](https://mariadb.com/docs/maxscale/maxscale-management/configuring-maxscales-rest-api.md): Enable remote management by configuring the MaxScale REST API. Learn to set listening ports, bind addresses, and secure administrative traffic with TLS.
- [Operating MaxScale](https://mariadb.com/docs/maxscale/maxscale-management/operating-maxscale.md): Perform day-to-day operations on MaxScale. This section covers managing REST API users, rotating logs, and enabling TLS for secure client connections.
- [Understanding MaxScale's Administrative Interfaces](https://mariadb.com/docs/maxscale/maxscale-management/understanding-maxscales-administrative-interfaces.md): Compare the available tools for managing MaxScale. Understand the differences between the MaxCtrl command-line utility, the MaxGUI web interface, and the REST API.
- [MaxScale 25.01 Limitations and Known Issues within MariaDB MaxScale](https://mariadb.com/docs/maxscale/maxscale-management/mariadb-maxscale-limitations-guide.md): Review the current constraints of MariaDB MaxScale. This document lists known issues regarding transaction parsing, protocol support, and specific module limitations.
- [MaxScale Troubleshooting](https://mariadb.com/docs/maxscale/maxscale-management/maxscale-troubleshooting.md): Diagnose and resolve common MaxScale issues. Find solutions for systemd watchdog kills, high memory usage, authentication failures, and connectivity errors.
- [MaxCtrl](https://mariadb.com/docs/maxscale/maxscale-management/administrative-tools-for-mariadb-maxscale-maxctrl.md): Manage your MariaDB MaxScale instance using MaxCtrl, a command-line utility for the REST API. Monitor status, configure services, and handle administrative tasks efficiently.
- [Connecting to MaxScale using TLS with MaxCtrl](https://mariadb.com/docs/maxscale/maxscale-management/administrative-tools-for-mariadb-maxscale-maxctrl/connecting-to-maxscale-using-tls-with-maxctrl.md): Learn how to secure your MaxCtrl connections using TLS. This guide details the necessary MaxScale configuration parameters and command-line flags to enable encrypted administrative sessions.
- [Creating a REST API User for MaxScale with MaxCtrl](https://mariadb.com/docs/maxscale/maxscale-management/administrative-tools-for-mariadb-maxscale-maxctrl/creating-a-rest-api-user-for-maxscale-with-maxctrl.md): Create new users for the MaxScale REST API using MaxCtrl. This page explains the difference between basic and admin users and provides command examples for adding credentials to your system.
- [Deleting a REST API User for MaxScale with MaxCtrl](https://mariadb.com/docs/maxscale/maxscale-management/administrative-tools-for-mariadb-maxscale-maxctrl/deleting-a-rest-api-user-for-maxscale-with-maxctrl.md): Remove unwanted or obsolete REST API users from your MariaDB MaxScale instance. This guide demonstrates how to safely delete user credentials using the MaxCtrl command-line utility.
- [Setting a Server to Maintenance Mode in MaxScale with MaxCtrl](https://mariadb.com/docs/maxscale/maxscale-management/administrative-tools-for-mariadb-maxscale-maxctrl/maxctrl-setting-a-server-to-maintenance-mode-in-maxscale-with-maxctrl.md): Perform server maintenance safely. Learn how to use MaxCtrl to gracefully drain connections or force a server into maintenance mode, effectively removing it from the load balancing pool.
- [Removing a Server using MaxCtrl](https://mariadb.com/docs/maxscale/maxscale-management/administrative-tools-for-mariadb-maxscale-maxctrl/removing-a-server-using-maxctrl.md)
- [MaxGUI](https://mariadb.com/docs/maxscale/maxscale-management/maxgui.md): Manage MariaDB MaxScale visually with MaxGUI. This browser-based dashboard simplifies configuration, monitoring, and administration tasks for your database proxy instances.
- [Configuring MaxScale for MaxGUI](https://mariadb.com/docs/maxscale/maxscale-management/maxgui/configuring-maxscale-for-maxgui.md): Enable the MaxGUI dashboard by configuring the MaxScale REST API. Learn to set up network listeners, enable TLS security, and create the required administrative user credentials.
- [Setting a Server to Maintenance Mode in MaxScale with MaxGUI](https://mariadb.com/docs/maxscale/maxscale-management/maxgui/maxgui-setting-a-server-to-maintenance-mode-in-maxscale-with-maxgui.md): Safely remove a server from rotation using the MaxGUI dashboard. This guide shows how to enable maintenance mode to stop traffic routing and gracefully drain connections for upgrades.