Skip to content

Commit

Permalink
docs: update index header
Browse files Browse the repository at this point in the history
  • Loading branch information
mmatczuk committed Nov 30, 2023
1 parent 00fe9a5 commit 9f29f09
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 18 deletions.
23 changes: 11 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Forwarder Proxy [![Build Status](https://github.com/saucelabs/forwarder/actions/workflows/go.yml/badge.svg)](https://github.com/saucelabs/forwarder/actions/workflows/go.yml) [![Go Report Card](https://goreportcard.com/badge/github.com/saucelabs/forwarder)](https://goreportcard.com/report/github.com/saucelabs/forwarder) [![GitHub release](https://img.shields.io/github/release/saucelabs/forwarder.svg)](https://github.com/saucelabs/forwarder/releases) ![GitHub all releases](https://img.shields.io/github/downloads/saucelabs/forwarder/total)

Forwarder is a forward HTTP proxy i.e. it supports `CONNECT` requests.

## It can proxy
Forwarder is a production-ready, MITM-capable HTTP proxy written in Go.
It's used as a core component of Sauce Labs' [Sauce Connect Proxy](https://docs.saucelabs.com/secure-connections/sauce-connect/).
It is a forward proxy, which means it proxies traffic from clients to servers (e.g. browsers to websites), and supports `CONNECT` requests.
It can proxy:

* HTTP/HTTPS/HTTP2 requests
* WebSockets (both HTTP and HTTPS)
Expand All @@ -18,13 +19,11 @@ Forwarder is a forward HTTP proxy i.e. it supports `CONNECT` requests.
* Supports augmenting requests and responses with headers
* Supports basic authentication, for websites and proxies

## Documentation

Full documentation is available at [forwarder-proxy.io](https://forwarder-proxy.io).

Quick links:
## Additional resources

- [forwarder run](https://forwarder-proxy.io/cli/forwarder_run) - Start HTTP (forward) proxy server
- [forwarder pac eval](https://forwarder-proxy.io/cli/forwarder_pac_eval) - Evaluate a PAC file for given URL (or URLs)
- [forwarder pac server](https://forwarder-proxy.io/cli/forwarder_pac_server) - Start HTTP server that serves a PAC file
- [forwarder ready](https://forwarder-proxy.io/cli/forwarder_ready) - Readiness probe for the Forwarder
* Forwarder Proxy documentation: https://forwarder-proxy.io
* Forwarder Proxy CLI reference:
- [forwarder run](https://forwarder-proxy.io/cli/forwarder_run) - Start HTTP (forward) proxy server
- [forwarder pac eval](https://forwarder-proxy.io/cli/forwarder_pac_eval) - Evaluate a PAC file for given URL (or URLs)
- [forwarder pac server](https://forwarder-proxy.io/cli/forwarder_pac_server) - Start HTTP server that serves a PAC file
- [forwarder ready](https://forwarder-proxy.io/cli/forwarder_ready) - Readiness probe for the Forwarder
12 changes: 6 additions & 6 deletions docs/content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@

[![Build Status](https://github.com/saucelabs/forwarder/actions/workflows/go.yml/badge.svg)](https://github.com/saucelabs/forwarder/actions/workflows/go.yml) [![Go Report Card](https://goreportcard.com/badge/github.com/saucelabs/forwarder)](https://goreportcard.com/report/github.com/saucelabs/forwarder) [![GitHub release](https://img.shields.io/github/release/saucelabs/forwarder.svg)](https://github.com/saucelabs/forwarder/releases) ![GitHub all releases](https://img.shields.io/github/downloads/saucelabs/forwarder/total)

Forwarder is a forward HTTP proxy i.e. it supports `CONNECT` requests.

## It can proxy
Forwarder is a production-ready, MITM-capable HTTP proxy written in Go.
It's used as a core component of Sauce Labs' [Sauce Connect Proxy](https://docs.saucelabs.com/secure-connections/sauce-connect/).
It is a forward proxy, which means it proxies traffic from clients to servers (e.g. browsers to websites), and supports `CONNECT` requests.
It can proxy:

* HTTP/HTTPS/HTTP2 requests
* WebSockets (both HTTP and HTTPS)
Expand All @@ -22,9 +23,8 @@ Forwarder is a forward HTTP proxy i.e. it supports `CONNECT` requests.

## Running

You can get Forwarder build from GitHub releases page or a container from Docker Hub.

Forwarder provides the following commands:
See the Install instructions for your platform or use the Docker image.
When you have Forwarder installed, you can run it with the following command:

- [forwarder run](cli/forwarder_run.md) - Start HTTP (forward) proxy server
- [forwarder pac eval](cli/forwarder_pac_eval.md) - Evaluate a PAC file for given URL (or URLs)
Expand Down

0 comments on commit 9f29f09

Please sign in to comment.