Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Cyberes committed Apr 17, 2024
1 parent 3b66b63 commit 68a444c
Showing 1 changed file with 4 additions and 7 deletions.
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,9 @@

_A round-robin load balancer for HTTP proxies._

This is a simple proxy load balancer that will route requests to a cluster of proxy backends in a round-robin fashion.
This makes it easy to connect your clients to a large number of proxy servers without worrying about implementing
anything special clientside.
This is a simple proxy load balancer that will route requests to a cluster of proxy backends in a round-robin fashion. This makes it easy to connect your clients to a large number of proxy servers without worrying about implementing anything special clientside.

- Downstream HTTPS proxy servers are not supported.
- This proxy server will transparently forward HTTPS requests without terminating them, meaning a self-signed certificate is not required.
This proxy server will transparently forward HTTPS requests without terminating them, meaning a self-signed certificate is not required. Downstream HTTPS proxy servers are not supported.

## Install

Expand All @@ -22,7 +19,7 @@ You can run your own "public IP delivery server" `canihazip` <https://git.evulid

An example systemd service `loadbalancer.service` is provided.

The server displays stats and info at `/json`
The server displays health, stats, info at `/json`.

```
=== Proxy Load Balancer ===
Expand All @@ -37,7 +34,7 @@ Usage of ./proxy-loadbalancer:

## Special Headers

The load balancer accepts special headers to control its behavior.
The load balancer accepts special headers to control its behavior:

- `Thirdparty-Bypass`: don't use any third-party endpoints for this request.
- `Thirdparty-Include-Broken`: use all online endpoints for this request, including third-party ones that failed the special test.

0 comments on commit 68a444c

Please sign in to comment.