/dns

🕹 Manage Hack Club's DNS through a GitHub repository

Primary LanguageYAML

Hack Club's DNS

test deploy

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

Limitations

hackclub.xxx subdomains are only available for all clubs and projects related to Hack Club.

Non-HQ sites using â–² Vercel can not use Hack Club's DNS due to Vercel's platform limitations. Please consider alternatives such as Netlify or GitHub Pages.

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.
  1. Replace SUBDOMAIN_NAME with the name of the sub-domain. So if the name was hello then the subdomain would be hello.hackclub.com.
  2. 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!
  3. Commit your changes and create the PR!

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