blax-software
/
laravel-websockets
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update Caddy example for Caddy v2 

Caddy v2 greatly simplifies things for proxying websockets. The dumb rewrite hack is no longer necessary because request matchers handle it perfectly.

Caddy is _by far_ the simplest and easiest solution for proxying websockets like this.
This commit is contained in:
Francis Lavoie 2020-09-03 20:37:33 -04:00 committed by GitHub
parent e9b85bbfc7
commit c499f5d80c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/basic-usage/ssl.md
View File

@ -270,28 +270,20 @@ You know you've reached this limit of your Nginx error logs contain similar mess
Remember to restart your Nginx after you've modified the `worker_connections`. Remember to restart your Nginx after you've modified the `worker_connections`.
### Example using Caddy ### Example using Caddy v2
[Caddy](https://caddyserver.com) can also be used to automatically obtain a TLS certificate from Let's Encrypt and terminate TLS before proxying to your echo server. [Caddy](https://caddyserver.com) can also be used to automatically obtain a TLS certificate from Let's Encrypt and terminate TLS before proxying to your websocket server.
An example configuration would look like this: An example configuration would look like this:
``` ```
socket.yourapp.tld { socket.yourapp.tld {
rewrite / { @ws {
if {>Connection} has Upgrade header Connection *Upgrade*
if {>Upgrade} is websocket header Upgrade websocket
to /websocket-proxy/{path}?{query}
} }
reverse_proxy @ws 127.0.0.1:6001
proxy /websocket-proxy 127.0.0.1:6001 {
without /special-websocket-url
transparent
websocket
}
tls youremail.com
} }
``` ```
Note the `to /websocket-proxy`, this is a dummy path to allow the `proxy` directive to only proxy on websocket connections. This should be a path that will never be used by your application's routing. Also, note that you should change `127.0.0.1` to the hostname of your websocket server. For example, if you're running in a Docker environment, this might be the container name of your websocket server. Note that you should change `127.0.0.1` to the hostname of your websocket server. For example, if you're running in a Docker environment, this might be the container name of your websocket server.