Skip to content

Commit a1def46

Browse files
lidellidel
committed
chore: missing affinity and improved descriptions
1 parent b7d4ff0 commit a1def46

File tree

6 files changed

+70
-21
lines changed

6 files changed

+70
-21
lines changed

‎src/http-gateways/dnslink-gateway.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,22 @@
11
---
22
title: DNSLink Gateway Specification
33
description: >
4-
DNSLink Gateways are an extension of Path Gateways that enable hosting a
5-
specific content path under a specific DNS name.
4+
Defines how to utilize the HTTP Host header to serve a content path from a
5+
DNSLink record as a website under a particular DNS name.
66
date: 2022-11-09
77
maturity: reliable
88
editors:
99
- name: Marcin Rataj
1010
github: lidel
1111
url: https://lidel.org/
12+
affiliation:
13+
name: Protocol Labs
14+
url: https://protocol.ai/
1215
- name: Thibault Meunier
1316
github: thibmeu
17+
affiliation:
18+
name: Cloudflare
19+
url: https://cloudflare.com/
1420
tags: ['httpGateways', 'webHttpGateways']
1521
order: 4
1622
---

‎src/http-gateways/libp2p-gateway.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: libp2p+HTTP Transport Gateway Specification
33
description: >
4-
The libp2p Transport Gateway specification describes how HTTP Gateway semantics can be used over libp2p transports.
4+
Describes how HTTP Gateway semantics can be used over libp2p transports.
55
date: 2023-10-04
66
maturity: draft
77
editors:

‎src/http-gateways/path-gateway.md‎

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,39 @@
11
---
22
title: Path Gateway Specification
33
description: >
4-
The most versatile form of IPFS Gateway is a Path Gateway. It exposes namespaces, such
5-
as /ipfs/ and /ipns/ under an HTTP server root and provides basic primitives for integrating
6-
IPFS resources within the existing HTTP stack.
4+
The comprehensive low-level HTTP Gateway enables the integration of IPFS
5+
resources into the HTTP stack through /ipfs and /ipns namespaces, supporting
6+
both deserialized and verifiable response types.
77
date: 2023-03-30
88
maturity: reliable
99
editors:
1010
- name: Marcin Rataj
1111
github: lidel
1212
url: https://lidel.org/
13+
affiliation:
14+
name: Protocol Labs
15+
url: https://protocol.ai/
1316
- name: Adrian Lanzafame
1417
github: lanzafame
18+
affiliation:
19+
name: Protocol Labs
20+
url: https://protocol.ai/
1521
- name: Vasco Santos
1622
github: vasco-santos
23+
affiliation:
24+
name: Protocol Labs
25+
url: https://protocol.ai/
1726
- name: Oli Evans
1827
github: olizilla
28+
affiliation:
29+
name: Protocol Labs
30+
url: https://protocol.ai/
1931
- name: Henrique Dias
2032
github: hacdias
2133
url: https://hacdias.com/
34+
affiliation:
35+
name: Protocol Labs
36+
url: https://protocol.ai/
2237
xref:
2338
- url
2439
- trustless-gateway

‎src/http-gateways/subdomain-gateway.md‎

Lines changed: 30 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,59 @@
11
---
22
title: Subdomain Gateway Specification
33
description: >
4-
Subdomain Gateways are an extension of Path Gateways that enable website hosting
5-
isolated per CID/name, while remaining compatible with web browsers relative pathing and
6-
the security model of the web.
4+
Defines how HTTP Gateway can implement support for HTTP Host headers to
5+
enable isolated website hosting based on root CID-derived Origins. This
6+
ensures compatibility with native ipfs:// and ipns:// URIs, and aligns with
7+
the existing Same-origin security model in web browsers, including
8+
relative URL pathing and permission scopes of Web APIs.
79
date: 2023-01-28
810
maturity: reliable
911
editors:
1012
- name: Marcin Rataj
1113
github: lidel
1214
url: https://lidel.org/
15+
affiliation:
16+
name: Protocol Labs
17+
url: https://protocol.ai/
1318
- name: Adrian Lanzafame
1419
github: lanzafame
20+
affiliation:
21+
name: Protocol Labs
22+
url: https://protocol.ai/
1523
- name: Vasco Santos
1624
github: vasco-santos
25+
affiliation:
26+
name: Protocol Labs
27+
url: https://protocol.ai/
1728
- name: Oli Evans
1829
github: olizilla
30+
affiliation:
31+
name: Protocol Labs
32+
url: https://protocol.ai/
1933
- name: Thibault Meunier
2034
github: thibmeu
35+
affiliation:
36+
name: Cloudflare
37+
url: https://cloudflare.com/
2138
- name: Steve Loeppky
2239
github: BigLep
40+
affiliation:
41+
name: Protocol Labs
42+
url: https://protocol.ai/
2343
xref:
2444
- url
2545
- html
2646
tags: ['httpGateways', 'webHttpGateways']
2747
order: 3
2848
---
2949

30-
Subdomain Gateway is an extension of :cite[path-gateway] that
31-
enables website hosting isolated per CID/name, while remaining compatible with
32-
web browsers relative pathing and security model of the web.
33-
Below should be read as a delta on top of that spec.
50+
Subdomain Gateways extend :cite[path-gateway] with HTTP [Host](#host-request-heafer)
51+
header support. Below should be read as a delta on top of that spec.
52+
53+
This specification enables isolated website hosting based on root CID-derived
54+
Origins, ensures compatibility with native ipfs:// and ipns:// URIs, and aligns
55+
with the existing Same-origin security model in web browsers,
56+
including relative URL pathing and permission scopes of Web APIs.
3457

3558
Summary:
3659

‎src/http-gateways/trustless-gateway.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
title: Trustless Gateway Specification
33
description: >
4-
Trustless Gateways are a minimal subset of Path Gateways that allow light IPFS
5-
clients to retrieve data behind a CID and verify its integrity without delegating any
6-
trust to the gateway itself.
4+
The minimal subset of HTTP Gateway response types facilitates data retrieval
5+
via CID and ensures integrity verification, all while eliminating the need to
6+
trust the gateway itself.
77
date: 2023-06-20
88
maturity: reliable
99
editors:

‎src/http-gateways/web-redirects-file.md‎

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,35 @@
11
---
22
title: Web _redirects File Specification
33
description: >
4-
The Redirects File specification is an extension of the Subdomain Gateway and DNSLink Gateway specifications that
5-
enables URL redirects or rewrites by adding redirect rules to a0 file stored underneath the root CID of a web
6-
site.
4+
Defines how URL redirects and rewrites can be implemented by adding rules to
5+
a plain text file stored underneath the root CID of a website.
76
date: 2023-01-28
87
maturity: reliable
98
editors:
109
- name: Justin Johnson
1110
github: justincjohnson
11+
affiliation:
12+
name: Fission
13+
url: https://fission.codes/
1214
- name: Marcin Rataj
1315
github: lidel
1416
url: https://lidel.org/
17+
affiliation:
18+
name: Protocol Labs
19+
url: https://protocol.ai/
1520
tags: ['httpGateways', 'webHttpGateways']
1621
order: 5
1722
---
1823

1924
The Web Redirects File specification is an extension of the Subdomain Gateway and DNSLink Gateway specifications.
2025

21-
Developers can enable URL redirects or rewrites by adding redirect rules to a file named `_redirects` stored underneath the root CID of their web site.
26+
Developers can enable URL redirects or rewrites by adding redirect rules to a file named `_redirects` stored underneath the root CID of their website.
2227

2328
This can be used, for example, to enable URL rewriting for hosting a single-page application, to redirect invalid URLs to a pretty 404 page, or to avoid [link rot](https://en.wikipedia.org/wiki/Link_rot) when moving to IPFS-based website hosting.
2429

2530
# File Name and Location
2631

27-
The Redirects File MUST be named `_redirects` and stored underneath the root CID of the web site.
32+
The Redirects File MUST be named `_redirects` and stored underneath the root CID of the website.
2833

2934
# File Format
3035

0 commit comments

Comments
 (0)