fix(cloudflareddns): Updated How-To for more complete setup (#3213)

* fix(cloudflareddns): Updated How-To for more complete setup

* fixed trailing whitespace

* Add images locally

* add both ways :)

Co-authored-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com>
Co-authored-by: Stavros kois <s.kois@outlook.com>
This commit is contained in:
StevenMcElligott 2022-07-19 02:41:39 -04:00 committed by GitHub
parent 8226b7bf81
commit 3aa7fb1912
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 33 additions and 16 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 200 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 74 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 110 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 63 KiB

View File

@ -10,7 +10,8 @@ Cloudflare DNS management
- Sign up for Cloudflare free
- Point your nameservers to the ones Cloudflare assigns to you
![image](https://user-images.githubusercontent.com/89483932/179332161-e903e46e-ed8c-4b58-81fc-6fcadf1a9851.png)
![cloudflare-ns](img/cloudflare-ns.png)
Cloudflareddns chart
@ -20,39 +21,55 @@ This guide assumes you've followed our main [Quick-Start Guide](https://truechar
The recommended way is to setup CNAMEs for your subdomains (charts) and keep your A record pointed to your base domain, such as below
![image](https://user-images.githubusercontent.com/89483932/179334653-316e462f-7bf7-4cda-a9dc-dd8842e76021.png)
![cloudflare-dns](img/cloudflare-dns.png)
Take note of the `Zone ID` and `Account ID`, that's what we'll use inside the Cloudflareddns chart.
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
![Overview](https://user-images.githubusercontent.com/89483932/179336819-64a32521-c64b-4ae6-8d5d-225b7342b786.png)
![cloudflare-api-keys](img/cloudflare-api-keys.png)
## Cloudflareddns chart setup
> **Alternatively** you can 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](img/cloudflare-token.png)
## Cloudflareddns Chart Setup
Step 1-2: Name chart and leave defaults for Step 2
![Step 1](https://user-images.githubusercontent.com/89483932/179336761-2ce2da3a-cd75-43ba-befe-4c3775f04027.png)
![cloudflare-name](img/cloudflare-name.png)
Step 3:
![Step 3 Part 1](https://user-images.githubusercontent.com/89483932/179336779-e2aa5273-8527-40f1-bc3c-3768931ea289.png)
![cloudflare-config](img/cloudflare-config.png)
Use ZoneID from Cloudflare Domain Overview page (see above) for the `CF_APITOKEN_ZONE` field
Use Global API key from Cloudflare Domain Overview page (see above) for the `CF_APIKEY` field
Use Account ID from Cloudflare Domain Overview page (see above) for the `CF_APITOKEN` 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
![Step 3 Part 2](https://user-images.githubusercontent.com/89483932/179336787-338b1939-546c-42fa-86a2-afe89da91e8d.png)
> **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
You can leave everything but the `CF_RECORDTYPES` to defaults if you're only changing your A record, (refer to the upstream documentation for more options [here](https://hotio.dev/containers/cloudflareddns/))
Change `CF_RECORDTYPES` 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 for real-time feedback and support
- Check our [Discord](https://discord.gg/tVsPTHWTtr)
- 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)
---