ipfs/ipfs-webui

IPFS Web UI

A web interface to IPFS, shipped with Kubo, and ipfs-desktop.

Check on your node stats, explore the IPLD powered merkle forest, see peers around the world and manage your files, without needing to touch the CLI.

---

What is IPFS Web UI? | Usage | Development | Translations | Getting Help

What is IPFS Web UI?

IPFS Web UI is a browser-based interface for interacting with your Kubo node. It uses kubo-rpc-client to communicate with your local Kubo RPC API.

Features:

• Status - View your Kubo node's connection status, peer count, bandwidth, and repo stats
• Files - Browse, upload, download, and manage files in your Kubo node
• Explore - Navigate the IPLD DAG and inspect CIDs
• Peers - See connected peers on a world map and manage connections
• Settings - Configure your Kubo node, manage pinning services, and customize the UI

Where to access it:

• Bundled with Kubo at http://127.0.0.1:5001/webui
• Bundled with IPFS Desktop
• Latest release: https://webui.ipfs.io
• Preview of main branch: https://dev.webui.ipfs.io

Usage

Running with Kubo

If you have Kubo installed, Web UI is available at http://127.0.0.1:5001/webui when your daemon is running.

Running with Docker

$ docker pull ipfs/kubo
$ docker run -p 8080:8080 -p 5001:5001 -it ipfs/kubo

See the Kubo Docker Hub page for more options.

Development

See docs/developer-notes.md for detailed development instructions.

Quick start:

$ npm install                  # Install dependencies
$ ./cors-config.sh             # Configure CORS for local development
$ ipfs daemon                  # Start Kubo daemon (in separate terminal)
$ npm start                    # Start dev server at http://localhost:3000

Other commands:

$ npm test                     # Run all tests
$ npm run build                # Build for production
$ npm run storybook            # Component viewer at http://localhost:9009
$ npm run lint                 # Run linter

[!NOTE] The Node.js version is pinned in .tool-versions. If you use asdf, run asdf install to set up the correct version.

Translations

The UI is available in multiple languages. Translations are managed on Transifex.

• Switch languages via Settings or the ?lng=<lang-code> URL parameter
• Translation files are in ./public/locales
• See docs/LOCALIZATION.md for details on contributing translations

Getting Help

• IPFS Forum - community support and discussion
• Matrix chat - real-time chat with the community
• GitHub Issues - bug reports and feature requests

Security Issues

To report a security issue, please follow the IPFS Security Policy.

Contributing

We welcome contributions! See docs/developer-notes.md for development setup and guidelines.

This repository follows the IPFS Code of Conduct.

Maintainer Info

[!NOTE] This project is maintained by the Shipyard team.

Releasing a new version: every merge to main is deployed to https://dev.webui.ipfs.io, and every tagged release to https://webui.ipfs.io.

License

MIT