ipfs-companion

(β˜… 2,157)

Browser extension that routes ipfs:// addresses and content-addressed websites through your own local IPFS node

File Explorer

Download Latest Version (.zip)
  • .dockerignore
  • .editorconfig
  • .gitattributes
  • .gitignore
  • .nvmrc
  • .release-please-manifest.json
  • AGENTS.md
  • CHANGELOG.md
  • docker-compose.e2e.yml
  • Dockerfile
  • eslint.config.js
  • LICENSE
  • Makefile
  • package-lock.json
  • package.json
  • playwright.config.js
  • PRIVACY-POLICY.md
  • README.md
  • release-please-config.json
  • rspack.config.js
  • SECURITY.md
  • tsconfig.json
  • tsconfig.typecheck.json
  • vitest.config.js

# Installation Guide

1. Get the code
git clone https://github.com/ipfs/ipfs-companion

Downloads the entire project code from GitHub to your computer.

cd ipfs-companion

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose -f docker-compose.e2e.yml up -d --build

Runs the command against the services defined in the compose file.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
$ npm run dev-build chromium

Starts the development/run server.

$ npm run dev-build firefox # firefox:nightly works too!

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

4. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.

Today's picks

gitignore β˜… 175,385

A collection of useful .gitignore templates
caveman β˜… 96,051

πŸͺ¨ why use many token when few token do trick β€” Claude Code skill that cuts 65% of tokens b

JavaScript
FreeDomain β˜… 194,714

Free domain registration and practical DNS learning resources for everyone.

Markdown
awesome-for-beginners β˜… 88,582

A list of awesome beginners-friendly projects.
llm-course β˜… 81,890

Course to get into Large Language Models (LLMs) with roadmaps and Colab notebooks.
act β˜… 71,587

Run your GitHub Actions locally πŸš€

Go
// repository documentation