omay238 / dns

🕹 Manage Hack Club's DNS through a GitHub repository

Hack Club's DNS

This repository is used for managing Hack Club's DNS configuration through OctoDNS. Please see its documentation for more information.

Adding a subdomain

1. Create a fork of this repository.
2. In your fork open the hackclub.com.yaml file and add the following alphabetically based off the subdomain name:

SUBDOMAIN_NAME:
  - ttl: 1
    type: CNAME
    value: SOURCE_DOMAIN_OR_IP.

3. Replace SUBDOMAIN_NAME with the name of the sub-domain. So if the name was hello then the subdomain would be hello.hackclub.com.
4. Replace SOURCE_DOMAIN_OR_IP with the domain or IP address of the website you want the subdomain to go. If you are using an IP address change type: CNAME to type: A. Remember to leave that . at the end!
5. Commit your changes and create the PR!

That's it! Someone with contributor access to the repo will then review your PR.

Google Workspace / Vercel Combination

If you're looking to use both Google Workspace and Vercel, deploying your changes may break. To fix this, follow these steps (each in a seperate step, irvine.hackclub.com is an example of this process):

1. Delete all records associated to your subdomain.
2. Add the records needed for Google Workspace to your subdomain.
3. Add the remaining records you'd like for your subdomain. Instead of a CNAME, use ALIAS.

Limitations

Subdomains, under domains following the format hackclub.xxx(or other domains reffering to hackclub), are only available for clubs and projects related to Hack Club, this does not include HCB projects. Everyone is welcome to use dino.icu!

When adding a site hosted on ▲ Vercel, you will need to verifiy the domain by adding a TXT record.

Add the value to the hackclub.com.yaml file as shown below:

_vercel:
  ttl: 1
  type: TXT
  values:
    - vc-domain-verify=wackclub.hackclub.com,423c28e0fbdd51449cf1