README

A WordPress maintenance mode module for Altis that displays a user-friendly maintenance page when your site is under maintenance, controlled via Altis environment variables.

Why?

WordPress' built-in maintenance mode isn't compatible with multi-server architecture like Altis, since it writes out to a .maintenance file.

However, there are times where you might still need to enable it - upgrading the database, rolling out substantial changes, or performing imports.

This package adds a maintenance mode which can be controlled through an Altis Dashboard variable.

This maintenance mode runs before the WordPress database loads, allowing you to perform invasive maintenance on the database including full downtime if needed.

Installation

We're working on adding this to Altis natively.

In the meantime, you can add it by adding this package to your site:

composer require altis/maintenance-mode

Usage

1. Navigate to the Altis Dashboard
2. Select your environment
3. Go to Settings → Variables
4. Add a new variable:
   • Name: MAINTENANCE_MODE
   • Value: true

Then, deploy your site to update the variables. The maintenance page will be displayed across your entire site.

The login form, admin, and CLI are unaffected by maintenance mode, enabling you to continue administrative tasks if needed.