mirror of
https://github.com/boringproxy/boringproxy.git
synced 2026-11-04 05:06:48 -06:00
54 lines
978 B
Markdown
54 lines
978 B
Markdown
# 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.
|
|
|
|
**NOTE:** For information on downloading and running boringproxy, it's best to
|
|
start on the website, [boringproxy.io](https://boringproxy.io/). The information
|
|
in this README is just for building from source.
|
|
|
|
|
|
# Building
|
|
|
|
```bash
|
|
git clone https://github.com/boringproxy/boringproxy
|
|
```
|
|
|
|
```bash
|
|
cd boringproxy
|
|
```
|
|
|
|
If you don't already have golang installed:
|
|
|
|
```bash
|
|
./install_go.sh
|
|
source $HOME/.bashrc
|
|
```
|
|
|
|
```bash
|
|
go build
|
|
```
|
|
|
|
To embed the web UI into the executable:
|
|
|
|
```bash
|
|
go get github.com/GeertJohan/go.rice/rice
|
|
rice embed-go
|
|
go build
|
|
```
|
|
|
|
# Running
|
|
|
|
## Server
|
|
|
|
```bash
|
|
boringproxy server -admin-domain bpdemo.brng.pro
|
|
```
|
|
|
|
## Client
|
|
|
|
```bash
|
|
boringproxy client -server bpdemo.brng.pro -token fKFIjefKDFLEFijKDFJKELJF -client-name demo-client -user demo-user
|
|
```
|