{"id":18627172,"url":"https://github.com/markshust/magento-module-maintenance-key","last_synced_at":"2025-10-28T19:40:20.455Z","repository":{"id":142878423,"uuid":"118518928","full_name":"markshust/magento-module-maintenance-key","owner":"markshust","description":"Magento 2 module to enable maintenance mode viewing by parameter key","archived":false,"fork":false,"pushed_at":"2018-01-30T13:54:21.000Z","size":3,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-12-27T06:26:37.013Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/markshust.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-01-22T21:41:40.000Z","updated_at":"2024-01-06T08:38:06.000Z","dependencies_parsed_at":"2023-06-15T08:30:10.883Z","dependency_job_id":null,"html_url":"https://github.com/markshust/magento-module-maintenance-key","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markshust%2Fmagento-module-maintenance-key","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markshust%2Fmagento-module-maintenance-key/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markshust%2Fmagento-module-maintenance-key/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markshust%2Fmagento-module-maintenance-key/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/markshust","download_url":"https://codeload.github.com/markshust/magento-module-maintenance-key/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239425310,"owners_count":19636346,"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-11-07T04:40:49.554Z","updated_at":"2025-10-28T19:40:20.345Z","avatar_url":"https://github.com/markshust.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MarkShust_MaintenanceKey\n\nMagento module to enable maintenance mode viewing by parameter key.\n\n## Overview\n\nInstead of creating a file at `var/.maintenance.ip` with the list of IP addresses to allow in maintenance mode, instead create a file at `var/.maintenance.key` to allow access by list of allowed keys. This allows developers with dynamic or changing IP addresses to access Magento while the site is in maintenance mode.\n\n## Install\n\n`composer require markoshust/magento-module-maintenance-key`\n\n## Usage\n\n1. Create the file: `./var/.maintenance.key`\n2. This file should contain a comma-delimited list of keys, for example:\n\t`67BBB06F-7C54-48E0-A124-44DC22649809,883233B6-8756-460D-A3D2-8C901C21FCE7`\n3. If the site contains the file `./var/.maintenance.flag`, the site will be deemed in maintenance mode.\n4. The site can now be accessed by appending the `MAINTENANCE_KEY` parameter with a value allowed in the `./var/.maintenance.key` file, for example::\n\t`http://mysite.com/?MAINTENANCE_KEY=67BBB06F-7C54-48E0-A124-44DC22649809`\n5. If the `./var/.maintenance.key` file does not exist, maintenance mode viewing will fallback to default methods.\n\n## Extra\n\nUse the [Requestly](https://www.requestly.in/) browser plugin to auto-append the `MAINTENANCE_KEY` parameter to a site's URL.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarkshust%2Fmagento-module-maintenance-key","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarkshust%2Fmagento-module-maintenance-key","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarkshust%2Fmagento-module-maintenance-key/lists"}