Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
chore: update README and dist.ini
  • Loading branch information
fffonion committed Apr 9, 2018
1 parent 0d52910 commit 85fa461
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions README.md
@@ -1,7 +1,7 @@
Name
====

lua-resty-multiplexer - Port service multiplexer for stream subsystem
lua-resty-multiplexer - Transparent port service multiplexer for stream subsystem

Table of Contents
=================
Expand All @@ -26,11 +26,11 @@ Table of Contents
Description
===========

This library is used to run multiple TCP services on the same port.
This library implemented a transparent port service multiplexer, which can be used to run multiple TCP services on the same port.

Note that nginx [stream module](https://nginx.org/en/docs/stream/ngx_stream_core_module.html) and [stream-lua-nginx-module](https://github.com/openresty/stream-lua-nginx-module) is required.

Also a customed [patch](patches/stream-lua-readpartial.patch) from [fcicq](https://github.com/fcicq) is needed. The origin discussion can be found [here](https://github.com/fffonion/lua-resty-sniproxy/issues/1).
Also a customed [patch](patches/stream-lua-readpartial.patch) from [@fcicq](https://github.com/fcicq) is needed. The origin discussion can be found [here](https://github.com/fffonion/lua-resty-sniproxy/issues/1).

Tested on Openresty 1.13.6.1.

Expand Down Expand Up @@ -95,7 +95,7 @@ The rules defined is prioritized. In the example above, we defined a rule such t
- If protocol is `HTTP` and client address is `10.0.0.2`, proxy to **internal-host:8001**
- If protocol is `SSH`, proxy to **github.com:22**
- If protocol is `DNS`, proxy to **1.1.1.1:53**
- If protocol is `SSL/TLS` and current minute is between **0** and **30**, proxy to **www.google.com:443**
- If protocol is `SSL/TLS` and current minute is between **0** and **30**, proxy to **twitter:443**
- If protocol is `SSL/TLS` and current minute is between **31** and **59**, proxy to **www.google.com:443**
- Otherwise, proxy to **127.0.0.1:80**

Expand Down
2 changes: 1 addition & 1 deletion dist.ini
@@ -1,5 +1,5 @@
name = lua-resty-multiplexer
abstract = Port service multiplexer for stream subsystem
abstract = Transparent port service multiplexer for stream subsystem
author = fffonion
is_original = yes
license = 3bsd
Expand Down

0 comments on commit 85fa461

Please sign in to comment.