User Webroots let you upload your own website to your Canary. Simply wrap up your HTML, JS and CSS into a Zip file, upload, and have the Canary run your own interface.

Creating your custom webroot is quick and can be easily done by following the steps below.

Note: Remotely uploading custom User Webroots is now possible from version 2.2.

Step 1 - Boot into config mode

Boot your device into configuration mode. If you have forgotten how to do that, click here.

Step 2 - Create the webroot ZIP file

The simplest custom webroot is a ZIP file containing an index.html in its root directory (ZIP file size is capped at 100MB).

As long as these requirements are met, you can create any static site that you want by following normal conventions and including your required pages, images, css, js, etc. in the ZIP file.

Step 3 - Including 403 and 404 Error Pages (optional)

You Canary will display generic 403 and 404 pages, but these can be changed. If you include your own 403.html and/or 404.html in your root directory, they will be used instead of the generic pages.

Step 4 - Including .posted pages (optional)

By default, if a POST request is made, a 403 page will be displayed. But you can change this behaviour by including .posted pages that will be returned instead of the forbidden page.

For example, if you have login.html that allows the user to attempt to login, you can include login.html.posted which will be displayed when the user tries to login (but the URL will still show login.html).

Capturing Incident Data on POSTs

If a POST request is made, any submitted POST parameters will be logged in the incident that gets created on your Console.

Step 5 - Save config and reboot

Once the bird reboots, it will host your customised webroot. Browse to it on port 80 and/or port 443 to view it.