kubo icon indicating copy to clipboard operation
kubo copied to clipboard

Gateway docs need to be updated to reflect supported features

Open delgyd opened this issue 1 year ago • 1 comments

Checklist

  • [X] My issue is specific & actionable.
  • [X] I am not suggesting a protocol enhancement.
  • [X] I have searched on the issue tracker for my issue.

Description

https://github.com/ipfs/kubo/blob/master/docs/gateway.md For convenience, the gateway (mostly) acts like a normal web-server when serving a directory:

If the directory contains an index.html file: If the path does not end in a /, append a / and redirect. This helps avoid serving duplicate content from different paths.† Otherwise, serve the index.html file. Dynamically build and serve a listing of the contents of the directory.

Among the above functions, a new page redirection function is added for directories without index.html, such as redirecting to ipfs.io. No need to directly build directory listing contents

delgyd avatar Nov 27 '23 09:11 delgyd

Thank you for filling this, iiuc the ask is to update https://github.com/ipfs/kubo/blob/master/docs/gateway.md with information about

  • generated directory listings for unixfs
  • dag-cbor preview
  • _redirects https://docs.ipfs.tech/how-to/websites-on-ipfs/redirects-and-custom-404s/

lidel avatar Nov 27 '23 14:11 lidel