🔧 Edgy
VERSION CHECK
This documentation applies to Edgy v.5.0. Please ensure you're running Edgy v.5.0 or newer for the latest features including SMS notifications and an improved configuration experience. To upgrade, visit your Installed Apps page.
The Skinny
Want to always be online for your visitors even when your site isn't responding? Set up Never Go Down to receive alerts the moment your site is down and render a page letting visitors know you're still there.
When Never Go Down is active:
Never Go Down won't kick in when your site is responding normally.
When your site stops responding normally, Edgy renders a page of your choice and optionally dispatches email or webhook based notifications.
Need a lightning-fast, on-demand maintenance page? You're in the right place. Toggle maintenance mode on and off as needed. It can even be set up on a per-route basis if you only want to take part of your site offline.
When Maintenance Mode is on:
When a route (or the entire website) is in maintenance mode, Edgy renders the maintenance mode page.
Tutorials
Check out these tutorials to see Edgy in action:
How to Install
Powered by Cloudflare
Edgy is powered by Cloudflare. If you're already using Cloudflare, click here to install Edgy.
TIP
Cloudflare offers DDoS protection, a global CDN, SSL certificates, and a lot more cool stuff for free. You should probably use it.
Getting Started
After installation, activate Edgy by clicking the link in the email we sent you.
Next, visit our tutorials to get started with various platforms. Learn more about Fortify and troubleshooting in the following sections:
Have a Twitter account? Extend your free trial!
Visit edgy.networkchimp.com/extend for more details.
Upgrade to Unlimited
Looking for the unlimited plan? You can find it here.
Reference
Edgy is dirt simple to set up. You can get the gist of it from the installation page, but we'll dig into the nuts and bolts below.
The following Site Configuration Options are available:
The following Never Go Down Options are available:
The following Maintenance Mode Options are available:
- Maintenance Mode
- Activate Maintenance Mode
- Scheduled Maintenance Mode
- Maintenance Routes
- Response Status
- Bypass Code
The following Maintenance Template Options are available:
The following Status Page Options are available:
- Status Page
- Status Page Route
- Status Page Remark
- Maintenance Alert
- Incident
- Incident History
- Incident Title
- Incident Thread
- Incident Status
- Post
- Post Content
- Post Author
Site Configuration
Site-related information used to personalize the Status Page Maintenance Mode pages.
Site Name
Name of your website to display in maintenance and status page templates.
Site Logo
Logo to display in maintenance and status page templates.
Never Go Down
Never Go Down keeps your site online even when your site isn't responding. Instead of seeing an ugly and potentially scary error page when your server isn't responding, Edgy renders a friendly downtime template your choice.
TIP
An Edgy-Mode=maintenance response header is set when Never Go Down is keeping your site online.
Edgy can be configured to send Email Alerts and/or Webhook Alerts when your site isn't responding.
TIP
Never Go Down is activated by the following 500-level response errors from your server: 500 502 503 504 505 506 507 508 510 520 521 522 523 524 525 526 527 530.
TIP
Consider enabling both Never Go Down and Status Page to benefit fully from their synergistic features. When your site isn't responding, Never Go Down renders a friendly template of your choice to let users know you're still there and can link to your status page to communicate updates to your users, even when your site isn't responding.
Never Go Down Options
Enable Never Go Down
Never Go Down can be enabled in a variety of modes. You can choose to:
Render Edgy's maintenance template
Configured in the Maintenance Mode section.
Render an HTML template
Paste in your own HTML template to render during mainteannce mode.
Render a remotely-hosted webpage
Render another webpage on the internet during maintenance mode.
Test Never Go Down
CAUTION! Automatically takes your website offline in order to test Never Go Down. Once enabled, visit your website to trigger Never Go Down including any configured notifications.
WARNING
Make sure to disable this after testing in order to bring your website back online.
Disable Never Go Down
Turning off Never Go Down will:
- Disable Edgy from sending your Never Go Down Alerts
- Disable Edgy's and render Cloudflare's normal 5xx error pages when your server experiences network connectivity issues or internal errors
Downtime Template
Edgy renders this HTML template if your server experiences network connectivity issues or internal errors.
WARNING
Do not include base64 encoded images in your template due to strict template size restrictions.
Downtime Template Location
Edgy renders the page at this public web address when your server experiences network connectivity issues or internal errors.
Alerting
Enable Alerts to quickly and effectively receive timely alerts when your site isn't responding. Edgy offers a variety of alerting mechanisms outlined in the sections below.
Alerting Options
Email Alerts BETA
When your site isn't responding, Edgy will immediately send a downtime alert with follow-up alerts every 30 minutes to five or fewer email addresses. Email addresses listed here will receive alerts similar to the following templates.
TIP
Ensure alerts are not being sent to your Spam folder by whitelisting emails from [email protected] to your Inbox.
To receive a test alert to your email address, send the following request:
curl http://notifier.networkchimp.com/notifier/test/YOUR_EMAIL_ADDRESS
SMS Alerts BETA
When your site isn't responding or comes back online, Edgy will send a single SMS alert to five or fewer valid phone numbers.
Webhook Alerts BETA
When your site isn't responding, Edgy will immediately send a downtime alert with follow-up alerts every 5 minutes to an endpoint of your choice. If your endpoint requires authorization, the value of the Authorization header may be set in the Authorization header field.
A webhook alert is delivered as a POST request with Content-Type: application/json and the following body:
isDown: boolean
requestUrl: string
requestMethod: string
responseStatus: string
Maintenance Mode
Edgy's Maintenance Mode is a simple and powerful developer tool used to safely take parts of your site offline for maintenance and replace it with a Theme of your choice.
Maintenance Mode may be activated on your entire domain or on part of your domain by setting a list of Maintenance Routes, and can be activated manually or scheduled by setting a future date in Scheduled Maintenance Mode.
Maintenance Mode Options
Activate Maintenance Mode
Activate maintenance mode in one of the following modes to render a friendly maintenance page.
Activate it on my entire domain
Immediatly activate maintenance mode on every page on your domain
Activate it on a part of my domain
Immediatly activate maintenance mode on only the routes provided in Maintenance Routes.
Schedule it on my entire domain
Schedule maintenance mode for a future date on your entire domain.
Schedule it on a part of my domain
Schedule maintenance mode for a future date on part of your site.
Disable maintenance mode on my domain
Disable maintenance mode on your entire site
TIP
An Edgy-Mode=maintenance response header is set when maintenance mode is active.
Maintenance Routes
The Maintenance Template will be displayed on these routes during maintenance mode. This may be any route on your domain including subdomains. It is important that a full URL is specified here. Edgy won't like it if you supply a path like /store here. It requires a URL like yoursite.com/store to work right. Here's some more examples in an informative table.
| Route URL | Result |
|---|---|
/sad/path | 🤮 |
yoursite.com/cool-beans | 🎉 |
blog.yoursite.com | 🎉 |
TIP
Edgy will automatically enable maintenance mode for any requests to subfolders of Route URL. In the table above, traffic to blog.yoursite.com/topics will also enter maintenance mode.
Scheduled Maintenance Mode
Activate maintenance mode after this valid ISO 8601 instant. Remove this value to disable Scheduled Maintence Mode.
TIP
An Edgy-Mode=maintenance response header is set when maintenance mode is active.
Bypass Code
Provide a Bypass Code to work on your domain while in maintenance mode. After setting a Bypass Code, pass it along with the page URL in a EdgyBypassCode query string.
TIP
If Maintenance Mode is active and Bypass Code=a6vgfQ, a request to www.yoursite.com?EdgyBypassCode=a6vgfQ will bypass maintenance mode for 24 hours. To stop bypassing maintenance mode, clear the edgy-bypass cookie in your browser.
Maintenance Template Options
Choose one of our built-in themes or bring your own template to render in Maintenance Mode.
Site Name
The name of your site to be displayed in the <title> attribute of the Maintenance Template. The title of the page will be [Site Name] | Under Maintenance.
Heading Text
The Heading text to display in the Maintenance Template.
TIP
The Heading Text is "We're undergoing a bit of scheduled maintenance" in the Themes images below.
Subheading Text
The Subheading text to display in the Maintenance Template.
TIP
The Subheading Text is "We'll be back online" in the Themes images below.
Theme
Choose from one of the following themes for the Maintenance Template.
Custom Template
Bring your own HTML Maintenance Template or Maintenance Template Location.
Multilingual Theme
TIP
A link to your Status Page is automatically included if the status page is enabled.
Rustic Theme
TIP
A link to your Status Page is automatically included if the status page is enabled.
Modern Theme
TIP
A link to your Status Page is automatically included if the status page is enabled.
Surreal Theme
TIP
A link to your Status Page is automatically included if the status page is enabled.
Maintenance Template
Template to display during Maintenance Mode. Refer to the following table for more information.
| Image src attribute | Result |
|---|---|
../assets/my-image.png | 🤮 |
https://somehost.com/my-image.png | 🎉 |
WARNING
Do not include base64 encoded images in your template due to strict template size restrictions.
Maintenance Template Location
Renders the page at this public web address during Maintenance Mode. Maintenance Template Location will be rendered if both Maintenance Template Location and Maintenance Template are set.
Status Page
Edgy's Status Page simply and effectively communicates website maintenance, issues and outages with your users. The status page can be rendered on any route on your domain (including subdomains) and is always online even when your site is down.
TIP
Consider enabling both Never Go Down and Status Page to benefit fully from their synergistic features. When your site isn't responding, Never Go Down renders a friendly template of your choice to let users know you're still there and can link to your status page to communicate updates to your users, even when your site isn't responding.
Status Page Options
Status Page Route
Renders the status page at this route on your site. Defaults to www.yoursite.com/status and may include subdomains such as status.yoursite.com. When using subdomains, ensure a corresponding DNS record is pointing it at an origin server.
Status Page Remark
Markdown-enabled message that personalizes the status page with your own remark to your users.
Maintenance Alert
Markdown-enabled message to render on the top of your status page when maintenance mode is scheduled or active.
Incident
An Incident is a channel to communicate with your users when your services are experiencing any outages or issues. An Incident contains a list of Posts to communicate updates to users as the incident evolves and is eventually resolved.
Incident History
A list of Incidents to publish on your status page. Create and manage your Incident History to easily and effectively communicate website issues with your users even when your site is down.
Incident Title
A title that describes the nature of the incident to your users.
Post
A Post communicates an update about the incident to your users.
Incident Status
The current status of the incident at the time of this post. The possible values are:
- Investigating - normally assigned to the first post` on an incident.
- Update - normally assigned to provide updates to users as the incident evolves.
- Fixed - should always be assigned as the last post` on an incident.
WARNING
An incident is considered Active until a postwithIncident Status: Fixed` is created. Active incidents are visually emphasized on the status page.
Post Content
Markdown-enabled message used to communicate updates to your users as the incident evolves.
Post Author
Markdown-enabled author of the post.
FAQ
There's nothing here yet.
Attributions
The Maintenance Template gear logo was designed by Icongeek26 at FlatIcon.
The Maintenance Template surreal drawings were made by a talented person at Absurd Design.