{"id":13824987,"url":"https://github.com/fusic/maintenance","last_synced_at":"2025-04-15T14:34:28.481Z","repository":{"id":971545,"uuid":"767335","full_name":"fusic/maintenance","owner":"fusic","description":"Maintenance plugin for CakePHP","archived":false,"fork":false,"pushed_at":"2021-03-02T01:43:17.000Z","size":34,"stargazers_count":43,"open_issues_count":1,"forks_count":15,"subscribers_count":8,"default_branch":"3.0","last_synced_at":"2024-09-17T20:29:57.406Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fusic.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2010-07-10T07:18:39.000Z","updated_at":"2021-07-03T07:12:21.000Z","dependencies_parsed_at":"2022-08-16T11:40:25.017Z","dependency_job_id":null,"html_url":"https://github.com/fusic/maintenance","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fusic%2Fmaintenance","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fusic%2Fmaintenance/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fusic%2Fmaintenance/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fusic%2Fmaintenance/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fusic","download_url":"https://codeload.github.com/fusic/maintenance/tar.gz/refs/heads/3.0","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223827174,"owners_count":17209733,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-04T09:01:13.095Z","updated_at":"2024-11-09T12:29:46.445Z","avatar_url":"https://github.com/fusic.png","language":"PHP","readme":"# Maintenance Plugin for CakePHP\r\n\r\n## Installation\r\n\r\nYou can install this plugin into your CakePHP application using [composer](http://getcomposer.org).\r\n\r\nThe recommended way to install composer packages is:\r\n\r\n```\r\ncomposer require fusic/maintenance\r\n```\r\n\r\n## Usage\r\n\r\n```php\r\n// src/Application.php\r\n\u003c?php\r\n\r\n// Add use\r\nuse Maintenance\\Middleware\\MaintenanceMiddleware;\r\n\r\n    public function middleware($middleware)\r\n    {\r\n        $middleware\r\n            // Add Maintenance Plugin\r\n            -\u003eadd(MaintenanceMiddleware::class)            \r\n            \r\n            -\u003eadd(ErrorHandlerMiddleware::class)\r\n            -\u003eadd(AssetMiddleware::class)\r\n            -\u003eadd(RoutingMiddleware::class);\r\n\r\n        return $middleware;\r\n    }\r\n```\r\n\r\n```html\r\n// src/Template/Error/maintenance.ctp\r\n\r\n\u003cp\u003emaintenance page. \u003c/p\u003e\r\n```\r\n\r\n```\r\n// tmp/maintenance\r\n\r\ntouch tmp/maintenance\r\n```\r\n\r\n## Config\r\n### useXForwardedFor\r\n\r\nIf your system is behind a reverse proxy like load balancer that adds X-Forwarded-For header, set useXForwardedFor as true.\r\n\r\n```php\r\n// src/Application.php\r\nuse Maintenance\\Middleware\\MaintenanceMiddleware;\r\n\r\n    public function middleware($middleware)\r\n    {\r\n        $middleware\r\n            -\u003eadd(new MaintenanceMiddleware([\r\n                'allowIp' =\u003e [\r\n                    '127.0.0.1',\r\n                ],\r\n                'useXForwardedFor' =\u003e true,\r\n            ]))\r\n            -\u003eadd(ErrorHandlerMiddleware::class)\r\n            -\u003eadd(AssetMiddleware::class)\r\n            -\u003eadd(RoutingMiddleware::class);\r\n        return $middleware;\r\n    }\r\n```\r\n","funding_links":[],"categories":["PHP"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffusic%2Fmaintenance","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffusic%2Fmaintenance","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffusic%2Fmaintenance/lists"}