ipfs/ipfs-companion

Feature request: support basic (or custom headers) auth for public gateway requests

Open

#538 opened on Jul 23, 2018

View on GitHub
 (10 comments) (0 reactions) (0 assignees)JavaScript (364 forks)batch import
good first issuehelp wantedkind/enhancementstatus/deferred

Repository metrics

Stars
 (1,992 stars)
PR merge metrics
 (Avg merge 53d 3h) (1 merged PR in 30d)

Description

It would be good if ipfs companion would allow me to use gateways which are running behind nginx with basic auth on them. The idea is a username/pw fields next to the public gateway configuration.

An alternative which works too would be to allow users to provide custom gateway request headers.

Contributor guide

Research direction
Examine the gateway configuration UI in the options page and the request building logic in the extension's background script. Add fields for username/password or custom headers, then modify the fetch or XMLHttpRequest call to include them.
Tech stack
javascript
Domain
frontend
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.
1-2 days
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
browser extension development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60