dnslink-fetch: README clarification

merge-requests/23/head
Michał 'rysiek' Woźniak 2022-10-22 10:22:48 +00:00
rodzic 6dd6c91e41
commit 3ea01a715e
1 zmienionych plików z 5 dodań i 5 usunięć

Wyświetl plik

@ -32,11 +32,11 @@ The `dnslink-fetch` plugin supports the following configuration options:
When fetching an URL, `dnslink-fetch` removes the scheme and domain component. Then, for each alternative endpoint that is used for this particular request (up to `concurrency` of endpoints, as described above), it concatenates the endpoint with the remaining URL part. Finally, it performs a [`fetch()`](https://developer.mozilla.org/en-US/docs/Web/API/fetch) request for every URL construed in such a way.
Let's say the plugin is deployed for website `https://example.com`, with `concurrency` set to `2` and these are the alternative endpoints specified in DNS according to the DNSLink specification (so, in [multiaddr form](https://github.com/multiformats/multiaddr#encapsulation-based-on-context)):
- `/https/example.org`
- `/https/example.net/alt-example`
- `/https/eu.example.cloud`
- `/https/us.example.cloud`
Let's say the plugin is deployed for website `https://example.com`, with `concurrency` set to `2` and these are the alternative endpoints specified in relevant TXT records according to the DNSLink specification (so, in [multiaddr form](https://github.com/multiformats/multiaddr#encapsulation-based-on-context)):
- `dnslink=/https/example.org`
- `dnslink=/https/example.net/alt-example`
- `dnslink=/https/eu.example.cloud`
- `dnslink=/https/us.example.cloud`
***Notice**: `dnslink-fetch` currently only supports a rudimentary, naïve form of [multiaddr](https://multiformats.io/multiaddr/) addresses, which is `/https/domain_name[/optional/path]`; full mutiaddr support might be implemented at a later date.*