docs: add README for Holesail reverse proxy installation and usage

This commit is contained in:
CyberL1 2025-02-16 12:58:33 +01:00
parent d2a8181804
commit 2cf1234534

22
README.md Normal file
View File

@ -0,0 +1,22 @@
# Holesail reverse proxy
A CLI for running holesail as a reverse proxy
# Instalation
> [!IMPORTANT]
> Make sure you have holesail installed on your system
Windows:
```
irm https://raw.githubusercontent.com/CyberL1/holesail-proxy/main/scripts/get.ps1 | iex
```
Linux:
```
curl -fsSL https://raw.githubusercontent.com/CyberL1/holesail-proxy/main/scripts/get.sh | sh
```
# Usage
1. Do `holesail-proxy up`
2. Go to `<hash>.localhost` and you'll be connected to the holesail connector after a moment