https://github.com/richardschneider/net-ipfs-mount

Mount the InterPlanetary File System as a mapped drive on Windows
https://github.com/richardschneider/net-ipfs-mount

Last synced: 4 months ago
JSON representation

Mount the InterPlanetary File System as a mapped drive on Windows

• Host: GitHub
• URL: https://github.com/richardschneider/net-ipfs-mount
• Owner: richardschneider
• License: mit
• Created: 2016-12-05T00:40:56.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2019-01-19T00:51:17.000Z (almost 7 years ago)
• Last Synced: 2025-07-11T21:27:32.211Z (4 months ago)
• Language: C#
• Homepage:
• Size: 112 KB
• Stars: 149
• Watchers: 13
• Forks: 22
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-ipfs - ipfs-mount - Mount IPFS as a mapped drive on Windows. (Tools)
• awesome-ipfs-cn - ipfs-mount - 在 Windows 上以映射驱动器的形式安装 IPFS (工具)

README

          
# net-ipfs-mount

[![Build status](https://ci.appveyor.com/api/projects/status/7jdxs33887unrhp0?svg=true)](https://ci.appveyor.com/project/richardschneider/net-ipfs-mount)

[![Coverage Status](https://coveralls.io/repos/richardschneider/net-ipfs-mount/badge.svg?branch=master&service=github)](https://coveralls.io/github/richardschneider/net-ipfs-mount?branch=master)

[![Chocolatey](https://img.shields.io/chocolatey/v/ipfs-mount.svg)](https://chocolatey.org/packages/ipfs-mount)

Mount the [InterPlanetary File System](https://ipfs.io/) as a mapped drive on Windows.

## Features

- Mounts IPFS and IPNS on a drive letter, `ipfs-mount z:`

- Unmounts the drive, `ipfs-mount z: /u`

- [Pinned files](https://github.com/ipfs/examples/blob/master/examples/pinning/readme.md) are available in `z:\ipfs`

- Root contains shortcut to the IPFS WebUI

## Installation

[IPFS](https://ipfs.io/) and [Dokany](https://dokan-dev.github.io/) are required.  If not already installed, they can be installed with [choco](https://chocolatey.org/). 

Installation of Dokany requires [administrator rights](http://www.howtogeek.com/194041/how-to-open-the-command-prompt-as-administrator-in-windows-8.1/).

    > choco install ipfs

    > ipfs init

    > choco install dokany

Then install `ipfs-mount`

    > choco install ipfs-mount

## Quick start

    > ipfs-mount z 

    > dir z:\ipfs\QmRCJXG7HSmprrYwDrK1GctXHgbV7EYpVcJPQPwevoQuqF /B/S

````

z:\ipfs\QmRCJXG7HSmprrYwDrK1GctXHgbV7EYpVcJPQPwevoQuqF\cat.jpg

z:\ipfs\QmRCJXG7HSmprrYwDrK1GctXHgbV7EYpVcJPQPwevoQuqF\test

z:\ipfs\QmRCJXG7HSmprrYwDrK1GctXHgbV7EYpVcJPQPwevoQuqF\test\bar

z:\ipfs\QmRCJXG7HSmprrYwDrK1GctXHgbV7EYpVcJPQPwevoQuqF\test\baz

z:\ipfs\QmRCJXG7HSmprrYwDrK1GctXHgbV7EYpVcJPQPwevoQuqF\test\foo

z:\ipfs\QmRCJXG7HSmprrYwDrK1GctXHgbV7EYpVcJPQPwevoQuqF\test\baz\b

z:\ipfs\QmRCJXG7HSmprrYwDrK1GctXHgbV7EYpVcJPQPwevoQuqF\test\baz\f

````

## Options

````

Usage: ipfs-mount drive [OPTIONS]

Options:

  -s, --server=VALUE         IPFS API server address

  -u, --unmount              Unmount the drive

  -d, --debug                Display debugging information

  -h, -?, --help             Show this help

````

    

## Example

A screen shot of Windows explorer displaying the contents of `z:\ipfs\QmRCJXG7HSmprrYwDrK1GctXHgbV7EYpVcJPQPwevoQuqF`

![Explorer](explorer.jpeg)

# License

Copyright © Richard Schneider (makaretu@gmail.com)

The library is licensed under the [MIT](http://www.opensource.org/licenses/mit-license.php "Read more about the MIT license form") license. Refere to the [LICENSE](https://github.com/richardschneider/net-ipfs-mount/blob/master/LICENSE.txt) file for more information.