Aaditya M Nair

Setup Github Pages with custom domain and Cloudflare

3 min read

Hosting a website is nice. Also, hosting said website is easy. Github, in the form of github-pages allows you to throw any standard HTML content into a repository and serve it under the domain username.github.io.

However, like me, you would like your own custom domain for this. Setting up a custom domain for github-pages is a bit more work than setting up the website itself. Here's how you could do it:

Setting up the repository and verify it works.

There is really no point in going further if this doesn't work. Create the repository and throw in some content and see if you can access it from username.github.io.

Register the domain.

I am assuming that you have already done that. This step varies according to which domain registrar you are working with. Now to add records, it depends on which type of domain you own, a subdomain (website.example.com) or an apex domain(example.com)

  1. For a subdomain, simply add a CNAME record to username.github.io.
  2. If you own an apex domain:

    • If your DNS provider allows for either ALIAS or ANAME records, add one of those pointing to username.github.io; just like above. However, a lot of providers, including mine, don't allow for that.
    • All providers will allow an A record to be added. Add an A record from your domain to the IP addresses, and

And, done. To test these changes, the following command should help:

    $ dig +short @ example.com A

for apex domains and

    $ dig +short @ website.example.com CNAME

for subdomains.

Do note that records take around a day to propagate and changes may not be immediately seen

Informing Github of this new domain.

Now, Github won't directly recognize that you have a domain configured. So what you have to do is to go to repository settings and add your domain in the requisite field. In your repository a file called CNAME will be added the contents of which is the configured domain. custom-domain

That's it. You are done. Your website should be accessible from the custom domain.

Moving to Cloudflare

Using Cloudflare to serve your websites has a lot of advantages. In addition to having a fast global CDN, you also get HTTPS enabled on your website for free. It also provides DDOS protection and always-online feature, just to name a few. In general, it is a pretty good idea to serve your website through cloudflare. Its pretty easy to do so too.

Setting up the domain in cloudflare.

Create an account on cloudlfare and go to the add website section. Enter your domain and cloudflare will try to locate all the records associated with it and a button to select which records will be transfered to cloudflare. cloudflare domains

Continue with the process until you see the new nameservers you have been assigned to. Go to your domain registrar and update the DNS nameservers there. Update the new nameservers there. What this essentially does is tell your registrar that cloudflare will be the one managing the records. nameservers

All your domains can now be managed by cloudflare now. All your requests go through them too. There is a ton of services there you can play with.

Go knock yourself out!!

Note: The dig tests above will not work after you have configured cloudflare. Cloudflare directs all traffic through them hence the IPs that you will see will not be of Github's. Rather, they will belong to Cloudflare.

Update (5th June, 2017): Cloudflare DNS actually supports CNAME for apex domains. apex-cname This will be equivalent of setting up an ALIAS or ANAME records. Refer to this excellent blog to see how they do it.

Copyright 2021 by Aaditya M Nair. Source here