mirror of
https://github.com/boringproxy/boringproxy.git
synced 2024-07-07 04:42:58 -05:00
Simple tunneling reverse proxy with a fast web UI and auto HTTPS. Designed for self-hosters.
This also adds a docker-compose.yml for easy running and rebuilding Signed-off-by: Felix Bartels <felix@host-consultants.de> |
||
---|---|---|
webui | ||
.dockerignore | ||
api.go | ||
auth.go | ||
boringproxy.go | ||
build.sh | ||
client.go | ||
database.go | ||
docker-compose.yml | ||
Dockerfile | ||
generate_logo.sh | ||
go.mod | ||
go.sum | ||
install_go.sh | ||
logo_concept.svg | ||
logo.svg | ||
main.go | ||
notes.md | ||
README.md | ||
todo.md | ||
tunnel_manager.go | ||
tunnel.sh | ||
ui_handler.go | ||
utils.go |
What is it?
If you have a webserver running on one computer (say your development laptop), and you want to expose it securely (ie HTTPS) via a public URL, boringproxy allows you to easily do that.
You can learn more at boringproxy.io.
Building
git clone https://github.com/boringproxy/boringproxy
cd boringproxy
If you don't already have golang installed:
./install_go.sh
source $HOME/.bashrc
go build
To embed the web UI into the executable:
go get github.com/GeertJohan/go.rice/rice
rice embed-go
go build
Running
Server
boringproxy server -admin-domain bpdemo.brng.pro
Client
boringproxy client -server bpdemo.brng.pro -token fKFIjefKDFLEFijKDFJKELJF -client-name demo-client -user demo-user