README

A Kirby CMS plugin that provides coming soon/maintenance mode functionality, hiding the website from non-logged-in users when enabled.

Installation

Manual Installation

Download and copy this repository to /site/plugins/kirby-coming-soon.

Composer

composer require kozmozio/kirby-coming-soon

Configuration

Config File

Add the following to your site/config/config.php:

'kozmozio.coming.soon' => [
    'enabled' => true,
    'ignore' => [],
    'title' => 'Coming Soon',
    'description' => 'This website is currently under maintenance and will be back online soon.',
    'redirect_url' => false
]

Options

Panel Configuration

You can also configure the plugin via the Kirby Panel by extending your site blueprint:

# site/blueprints/site.yml
tabs:
  comingsoon:
    extends: kozmoz/comingsoon

This adds a "Coming Soon" tab to your site settings with fields for:

• Enable/disable toggle
• Redirect URL
• Title
• Description (rich text)

Activation Methods

The plugin can be activated in several ways:

1. Config option: Set 'enabled' => true in config
2. Panel toggle: Enable via the Panel UI
3. File-based: Create a .comingsoon file in your site root
4. Global option: Set 'maintenance' => true in config

Ignored Paths

By default, these paths are always accessible:

• assets
• api
• media
• panel

Add custom paths via the ignore option.

Logged-in Users

Logged-in users (via Kirby Panel) can always access the full website, even when coming soon mode is enabled.

License

MIT

Author

Kozmozio - https://kozmoz.io