update documentation
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
This commit is contained in:
parent
667643445b
commit
6d1722b302
28
README.md
28
README.md
|
@ -2,14 +2,13 @@
|
|||
**Capture** is a reverse proxy that takes an incoming HTTP request and sends it to another server,
|
||||
proxying the response back to the client, while showing them in a dashboard.
|
||||
|
||||
[![Build Status](https://github.com/ofabricio/capture/workflows/build/badge.svg)](https://github.com/ofabricio/capture/actions?query=workflow%3Abuild)
|
||||
[![Github Release](https://img.shields.io/github/release/ofabricio/capture.svg)](https://github.com/ofabricio/capture/releases)
|
||||
|
||||
[![status-badge](https://ci.gitnet.fr/api/badges/deblan/capture/status.svg)](https://ci.gitnet.fr/deblan/capture)
|
||||
|
||||
## Running
|
||||
|
||||
./capture -url=https://example.com/
|
||||
|
||||
```
|
||||
./capture -url=https://example.com/
|
||||
```
|
||||
|
||||
#### Settings
|
||||
|
||||
|
@ -35,22 +34,25 @@ To access the dashboard go to `http://localhost:9001/`
|
|||
|
||||
##### Preview
|
||||
|
||||
![dashboard](https://i.imgur.com/4yOSWFn.png)
|
||||
|
||||
![dashboard](https://upload.deblan.org/u/2023-05/6470ba9d.png)
|
||||
|
||||
## Building
|
||||
|
||||
Manually:
|
||||
|
||||
git clone --depth 1 https://github.com/ofabricio/capture.git
|
||||
cd capture
|
||||
go build
|
||||
```
|
||||
git clone --depth 1 https://gitnet.fr/deblan/capture.git
|
||||
cd capture
|
||||
go build
|
||||
```
|
||||
|
||||
Via docker:
|
||||
|
||||
git clone --depth 1 https://github.com/ofabricio/capture.git
|
||||
cd capture
|
||||
docker run --rm -v $PWD:/src -w /src -e GOOS=darwin -e GOARCH=amd64 golang:alpine go build
|
||||
```
|
||||
git clone --depth 1 https://gitnet.fr/deblan/capture.git
|
||||
cd capture
|
||||
docker run --rm -v $PWD:/src -w /src -e GOOS=darwin -e GOARCH=amd64 golang:alpine go build
|
||||
```
|
||||
|
||||
Now you have an executable binary in your directory.
|
||||
|
||||
|
|
Loading…
Reference in a new issue