Skip to content
Barry O'Donovan edited this page Aug 3, 2013 · 4 revisions

Introduced in V3.4.0.

While most updates of IXP Manager are quick, some may be more involved with schema updates or complicated migration steps. In these cases it's useful and advisable to put IXP Manager in maintenance mode.

When maintenance mode is enabled, the front-end will make it abundantly clear that the user is in maintenance mode via page titles and footer alerts. This way, the user will not forget to disable maintenance mode when finished. There is also a defined constant called MAINTENANCE_MODE which will evaluate as true or false.

Set Up Maintenance Mode

To set up maintenance mode, copy our default file as follows:

cd APPLICATION_PATH/public
cp maintenance.dist.php maintenance.php

Then edit maintenance.php as you like - while ensuring to add some additional $safe_ips at the top - these are the IP addresses that you will use when performing maintenance / tests.

You can view the default sample maintenance page at your installation via http[s]://www.example.com/ixp/maintenance.dist.php.

Enabling / Disabling Maintenance Mode

Enabling maintenance mode is as simple as:

cd APPLICATION_PATH
touch MAINT_MODE_ENABLED

To disable it, just do the opposite:

cd APPLICATION_PATH
rm MAINT_MODE_ENABLED

Maintenance Mode Effects on IXPtool

Upgrades may require the use of bin/ixptool.php. Maintenance mode will prevent this from running by default. You can override this for maintenance actions by passing it the -f flag. E.g.:

APPLICATION_PATH/bin/ixptool.php -f -a xx.yyy