Skip to content

Commit 82daca0

Browse files
smiratalos-bot
authored andcommitted
docs: update README
Some clarifications, add a link to the slides. Signed-off-by: Andrey Smirnov <[email protected]>
1 parent fa6843a commit 82daca0

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,32 +6,29 @@
66

77
[gRPC Go](https://github.com/grpc/grpc-go) Proxy server
88

9-
This is a fork of awesome [mwitkow/grpc-proxy](https://github.com/mwitkow/grpc-proxy) with support
10-
for one to many proxying added.
11-
129
## Project Goal
1310

1411
Build a transparent reverse proxy for gRPC targets that will make it easy to expose gRPC services
15-
over the internet.
12+
over the Internet.
1613

1714
This includes:
1815

1916
* no needed knowledge of the semantics of requests exchanged in the call (independent rollouts)
20-
* easy, declarative definition of backends and their mappings to frontends
17+
* easy declarative definition of backends and their mappings to frontends
2118
* simple round-robin load balancing of inbound requests from a single connection to multiple backends
2219

2320
## Proxying Modes
2421

2522
There are two proxying modes supported:
2623

2724
* one to one: in this mode data passed back and forth is transmitted as is without any modifications;
28-
* one to many: one client connection is mapped into multiple upstream connections, results might be aggregated
29-
(for unary calls), errors translated into response messages; this mode requires special layout of protobuf messages.
25+
* one to many: one client connection gets mapped into multiple upstream connections, results might be aggregated
26+
(for unary calls), errors translated into response messages; this mode requires a special layout of protobuf messages.
3027

3128
## Proxy Handler
3229

33-
The package [`proxy`](proxy/) contains a generic gRPC reverse proxy handler that allows a gRPC server to
34-
not know about registered handlers or their data types.
30+
The package [`proxy`](proxy/) contains a generic gRPC reverse proxy handler that allows a gRPC server not to
31+
know about method names and their request/response data types.
3532
Please consult the package documentation.
3633
Here you can find an example usage.
3734

@@ -100,6 +97,15 @@ concatenated to build a combined response from all the upstreams.
10097
2. Response should contain common metadata fields which allow grpc-proxy to inject source information and error information
10198
into response.
10299

100+
## Talks
101+
102+
* "Transparent gRPC proxy in Go" at [GopherCon Russia 2021](https://www.gophercon-russia.ru/) [slides](https://speakerdeck.com/smira/transparent-grpc-gateway-in-go)
103+
104+
## History
105+
106+
This is a fork of awesome [mwitkow/grpc-proxy](https://github.com/mwitkow/grpc-proxy) package with added support
107+
for one to many proxying.
108+
103109
## License
104110

105111
`grpc-proxy` is released under the Apache 2.0 license.

0 commit comments

Comments
 (0)