Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document how to reverse proxy this relay #6

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,29 @@ then just run it with some environment variables for configuration.

A reverse proxy configured to allow websockets should be pointed at the RELAY_LISTEN port to enable TLS.
The bridge and registration providers can then be pointed at the public address of the reverse proxy.

For example, if using `nginx`, the following configuration can be used:

```nginx
location /health {
proxy_pass http://127.0.0.1:8000;
}

location /api/v1/provider {
proxy_pass http://127.0.0.1:8000;
# https://www.nginx.com/blog/websocket-nginx/
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "Upgrade";
proxy_set_header Host $host;
}

location /api/v1/bridge {
proxy_pass http://127.0.0.1:8000;
# https://www.nginx.com/blog/websocket-nginx/
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "Upgrade";
proxy_set_header Host $host;
}
```