ipfs/kubo

Add flag to ignore `index.html` resolution in gateway

Open

#8,265 opened on Jul 16, 2021

View on GitHub
 (4 comments) (3 reactions) (0 assignees)Go (2,725 forks)batch import
P3effort/hourshelp wantedkind/enhancementtopic/gateway

Repository metrics

Stars
 (13,906 stars)
PR merge metrics
 (Avg merge 4d 2h) (28 merged PRs in 30d)

Description

At the moment, if I want to do a directory listing using an HTTP request to a gateway, I cannot do anything if there is an index.html file inside a given path.

It would be nice to be able to specify a flag in the querystring (eg, ?noResolve) to skip the resolution of index.html and to do a regular directory read.

This is something I've played with a bit in js-ipfs-fetch using a custom header, but that doesn't play well with CORS and I've since learned that querystrings are much more reliable/ usable (in hypercore-fetch).

Is this something that could be considered for addition?

Contributor guide

Research direction
Explore the gateway handler code that resolves index.html in directory listings. Identify where the resolution occurs and how to add a query parameter to skip it. Consider existing tests for directory listing.
Tech stack
go
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoHTTP
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60