diff --git a/README.md b/README.md index 72d3725..cee1f50 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,8 @@ Inspired by [`g0v/domain`][g0v/domain] The intended way to use this repository is via pull request directly on GitHub. -For support in managing common DNS changes, see [`docs/HOWTO.md`](/docs/HOWTO.md). +For support in managing common DNS changes and adding new domains, see +[`docs/HOWTO.md`](/docs/HOWTO.md). To learn to submit changes, see [Contributing][contrib] diff --git a/docs/HOWTO.md b/docs/HOWTO.md index b36bb75..4971237 100644 --- a/docs/HOWTO.md +++ b/docs/HOWTO.md @@ -166,9 +166,25 @@ new subdomain using a new config file. ### Add a New Domain -- Point nameservers to Cloudflare #todo -- #todo can octodns create new zonefile automatically? -- DNS Nameserver Checker: https://mxtoolbox.com/SuperTool.aspx?action=dns:g0v.ca&run=toolpage +If you'd like to start managing a new domain through this repo, you can do +that! You'll only need to point your registrar at our Cloudflare nameservers -- +you keep the domain with your registrar, and the domain itself stays in your +hands. + +1. Create a new domain directory and config (see below) +2. Copy your existing records into appropriate yaml config. +3. Submit a pull request. +4. We'll create a new zone for your domain in the Cloudflare admin interface. +5. We'll add that zone to our existing Cloudflare API token, so it can be managed by our automation. +6. We'll merge the pull request after review + - Cloudflare's nameserver will be updated on merge, but your registrar won't be pointed to it yet. +7. After merging, point your registrar at our Cloudflare nameservers: + ``` + clyde.ns.cloudflare.com + tina.ns.cloudflare.com + ``` +- Confirm that your DNS records work as expected, using: + - DNS Nameserver Checker: https://mxtoolbox.com/SuperTool.aspx?action=dns:g0v.ca&run=toolpage
Adding example.com as newly managed domain