believerhsp / oauth-tutorial

Like GitHub Pages, but you choose who can see it without usernames & passwords.

Make Static Sites Private With OAuth For Free

Like GitHub Pages, but you choose who can see it, without usernames & passwords 🪄 🎩 🐰

Background

Do you want to serve a static site semi-privately so only specific users can see it? For example, you may want to host private docs or offer a paid course. There are many complicated solutions that involve building a login flow and maintaining a database of usernames/passwords. Thankfully, there is a much easier way with Oauth2 Proxy.

Concretely, this tutorial shows how to use the Oauth2 Proxy to make a static site private with minimal dependencies and secure it with an email whitelist (a text file with emails). There are many other authorization schemes in addition to an email whitelist, which you can read about here.

This section describes how OAuth works in the context of this tutorial.

Tutorial

This tutorial has three parts that become progressively complex depending on your goals. However, you can stop at any lesson once you are satisfied.

Prerequisites: knowledge of Docker and familiarity with hosting static sites (like on GitHub Pages).

1. Running OAuth Locally: this runs a minimal static site locally, secured with the OAuth2 Proxy. This allows you to gain an intuition of how things work before proceeding to the next step.

2. Serve The Private Site (For Free!): You will host the same site you created locally for free! You will also learn how to set up SSL for https with a custom domain.

3. (Optional) Hosting on Kubernetes: Finally, you will deploy a website secured by OAuth on Kubernetes. This assumes some experience with Kubernetes.

FAQ

1. Does the proxy only work for static sites? No! You can put applications behind the proxy too. See this explanation.

2. Does GitHub Pages have something like this?: Only if you purchase GitHub Enterprise Cloud which is absurdly expensive if you want it solely for the purposes of securing a static site (> $100/month for just 5 users!).

3. Can't you do this with Netlify?: To do something similar on Netlify, you have to use invite-only private sites, which triggers identity pricing, which means that you need to pay over $99 per month if you have over 5 Active users! That is ridiculous.