Skip to content

Commit 8094db7

Browse files
committed
🦊 update readme
1 parent 92810d3 commit 8094db7

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# 🐙 Octo-Proxy
2-
Octo-proxy or `octo` is simple TCP & TLS Proxy with mutual authentication and mirroring/shadowing support.
2+
Octo-proxy or `octo` is simple TCP & TLS Proxy with mutual authentication and traffic mirroring/shadowing support.
33

4-
[![Go Report Card](https://goreportcard.com/badge/github.com/nothinux/octo-proxy)](https://goreportcard.com/report/github.com/nothinux/octo-proxy) ![test status](https://github.com/nothinux/octo-proxy/actions/workflows/test.yml/badge.svg?branch=master)
4+
[![Go Report Card](https://goreportcard.com/badge/github.com/nothinux/octo-proxy)](https://goreportcard.com/report/github.com/nothinux/octo-proxy) ![test status](https://github.com/nothinux/octo-proxy/actions/workflows/test.yml/badge.svg?branch=main) [![codecov](https://codecov.io/gh/nothinux/octo-proxy/branch/main/graph/badge.svg?token=HBRTW7DX0K)](https://codecov.io/gh/nothinux/octo-proxy)
55

66
### Feature
77
- Accept TCP connection and forward/mirror it to TCP
@@ -82,5 +82,11 @@ octo -config config.yaml
8282

8383
See all configuration in [CONFIGURATION.md](https://github.com/nothinux/octo-proxy/tree/master/docs/CONFIGURATION.md)
8484

85+
### Reloading Configuration
86+
After changing configuration, send signal `SIGUSR` or `SIGUSR2` to `octo` process. Configuration will be reloaded if configuration is valid.
87+
88+
### Monitoring
89+
Metrics running at `http://127.0.0.1:9123`
90+
8591
### LICENSE
8692
[LICENSE](https://github.com/nothinux/octo-proxy/blob/main/LICENSE.md)

0 commit comments

Comments
 (0)