Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vdemeester/docker-volume-ipfs
🐳 This is an open source volume plugin that allows using an ipfs filesystem as a volume.
https://github.com/vdemeester/docker-volume-ipfs
docker docker-volumes filesystem fuse ipfs volume
Last synced: about 1 month ago
JSON representation
🐳 This is an open source volume plugin that allows using an ipfs filesystem as a volume.
- Host: GitHub
- URL: https://github.com/vdemeester/docker-volume-ipfs
- Owner: vdemeester
- License: mit
- Archived: true
- Created: 2016-01-30T14:57:55.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-05-13T15:09:11.000Z (over 7 years ago)
- Last Synced: 2024-08-02T02:15:08.361Z (4 months ago)
- Topics: docker, docker-volumes, filesystem, fuse, ipfs, volume
- Language: Go
- Homepage:
- Size: 1.12 MB
- Stars: 119
- Watchers: 10
- Forks: 23
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - vdemeester/docker-volume-ipfs - 🐳 This is an open source volume plugin that allows using an ipfs filesystem as a volume. (ipfs)
README
# 🐳 docker-volume-ipfs
[](https://godoc.org/github.com/vdemeester/docker-volume-ipfs)
[](https://travis-ci.org/vdemeester/docker-volume-ipfs)
[](https://goreportcard.com/report/github.com/vdemeester/docker-volume-ipfs)
[]()
[](https://codecov.io/gh/vdemeester/docker-volume-ipfs)
This is an open source volume plugin that allows using an
[ipfs](https://ipfs.io/) filesystem as a volume.
```bash
$ docker-volume-ipfs &
$ docker run -it --rm -v QmPXME1oRtoT627YKaDPDQ3PwA8tdP9rWuAAweLzqSwAWT/readme:/data --volume-driver=ipfs busybox cat data
Hello and Welcome to IPFS!
██╗██████╗ ███████╗███████╗
██║██╔══██╗██╔════╝██╔════╝
██║██████╔╝█████╗ ███████╗
██║██╔═══╝ ██╔══╝ ╚════██║
██║██║ ██║ ███████║
╚═╝╚═╝ ╚═╝ ╚══════╝
If you're seeing this, you have successfully installed
IPFS and are now interfacing with the ipfs merkledag!
-------------------------------------------------------
| Warning: |
| This is alpha software. use at your own discretion! |
| Much is missing or lacking polish. There are bugs. |
| Not yet secure. Read the security notes for more. |
-------------------------------------------------------
Check out some of the other files in this directory:
./about
./help
./quick-start <-- usage examples
./readme <-- this file
./security-notes
```
## Goals
The main goal is to be able to create docker volumes that are backed by the IPFS filesystem. They could be named volumes,
anonymous volumes. The plugin should also work in a cluster / swarm environment (but by its nature it should be built-in).
First, let's define a "format" for creating volumes. There is two cases: `docker volume create` and `docker run -v`.
For `docker volume create`, it could be an option `ipfs=`, `ipns=`...
```bash
$ docker volume create --driver=ipfs --opt ipfs=QmPXME1oRtoT627YKaDPDQ3PwA8tdP9rWuAAweLzqSwAWT --name ipfs-welcome
$ docker run -v ipfs-welcome:/ipfs/welcome busybox cat /ipfs/welcome/readme
Hello and Welcome to IPFS!
██╗██████╗ ███████╗███████╗
██║██╔══██╗██╔════╝██╔════╝
██║██████╔╝█████╗ ███████╗
██║██╔═══╝ ██╔══╝ ╚════██║
██║██║ ██║ ███████║
╚═╝╚═╝ ╚═╝ ╚══════╝
If you're seeing this, you have successfully installed
# […]
# would also work with ipns
$ docker volume create --driver=ipfs --opt ipns=ipfs.io --name ipfs-io-website
$ docker run -v ipfs-io-website:/var/www/html nginx
```
For `-v` directly in `docker run` (a.k.a. anonymous volume), we could namespace it somehow.
```
# Default to ipfs
$ docker run -it --rm -v QmPXME1oRtoT627YKaDPDQ3PwA8tdP9rWuAAweLzqSwAWT/readme:/data --volume-driver=ipfs busybox cat data
Hello and Welcome to IPFS!
# […]
$ docker run -it --rm -v $(docker volume create --driver=ipfs --opt ipns=ipfs.io):/var/www/html --volume-driver=ipfs nginx
```
## TODO(s)
- [ ] Use `ipfs daemon` API instead of making the assumption that a daemon is running and mounting ipfs using fuse
- [ ] Support ipfs mounts (via fuse)
- [ ] Support ipns mounts
- [ ] Create a volume v2 plugin