X-Git-Url: https://git.josue.xyz/?a=blobdiff_plain;f=gprox%2FREADME.md;h=ae9e6cf48bd3408cc5cb106fe20772dd3508537f;hb=e7dad6227425d813b17dadd6138cdffbc3341d8b;hp=f8650bb15161f6c5d019b6cb9751281c4a156888;hpb=46445e9382905a52e770d44191235be179616049;p=webi-installers%2F.git diff --git a/gprox/README.md b/gprox/README.md index f8650bb..ae9e6cf 100644 --- a/gprox/README.md +++ b/gprox/README.md @@ -11,7 +11,13 @@ tagline: | ## Cheat Sheet -`gprox` was built to be a no-dependency development tool for simply proxying HTTPS traffic to a local HTTP endpoint. It was written as a port of [local-ssl-proxy](https://github.com/cameronhunter/local-ssl-proxy), a perfectly good NodeJS app for the same purpose. But the benefit is that you can install `gprox` very simply from `webi` or `go` (if you must), and you dont have to worry at all about NodeJS versions, etc! Plus there isn't any elevated access given to an interpreter you dont know much about if you're using `webi`. +`gprox` was built to be a no-dependency development tool for simply proxying +HTTPS traffic to a local HTTP endpoint. It was written as a port of +[local-ssl-proxy](https://github.com/cameronhunter/local-ssl-proxy), a perfectly +good NodeJS app for the same purpose. But the benefit is that you can install +`gprox` very simply from `webi` or `go` (if you must), and you dont have to +worry at all about NodeJS versions, etc! Plus there isn't any elevated access +given to an interpreter you dont know much about if you're using `webi`. The fastest way to get started is just by running: @@ -20,25 +26,33 @@ gprox # example output # 9:12PM INF Running proxy! from=https://localhost:9001 to=http://localhost:9000 ``` + And you're off to the races! -That is... if you're app happens to be running on port `9000`. If not, no worries! Simply pass the target port option `-t, --target` and specify the port your app _is_ running on. +That is... if you're app happens to be running on port `9000`. If not, no +worries! Simply pass the target port option `-t, --target` and specify the port +your app _is_ running on. ```bash gprox -t 8080 ``` -Feeling like you should save this magic built-in cert so you can inspect it for anything? +Feeling like you should save this magic built-in cert so you can inspect it for +anything? + ```bash gprox --dropcert ``` Want to use your own cert/key? + ```bash gprox -c testcert.crt -k testkey.key ``` -And for anything else, just use the `-h, --help` flag to get a little more information or refer to the [README](https://github.com/creedasaurus/gprox/blob/main/README.md): +And for anything else, just use the `-h, --help` flag to get a little more +information or refer to the +[README](https://github.com/creedasaurus/gprox/blob/main/README.md): ``` ❯ gprox --help