GitHub - ipfs-shipyard/ipfs-desktop: Menubar IPFS Application

 3 years ago
source link: https://github.com/ipfs-shipyard/ipfs-desktop
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.


IPFS Desktop

A desktop client for IPFS.

You don't need the command line to run an IPFS node. Just install IPFS Desktop and have all the power of IPFS in your hands. Powered by Web UI.

Download the latest release

or see the install section for more options.

IPFS Desktop

total download count latest release download count

IPFS Desktop allows you to run your IPFS Node on your machine without having to bother with command line tools. With it, you the power of Web UI on tip of your hands plus a handful of shortcuts you can find on settings.

⚠ Please note that this version is not stable yet and might change. Also, Linux support is still experimental and it might not work on every desktop environment. Please file an issue if you find a bug.

Table of Contents


IPFS daemon always running

IPFS Desktop's main feature is to allow you to have the IPFS daemon always running in the background. But fear not! If you need to stop it, you can do it just by clicking on 'Stop'.

Handle ipfs://, ipns:// and dweb: links

If you come across a link to any of the protocols above, IPFS Desktop will be able to open them and redirect them to your default browser.

Adds ipfs to your system

If you're using macOS or Windows and don't have ipfs installed on your system, IPFS Desktop will automatically install it so it is available through the command line. If you're using Linux, or already have ipfs installed, you can tell IPFS Desktop to take care of it (and keep it up to date!) by toggling the option on Settings.

Easy add to IPFS

You can easily add files and folders to IPFS:

  • On Windows, you can right click on files to add them to IPFS through IPFS Desktop.
  • On macOS, you can drag and drop them to the tray icon.

Download copied hashes

You can enable, on Settings, a shortcut to download an hash on the keyboard.

Auto-add screenshots

You can enable, on Settings, a shortcut to take screenshots and add them automatically to IPFS.


Download the latest release of IPFS Desktop for your OS, below.

Platform Download link Download count Windows ipfs-desktop-setup-0.8.0.exe Mac ipfs-desktop-0.8.0.dmg

We build out multiple installers for Linux

Package Download link Download count AppImage ipfs-desktop-0.8.0-linux-x86_64.AppImage tar ipfs-desktop-0.8.0-linux-x64.tar.xz deb ipfs-desktop-0.8.0-linux-amd64.deb rpm ipfs-desktop-0.8.0-linux-x86_64.rpm snap ipfs-desktop-0.8.0-linux-amd64.snap

Or you can use your favorite package manager:

  • Homebrew - brew cask install ipfs
  • Chocolatey - choco install ipfs-desktop

Using package managers? Please head to our package managers page and help us add support for yours!

You can find releases notes and older versions on the releases page.

Install from Source

To install it from source you need Node.js >=10.4.0 and need npm >=6.1.0 installed. This uses node-gyp so you must take a look at their platform specific dependencies.

Then the follow the steps below to clone the source code, install the dependencies and run it the app:

git clone https://github.com/ipfs-shipyard/ipfs-desktop.git
cd ipfs-desktop
npm install
npm start

The IPFS Desktop app will launch and should appear in your OS menu bar.


The translations are stored on ./src/locales and the English version is the source of truth. Other languages are periodically pulled from Transifex, a web interface to help us translate IPFS Desktop and its components to another languages.


  • (Optional) Create a new Draft Release.
  • Bump the version in package.json.
  • Create a tag with the same version.
  • git push && git push --tags
  • Wait for the CI to upload the binaries to the draft release (a new one will be created if you haven't drafted one).
  • The latest.yml, latest-mac.yml, latest-linux.yml files on the release are used by the app to determin when an app update is available. Once a release is published, users should recieve the app update. See: https://www.electron.build/auto-update.
  • Update Homebrew Cask.
  • Update Chocolatey package.
  • To start work on the next version, bump the version in the package.json and repeat theses steps.


Feel free to join in. All welcome. Open an issue!

If you're interested in contributing translations, go to project page on Transifex, create an account, pick a language and start translating.

This repository falls under the IPFS Code of Conduct.


Where is the configuration and logs?

The configuration file and logs are located on ~/Library/Application Support/IPFS Desktop on macOS and %appdata%/IPFS Desktop on Windows. For quick access to this folders, just right-click on your tray icon and then 'Logs Directory' or 'Configuration File', depending on what you want.

How do we select the IPFS repo location?

We use ipfsd-ctl, which, in default conditions, will check IPFS_PATH environment variable. If not set, we fallback to $HOME/.ipfs. As soon as the first run has succeded, we save the information about the repository location in the configuration file, which becomes the source of truth.

Which version of IPFS are we running?

Since we're using ipfsd-ctl, we have our own embedded IPFS binary. We try to always have the latest version.

Which flags do we use to boot IPFS?

By default we use the flags --migrate=true --routing=dhtclient ----enable-gc=true when running the IPFS daemon. They can be changed via the configuration file, which can be easily accessed as mentioned above.


MIT Protocol Labs, Inc.

About Joyk

Aggregate valuable and interesting links.
Joyk means Joy of geeK