Skip to main content

introduction

Introduction​

Holesail is a peer-to-peer reverse proxy / tunnelling software based on the Kademliya algorithm and powered by the Holepunch tech stack.

Setting up a custom reverse proxy is time-consuming and requires advanced knowledge of nginx/apache2.

🚤 holesail will help you set up a reverse proxy with a maximum of two commands.

💥 Share websites, create VNC connections, play Minecraft with friends with a single command and much more.

👨‍💻 No servers needed, no premium plan either; it's all open source.

💅 Check out the holesail blog for inspiration and tutorials on combining holesail with other apps.

🕸️ Holesail lets you create peer-to-peer connections with a few commands. It can bypass almost all firewall and NAT restrictions and establish a connection with peers, enabling you to securely close the front gates of your applications (a.k.a. firewall) and allow access to anyone with the discovery key only.

Fast Track ⏱️

Understand holesail in two commands by playing with it!

Start an application which you need to share with the rest of the world. For example, a local Minecraft server is running on port 25565.

Install Node.js and install holesail using NPM.

$ npm i holesail -g

Share the local Minecraft server:

$ holesail --live 25565 --connector "holesailMCServer420"

On other computer(s):

$ holesail "holesailMCServer420"

Now open Minecraft and "Add Server" with IP address 127.0.0.1 and port 8989.

Note: The example above is for Minecraft but works similarly for anything else out there as well.==

tip

You can join the holesail discord community for help and support and to discuss random cool stuff!

Features​

  • Built with Open Source love ❤️:
    • Extend and customise holesail by forking it and submitting a pull request.
    • We value every single feedback and use it to improve holesail
  • Module Ecosystem:
    • Holesail has an ecosystem of modules such as holesail-server and holesail-client that makes it very easy for you to build your own P2P node apps running on holesail.
    • Holesail in itself is an implementation of the two modules mentioned above.

Finished reading? Follow our Getting started guide.