Skip to content

ipfs/ipfs-webui

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

Screenshot of the status page

Files Explore Peers Settings
Screenshot of the file browser page Screenshot of the IPLD explorer page Screenshot of the swarm peers map Screenshot of the settings page

GitHub release CI status i18n status Discourse Forum


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:

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.

Getting Help

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

License

MIT