ipfs-docs icon indicating copy to clipboard operation
ipfs-docs copied to clipboard
verified publisher icon ipfs

`ipfs-404.html` is not documented

Open jyooru opened this issue 3 years ago • 3 comments

There is no documentation (as verified by a text search through this repository) on the ipfs-404.html file, which is returned if a file is not found. Only found out about this file by looking inside the folders of the official IPFS websites.

jyooru avatar May 19 '22 07:05 jyooru

Thank you for submitting your first issue to this repository! A maintainer will be here shortly to triage and review. In the meantime, please double-check that you have provided all the necessary information to make this process easy! Any information that can help save additiona round trips is useful! We currently aim to give initial feedback within two business days. If this does not happen, feel free to leave a comment. Please keep an eye on how this issue will be labeled, as labels give an overview of priorities, assignments and additional actions requested by the maintainers:

  • "Priority" labels will show how urgent this is for the team.
  • "Status" labels will show if this is ready to be worked on, blocked, or in progress.
  • "Need" labels will indicate if additional input or analysis is required.

Finally, remember to use https://discuss.ipfs.io if you just need general support.

welcome[bot] avatar May 19 '22 07:05 welcome[bot]

Thanks for raising this!

Tasks

  • [ ] Write a basic description for what the ipfs-404.html page does.
    • [ ] Can likely grab the Custom 404 Pages paragraph from this blog: https://blog.ipfs.io/2020-06-26-go-ipfs-0-6-0/
  • [ ] Create an example ipfs-404.html page.
  • [ ] Show the reader where to store this file.
  • [ ] Show an example of what the file looks like on a webserver.
  • [ ] Link to web services like Fleek: https://docs.fleek.co/hosting/troubleshooting/#adding-404-errors

johnnymatthews avatar May 24 '22 13:05 johnnymatthews

Would it be possible to wait with documenting this until _redirects file support https://github.com/ipfs/go-ipfs/pull/8890 lands? Or at least mention it as a better solution in the works that will supersede ipfs-404.html.

lidel avatar Jun 10 '22 11:06 lidel

Closing this now, it has been addressed here: https://docs.ipfs.tech/how-to/websites-on-ipfs/redirects-and-custom-404s/

TMoMoreau avatar Oct 03 '22 18:10 TMoMoreau