docs(cloudflareddns): update setup guide (#9875)

**Description**
Update cloudflareddns setup guide

⚒️ Fixes  # 

**⚙️ 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?**

**📃 Notes:**


**✔️ 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._
This commit is contained in:
kqmaverick
2023-06-24 09:07:37 -07:00
committed by GitHub
parent ecb5212943
commit fedc007d9c
4 changed files with 8 additions and 38 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 200 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 74 KiB

After

Width:  |  Height:  |  Size: 61 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

View File

@@ -4,7 +4,7 @@ So you've followed some of our TrueNAS guides, setup your domain name, certifica
## Requirements
Domain name (can be purchased through Cloudflare or etc)
Domain name (can be purchased through Cloudflare or any other domain registrar)
Cloudflare DNS management
@@ -17,20 +17,13 @@ Cloudflareddns chart
## Prerequisites
This guide assumes you've followed our main [Guide](https://truecharts.org/manual/guides/adding-letsencrypt/) with your domain on TrueNAS and done the configuration for your DNS on Cloudflare
(see this video on our YouTube channel)
<iframe width="560" height="315" src="https://www.youtube.com/watch?v=hJVghecs3rE" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
This guide assumes you've followed our [clusterissuer guide](https://truecharts.org/charts/enterprise/clusterissuer/how-to) 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](img/cloudflare-dns.png)
To keep things simple, one can simply use the Global API key from Cloudflare that you previously used inside our guides to setup your certificates, in case you forget it's in the page below
![cloudflare-api-keys](img/cloudflare-api-keys.png)
> **Alternatively** you can create an API Token, with the following permissions:
> Create an API Token, with the following permissions:
> Click `Create Token` and `Use Template` on the Edit zone DNS.
>
> - Zone - DNS - Edit
@@ -44,38 +37,15 @@ To keep things simple, one can simply use the Global API key from Cloudflare tha
## Cloudflareddns Chart Setup
Step 1-2: Name chart and leave defaults for Step 2
![cloudflare-name](img/cloudflare-name.png)
Step 3:
![cloudflare-config](img/cloudflare-config.png)
Use Global API key from Cloudflare Domain Overview page (see above) for the `CF_APIKEY` field
Use API Token previously created for the `CF API Token` field.
- Change `CF_USER` to your Cloudflare Email Account
- Change `CF_HOSTS` to your DNS Zone A record (mydomain.com)
- Change `CF_ZONES` to the same Zone (mydomain.com)
- Change `CF_RECORDTYPES` to A if you're only changing your main domain
Click Add for Hosts, Zones and Record Types.
> **Alternatively** (Only if you created an API Token)
>
> - Change `CF_APITOKEN` to your generated Token
> - Change `CF_HOSTS` to your `yourdomain.com` (or the record you want to update)
> - Change `CF_ZONES` to your Zone ID (Found in your Cloudflare dashboard, on the right column)
> - Change `CF_RECORDTYPES` to `A` if you want to update an A record
- 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](https://hotio.dev/containers/cloudflareddns/))
Steps 4-8: Adjust as necessary but defaults are fine
## Support
- If you need more details or have a more custom setup the documentation on the [upstream](https://hotio.dev/containers/cloudflareddns/) is very complete so check the descriptions of the options there.
- You can also reach us using [Discord](https://discord.gg/tVsPTHWTtr) for real-time feedback and support
- If you found a bug in our chart, open a Github [issue](https://github.com/truecharts/apps/issues/new/choose)
---
All Rights Reserved - The TrueCharts Project