Ada 2 cara untuk memasang custom domain pada Github, pertama menggunakan record CNAME dan kedua menggunakan record A pada DNS. Tulisannya ini hanya membahas bagaimana cara setting custom domain menggunakan CNAME.

Default Domain

Akun github.com/username atau github.com/organization jika memiliki repositori bernama username.github.io atau organization.github.io, maka otomatis akan mendapatkan URL username.github.io atau organization.github.io selama branch master tersebut berisi file HTML.

Konfigurasi Custom Domain

Custom domain yang dimaksud disini contohnya adalah nama domain yang kita miliki. Berikut ini adalah langkah-langkah memasang custom domain.

  1. Misal akun bernama github.com/kaklabs, maka buat repositori dengan nama kaklabs.github.io.
  2. Push html file yang ingin di hosting di github ke branch master, maka secara otomatis ketika buka browser kaklabs.github.io website kita akan tampil.
  3. Untuk custom domain, buat file CNAME dalam branch master dengan isi nama domain, misal www.kaklabs.com.

  4. Pada DNS Manager domain tambahkan CNAME dengan value username.github.io atau organization.github.io.

    TypeNameValue
    CNAMEwwwkaklabs.github.io

  5. Tunggu sekitar 1 - 24 jam sampai DNS update dan setelah update maka username.github.io atau organization.github.io dapat diakses melalui custom domain yang ditulis pada file CNAME yaitu www.kaklabs.com.

  6. Contoh repositori yang menggunakan cara ini untuk memasang domain (saat ini hosting sudah dipindah dari github): https://github.com/islampedia/islampedia.github.io

Custom Domain Pada Repositori Project

Langkah sebelumnya merupakan cara untuk memasang custom domain per nama akun. Pada langkah ini merupakan cara memasang domain pada repositori yang kita inginkan.

Repositori pada github.com/username/nama-project atau github.com/organization/nama-project dapat diberi custom page dan diakses melalui username.github.com/project-name atau organization.github.com/project-name.

Berikut ini langkah-langkah memasang custom domain per proyek dan pastikan repositori github memiliki branch gh-pages dan memiliki file HTML.

  1. Misal punya branch https://github.com/kaklabs/demo-dekyll, secara default file html yang kita hosting akan dapat diakses melalui https://kaklabs.github.io/demo-dekyll/.
  2. Untuk membuat format username.github.io/project dapat diakses melalui domain, maka perlu membuat branch gh-pages.
  3. Lalu buat file CNAME dalam branch gh-pages dengan isi nama domain, misal example.kaklabs.com.

  4. Pada DNS Manager domain tambahkan CNAME dengan value username.github.io. atau organization.github.io. dan Pastikan value dari CNAME dibelakangnya ada titik.

    TypeNameValue
    CNAMEexamplekaklabs.github.io.
  5. Tunggu sampai DNS update dan setelah update maka kaklabs.github.io/demo-dekyll dapat diakses melalui example.kaklabs.com

Informasi lebih lanjut mengenai ini, dapat dilihat melalui https://help.github.com/en/github/working-with-github-pages.