klxf/flarum-maintenance

Highly customizable maintenance mode

Maintainers

Details

github.com/klxf/flarum-maintenance

Source

Issues

Installs: 5

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 0

Forks: 0

Open Issues: 0

Language:TypeScript

Type:flarum-extension

1.0.1 2025-09-15 08:52 UTC

Requires

MIT b7f91cb8a403154fd22db794ae4fa4e5826b0150

  • Fang_Zhijian <klxf.woop@vip.qq.com>

flarum

This package is auto-updated.

Last update: 2025-09-15 08:53:11 UTC

README

License Latest Stable Version Total Downloads

A Flarum extension. Highly customizable maintenance mode.

Features

  • Enable/disable maintenance mode.
  • Customizable maintenance page with HTML support.
  • Only administrators can access the forum when maintenance mode is enabled.

Installation

Install with composer:

composer require klxf/flarum-maintenance:"*"

Updating

composer update klxf/flarum-maintenance:"*"
php flarum migrate
php flarum cache:clear

Placeholders

You can use the following placeholders in the maintenance page:

  • $forumStyle - The forum's CSS styles.
  • $settings - The forum's settings.
    • Example: $settings->get('forum_title') for the forum title.
  • $url - Flarum URL Generator.
    • Example: $url->to('forum')->base() for the forum base URL.

Links