Code Monkey home page Code Monkey logo

ipfs-webui's Introduction

IPFS webui

IPFS Webui is a web interface for IPFS, the Interplanetary File System. With the interface, you can check on your node info, network addresses, see connections on a globe visually, see your files, look at your config and logs without needing to touch the CLI, and more. This interface uses the js-ipfs-api for all of its heavy lifting.

The webui is a work-in-progress. Follow the development processes below to check it out.

Usage

Config your IPFS Daemon

When developing the WebUI you will need an ipfs daemon running with API access on port 5001, as well as the following configuration set, otherwise you will not be able to communicate with the ipfs node.

> ipfs config --json API.HTTPHeaders.Access-Control-Allow-Origin '["http://localhost:3000"]'
> ipfs config --json API.HTTPHeaders.Access-Control-Allow-Methods '["PUT", "GET", "POST"]'
> ipfs config --json API.HTTPHeaders.Access-Control-Allow-Credentials '["true"]'

Alternatively, just run the quick config script with:

> ./quick-config.sh

Reset your IPFS Daemon config

To reset your config back to the default configuration, run the following command.

> ipfs config --json API.HTTPHeaders {}

It might be a good idea to copy the .ipfs/config file somewhere with a useful name so you can use ipfs config replace <file> to switch between dev mode easily.

Installation and running

> git clone https://github.com/ipfs/webui
> cd webui
> npm install
# Runs server on port 3000.
> npm start

Building

> npm run build
# The result will be in /dist

Development

Make sure node.js version 6 and npm version 3+ are installed and in your path.

Contribute

Please contribute! The more people who work on this, the faster we'll be able to ship it. Dive in by testing it and looking at the issues.

The CONTRIBUTING file has more information relevant to this repo. To contribute to IPFS in general, just click on the image above to go to our global contributing guide.

License

MIT License

FOSSA Status

ipfs-webui's People

Contributors

59023g avatar alanshaw avatar atinux avatar caioalonso avatar chevdor avatar daviddias avatar digital-dreamer avatar dignifiedquire avatar drathir avatar grassias avatar greenkeeperio-bot avatar hacdias avatar harlantwood avatar harveyqiu avatar infinisil avatar jbenet avatar jestersimpps avatar jirayudech avatar krl avatar luigiplr avatar mappum avatar notslang avatar richardlitt avatar sh4d1 avatar stebalien avatar strml avatar timmak avatar travisperson avatar tsudoko avatar victorb avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.