Files
truecharts/charts/stable/cloudflareddns/docs/setup-guide.md
Stavros Kois a51d429028 chore(preccomit): run precocmit (#13387)
**Description**
<!--
Please include a summary of the change and which issue is fixed. Please
also include relevant motivation and context. List any dependencies that
are required for this change.
-->
⚒️ Fixes  # <!--(issue)-->

**⚙️ Type of change**

- [ ] ⚙️ Feature/App addition
- [ ] 🪛 Bugfix
- [ ] ⚠️ Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] 🔃 Refactor of current code

**🧪 How Has This Been Tested?**
<!--
Please describe the tests that you ran to verify your changes. Provide
instructions so we can reproduce. Please also list any relevant details
for your test configuration
-->

**📃 Notes:**
<!-- Please enter any other relevant information here -->

**✔️ Checklist:**

- [ ] ⚖️ My code follows the style guidelines of this project
- [ ] 👀 I have performed a self-review of my own code
- [ ] #️⃣ I have commented my code, particularly in hard-to-understand
areas
- [ ] 📄 I have made corresponding changes to the documentation
- [ ] ⚠️ My changes generate no new warnings
- [ ] 🧪 I have added tests to this description that prove my fix is
effective or that my feature works
- [ ] ⬆️ I increased versions for any altered app according to semantic
versioning

** App addition**

If this PR is an app addition please make sure you have done the
following.

- [ ] 🪞 I have opened a PR on
[truecharts/containers](https://github.com/truecharts/containers) adding
the container to TrueCharts mirror repo.
- [ ] 🖼️ I have added an icon in the Chart's root directory called
`icon.png`

---

_Please don't blindly check all the boxes. Read them and only check
those that apply.
Those checkboxes are there for the reviewer to see what is this all
about and
the status of this PR with a quick glance._
2023-10-08 02:01:20 +03:00

1.9 KiB

How-To

So you've followed some of our TrueNAS guides, setup your domain name, certificates and use Cloudflare for your DNS management, however you don't have a static IP, then this guide is for you. This quick guide will help you go through the steps to use Cloudflareddns to update your dynamic IP along with your entire deployment so that even if you change IP your domain will point to the right address.

Requirements

Domain name (can be purchased through Cloudflare or any other domain registrar)

Cloudflare DNS management

  • Sign up for Cloudflare free

  • Point your nameservers to the ones Cloudflare assigns to you

    cloudflare-ns

Cloudflareddns chart

Prerequisites

This guide assumes you've followed our clusterissuer guide with your domain on TrueNAS and done the configuration for your DNS on Cloudflare

The recommended way is to setup CNAMEs for your subdomains (charts) and keep your A record pointed to your base domain, such as below

cloudflare-dns

Create an API Token, with the following permissions: Click Create Token and Use Template on the Edit zone DNS.

  • Zone - DNS - Edit
  • Zone - Zone - Read

And the following Zone resources

  • Include - Specific zone - yourdomain.com

    cloudflare-token

Cloudflareddns Chart Setup

cloudflare-config

Use API Token previously created for the CF API Token field.

Click Add for Hosts, Zones and Record Types.

  • Change Domain to your DNS Zone A record (yourdomain.com)
  • Change Zone to DNS Zone ID found on the Cloudflare Overview Page for your domain.
  • Change Record Type to A if you're only changing your main domain

If you're using or changing specific A records or CNAMEs you may want to refer to the upstream documentation for more examples here)