TrueChartsClone/charts/stable/ddns-updater/docs/How-To.md

68 lines
1.8 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 14:24:05 +00:00
---
title: How To
---
2022-10-25 05:51:58 +00:00
You can use the following json code to construct a json object to be used for the `config` field or use the upstream doc for your specific domain provider [here](https://github.com/qdm12/ddns-updater#configuration):
My domain provider is `cloudflare`.
The `zone_identifier` or `Zone ID` is _per_ domain and can be found in the overview of the website/domain.
My host or the `A record` is set to `@`.
If the record is proxied through CLoudflare, set `proxied` to `true` or otherwise `false`.
The `token` is different from the API key. Please go to [api-tokens](https://dash.cloudflare.com/profile/api-tokens) in Cloudflare to create a `Edit zone DNS` token for your specific zone or domain.
:::caution
For security purposes create multiple different tokens for every domain you plan to add. **DO NOT** use a global token.
:::
The `ip_version` should always be `ipv4` unless your special :/.
```json
{
"settings": [
{
"provider": "cloudflare",
"zone_identifier": "ZONE_ID",
"domain": "MY_DOMAIN_1.com",
"host": "@",
"proxied": true,
"ttl": 600,
"token": "TOKEN_1",
"ip_version": "ipv4"
},
{
"provider": "cloudflare",
"zone_identifier": "ZONE_ID_2",
"domain": "MY_DOMAIN_2.com",
"host": "@",
"proxied": true,
"ttl": 600,
"token": "TOKEN_2",
"ip_version": "ipv4"
},
{
"provider": "cloudflare",
"zone_identifier": "ZONE_ID_3",
"domain": "MY_DOMAIN_3.com",
"host": "@",
"proxied": true,
"ttl": 600,
"token": "TOKEN_3",
"ip_version": "ipv4"
}
]
}
```
:::tip
2022-10-25 05:51:58 +00:00
You can also reach us using Discord for real-time feedback and support
If you found a bug in our chart, open a Github issue but generally it's advised to contact us on Discord first in most cases.
:::