mirror of
https://github.com/fosrl/docs-v2.git
synced 2026-02-08 05:56:45 +00:00
Add maintenance page docs
This commit is contained in:
@@ -46,8 +46,9 @@
|
||||
"pages": [
|
||||
"manage/resources/public/authentication",
|
||||
"manage/resources/public/targets",
|
||||
"manage/resources/public/healthchecks-failover",
|
||||
"manage/resources/public/raw-resources"
|
||||
"manage/resources/public/raw-resources",
|
||||
"manage/resources/public/maintenance",
|
||||
"manage/resources/public/healthchecks-failover"
|
||||
]
|
||||
},
|
||||
{
|
||||
|
||||
BIN
images/maintenance_page.png
Normal file
BIN
images/maintenance_page.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 49 KiB |
38
manage/resources/public/maintenance.mdx
Normal file
38
manage/resources/public/maintenance.mdx
Normal file
@@ -0,0 +1,38 @@
|
||||
---
|
||||
title: "Maintenance Page"
|
||||
description: "Show a maintenance page to users when a resources is down for maintenance or targets are unhealthy"
|
||||
---
|
||||
|
||||
<Note>
|
||||
Maintenance pages are only available in Enterprise Edition.
|
||||
</Note>
|
||||
|
||||
Pangolin can display a customizable maintenance page to users when a resource is undergoing maintenance or when all targets are unhealthy. This ensures users are informed about the downtime and provides a better user experience.
|
||||
|
||||
<Frame caption="Maintenance Page Preview">
|
||||
<img src="/images/maintenance_page.png" alt="Maintenance Page Preview"/>
|
||||
</Frame>
|
||||
|
||||
## Configuration
|
||||
|
||||
Title: The main title text displayed on the maintenance page.
|
||||
|
||||
Message: A descriptive message informing users about the maintenance status.
|
||||
|
||||
Estimated completion time: Optionally provide an estimated time for when the resource will be back online.
|
||||
|
||||
## Enabling Maintenance Page
|
||||
|
||||
To enable the maintenance page for a resource, navigate to the general resource settings in the Pangolin dashboard. Under the "Maintenance Page" section, you can customize the title, message, and estimated completion time. This can also be set using Blueprints.
|
||||
|
||||
## When is the Maintenance Page Shown?
|
||||
|
||||
There are two modes that control when the page is shown:
|
||||
|
||||
#### Forced
|
||||
|
||||
In forced mode, the maintenance page is displayed to all users regardless of the health status of the resource targets. This is useful for planned maintenance windows.
|
||||
|
||||
#### Automatic
|
||||
|
||||
In automatic mode, the maintenance page is shown only when all targets associated with the resource are unhealthy or all of the sites are offline. This is useful for unplanned outages and can be used to inform the user that the resource is temporarily unavailable by customizing the above settings.
|
||||
Reference in New Issue
Block a user