Overview

Holesail can be segregated into mainly two parts, one is the server and other the client. When you set a port live (expose a port), you use the Holesail server, and when you connect to a Holesail server, you use a Holesail client.

Step 1 : Share a port

Let's assume we have a react website running on localhost:8080, to share this service we need to run the following in terminal:

holesail --live 8080 --host localhost

Step 2: Connect to the server

Now, on a different computer (or even same) copy the connection key you got from the previous step and run:

holesail <key>

Replacing <key> with the key your received from Step 1.

You can also scan the QR code using Holesail Go app on your phone to connect.

Step 3: Access the application

You are now connected, and the port from device 1 is available on device 2. You can now access the running application on the provided URL after "Access application on". Which is localhost:8080 in this case.

The port details used when the host started the connection will automatically transfer along with the connection, however, if the user on device 2 wants to utilize a different port and host, they may specify a custom port using the --port and --host flag.