Skip to content

Commit 3cca540

Browse files
authored
Update README.md
1 parent 0321ec7 commit 3cca540

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@
1414

1515
## Features
1616

17-
* [L4 TCP Load Balancing](https://github.com/yyyar/gobetween/wiki)
17+
* [Fast L4 TCP Load Balancing](https://github.com/yyyar/gobetween/wiki)
1818

19-
* [Clear Configuration](https://github.com/yyyar/gobetween/wiki/Configuration) with [TOML](config/gobetween.toml) or [JSON](config/gobetween.json)
19+
* [Clear & Flexible Configuration](https://github.com/yyyar/gobetween/wiki/Configuration) with [TOML](config/gobetween.toml) or [JSON](config/gobetween.json)
2020
* **File** - read configuration from the file
21-
* **URL** - querying URL by HTTP and get configuration from response
22-
* **Consul** - get configuration from Consul key-value storage value
21+
* **URL** - query URL by HTTP and get configuration from the response body
22+
* **Consul** - query Consul key-value storage API for configuration
2323

2424
* [Management REST API] (https://github.com/yyyar/gobetween/wiki/REST-API)
2525
* **System Information** - general server info
@@ -34,16 +34,18 @@
3434
* **JSON** - query arbitrary http url and pick backends from response json (of any structure)
3535
* **Plaintext** - query arbitrary http and parse backends from response text with customized regexp
3636
* **SRV** - query DNS server and get backends from SRV records
37+
* **Consul** - query Consul Services API for backends
3738

3839
* [Healthchecks](https://github.com/yyyar/gobetween/wiki/Healthchecks)
3940
* **Ping** - simple TCP ping healtcheck
4041
* **Exec** - execute arbitrary program passing host & port as options, and read healtcheck status from the stdout
4142

4243
* [Balancing Strategies](https://github.com/yyyar/gobetween/wiki/Balancing)
43-
* **Iphash**
44-
* **Leastconn**
45-
* **Roundrobin**
46-
* **Weight**
44+
* **Weight** - select backend from pool based relative weights of backends
45+
* **Roundrobin** - simple elect backend from pool in circular order
46+
* **Iphash** - route client to the same backend based on client ip hash
47+
* **Leastconn** - select backend with least active connections
48+
* **Leastbandwidth** - select backends with least bandwidth
4749

4850
* Integrates seamlessly with Docker and with any custom system (thanks to Exec discovery and healtchecks)
4951

@@ -56,7 +58,8 @@
5658
## Usage
5759

5860
* [Download and Install](https://github.com/yyyar/gobetween/wiki/Installation)
59-
* Consider [Configuration manual](https://github.com/yyyar/gobetween/wiki) and [config file](config/gobetween.toml)
61+
* [Read Configuration Reference](https://github.com/yyyar/gobetween/wiki)
62+
* Execute `gobetween --help` for full help on all available commands and options.
6063

6164

6265
## Hacking

0 commit comments

Comments
 (0)