Overview

Protect your site or a section of your site from public viewing by requiring authentication.

CloudCannon has several authentication options:

None - Your site is entirely public.
Password - Visitors must enter a password
Bearer Token - Authenticate by setting a token header.
User Accounts - You can control a set of users who have access to the site, each with their own username and password.
SAML - Authenticates access to your site using a SAML / SSO provider.

Logging out

Once a user is authenticated, they can log out at <your-domain>/logout. You can provide a logout button on your authenticated pages with this link.

index.html

<a href="/logout">Log out</a>

CloudCannon sets a cookie when the user is authenticated. Use this to show the logout button for authenticated users on public pages, and hide it otherwise.

Note

No sensitive authentication data is exposed through cookies.

The cookie is used to set a class on the body. The CSS will show the logout button with this class.

script.js

var isAuthenticated = document.cookie.indexOf("authenticated=true") >= 0;

if (isAuthenticated) {
  document.body.className += " authenticated";
}

styles.css

.logout {
  display: none;
}

.authenticated .logout {
  display: block;
}

index.html

<a href="/logout" class="logout">Log out</a>

Custom Routes

Custom routes allow you to specify the routes you want to be authenticated and keep the rest public. By default, all routes are authenticated.

This feature is ideal for staff or special subscriber sections of your site.

To specify custom authenticated routes for your site:

Create a file named auth-routes.txt in the root folder
Add the routes you want to this file, one on each line.

CloudCannon supports wildcards, allowing you to specify child folders or multiple files.

In the following example, visitors will have to log in to access /internal-news.html and anything inside /staff. Everything else is public.

auth-routes.txt

/internal-news.html
/staff/*

Custom interfaces

You can create your own custom branded pages for authentication. This is possible for Password and User Account authentication methods.

Each page is different, but the process is the same:

Create the relevant file in the root folder of your site
Add the HTML for the page

Google reCAPTCHA

None

Don’t miss the latest

CloudCannon news freshly delivered to your inbox

Overview

Logging out

Authenticated Cookie

Custom Routes

Custom interfaces