Skip to content

Commit 56a9da6

Browse files
committed
cleanup
1 parent b80cb26 commit 56a9da6

File tree

3 files changed

+2
-56
lines changed

3 files changed

+2
-56
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
webrtc-socket-proxy
22
centrifugo
3+
.vscode

.vscode/settings.json

Lines changed: 0 additions & 3 deletions
This file was deleted.

README.md

Lines changed: 1 addition & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1 @@
1-
# kahlys/proxy
2-
3-
[![godoc](https://godoc.org/github.com/kahlys/proxy?status.svg)](https://godoc.org/github.com/kahlys/proxy)
4-
[![build](https://api.travis-ci.org/kahlys/proxy.svg?branch=master)](https://travis-ci.org/kahlys/proxy)
5-
[![go report](https://goreportcard.com/badge/github.com/kahlys/proxy)](https://goreportcard.com/report/github.com/kahlys/proxy)
6-
7-
Simple tcp proxy package and executable binary in Golang.
8-
9-
:warning: This code is for test purpose, it is sometimes ugly, it is not production ready, and the API will probably change. :warning:
10-
11-
## Installation
12-
13-
With a correctly configured [Go toolchain](https://golang.org/doc/install):
14-
15-
```sh
16-
$ git clone github.com/kahlys/proxy/
17-
$ cd proxy
18-
$ go install cmd/tcpproxy/*.go
19-
```
20-
21-
## Example
22-
23-
The example executable provides both TCP and TCP/TLS connection: `cmd/tcpproxy/main.go`
24-
25-
By default, the proxy address is *localhost:4444* and the target address is *localhost:80*.
26-
27-
```sh
28-
$ tcpproxy
29-
2018/12/13 17:10:25 Proxying from :4444 to :80
30-
```
31-
32-
You can specify some options.
33-
34-
```sh
35-
$ tcpproxy -help
36-
Usage of tcpproxy:
37-
-lcert string
38-
certificate file for proxy server side
39-
-lhost string
40-
proxy local address (default ":4444")
41-
-lkey string
42-
key x509 file for proxy server side
43-
-ltls
44-
tls/ssl between client and proxy, you must set 'lcert' and 'lkey'
45-
-rcert string
46-
certificate file for proxy client side
47-
-rhost string
48-
proxy remote address (default ":80")
49-
-rkey string
50-
key x509 file for proxy client side
51-
-rtls
52-
tls/ssl between proxy and target, you must set 'rcert' and 'rkey'
53-
```
1+
# webrtc-socket-proxy

0 commit comments

Comments
 (0)