{"id":25209879,"url":"https://github.com/backdrop-contrib/readonlymode","last_synced_at":"2026-01-12T07:40:04.812Z","repository":{"id":217377315,"uuid":"743723181","full_name":"backdrop-contrib/readonlymode","owner":"backdrop-contrib","description":"Lock your Backdrop CMS site config and content so maintenance and deployments can happen without taking the site offline.","archived":false,"fork":false,"pushed_at":"2024-07-27T18:40:26.000Z","size":42,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":9,"default_branch":"1.x-1.x","last_synced_at":"2025-04-01T09:52:17.773Z","etag":null,"topics":["backdrop","backdropcms","cms","deployment","maintenance","readonly","uptime"],"latest_commit_sha":null,"homepage":"https://backdropcms.org/project/readonlymode","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/backdrop-contrib.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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":"2024-01-15T21:04:12.000Z","updated_at":"2024-07-27T18:40:29.000Z","dependencies_parsed_at":"2024-07-27T19:49:21.488Z","dependency_job_id":"e109b520-12cd-47e2-87f2-7195ca4396a6","html_url":"https://github.com/backdrop-contrib/readonlymode","commit_stats":null,"previous_names":["backdrop-contrib/readonlymode"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/backdrop-contrib/readonlymode","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/backdrop-contrib%2Freadonlymode","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/backdrop-contrib%2Freadonlymode/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/backdrop-contrib%2Freadonlymode/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/backdrop-contrib%2Freadonlymode/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/backdrop-contrib","download_url":"https://codeload.github.com/backdrop-contrib/readonlymode/tar.gz/refs/heads/1.x-1.x","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/backdrop-contrib%2Freadonlymode/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28336624,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-12T06:09:07.588Z","status":"ssl_error","status_checked_at":"2026-01-12T06:05:18.301Z","response_time":98,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["backdrop","backdropcms","cms","deployment","maintenance","readonly","uptime"],"created_at":"2025-02-10T13:18:48.474Z","updated_at":"2026-01-12T07:40:04.795Z","avatar_url":"https://github.com/backdrop-contrib.png","language":"PHP","readme":"# Read Only Mode\n\u003c!--\nThe first paragraph of this file should be kept short as it will be used as the\nproject summary on BackdropCMS.org. Aim for about 240 characters (three lines at\n80 characters each).\n\nAll lines in this file should be no more than 80 characters long for legibility,\nunless including a URL or example that requires the line to not wrap.\n|\u003c- - - - - - - This line is exactly 80 characters for reference - - - - - - -\u003e|\n\nDetail in READMEs should be limited to the minimum required for installation and\ngetting started. More detailed documentation should be moved to a GitHub wiki\npage; for example: https://github.com/backdrop-contrib/setup/wiki/Documentation.\n--\u003e\nRead Only Mode allows site administrators and developers to lock down or\nfreeze a production server so that maintenance or large deployments can occur\nwithout taking the site offline.\n\nIn a typical example, Read Only Mode is activated on the production server,\nthe database is copied to a development server where work is done, and then the\ndatabase is pushed back to the production server and Read Only Mode disabled.\n\nRead Only Mode can be checked, enabled or disabled using the user interface,\nbee or drush.\n\n### Differences from Drupal 7\n- Uses 'state' and 'config' rather than 'variables'.\n- Form IDs updated in allow/view only lists to reflect Backdrop equivalents.\n- Dedicated Bee command added to simply operations.\n- Drush command uses `state-set` and `state-get` rather than `variable-set` and\n`variable-get`.\n- Includes patch from [Issue 2458051](https://www.drupal.org/project/readonlymode/issues/2458051)\nto fix issue with View Only forms.\n- Includes an API for other modules to modify the default form lists.\n\n## Installation\n\u003c!--\nList the steps needed to install and configure the module. Add/remove steps as\nnecessary.\n--\u003e\n- Install this module using the official Backdrop CMS instructions at\n  https://docs.backdropcms.org/documentation/extend-with-modules.\n\n- Visit the configuration page under Administration \u003e Configuration \u003e\nDevelopment \u003e Maintenance mode (admin/config/development/maintenance) to\ncustomize settings.\n\n## Usage\nEnable and disable Read Only Mode using the \"Read only mode\" checkbox at\nAdministration \u003e Configuration \u003e Development \u003e Maintenance mode\n(admin/config/development/maintenance).\n\nOn this page, it is also possible to:\n- Customize the messages that are shown to users when Read Only Mode is\nenabled.\n- Redirect users to a specific page instead of showing messages.\n- Define additional forms that are allowed using the form id.\n- Define additional forms that can be accessed as view only forms.\n\nYou may want to allow other forms if the form does not write to the Backdrop\ndatabase, but instead sends the form content to a different web service or by\nemail.\n\nYou may want to allow other forms to be viewed but not changed so users can\ncheck details but not make changes.\n\nThe module provides a permission that overrides access restrictions and can be\ngiven to administrators; user 1 can access all forms regardless of the\npermission.\n\n### Bee support\nThis module adds a dedicated bee command to enable, disable and check status of\nRead Only Mode. It can be used with `bee readonlymode`, `bee ro` or `bee rom`.\n\nThe command will treat `1`, `true`, `TRUE` as `TRUE` and `0`, `false`, `FALSE`\nas `FALSE`.\n\n- Check the status:         `bee readonlymode`\n- Turn on Read Only Mode:   `bee readonlymode 1`\n- Turn off Read Only Mode:  `bee readonlymode 0`\n\n### Drush support\nAs Read Only Mode is defined by a single state, it is easy to use Drush\nto enable and disable the mode. Drush aliases `sget` and `sset` will also work\nhere.\n\n- Check the status:         `drush state-get site_readonly`\n- Turn on Read Only Mode:   `drush state-set site_readonly 1`\n- Turn off Read Only Mode:  `drush state-set site_readonly 0`\n\n### API support\nThe module has an API to support modification of the lists of allowed forms and\nview only forms by other contrib and custom modules. See `readonlymode.api.php`\nfor more details.\n\nIssues\n------\n\u003c!--\nLink to the repo's issue queue.\n--\u003e\nBugs and Feature Requests should be reported in the Issue Queue:\nhttps://github.com/backdrop-contrib/readonlymode/issues.\n\n\nCurrent Maintainers\n-------------------\n\u003c!--\nList the current maintainer(s) of the module, and note if this module needs\nnew/additional maintainers.\n--\u003e\n- [Martin Price](https://github.com/yorkshire-pudding) - [System Horizons Ltd](https://www.systemhorizons.co.uk)\n- Collaboration and co-maintainers welcome!\n\nCredits\n-------\n\u003c!--\nGive credit where credit's due.\nIf this is a Drupal port, state who ported it, and who wrote the original Drupal\nmodule. If this module is based on another project, or uses third-party\nlibraries, list them here. You can also mention any organisations/companies who\nsponsored the module's development.\n--\u003e\n- Ported to Backdrop CMS by - [Martin Price](https://github.com/yorkshire-pudding) - [System Horizons Ltd](https://www.systemhorizons.co.uk).\n- Port sponsored by [System Horizons Ltd](https://www.systemhorizons.co.uk).\n- Originally written for Drupal by [Sharique Farooqui](https://www.drupal.org/u/sharique)\n\nLicense\n-------\n\u003c!--\nMention what license this module is released under, and where people can find\nit.\n--\u003e\n\nThis project is GPL v2 software.\nSee the LICENSE.txt file in this directory for complete text.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbackdrop-contrib%2Freadonlymode","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbackdrop-contrib%2Freadonlymode","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbackdrop-contrib%2Freadonlymode/lists"}