https://github.com/novactive/novaezmaintenancebundle
https://github.com/novactive/novaezmaintenancebundle
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/novactive/novaezmaintenancebundle
- Owner: Novactive
- License: mit
- Created: 2020-11-25T04:28:14.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-18T08:50:06.000Z (over 1 year ago)
- Last Synced: 2025-04-10T20:50:51.433Z (11 months ago)
- Language: PHP
- Size: 47.9 KB
- Stars: 0
- Watchers: 7
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Novactive eZ Maintenance Bundle
----
This repository is what we call a "subtree split": a read-only copy of one directory of the main repository.
It is used by Composer to allow developers to depend on specific bundles.
If you want to report or contribute, you should instead open your issue on the main repository: https://github.com/Novactive/Nova-eZPlatform-Bundles
Documentation is available in this repository via `.md` files but also packaged here: https://novactive.github.io/Nova-eZPlatform-Bundles/master/MaintenanceBundle/README.md.html
----
[](https://packagist.org/packages/novactive/ezmaintenance)
[](https://github.com/Novactive/NovaeZMaintenanceBundle/releases)
[](LICENSE)
Easily enable a Maintenance page.
## Installation
### Step 1: Download using composer
Add the lib to your composer.json, run `composer require novactive/ezmaintenancebundle` to refresh dependencies.
### Step 2: Enable the bundle
Then inject the bundle in the `bundles.php` of your application.
```php
Novactive\NovaeZMaintenanceBundle\NovaeZMaintenanceBundle::class => [ 'all'=> true ],
```
### Step 3: Add the default routes
Activate the sroutes:
```yml
_novaezmaintenance_routes:
resource: '@NovaeZMaintenanceBundle/Resources/config/routing/main.yaml'
```
### Step 4: Clear the cache and check
```bash
php app|ezpublish/console cache:clear --env=dev
```
### Step 5: check X-Maintenance response header to VCL
Maintenance page will return 503 status code and VCL will abandon it,
So update your vcl to force displaying response with 503 and X-Maintenance header
```vcl
if (bereq.http.accept ~ "application/vnd.fos.user-context-hash"
&& beresp.status >= 500 && !beresp.http.X-Maintenance
) {
return (abandon);
}
```
## Configuration
```yaml
nova_ezmaintenance:
system:
default:
enable: false # to enable to capability
template: '@ibexadesign/maintenance.html.twig' # the template you want as a maintenace page
lock_file_id: 'plop.lock' # the name of the lock file in the cluster
```