Using Custom Domains

Instead of using the codeberg.page domain, you can also purchase your own domain from a domain registrar of your choice and configure it to serve content from Codeberg Pages.

For custom domains, two things are required:

• a .domains file in the repository and branch where your files reside which you want to publish via Codeberg Pages. The file should contain a list of all domains that shall be usable to access that repository, according to the following rules:

  • One domain per line, you can leave lines empty and comment out lines with #.
  • The first domain is the main domain, all other domains in the file will be redirected to the first one.
  • The rest of the list includes all relevant *.codeberg.page domains for the specific repository.

• a DNS record pointing to one of the following targets, depending on where your static files reside:

Setting the DNS record

There are several ways DNS records for your website can be setup in order to tell the Pages server your repository location. For all of the options it is important that the Pages server knows where to look for the .domains file and your content. Depending on from where you want to serve your files, there is a naming scheme for the domain:

We assume for the following description, that you want to serve your website with and without www in front. If you are on a subdomain already (like myproject.yourdomain.com), you can skip the www.yourdomain.com CNAME entry.

Option 1: CNAME record

The easiest and recommended way is to just setup a CNAME record for your domain, pointing to the mentioned above locations. In the end, it should look like this:

Option 2: ALIAS record

If you cannot use a CNAME record to configure the target you can use this method, which needs two entries instead of one.

• First you need to specify which server should be serving your website. Similar to CNAME you can use an ALIAS record. The difference between an CNAME record is, that the DNS server directly responds with the ip address and not the codeberg.page domain. Therefore you need to add a second entry, so that the pages server knows what to serve under this domain.
• Second, you need to setup a TXT record which contains the information from the CNAME entry which is your repository location as mentioned above. For example [[branch.]repo.]user.codeberg.page.

In the end it should look like this:

Option 3: A/AAAA record

If your service provider does not support ALIAS records you can also use A records and AAAA records instead.

• First you need to specify which server should be serving your website. You can do this by setting an A record for IPv4 and an AAAA record for IPv6 which contains the ip address of the Codeberg Pages server. The servers' ip addresses are:
  • A record which contains the IPv4 value 217.197.91.145
  • AAAA record which contains the IPv6 value 2001:67c:1401:20f0::1
• Second, you need to setup a TXT record which contains the information from the CNAME entry which is your repository location as mentioned above. For example [[branch.]repo.]user.codeberg.page.

In the end, it should look like this:

Examples

The following sub-sections include a few examples of the different alternatives, assuming the following:

• we can add/modify DNS records in domain example.com.
• Our Codeberg username is frida, and we want to publish pages for:
  • frida/pages, with a Personal static site inside branch pages;
  • frida/colormix, with a Project site (again, inside branch pages).

All considerations regarding a Personal site also apply to an Organization site, so these two cases will be addressed together.

Personal (or Organization) site, third level domain

In this case, we want our Personal pages available at the URL https://myself.example.com.

The .domains file contains the following:

myself.example.com
frida.codeberg.page
pages.frida.codeberg.page
pages.pages.frida.codeberg.page

For the DNS configuration:

• if CNAME can be used, one single DNS record will suffice:

  • name myself.example.com, type CNAME, data frida.codeberg.page

• otherwise, if ALIAS can be used, two DNS records will be needed:

  • name myself.example.com, type ALIAS, data codeberg.page
  • name myself.example.com, type TXT, data frida.codeberg.page

• otherwise, A/AAAA records must be used, together with one TXT record:

  • name myself.example.com, type A, data 217.197.91.145
  • name myself.example.com, type AAAA, data 2001:67c:1401:20f0::1
  • name myself.example.com, type TXT, data frida.codeberg.page

Personal/Organization site, apex domain

In this case, we want our Personal/Organization pages available at the URL https://example.com.

The .domains file contains the following:

example.com
frida.codeberg.page
pages.frida.codeberg.page
pages.pages.frida.codeberg.page

For the DNS configuration, the CNAME SHOULD NOT be used, so:

• if ALIAS can be used, two DNS records will be needed:

  • name example.com, type ALIAS, data codeberg.page
  • name example.com, type TXT, data frida.codeberg.page

• otherwise, A/AAAA records must be used, together with one TXT record:

  • name example.com, type A, data 217.197.91.145
  • name example.com, type AAAA, data 2001:67c:1401:20f0::1
  • name example.com, type TXT, data frida.codeberg.page

Project site, third-level domain

In this case, we want our Project pages available at the URL https://colormix-app.example.com.

The .domains file contains the following:

colormix-app.example.com
colormix.frida.codeberg.page
pages.colormix.frida.codeberg.page

For the DNS configuration:

• if CNAME can be used, one single DNS record will suffice:

  • name colormix-app.example.com, type CNAME, data colormix.frida.codeberg.page

• otherwise, if ALIAS can be used, two DNS records will be needed:

  • name colormix-app.example.com, type ALIAS, data codeberg.page
  • name colormix-app.example.com, type TXT, data colormix.frida.codeberg.page

• otherwise, A/AAAA records must be used, together with one TXT record:

  • name colormix-app.example.com, type A, data 217.197.91.145
  • name colormix-app.example.com, type AAAA, data 2001:67c:1401:20f0::1
  • name colormix-app.example.com, type TXT, data colormix.frida.codeberg.page

Project site, apex domain

In this case, we want our Project pages available at the URL https://example.com.

The .domains file contains the following:

example.com
colormix.frida.codeberg.page
pages.colormix.frida.codeberg.page

For the DNS configuration, CNAME SHOULD NOT be used:

• if ALIAS can be used, two DNS records will be needed:

  • name example.com, type ALIAS, data codeberg.page
  • name example.com, type TXT, data colormix.frida.codeberg.page

• otherwise, A/AAAA records must be used, together with one TXT record:

  • name example.com, type A, data 217.197.91.145
  • name example.com, type AAAA, data 2001:67c:1401:20f0::1
  • name example.com, type TXT, data colormix.frida.codeberg.page