@@ -67,6 +67,7 @@ You can check the development status at the [Waffle Board](https://waffle.io/ipf
6767 - [ Node Management] ( #node-management )
6868 - [ Domain data types] ( #domain-data-types )
6969- [ FAQ] ( #faq )
70+ - [ Running js-ipfs with Docker] ( #running-js-ipfs-with-docker )
7071- [ Packages] ( #packages )
7172- [ Development] ( #development )
7273 - [ Clone and install dependencies] ( #clone-and-install-dependencies )
@@ -501,6 +502,38 @@ HOME=~/.electron-gyp npm install
501502
502503If you find any other issue, please check the [ ` Electron Support ` issue] ( https://github.com/ipfs/js-ipfs/issues/843 ) .
503504
505+ ## Running js-ipfs with Docker
506+
507+ We have automatic Docker builds setup with Docker Hub: https://hub.docker.com/r/ipfs/js-ipfs/
508+
509+ All branches in the Github repository maps to a tag in Docker Hub, except ` master ` Git branch which is mapped to ` latest ` Docker tag.
510+
511+ You can run js-ipfs like this:
512+
513+ ```
514+ $ docker run -it -p 4002:4002 -p 4003:4003 -p 5002:5002 -p 9090:9090 ipfs/js-ipfs:latest
515+
516+ initializing ipfs node at /root/.jsipfs
517+ generating 2048-bit RSA keypair...done
518+ peer identity: Qmbd5jx8YF1QLhvwfLbCTWXGyZLyEJHrPbtbpRESvYs4FS
519+ to get started, enter:
520+
521+ jsipfs files cat /ipfs/QmfGBRT6BbWJd7yUc2uYdaUZJBbnEFvTqehPFoSMQ6wgdr/readme
522+
523+ Initializing daemon...
524+ Using wrtc for webrtc support
525+ Swarm listening on /ip4/127.0.0.1/tcp/4003/ws/ipfs/Qmbd5jx8YF1QLhvwfLbCTWXGyZLyEJHrPbtbpRESvYs4FS
526+ Swarm listening on /ip4/172.17.0.2/tcp/4003/ws/ipfs/Qmbd5jx8YF1QLhvwfLbCTWXGyZLyEJHrPbtbpRESvYs4FS
527+ Swarm listening on /ip4/127.0.0.1/tcp/4002/ipfs/Qmbd5jx8YF1QLhvwfLbCTWXGyZLyEJHrPbtbpRESvYs4FS
528+ Swarm listening on /ip4/172.17.0.2/tcp/4002/ipfs/Qmbd5jx8YF1QLhvwfLbCTWXGyZLyEJHrPbtbpRESvYs4FS
529+ API is listening on: /ip4/0.0.0.0/tcp/5002
530+ Gateway (readonly) is listening on: /ip4/0.0.0.0/tcp/9090
531+ Daemon is ready
532+
533+ $ curl --silent localhost:5002/api/v0/id | jq .ID
534+ "Qmbd5jx8YF1QLhvwfLbCTWXGyZLyEJHrPbtbpRESvYs4FS"
535+ ```
536+
504537## Packages
505538
506539| Package | Version | Deps | DevDeps | Travis | Circle | AppVeyor | Coverage |
0 commit comments