README

A Symfony bundle that lets you enable or disable a Coming Soon page for your application with a single configuration flag.

Features

• Toggle the coming soon page on/off via a single enabled flag
• Configurable HTTP status code (default: 503 Service Unavailable)
• Customisable Twig template
• IP whitelist – allow specific IP addresses to bypass the coming soon page
• Excluded routes – allow specific named routes to pass through
• Excluded paths – allow specific URL path prefixes to pass through (e.g. /admin)
• Symfony Web Debug Toolbar / Profiler (/_wdt, /_profiler) is automatically allowed through when kernel.debug is true

Installation

composer require jack009/coming-soon-symfony-bundle

Register the bundle in config/bundles.php:

return [
    // ...
    Jack009\ComingSoonBundle\ComingSoonBundle::class => ['all' => true],
];

Configuration

Create config/packages/coming_soon.yaml:

coming_soon:
    enabled: true                                      # set to false to disable
    template: '@ComingSoon/coming_soon.html.twig'      # optional, override the template
    status_code: 503                                   # optional, default 503
    whitelisted_ips:                                   # optional
        - 127.0.0.1
        - 192.168.1.100
    excluded_routes:                                   # optional
        - app_health_check
    excluded_paths:                                    # optional
        - /admin

Options

Custom Template

Override the built-in template by pointing template at your own Twig file:

coming_soon:
    enabled: true
    template: 'coming_soon/index.html.twig'

The template receives one variable:

License

MIT