Vue Storefront is now Alokai! Learn More
Maintenance Mode

Maintenance Mode

The documentation only applies to instances deployed on Alokai@Edge.

Maintenance Mode allows you to temporarily take your store offline and serve a custom maintenance page to all visitors. When enabled, all requests are redirected to the maintenance page, except for addresses on the Maintenance allow IP list.

This feature is useful during planned upgrades, deployments, or troubleshooting when you want to prevent regular traffic from accessing the site.

The IP access list does not apply when Maintenance Mode is active. Maintenance Mode uses its own Maintenance allow IP list to define which addresses can bypass the maintenance page.

Configurationri:link

General behavior

  • You can enable or disable Maintenance Mode at any time.
  • When enabled, all requests are redirected to the maintenance page, except for IPs on the Maintenance allow IP list.
  • A custom HTML page can be uploaded and served as the maintenance page.
  • You can define IP addresses or CIDR ranges in the Maintenance allow IP list that bypass Maintenance Mode and continue to access the storefront.

Steps

  1. Upload a maintenance page – provide the HTML file that will be shown to all visitors.
  2. Add IPs to the Maintenance allow IP list – enter IPv4, IPv6, or CIDR ranges (e.g., 203.0.113.10, 2001:db8::1, 198.51.100.0/24).
  3. Enable Maintenance Mode – once active, all traffic is redirected to the uploaded page, except requests from IPs on the allow list.
  4. Disable Maintenance Mode when the storefront should become available again.

Notes

  • Adding HTML file is required before enabling Maintenance Mode.
  • The Maintenance allow IP list works independently of the standard IP access list.
  • Be careful not to lock out your own team — always add your current IPs before enabling.
  • Changes may take a few minutes to propagate across the edge.

Best practicesri:link

  • Use for planned maintenance only Maintenance Mode is meant for short-term outages or upgrades. For long-term access control, use Basic Auth or IP access list.
  • Always add team IPs to the Maintenance allow IP list Include VPN or office IPs so your team can monitor the store while customers see the maintenance page.
  • Keep the maintenance page lightweight A simple, branded HTML page with a message like “We’ll be back soon” and contact information is recommended.
  • Communicate proactively Consider notifying customers in advance, and avoid frequent toggling to reduce confusion and SEO impact.