Skip to content

Commit 49f768d

Browse files
committed
improving PublicGateways docs
License: MIT Signed-off-by: Marcin Rataj <[email protected]>
1 parent 3ef4d61 commit 49f768d

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

docs/config.md

+11-5
Original file line numberDiff line numberDiff line change
@@ -424,18 +424,24 @@ Options for changing behavior per hostname:
424424
- `Paths`
425425
Array of paths that should be mounted at the root of domain name.
426426
Example: `["/ipfs", "/ipns", "/api"]`
427-
- **Note:** when both `Paths` and DNSLink are mounted, `Paths` takes priority
427+
**Note:** If DNSLink is enabled, all defined `Paths` are mounted on top of `/` and take priority over DNSLink.
428428

429-
- `UseSubdomains`
429+
- `UseSubdomains`
430430
A boolean to configure whether the gateway provides [Origin isolation](https://developer.mozilla.org/en-US/docs/Web/Security/Same-origin_policy)
431431
between content roots.
432432
Default: `false`
433-
- `true` – mount [subdomain gateway](#https://docs-beta.ipfs.io/how-to/address-ipfs-on-web/#subdomain-gateway) at `http://{cid}.ipfs.{hostname}`
434-
- requires respective `Paths` to be set
435-
- requests for `http://{hostname}/ipfs/{cid}` will return redirect to `http://{cid}.ipfs.{hostname}`
433+
- `true` – mount [subdomain gateway](#https://docs-beta.ipfs.io/how-to/address-ipfs-on-web/#subdomain-gateway) at `http://*.{hostname}`
434+
- requires respective `Paths` to be set
435+
Example: `Paths: ["/ipfs", "/ipns"]` is required for `http://{cid}.ipfs.{hostname}` and `http://{foo}.ipns.{hostname}` to work.
436+
- requests for content paths such as `http://{hostname}/ipfs/{cid}` will return redirect to `http://{cid}.ipfs.{hostname}`
436437
- `false` – mount [path gateway](https://docs-beta.ipfs.io/how-to/address-ipfs-on-web/#path-gateway) at `http://{hostname}/ipfs/{cid}`
437438
<!-- **(not implemented yet)** due to the lack of Origin isolation, cookies and storage on `Paths` will be disabled by [Clear-Site-Data](https://github.com/ipfs/in-web-browsers/issues/157) header -->
438439

440+
- `NoDNSLink`
441+
A boolean to configure whether DNSLink for FQDN present in `Host`
442+
HTTP header should be resolved. Overrides global setting.
443+
Default: `false` (DNSLink enabled by default for every defined hostname)
444+
439445
#### Examples of common use cases
440446

441447
* Public [subdomain gateway](https://docs-beta.ipfs.io/how-to/address-ipfs-on-web/#subdomain-gateway) at `http://{cid}.ipfs.dweb.link`

0 commit comments

Comments
 (0)