Create a gist now

Instantly share code, notes, and snippets.

@cvan /
Last active Jan 17, 2018

What would you like to do?
How to serve a custom HTTPS domain on GitHub Pages with CloudFlare: *FREE*, secure and performant by default


CloudFlare is an awesome reverse cache proxy and CDN that provides DNS, free HTTPS (TLS) support, best-in-class performance settings (gzip, SDCH, HTTP/2, sane Cache-Control and E-Tag headers, etc.), minification, etc.

  1. Make sure you have registered a domain name.
  2. Sign up for CloudFlare and create an account for your domain.
  3. In your domain registrar's admin panel, point the nameservers to CloudFlare's (refer to this awesome list of links for instructions for various registrars).
  4. From the CloudFlare settings for that domain, enable HTTPS/SSL and set up a Page Rule to force HTTPS redirects. (If you want to get fancy, you can also enable automatic minification for text-based assets [HTML/CSS/JS/SVG/etc.], which is a pretty cool feature if you don't want already have a build step for minification.)
  5. If you don't already have one, create a new repository on GitHub to store your site's contents (preferably in the form of static web pages and assets; though not necessary, for the A-Frame site we use a static-site generator called Hexo).
  6. From your domain registrar's settings, create a CNAME record to point <domain>.<tld> to <user> (Refer to the GitHub docs for more information.)
  7. In your Github repo, create a file at the root called CNAME containing the domain name (e.g.,
  8. Push to GitHub Pages (either by pushing to gh-pages or master of your repo; or you can use the master branch of a repo named <org> - example: automatically gets published to, which redirects to
  9. You're done! All content will now be served to your users from CloudFlare.

caike commented Mar 28, 2017

Thanks for putting this together! If my registrar is DNSimple and I'm pointing to Cloudflare's nameservers (per step #3), then where should step #6 be done: DNSimple or Cloudflare ?

@caike step #6 should be done in Cloudflare

goyllo commented Apr 27, 2017

Yes Step 6 should be done in Cloudflare, here is all steps to implement SSL in your github pages using cloudflare

Worked for me. Thanks!

rpavlov commented Jun 16, 2017

God bless

AmusingThrone commented Jun 25, 2017

I am not sure why I keep getting NET::ERR_CERT_COMMON_NAME_INVALID, no matter what I do. I have followed the steps on your website as well. I can setup Cloudflare for any other site, just doesn't want to work on GitHub

I have same issue as @AmusingThrone

ms-studio commented Sep 12, 2017

After setting this up for an Apex domain, I get errors: "ERR_SSL_VERSION_OR_CIPHER_MISMATCH" in Chrome, "SSL_ERROR_NO_CYPHER_OVERLAP" in Firefox.

UPDATE: the problem was only temporary, during the time it took CloudFlare to generate the certificate. Now the certificate shows as active, and the domain is loading fine.

So if your site already gets traffic, a good idea is to set up everything while keeping SSL optional. In a second step, once your certificate works, you may enable a rule to force HTTPS.


cvan commented Oct 18, 2017

Just seeing all these comments now. Good tips, @ms-studio. Thanks!

Andrew-Max commented Nov 5, 2017

Regarding step 6: I am trying to use a repo that does not match my account name (I already have that deployed as a different site). The name of the repo I am trying to deploy is qubitix.

So then my A is and then I need to setup a cname to <user> or ? It won't let me do the second but I don't see how the first won't go to the other repo which matches my user name.

Any help would be greatly appreciated!

rugk commented Nov 22, 2017

To be secure you'd also have to enable "Full SSL (Strict)" in Cloudflare… see why

great! thx!

mkpt commented Dec 13, 2017

For the folks here looking for more help setting up the page rule, check out Cloudflare's official instructions on how to set this up. It turns out I had set up the rule wrong, which was preventing my site from showing up properly. Hope this helps!

Conorbro commented Dec 15, 2017

Worked like a charm, thanks!

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment