Maintenance mode

This app features a maintenance mode, allowing temporary shutdowns for updates, repairs, and other maintenance tasks. During maintenance mode, regular users will encounter a custom message indicating that the app/site is undergoing maintenance whenever they attempt to access any URL within the app. However, administrators retain full access to the app, enabling them to perform tests and ensure smooth operation.

To enable the maintenance mode...

  1. Open this configuration file: [app_root]/Nudasoft/App/Config/Main.php.
  2. Locate this config item: public $app_maintenanceMode.
  3. Set it to boolean true and save the config file.

If maintenance mode is on...

If maintenance mode is activated, users will encounter a screen similar to the one depicted in the image below, regardless of the URL they attempt to access.

Maintenance mode is on

Access the app/site while in the maintenance mode...

For app/site administrators, it's crucial to access the app/site while in maintenance mode for testing purposes. To do so, you need to set the maintenance mode bypass cookie in the web browser. To accomplish this, you must access the maintenance mode bypass special route/URL once. This action will place a special cookie in your web browser, allowing you to access the app/site normally. To indicate that you are currently in maintenance mode, the app/site will display a special alert stating Maintenance mode is on. This alert informs you that despite being able to access the site/app normally, maintenance mode is active.

The special maintenance mode bypass route/URL...

In the [app_root]/Nudasoft/App/Config/Main.php config file, there is a config item called: public $app_maintenanceModeBypassRoute. this item already set to a special random text string. you have to use this special text string in a url format like http://localhost:8080/index.php/maintenance/mode/bypass/route/[special text string],
http://localhost:8080/maintenance/mode/bypass/route/[special text string] or
http://example.com/maintenance/mode/bypass/route/[special text string].
Its recommended to change this config value every time before you are starting a new maintenance mode session. And keep this route and the special text string as a secret.

If bypass cookie successfully set...

If the maintenance mode bypass cookie is successfully set in your web browser, you can access the site/app normally, with an alert indicating that the site/app is still in maintenance mode.

Maintenance mode bypass

To turn off the maintenance mode...

  1. Open this configuration file: [app_root]/Nudasoft/App/Config/Main.php.
  2. Locate this config item: public $app_maintenanceMode.
  3. Set it to boolean false and save the config file.
Copyright © Nudasoft.