Maintenance Mode Guide
The maintenance mode feature allows Super Admins to temporarily disable the service for updates or maintenance while keeping users informed.
⚠️ Super Admin Only: Maintenance mode can only be enabled by Super Admins, not regular providers.
What Happens in Maintenance Mode?
When maintenance mode is enabled:
- API requests return a 503 (Service Unavailable) status
- Users see a maintenance message
- Super Admins can still access the platform
- Scheduled end time is shown to users
Enabling Maintenance Mode
- Login as Super Admin
- Go to "Maintenance Settings" in the sidebar
- Configure the settings:
- Enable Maintenance: Toggle ON to activate
- Scheduled Start: When maintenance begins (optional)
- Scheduled End: When maintenance ends (optional)
- Message: Custom message to show users
- Click "Save Settings"
📸 Screenshot: Maintenance Settings Panel
Shows the maintenance toggle, date pickers, and message field
Scheduling Maintenance
You can schedule maintenance in advance:
- Set the Scheduled Start date and time
- Set the Scheduled End date and time
- The system will automatically enter maintenance mode at the start time
- And exit maintenance mode at the end time
💡 Tip: Use the messaging system to notify users before scheduled maintenance. Send an announcement a few hours or days in advance.
Custom Maintenance Message
Customize the message users see during maintenance:
Default: "System is under maintenance. Please check back later."
Custom example:
"We're upgrading our servers to provide you with better
performance. Expected completion: 3:00 AM EST.
Thank you for your patience!"
Disabling Maintenance Mode
- Go to Maintenance Settings
- Toggle "Enable Maintenance" to OFF
- Click "Save Settings"
The service will immediately be available again.
Best Practices
- Notify in advance: Send announcements before maintenance
- Schedule off-peak hours: Minimize impact on users
- Provide time estimates: Include expected end time in your message
- Test thoroughly: Complete all testing before disabling maintenance mode
- Monitor after: Watch for issues after re-enabling service
Emergency Maintenance
For immediate maintenance:
- Enable maintenance mode immediately (don't set schedule)
- Add a brief message explaining the situation
- Use the messaging system to send notifications
- Disable when issues are resolved