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

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

compose docker docker-compose download ipfs ipfs-api ipfs-gateway ipfs-node openvpn openvpn-client port-forwarding vpn

Last synced: 6 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/master-hax/compose-openvpn-ipfs
• Owner: master-hax
• Created: 2022-01-20T07:37:12.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2022-03-02T02:27:24.000Z (almost 3 years ago)
• Last Synced: 2024-12-03T15:10:03.068Z (23 days ago)
• Topics: compose, docker, docker-compose, download, ipfs, ipfs-api, ipfs-gateway, ipfs-node, openvpn, openvpn-client, port-forwarding, vpn
• Homepage:
• Size: 16.6 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# compose-openvpn-ipfs

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

## how to set it up

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

1. put your `*.ovpn` file into `./openvpn`

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)

## how it works

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

## note: a [Wireguard](https://github.com/master-hax/compose-wireguard-ipfs) version is also available