Configuration
The config.json file controls your status page's appearance, behavior, and integrations.
Basic Configuration
Here's a minimal configuration to get started:
config.json
{
"domain": "https://status.example.com",
"siteSettings": {
"siteName": "My Status Page",
"siteDescription": "Service status for My Company"
},
"github": {
"owner": "your-username",
"repo": "your-repo-name"
}
}
Full Configuration Reference
Site Settings
{
"domain": "https://status.example.com",
"majorOutageThreshold": 2,
"siteSettings": {
"siteName": "My Status Page",
"siteDescription": "Service status for My Company",
"metaColor": "#3b5998"
}
}
| Property | Type | Default | Description |
|---|---|---|---|
domain | string | Required | Full URL of your status page |
majorOutageThreshold | number | 2 | Consecutive failures before marking as "Major Outage" |
siteSettings.siteName | string | Required | Display name shown in header |
siteSettings.siteDescription | string | "" | Description shown below the title |
siteSettings.metaColor | string | "#3b5998" | Theme color for browser/embed meta tags |
GitHub Integration
{
"github": {
"owner": "your-username",
"repo": "your-repo-name",
"issuesLabel": "incident",
"manualMonitorLabel": "manual",
"maintenanceLabel": "maintenance",
"announcementLabel": "announce"
}
}
| Property | Type | Default | Description |
|---|---|---|---|
owner | string | Required | GitHub username or organization |
repo | string | Required | Repository name |
issuesLabel | string | "incident" | Label for incident issues |
manualMonitorLabel | string | "manual" | Label for manual status updates |
maintenanceLabel | string | "maintenance" | Label for maintenance windows |
announcementLabel | string | "announce" | Label for announcements |
tip
Create these labels in your GitHub repository before using them. Go to Issues > Labels > New label.
Design Options
{
"design": {
"useLogo": "/img/logo.png",
"logoDimensions": {
"width": 200,
"height": 50
},
"showSiteName": true,
"showDescription": true,
"showOverallStatus": true,
"footer": {
"enabled": true,
"credits": true
},
"statusDot": {
"enabled": {
"group": true,
"monitor": true
},
"animation": {
"group": false,
"monitor": "ping"
}
},
"recentIncidents": {
"active": true,
"number": 5
},
"incident": {
"showCommentAuthor": true,
"showGithubLink": true
},
"announcement": {
"showIcon": true,
"showTitle": true,
"showCommentAuthor": false,
"showGithubLink": true
}
}
}
Logo & Header
| Property | Type | Default | Description |
|---|---|---|---|
useLogo | string | null | Path to logo image (relative to static/) |
logoDimensions.width | number | 200 | Logo width in pixels |
logoDimensions.height | number | 50 | Logo height in pixels |
showSiteName | boolean | true | Show site name in header |
showDescription | boolean | true | Show description below header |
showOverallStatus | boolean | true | Show overall status banner |
Footer
| Property | Type | Default | Description |
|---|---|---|---|
footer.enabled | boolean | true | Show footer |
footer.credits | boolean | true | Show "Powered by Shadow Development" credit |
Status Indicators
| Property | Type | Default | Description |
|---|---|---|---|
statusDot.enabled.group | boolean | true | Show status dot on groups |
statusDot.enabled.monitor | boolean | true | Show status dot on monitors |
statusDot.animation.group | string/boolean | false | Animation for group dots ("ping", "pulse", or false) |
statusDot.animation.monitor | string/boolean | "ping" | Animation for monitor dots |
Incidents & Announcements
| Property | Type | Default | Description |
|---|---|---|---|
recentIncidents.active | boolean | true | Show recent resolved incidents |
recentIncidents.number | number | 5 | Number of recent incidents to show |
incident.showCommentAuthor | boolean | true | Show author on incident updates |
incident.showGithubLink | boolean | true | Link to GitHub issue |
announcement.showIcon | boolean | true | Show icon on announcements |
announcement.showTitle | boolean | true | Show title on announcements |
Overall Status Text
Customize the messages shown in the overall status banner:
{
"overallStatusText": {
"operational": "All systems are running smoothly.",
"degraded": "Some systems are experiencing issues.",
"major": "We're experiencing a major outage.",
"maintenance": "Scheduled maintenance is in progress."
}
}
Status Levels
Define the available status levels for incidents and monitors:
{
"statusLevels": {
"operational": {
"label": "Operational",
"color": "success",
"priority": 0
},
"degraded": {
"label": "Degraded Performance",
"color": "warning",
"priority": 1
},
"partial": {
"label": "Partial Outage",
"color": "warning",
"priority": 2
},
"major": {
"label": "Major Outage",
"color": "error",
"priority": 3
},
"maintenance": {
"label": "Under Maintenance",
"color": "info",
"priority": 4
}
}
}
| Property | Type | Description |
|---|---|---|
label | string | Display text for this status |
color | string | Color theme: "success", "warning", "error", or "info" |
priority | number | Higher number = worse status. Used to determine overall/group status |
Priority Logic
When calculating overall or group status, the system uses the highest priority among all monitors. For example, if one monitor is major (priority 3) and others are operational (priority 0), the overall status shows "Major Outage".
Exception: maintenance (priority 4) only applies during active maintenance windows, not as a "worst" status.
Notifications
Configure Discord and webhook notifications:
{
"notifications": {
"defaultEnabled": true,
"numberOfDown": 1,
"discord": {
"enabled": true,
"defaultPingRole": "",
"pingForReturn": false
},
"webhook": false
}
}
| Property | Type | Default | Description |
|---|---|---|---|
defaultEnabled | boolean | true | Enable notifications by default for monitors |
numberOfDown | number | 1 | Consecutive failures before sending notification |
discord.enabled | boolean | false | Enable Discord notifications |
discord.defaultPingRole | string | "" | Role to ping: "" (none), "everyone", "here", or role ID |
discord.pingForReturn | boolean | false | Ping when service recovers |
webhook | boolean | false | Enable generic webhook notifications |
See the Notifications guide for detailed setup instructions.
Complete Example
Click to expand full config.json example
config.json
{
"domain": "https://status.example.com",
"majorOutageThreshold": 2,
"siteSettings": {
"siteName": "Example Status",
"siteDescription": "Real-time status for Example services",
"metaColor": "#3b5998"
},
"github": {
"owner": "example-org",
"repo": "status-page",
"issuesLabel": "incident",
"manualMonitorLabel": "manual",
"maintenanceLabel": "maintenance",
"announcementLabel": "announce"
},
"design": {
"useLogo": "/img/logo.png",
"logoDimensions": {
"width": 200,
"height": 50
},
"showSiteName": true,
"showDescription": false,
"showOverallStatus": true,
"footer": {
"enabled": true,
"credits": true
},
"statusDot": {
"enabled": {
"group": true,
"monitor": true
},
"animation": {
"group": false,
"monitor": "ping"
}
},
"recentIncidents": {
"active": true,
"number": 5
},
"incident": {
"showCommentAuthor": false,
"showGithubLink": true
},
"announcement": {
"showIcon": true,
"showTitle": false,
"showCommentAuthor": false,
"showGithubLink": true
}
},
"overallStatusText": {
"operational": "All systems are running smoothly.",
"degraded": "Some systems are experiencing issues.",
"major": "We're experiencing a major outage.",
"maintenance": "Scheduled maintenance is in progress."
},
"statusLevels": {
"operational": {
"label": "Operational",
"color": "success",
"priority": 0
},
"degraded": {
"label": "Degraded Performance",
"color": "warning",
"priority": 1
},
"partial": {
"label": "Partial Outage",
"color": "warning",
"priority": 2
},
"major": {
"label": "Major Outage",
"color": "error",
"priority": 3
},
"maintenance": {
"label": "Under Maintenance",
"color": "info",
"priority": 4
}
},
"notifications": {
"defaultEnabled": true,
"numberOfDown": 1,
"discord": {
"enabled": true,
"defaultPingRole": "",
"pingForReturn": false
},
"webhook": false
}
}