https://github.com/master-hax/compose-wireguard-ipfs

a multi-container application to run an IPFS node behind a Wireguard client
https://github.com/master-hax/compose-wireguard-ipfs

compose docker docker-compose ipfs ipfs-api ipfs-gateway ipfs-node port-forwarding vpn wireguard wireguard-client

Last synced: 2 days ago
JSON representation

a multi-container application to run an IPFS node behind a Wireguard client

• Host: GitHub
• URL: https://github.com/master-hax/compose-wireguard-ipfs
• Owner: master-hax
• Created: 2022-01-20T07:37:51.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2022-03-02T02:26:02.000Z (almost 3 years ago)
• Last Synced: 2024-12-17T11:44:11.449Z (7 days ago)
• Topics: compose, docker, docker-compose, ipfs, ipfs-api, ipfs-gateway, ipfs-node, port-forwarding, vpn, wireguard, wireguard-client
• Homepage:
• Size: 18.6 KB
• Stars: 6
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# compose-wireguard-ipfs

a multi-container Docker application to run an [IPFS node](https://hub.docker.com/r/linuxserver/ipfs) behind a [Wireguard](https://hub.docker.com/r/linuxserver/wireguard) client

## how to set it up

1. download [docker-compose.yml](/docker-compose.yml)

1. put your `wg0.conf` file into `./wireguard`

1. run `docker-compose up`

if everything works correctly, go-ipfs should be running behind your VPN!

## how to use it

the IPFS web UI should be accessible at http://localhost:5001/webui

the IPFS gateway should be accessible at http://localhost:8080 e.g. http://localhost:8080/ipfs/QmVmtux8UCk8553R2qVa7CBYJbQ11hfyswqEJmTLYCugPx?.png

if you want to use this persistently, you should probably

1. change the locations of the `ipfs-node-data-volume` & `downloads-volume`

1. forward port 4001 with your VPN provider (or pick a different port), then add port forwarding to your `wg0.conf` using the rules proposed [here](https://github.com/linuxserver/docker-wireguard/issues/58#issuecomment-723702782)

## how it works

the `ipfs-node` service shares the network stack of the `vpn-sidecar` service (Wireguard), which is tunneled through your VPN provider. to maintain local connectivity to the `ipfs-node` container's web UI & IPFS gateway, we proxy to it to through the `web-proxy` service (Nginx) using [Docker container links](https://docs.docker.com/network/links/).

## note: an [OpenVPN](https://github.com/master-hax/compose-openvpn-ipfs) version is also available