11.4. Maintenance Mode

This option is only available on self hosted Helpspot.

Maintenance mode allows Administrators to suspends the creation and updating of requests while upgrades or other maintenance is being completed.

Maintenance mode suspends:

Email integration. All emails will remain on the mail server until maintenance mode is disabled, at which time all emails sent during the maintenance period will be pulled.
Portal submission. Customers will not have access to the portal during maintenance mode periods. Subsequent sections discuss on this page discuss how this looks to the customer.
API integration. Those creating/updating requests via an automated process (API) will find during a maintenance period that an error to the application calling the API.

Enable Maintenance Mode

php hs down

This command immediately puts HelpSpot into maintenance mode. Users will see a maintenance page instead of the normal application.

php hs down --message="We are upgrading our systems. Please check back in 30 minutes."

Displays a custom message to users on the maintenance page.

php hs up

This command immediately brings HelpSpot back online and makes it accessible to users.

Knowledge Tags

Maintenance /

This page was: Helpful | Not Helpful