Skip to content

Web socket communications via route services #193

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.

Sign up for GitHub

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

Merged
anita-flegg merged 1 commit into from
Jun 4, 2025
Merged

Web socket communications via route services #193

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions route-services.html.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -488,4 +488,12 @@ apps make requests over TLS.
1. Confirm that route services do not change the value of the
`X-Forwarded-Proto` header.

## <a name='websocket-route-services'></a> Web socket communications through route services

Web socket communications through route services are supported by default and can be disabled by the following property:

1. Set the `router.route_services.enable_websockets: false` manifest
property to disable web socket communications.
Http status code 503, `StatusServiceUnavailable`, with an error message `Websocket requests are not supported for routes bound to Route Services` will be returned if one tries to establish a web socket connection via a route service.

<% end %>