Skip to content

Commit a1a1e51

Browse files
committed
Improved documentation
1 parent 9babde4 commit a1a1e51

File tree

4 files changed

+13
-3
lines changed

4 files changed

+13
-3
lines changed

README.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,8 @@ _LB_ role will need to update this file accordingly.
9393

9494
## List of available checks
9595

96+
Because of the usage of _RAW_ sockets, all checks need to be run as _root_.
97+
9698
* [TCP check](doc/check_tcp_raw.md)
9799
* [HTTP GET check](doc/check_http_get_raw.md) (_BETA_)
98100
* [HTTP check](doc/check_http_raw.md) (_BETA_)
@@ -114,9 +116,11 @@ To compile all checks just run:
114116
make
115117
```
116118

117-
The binaries are created in the `bin/` directory, all the other build artifacts
118-
are created in the `build/` directory. Run `make clean` to clean all compiled
119-
artifacts.
119+
* The binaries are created in the `bin/` directory.
120+
* All the other build artifacts are created in the `build/` directory.
121+
* Run `make clean` to clean all compiled artifacts.
122+
* The checks can be compiled individually, using `make tcp`, `make http_get`
123+
or `make http`.
120124

121125
## TODO
122126

doc/check_http_get_raw.md

+2
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ The binary `check_http_get_raw` is created in the `bin/` directory.
3434

3535
## Usage
3636

37+
Because of the usage of _RAW_ sockets, the check need to be run as _root_.
38+
3739
```sh
3840
check_http_get_raw [OPTION...]
3941
SOURCE_IFACE

doc/check_http_raw.md

+2
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ The binary `check_http_raw` is created in the `bin/` directory.
3535

3636
## Usage
3737

38+
Because of the usage of _RAW_ sockets, the check need to be run as _root_.
39+
3840
```sh
3941
check_http_get_raw [OPTION...]
4042
SOURCE_IFACE

doc/check_tcp_raw.md

+2
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ The binary `check_tcp_raw` is created in the `bin/` directory.
3030

3131
## Usage
3232

33+
Because of the usage of _RAW_ sockets, the check need to be run as _root_.
34+
3335
```sh
3436
check_tcp_raw [OPTION...] SOURCE_IFACE REAL_SERVER VIRTUAL_IP PORT
3537
```

0 commit comments

Comments
 (0)