diff --git a/README.md b/README.md index 971f961..3b6a359 100644 --- a/README.md +++ b/README.md @@ -2,16 +2,15 @@ **Capture** is a reverse proxy that captures the network traffic and shows it in a dashboard -## Building / Running +## Binaries / Executables - git clone https://github.com/ofabricio/capture.git - cd capture - go build - ./capture -url=https://example.com/api -port=9000 -dashboard=apple -max-captures=16 +For ready-to-use executables for *Windows*, *Linux* and *Mac*, see [Releases](https://github.com/ofabricio/capture/releases) page -### Binaries / Executables -For ready-to-use executables (no need to build it yourself) for *Windows* and *Linux*, see [Releases](https://github.com/ofabricio/capture/releases) page +## Running + + ./capture -url=https://example.com/ + ### Configurations @@ -24,6 +23,22 @@ For ready-to-use executables (no need to build it yourself) for *Windows* and *L | `-h` | Show help | +## Building + +Manually: + + git clone https://github.com/ofabricio/capture.git + cd capture + go get -d ./... + go build -o capture . + +Via docker: + + git clone https://github.com/ofabricio/capture.git + cd capture + docker build -t capture . + docker run --rm -v "${PWD}:/src" -e "OS=linux" capture + ## Using If you set your base url as `http://example.com/api`, now `http://localhost:9000` points to that @@ -39,6 +54,7 @@ To access the dashboard go to `http://localhost:9000/dashboard` The path `/dashboard/**` is reserved, that means if your api has a path like that it will be ignored in favor of the dashboard. However, you can change the dashboard's name with `-dashboard` + ##### Preview ![dashboard](https://i.imgur.com/13nzb48.png) \ No newline at end of file