🔧 Edgy

The Skinny

Need a lightning-fast, on-demand maintenance page? You're in the right place. Edgy is a customizeable maintenance page that can be toggled on and off as needed. It can even be set up on a per-route basis if you only want to put some parts of your site in maintenance mode.

When Maintenance Mode is off:

graph LR A[Browser] --> |request| B{Edgy} style B fill:#FAC37E,stroke:#333,stroke-width:3px B --> C(GET yoursite.com) style C fill:#FFF,stroke:#333,stroke-width:1px B --> |response| A

When Maintenance Mode is on:

graph LR A[Browser] --> |request| B{Edgy} style B fill:#FAC37E,stroke:#333,stroke-width:3px B -- X --- C(GET yoursite.com) style C fill:#FFF,stroke:#333,stroke-width:1px B --> |Maintenance Page| A

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 Global Maintenance Options are available:

The following Bypass Options are available:

The following Global Maintenance Page Options are available:

The following Route Based Maintenance Options are available:

Global Maintenance Options

Activate Maintenance Mode

Persist maintenance mode sitewide if set inside Global Maintenance Page Options or on a Route if set on Route Based Maintenance Options. An Edgy-Mode=maintenance response header is set when maintenance mode is active.

TIP

If Activate Maintenance Mode is set both globally and on a route, the global option wins and maintenance mode will appear on your entire site.

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.

TIP

If Scheduled Maintenance Mode is set both globally and on a route, the global option wins and maintenance mode will appear on your entire site after the provided instant.

Enable Always Up Mode

Always Up Mode makes your site appear online even when your servers are unresponsive. Edgy renders the Always Up Template of your choice when requests fail if certain 500-level response errors are received from your servers. An Edgy-Mode=alwaysup response header is set when Always Up Mode is active.

TIP

Always Up Mode is activated by the following 500-level response errors from your server: 502 503 504 520 521 522 523 524 525 526 527 530.

Always Up Template

Edgy renders this HTML template if your servers become unresponsive.

TIP

If Always Up Template and Always Up Template Location are empty, Global Maintenance Page is rendered in Always Up Mode.

Always Up 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 Always Up Template are set.

TIP

If Always Up Template and Always Up Template Location are empty, Global Maintenance Page is rendered in Always Up Mode.

Bypass Options

IP Whitelist

These IP addresses will be able to view your page, bypassing Maintenance Mode. This is useful if you want to debug your site in maintenance mode.

TIP

Multiple IP addresses should be separated by new lines

Bypass Code

Bypass Maintenance Mode with a query string using a Bypass Code. Set a Bypass Code value and pass it along with the page URL in a EdgyBypassCode query string. This is useful if you want to debug your site in maintenance mode.

TIP

If Maintenance Mode is active and Bypass Code=a6vgfQ, a request to www.yoursite.com?EdgyBypassCode=a6vgfQ will bypass maintenance mode.

Global Maintenance Page 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 Global Maintenance Page. The title of the page will be [Site Name] | Under Maintenance.

Heading Text

The Heading text to display in the Global Maintenance Page`.

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 Global Maintenance Page`.

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 Global Maintenance Page.

Black & White Theme

Black & White Theme

Rustic Theme

Rustic Theme

Modern Theme

Modern Theme

Surreal 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.

TIP

Page Templates are displayed in rank order. Route Maintenance Template has precedence over Global Maintenance Page.

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.

Route Based Maintenance Options

Route URL

The maintenance page will be displayed on this URL. This can be any URL on your domain and can include 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.

Route Maintenance Template

Template to display during Maintenance Mode on this route. If unset, Global Maintenance Page will be displayed instead. 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.

TIP

Page Templates are displayed in rank order. Route Maintenance Template has precedence over Global Maintenance Page.

Response Status

HTTP status code to return along with the maintenance page. A 200 is returned by default, but any number between 200 and 600 is valid. Responding with an unusual status code can be useful if you're using site reliability software to monitor your site.

FAQ

There's nothing here yet.

Attributions

The Global Maintenance Page gear logo was designed by Icongeek26 at FlatIcon.

The Global Maintenance Page surreal drawings were made by a talented person at Absurd Design.