In this section · 14 articles

Turn on maintenance mode

Show visitors a maintenance page while you work on Laramin, now or in a scheduled window, and choose which IP addresses can still get in.

Applies to
Core 12.7 and later
Who can do this
Administrator, Platform owner
Permission
feature.core.maintenance_mode.edit
Where
Configurations › General Settings › Maintenance Mode
On this page

Before you start

Maintenance mode closes every page of Laramin, not just the public website. That includes the admin and its REST API. While it is on, only these get through:

  • super admins. The sign-in page stays open, so a super admin can sign in at any time.
  • anyone whose IP address is in Bypass IPs
  • if Bypass IPs is empty, the server itself (127.0.0.1 or ::1)

Everyone else, administrators included, sees the maintenance page. They can still sign in, but they see the maintenance page instead of the admin until it ends.

The mobile app is closed to super admins too: it gets the maintenance answer unless the phone's address is in Bypass IPs. See The app shows a maintenance screen.

Payment providers and other services that send Laramin webhooks aren't affected, so payments made during maintenance are still recorded.

Tip: If nobody can sign in to switch it off, someone with access to the server can run php artisan app:maintenance off. It also clears a scheduled window. php artisan app:maintenance on turns it on.

Steps

  1. Open Configurations › General Settings › Maintenance Mode. The Maintenance panel opens.
  2. Optional: under Schedule & Access, enter in Bypass IPs the addresses that should still get in, for example your office's. Each one can be an IP address or a CIDR range such as 203.0.113.0/24. Separate them with commas or new lines.
  3. Under Maintenance Page, add a Maintenance Image and a Maintenance Title if you want them.
  4. Write the message visitors will see in Maintenance Content.
  5. Turn on Maintenance Mode.
  6. Select Save changes.
The Maintenance panel with Maintenance Mode switched on, a title and message filled in, and 203.0.113.0/24 entered in Bypass IPs under Schedule & Access.

Tip: You can prepare the image, title and message with Maintenance Mode off and save them. They're used the next time maintenance starts.

Schedule a maintenance window instead

  1. Leave Maintenance Mode off.

  2. Set both Start Date / Time and End Date / Time. The end can't be before the start.

    The Schedule & Access section of the Maintenance panel with Start Date / Time and End Date / Time set, and the tooltip explaining both times are in the installation's time zone, Asia/Kolkata.
  3. Select Save changes.

Laramin closes between those two times and opens again by itself afterwards. You need both times: a start time on its own does nothing.

The times are read in the installation's time zone, the Default Timezone on the System panel, whatever time zone you're in yourself. The tooltip on each field names it. See System and company settings.

What happens next

Visitors see the maintenance page, with your image, title and message, and the system name in the browser tab. The page tells search engines not to index it.

Apps and other programs that call the API get a 503 response with the code MAINTENANCE, so a mobile app can show its own maintenance screen. The answer says when maintenance ends, if you set an end time, and asks them to try again then. Without an end time, it asks them to try again in an hour.

To end maintenance early, turn Maintenance Mode off. If a scheduled window is still running, clear its start and end times too. Then select Save changes. Or run php artisan app:maintenance off on the server, which does both.