Skip to content

Commit

Permalink
mention reverse proxy considerations
Browse files Browse the repository at this point in the history
  • Loading branch information
or-else committed May 10, 2020
1 parent 9c66ecb commit b7568b8
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
- [WebSocket](#websocket)
- [Long Polling](#long-polling)
- [Out of Band Large Files](#out-of-band-large-files)
- [Running Behind a Reverse Proxy](#running-behind-a-reverse-proxy)
- [Users](#users)
- [Authentication](#authentication)
- [Creating an Account](#creating-an-account)
Expand Down Expand Up @@ -140,6 +141,10 @@ Server allows connections from all origins, i.e. `Access-Control-Allow-Origin: *

Large files are sent out of band using `HTTP POST` as `Content-Type: multipart/form-data`. See [below](#out-of-band-handling-of-large-files) for details.

### Running Behind a Reverse Proxy

Tinode server can be set up to run behind a reverse proxy, such as NGINX. For efficiency it can accept client connections from Unix sockets by setting `listen` and/or `grpc_listen` config parameters to the path of the Unix socket file, e.g. `unix:/run/tinode.sock`. The server may also be configured to read peer's IP address from `X-Forwarded-For` HTTP header by setting `use_x_forwarded_for` config parameter to `true`.

## Users

User is meant to represent a person, an end-user: producer and consumer of messages.
Expand Down

0 comments on commit b7568b8

Please sign in to comment.