Skip to content

Latest commit

 

History

History
108 lines (73 loc) · 3.58 KB

README.md

File metadata and controls

108 lines (73 loc) · 3.58 KB
Raw

g0v.network domains domain-sync

For automating management of some g0v-related domains via config files.

The following damains can be managed here:

  • g0v.network
  • g0v.ca
  • c4nada.ca
  • t0ronto.ca

Changing or adding DNS records in main branch of this repository will update the actual domain records.

Inspired by g0v/domain

Note: Work in progress. Not yet functional.

Technologies Used

  • YAML. A human-friendly configuration file format.
  • octoDNS. Command-line tool to update domain records from files -- infra-as-code!
  • GitHub Actions. Continuous integration platform to run automation in the cloud.

Usage

The intended way to use this repository is via pull request directly on GitHub.

(You should only need to clone this code locally in order to improve the automation part of this repository. See Development section.)

Create a new subdomain

Create a new YAML file, and fill it out. For example, to create my.example.g0v.network, you'd create a config file with the full subdomain name, with a key inside it for my.example. Like so (click through the link to see example):

g0v.network./my.example.g0v.network.yaml

Delete an existing subdomain

Delete a file or a specific record type within a file. Our automation will sync this deletion when it runs.

Modify an existing subdomain

Modify an existing file. Our automation will sync this change when it runs.

Development

To contribute changes to our automation, you'll likely want to be able to run it locally. Here's what you'll need:

  • Python 3
  • Cloudflare account
  • Cloudflare sites: (can "fake it"; no need to actually have access to it)
    • g0v.network
    • g0v.ca
    • c4nada.ca
    • t0ronto.ca
  • Cloudflare API token (see instructions in sample.env)
git clone https://github.com/g0v-network/domains
cd domains

brew install pipenv
pipenv install

# Copy and modify as needed with API token
cp sample.env .env

# Validate your config locally
pipenv run octodns-validate --config-file config.yaml

# Do a dry run (no changes will be made)
pipenv run octodns-sync --config-file config.yaml

# Do a REAL run (!!!)
#
# WARNING: this is destructive, and will delete any records on a domain that
# are not present in your configuration files.
pipenv run octodns-sync --config-file config.yaml --doit

💪 Contributing

Please open an issue or pull request in order to create/update/delete any subdomains.

©️ License

CC0 1.0 Universal