docs: cleanup config formatting
Adin Schmahmann committed
May 20, 2020 at 13:45 UTC
a0e01501e7cd758671e78153a33ab098b3b09988
1 file changed
+17
-8
docs/config.md
+17
-8
@@ -459,6 +459,7 @@ Example: We mount `blog.ipfs.io` (a dnslink page) at `ipfs.io/blog`.
459
```json
460
"Gateway": {
461
"PathPrefixes": ["/blog"],
462
+}
463
```
464
465
**nginx_ipfs.conf**
@@ -489,6 +490,10 @@ Example:
490
"PublicGateways": {
491
"example.com": {
492
"Paths": ["/ipfs", "/ipns"],
493
+ }
494
+ }
495
+ }
496
+}
497
```
498
499
Above enables `http://example.com/ipfs/*` and `http://example.com/ipns/*` but not `http://example.com/api/*`
@@ -504,12 +509,14 @@ between content roots.
509
- **Requires whitelist:** make sure respective `Paths` are set.
510
For example, `Paths: ["/ipfs", "/ipns"]` are required for `http://{cid}.ipfs.{hostname}` and `http://{foo}.ipns.{hostname}` to work:
511
```json
507
- {
512
"Gateway": {
513
"PublicGateways": {
510
- "dweb.link": {
511
- "UseSubdomains": true,
512
- "Paths": ["/ipfs", "/ipns"],
514
+ "dweb.link": {
515
+ "UseSubdomains": true,
516
+ "Paths": ["/ipfs", "/ipns"],
517
+ }
518
+ }
519
+ }
520
```
521
- **Backward-compatible:** requests for content paths such as `http://{hostname}/ipfs/{cid}` produce redirect to `http://{cid}.ipfs.{hostname}`
522
- **API:** if `/api` is on the `Paths` whitelist, `http://{hostname}/api/{cmd}` produces redirect to `http://api.{hostname}/api/{cmd}`
@@ -517,12 +524,14 @@ between content roots.
524
- `false` - enables [path gateway](https://docs-beta.ipfs.io/how-to/address-ipfs-on-web/#path-gateway) at `http://{hostname}/*`
525
- Example:
526
```json
520
- {
527
"Gateway": {
528
"PublicGateways": {
523
- "ipfs.io": {
524
- "UseSubdomains": false,
525
- "Paths": ["/ipfs", "/ipns", "/api"],
529
+ "ipfs.io": {
530
+ "UseSubdomains": false,
531
+ "Paths": ["/ipfs", "/ipns", "/api"],
532
+ }
533
+ }
534
+ }
535
```
536
<!-- **(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 -->
537