Cloned2Preserve
/
TrueChartsClone
mirror of https://github.com/truecharts/charts.git
1
0
Fork 0
Code
TrueChartsClone/charts/stable/cloudflareddns/docs/setup-guide.md

53 lines
1.9 KiB
Markdown
Raw Normal View History

chore(docs): lints some docs, uses front-matter instead of # h1, and fix list items in changelog (#16589) **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)--> front matter is supported by all doc sites (including github markdown rendering and is easier to add extra metadata later on, if we want to. ``` --- title: sometitle --- ``` **⚙️ 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-12-31 09:24:05 -05:00
---
title: How-To
---
feat(Docs): Add Setup-Guide for cloudflareddns (#3197) * feat(Docs): Add Setup-Guide for cloudflareddns * fixing lint errors for some reason * Update charts/incubator/cloudflareddns/docs/setup-guide.md Co-authored-by: Kjeld Schouten-Lebbing <kjeld@schouten-lebbing.nl>
2022-07-17 06:04:56 -04:00
chore(docs): extend linter and apply lint (#3200) * chore(docs): extend linter and apply lint * bump apps to forward docs to websiter
2022-07-17 07:14:52 -04:00
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.
feat(Docs): Add Setup-Guide for cloudflareddns (#3197) * feat(Docs): Add Setup-Guide for cloudflareddns * fixing lint errors for some reason * Update charts/incubator/cloudflareddns/docs/setup-guide.md Co-authored-by: Kjeld Schouten-Lebbing <kjeld@schouten-lebbing.nl>
2022-07-17 06:04:56 -04:00
## Requirements
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._
2023-06-24 12:07:37 -04:00
Domain name (can be purchased through Cloudflare or any other domain registrar)
feat(Docs): Add Setup-Guide for cloudflareddns (#3197) * feat(Docs): Add Setup-Guide for cloudflareddns * fixing lint errors for some reason * Update charts/incubator/cloudflareddns/docs/setup-guide.md Co-authored-by: Kjeld Schouten-Lebbing <kjeld@schouten-lebbing.nl>
2022-07-17 06:04:56 -04:00
Cloudflare DNS management
chore(docs): extend linter and apply lint (#3200) * chore(docs): extend linter and apply lint * bump apps to forward docs to websiter
2022-07-17 07:14:52 -04:00
- Sign up for Cloudflare free
- Point your nameservers to the ones Cloudflare assigns to you
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>
2022-07-19 02:41:39 -04:00
chore(docs): standardize ./img references (#16704) **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-12-31 15:39:31 -05:00
![cloudflare-ns](./img/cloudflare-ns.png)
feat(Docs): Add Setup-Guide for cloudflareddns (#3197) * feat(Docs): Add Setup-Guide for cloudflareddns * fixing lint errors for some reason * Update charts/incubator/cloudflareddns/docs/setup-guide.md Co-authored-by: Kjeld Schouten-Lebbing <kjeld@schouten-lebbing.nl>
2022-07-17 06:04:56 -04:00
Cloudflareddns chart
## Prerequisites
chore(docs): make links relative
2024-04-13 19:26:39 -04:00
This guide assumes you've followed our [clusterissuer guide](/charts/premium/clusterissuer/how-to) with your domain on TrueNAS and done the configuration for your DNS on Cloudflare
feat(Docs): Add Setup-Guide for cloudflareddns (#3197) * feat(Docs): Add Setup-Guide for cloudflareddns * fixing lint errors for some reason * Update charts/incubator/cloudflareddns/docs/setup-guide.md Co-authored-by: Kjeld Schouten-Lebbing <kjeld@schouten-lebbing.nl>
2022-07-17 06:04:56 -04:00
The recommended way is to setup CNAMEs for your subdomains (charts) and keep your A record pointed to your base domain, such as below
chore(docs): standardize ./img references (#16704) **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-12-31 15:39:31 -05:00
![cloudflare-dns](./img/cloudflare-dns.png)
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>
2022-07-19 02:41:39 -04:00
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._
2023-06-24 12:07:37 -04:00
> Create an API Token, with the following permissions:
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>
2022-07-19 02:41:39 -04:00
> 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
>
chore(docs): standardize ./img references (#16704) **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-12-31 15:39:31 -05:00
> ![cloudflare-token](./img/cloudflare-token.png)
feat(Docs): Add Setup-Guide for cloudflareddns (#3197) * feat(Docs): Add Setup-Guide for cloudflareddns * fixing lint errors for some reason * Update charts/incubator/cloudflareddns/docs/setup-guide.md Co-authored-by: Kjeld Schouten-Lebbing <kjeld@schouten-lebbing.nl>
2022-07-17 06:04:56 -04:00
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>
2022-07-19 02:41:39 -04:00
## Cloudflareddns Chart Setup
feat(Docs): Add Setup-Guide for cloudflareddns (#3197) * feat(Docs): Add Setup-Guide for cloudflareddns * fixing lint errors for some reason * Update charts/incubator/cloudflareddns/docs/setup-guide.md Co-authored-by: Kjeld Schouten-Lebbing <kjeld@schouten-lebbing.nl>
2022-07-17 06:04:56 -04:00
chore(docs): standardize ./img references (#16704) **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-12-31 15:39:31 -05:00
![cloudflare-config](./img/cloudflare-config.png)
feat(Docs): Add Setup-Guide for cloudflareddns (#3197) * feat(Docs): Add Setup-Guide for cloudflareddns * fixing lint errors for some reason * Update charts/incubator/cloudflareddns/docs/setup-guide.md Co-authored-by: Kjeld Schouten-Lebbing <kjeld@schouten-lebbing.nl>
2022-07-17 06:04:56 -04:00
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._
2023-06-24 12:07:37 -04:00
Use API Token previously created for the `CF API Token` field.
feat(Docs): Add Setup-Guide for cloudflareddns (#3197) * feat(Docs): Add Setup-Guide for cloudflareddns * fixing lint errors for some reason * Update charts/incubator/cloudflareddns/docs/setup-guide.md Co-authored-by: Kjeld Schouten-Lebbing <kjeld@schouten-lebbing.nl>
2022-07-17 06:04:56 -04:00
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._
2023-06-24 12:07:37 -04:00
Click Add for Hosts, Zones and Record Types.
feat(Docs): Add Setup-Guide for cloudflareddns (#3197) * feat(Docs): Add Setup-Guide for cloudflareddns * fixing lint errors for some reason * Update charts/incubator/cloudflareddns/docs/setup-guide.md Co-authored-by: Kjeld Schouten-Lebbing <kjeld@schouten-lebbing.nl>
2022-07-17 06:04:56 -04:00
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._
2023-06-24 12:07:37 -04:00
- 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
feat(Docs): Add Setup-Guide for cloudflareddns (#3197) * feat(Docs): Add Setup-Guide for cloudflareddns * fixing lint errors for some reason * Update charts/incubator/cloudflareddns/docs/setup-guide.md Co-authored-by: Kjeld Schouten-Lebbing <kjeld@schouten-lebbing.nl>
2022-07-17 06:04:56 -04:00
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>
2022-07-19 02:41:39 -04:00
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/))