[go: nahoru, domu]

Skip to content

Firefox addon that provides transparent access to IPFS resources via local HTTP2IPFS gateway

License

Notifications You must be signed in to change notification settings

the8472/ipfs-firefox-addon

 
 

Repository files navigation

ipfs-firefox-addon

js-standard-style build-status

Firefox addon that provides transparent access to IPFS resources via local HTTP2IPFS gateway.

(If you are using Google Chrome or Chromium check ipfs-chrome-extension or ipfs-chrome-station instead)

screenshot of v1.5.0

Features

  • Toolbar icon displays current IPFS peering status
  • Click on it to open IPFS actions menu
    • Display information about custom gateway
    • Toggle redirection to the gateway (ON by default)
    • Open WebUI (eg. go-ipfs daemon running at the custom gateway)
    • Additionally, on pages loaded from IPFS:
      • Pin IPFS Resource (via API)
      • Copy canonical IPFS address
      • Copy shareable URL to resource at a default public gateway (first one on public gateway list)
  • Requests to https?://<public_gateway>/(ipfs|ipns)/$RESOURCE
    are replaced with http://127.0.0.1:8080/(ipfs|ipns)/$RESOURCE
  • Custom Gateway address and other settings can be tweaked at
    about:addons → Extensions → IPFS Gateway Redirect → Preferences
  • Requests made via popular custom protocols are routed to the active gateway (public or custom):
    • [web+](ipfs|ipns):/*$RESOURCE
    • [web+]fs:/*(ipfs|ipns)/$RESOURCE
  • Experimental features (disabled by default, use Preferences screen to enable)
    • Automatic Mode: enable/disable redirect based on the number of peers
    • Detect and redirect sites with dnslink to /ipns/<fqdn>
    • Rewrite hrefs with /ip(f|n)s/* paths on every page to point to IPFS gateway. Make plaintext IPFS links clickable.

How to install

The easiest way is to get it from addons.mozilla.org:

Get the add-on

It will guarantee automatic updates to the latest version reviewed by Mozilla community.

It is also possible to manually build XPI from the latest relase sources, however offical Firefox builds do not accept unsigned XPIs anymore.

Please read SECURITY.md if you want to perform quick security audit BEFORE installation.

TROUBLESHOOTING

Rule to work with NoScript with ABE enabled

By default NoScript breaks this addon by blocking assets loaded from IPFS Gateway running on localhost.
To make it work, one needs to extend the SYSTEM Rulset and prepend it with IPFS whitelist:

# Enable IPFS redirect to LOCAL
Site ^http://127.0.0.1:8080/(ipfs|ipns)*
Anonymize

# Prevent Internet sites from requesting LAN resources.
Site LOCAL
Accept from LOCAL
Deny

Feel free to modify it, but get familiar with ABE rule syntax first.

CONTRIBUTING

See CONTRIBUTING

LICENSE

IPFS logo belongs to The IPFS Project and is licensed under a CC-BY-SA 3.0.

is-ipfs, js-multihash and other NPM dependencies are under MIT license.

The add-on itself is released under CC0: to the extent possible under law, the author has waived all copyright and related or neighboring rights to this work, effectively placing it in the public domain.

About

Firefox addon that provides transparent access to IPFS resources via local HTTP2IPFS gateway

Resources

License

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 96.7%
  • Shell 3.3%