ipfs / ipfs/specs

Manifest files for unixfs loaded via HTTP Gateway

Open
#257 9 comments 11 reactions 1 assignee Assigned to @lidel View on GitHub
dif/expert help wanted kind/discussion kind/enhancement kind/maintenance need/community-input
Dominant language
HTML
Stars
1.2k
Forks
247
Avg merge
5d 21h
Merged PRs (30d)
4

Description

This is a placeholder issue for creating a spec for "content root's manifest files" which would be part of the data published on IPFS (eg. `/ipfs/CID/_something` or `/ipfs/CID/.well-known/ipfs/foo`) that provides hints to HTTP Gateway around things like redirects, content types and custom HTTP headers.

Related reading:
- [Proposal: manifest file for the IPFS gateway](https://github.com/ipfs/go-ipfs/issues/6214)
- [Proposal: native redirects config](https://github.com/ipfs/go-ipfs/issues/7392)
- [Content Type set by HTTP Gateway](https://github.com/ipfs/in-web-browsers/issues/152)

Possible reuse of:
- [x] `_redirects` (prior art in [netlify docs](https://docs.netlify.com/routing/redirects/)
- **DONE**
- IPIP: https://specs.ipfs.tech/ipips/ipip-0002/
- Specification: https://specs.ipfs.tech/http-gateways/web-redirects-file/
- Docs: https://docs.ipfs.tech/how-to/websites-on-ipfs/redirects-and-custom-404s/
- [ ] `_headers` file (prior art in [netlify docs](https://docs.netlify.com/routing/headers/#syntax-for-the-headers-file) and [cloudflare docs](https://developers.cloudflare.com/pages/configuration/headers/))
- **TBD**

Feel free to discuss/post ideas below, or open PRs with IPIP drafts that could be reviewed independently.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.