From 5c6325004db532e29d84193e29e57b8ed64f4840 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonathan=20Beli=C3=ABn?= Date: Sun, 18 May 2025 22:47:50 +0200 Subject: [PATCH] Add some documentation --- OWNERS | 1 + README.md | 1 + documentation/SUMMARY.md | 1 + documentation/provider/infomaniak.md | 38 ++++++++++++++++++++++++++++ 4 files changed, 41 insertions(+) create mode 100644 documentation/provider/infomaniak.md diff --git a/OWNERS b/OWNERS index ff50183b7..02bfbb1f5 100644 --- a/OWNERS +++ b/OWNERS @@ -26,6 +26,7 @@ providers/hetzner @das7pad providers/hexonet @KaiSchwarz-cnic providers/hostingde @juliusrickert providers/huaweicloud @huihuimoe +providers/infomaniak @jbelien providers/internetbs @pragmaton providers/inwx @patschi providers/linode @koesie10 diff --git a/README.md b/README.md index d2410bf47..afd28641a 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,7 @@ Currently supported DNS providers: - hosting.de - Huawei Cloud DNS - Hurricane Electric DNS +- Infomaniak - INWX - Linode - Loopia diff --git a/documentation/SUMMARY.md b/documentation/SUMMARY.md index 2c39e1b80..a008f0cc6 100644 --- a/documentation/SUMMARY.md +++ b/documentation/SUMMARY.md @@ -131,6 +131,7 @@ * [hosting.de](provider/hostingde.md) * [Huawei Cloud DNS](provider/huaweicloud.md) * [Hurricane Electric DNS](provider/hedns.md) +* [Infomaniak](provider/infomaniak.md) * [Internet.bs](provider/internetbs.md) * [INWX](provider/inwx.md) * [Linode](provider/linode.md) diff --git a/documentation/provider/infomaniak.md b/documentation/provider/infomaniak.md new file mode 100644 index 000000000..076295230 --- /dev/null +++ b/documentation/provider/infomaniak.md @@ -0,0 +1,38 @@ +This is the provider for [Infomaniak](https://www.infomaniak.com/). + +## Configuration + +To use this provider, add an entry to `creds.json` with `TYPE` set to `INFOMANIAK` along with a Infomaniak account personal access token. + +Examples: + +{% code title="creds.json" %} +```json +{ + "netlify": { + "TYPE": "INFOMANIAK", + "token": "your-infomaniak-account-access-token", + } +} +``` +{% endcode %} + +## Metadata +This provider does not recognize any special metadata fields unique to Infomaniak. + +## Usage +An example configuration: + +{% code title="dnsconfig.js" %} +```javascript +var REG_INFOMANIAK = NewRegistrar("infomaniak"); +var DSP_INFOMANIAK = NewDnsProvider("infomaniak"); + +D("example.com", REG_INFOMANIAK, DnsProvider(DSP_INFOMANIAK), + A("test", "1.2.3.4"), +); +``` +{% endcode %} + +## Activation +DNSControl depends on a Infomaniak account personal access token.