A beautiful, fully open-source tunneling service written in pure PHP.
- Docker & Docker Compose (recommended)
- PHP 8.2+ and Composer (for running locally)
-
Copy or create an
.env
file at the project root. The repository uses the following environment variables.PORT
— port to expose on the host (default: 8080)DOMAIN
— domain used by the server (e.g.localhost
)ADMIN_USERNAME
/ADMIN_PASSWORD
— credentials for admin dashboardADMIN_SUBDOMAIN
— subdomain to access the admin dashboardRESERVED_SUBDOMAINS
— comma-separated list of reserved subdomains (e.g.www,admin,api
)
-
Install the dependencies.
composer install
-
Start the server.
./expose-server serve <domain> --port <port> --validateAuthTokens
-
Build the image.
docker build -t expose-server:latest .
-
Run the image.
docker run --rm -p 8080:8080 \ -e DOMAIN=example.com -e PORT=8080 \ -e ADMIN_USERNAME=admin -e ADMIN_PASSWORD=secret \ expose-server:latest