Skip to content

Commit

Permalink
Add documentation for websockify
Browse files Browse the repository at this point in the history
  • Loading branch information
dylex committed Feb 18, 2024
1 parent e7c5013 commit 7a97e79
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/source/server-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,18 @@ One of:

(server-process:callable-arguments)=

### `websockify`

_True_ to proxy only websocket connections into raw stream connections.
_False_ (default) if the proxied server speaks full HTTP.

If _True_, the proxied server is treated a raw TCP (or unix socket) server that
does not use HTTP.
In this mode, only websockets are handled, and messages are sent to the backend
server as stream data. This is equivalent to running a
[websockify](https://github.com/novnc/websockify) wrapper.
All other HTTP requests return 405.

#### Callable arguments

Any time you specify a callable in the config, it can ask for any arguments it needs
Expand Down

0 comments on commit 7a97e79

Please sign in to comment.