🔧 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 goes down? 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.
Configuration Options
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 Never Go Down Options are available:
- Never Go Down
- Never Go Down Template
- Never Go Down Template Location
- Email Alerts
- SMS Alerts
- Webhook Alerts
The following Maintenance Mode Options are available:
The following Maintenance Template Options are available:
Never Go Down Options
Enable Never Go Down
Never Go Down makes your site appear online even when your servers are unresponsive. Edgy renders the Never Go Down Template of your choice when requests fail if certain 500-level response errors are received from your servers. An Edgy-Mode=maintenance response header is set when Never Go Down is active.
Edgy can be configured to send Email Alerts and/or Webhook Alerts when your site becomes unresponsive.
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.
Never Go Down Template
Edgy renders this HTML template if your servers become unresponsive.
Never Go Down Template Location
Edgy renders the page at this remote URL when your servers become unresponsive. Template Location will be rendered if both Template Location and Never Go Down Template are set.
Email Alerts BETA
When your site goes down, Edgy will immediately send an 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 goes down or comes back online, Edgy will send a single SMS alert to five or fewer valid phone numbers.
Webhook Alerts BETA
When your site goes down, Edgy will immediately send an alert with follow-up alerts 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
Activate Maintenance Mode
Activating maintenance mode to render the Maintenance Template. An Edgy-Mode=maintenance response header is set when maintenance mode is active.
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 scheduled by setting a future date in Scheduled Maintenance Mode.
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 display 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. 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 Maintenance Template or Maintenance Template Location below.
Multilingual Theme
Rustic Theme
Modern Theme
Surreal Theme
Maintenance Template
Template to display during Maintenance Mode. All media resources should be hosted remotely due to strict template size limitations. 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
Edgy renders the page at this remote URL during Maintenance Mode. Maintenance Template Location will be rendered if both Maintenance Template Location and Maintenance Template are set.
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.