From 8094db7920a8c68db3b2370c0f9d02d88529f332 Mon Sep 17 00:00:00 2001 From: nothinux Date: Sun, 12 Jun 2022 11:13:26 +0700 Subject: [PATCH] =?UTF-8?q?=F0=9F=A6=8A=20update=20readme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 16d43c7..b518e21 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # 🐙 Octo-Proxy -Octo-proxy or `octo` is simple TCP & TLS Proxy with mutual authentication and mirroring/shadowing support. +Octo-proxy or `octo` is simple TCP & TLS Proxy with mutual authentication and traffic mirroring/shadowing support. -[![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) +[![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) ### Feature - Accept TCP connection and forward/mirror it to TCP @@ -82,5 +82,11 @@ octo -config config.yaml See all configuration in [CONFIGURATION.md](https://github.com/nothinux/octo-proxy/tree/master/docs/CONFIGURATION.md) +### Reloading Configuration +After changing configuration, send signal `SIGUSR` or `SIGUSR2` to `octo` process. Configuration will be reloaded if configuration is valid. + +### Monitoring +Metrics running at `http://127.0.0.1:9123` + ### LICENSE [LICENSE](https://github.com/nothinux/octo-proxy/blob/main/LICENSE.md)