Skip to content

Commit

Permalink
🦊 update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nothinux committed Jun 12, 2022
1 parent 92810d3 commit 8094db7
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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)

0 comments on commit 8094db7

Please sign in to comment.