diff options
Diffstat (limited to 'plugins')
| -rw-r--r-- | plugins/backend_file.cfg | 11 | ||||
| -rw-r--r-- | plugins/backend_file.md | 16 |
2 files changed, 24 insertions, 3 deletions
diff --git a/plugins/backend_file.cfg b/plugins/backend_file.cfg new file mode 100644 index 0000000..e986405 --- /dev/null +++ b/plugins/backend_file.cfg @@ -0,0 +1,11 @@ +[core] +port = 8000 +backend = file + +[backend] +path = files/ +expression = %endpoint%.txt +expression = %cookie:session%.txt +expression = %header:X-Foo-Bar%.txt +expression = default.txt + diff --git a/plugins/backend_file.md b/plugins/backend_file.md index 7359c94..aefebf9 100644 --- a/plugins/backend_file.md +++ b/plugins/backend_file.md @@ -14,13 +14,21 @@ user-configurable templates which may use the following variables: All slashes in variable values are replaced by underscores to defend against directory traversal attacks. -If a specified file or variable does not exist (ie. the header or cookie is missing), the expression is skipped and the next one is evaluated. When the end of the template expression list is reached without a valid peer being found, the WebSocket connection will be rejected. +If a specified file or variable does not exist (ie. the header or cookie is missing), the expression is skipped and the next +one is evaluated. When the end of the template expression list is reached without a valid peer being found, the WebSocket connection +will be rejected. The files accessed via the expression list must contain lines of the form -`<network peer> <protocol> [<framing>] [<framing-config>]` +`<network peer> <subprotocol> [<framing>] [<framing-config>]` -If the WebSocket client indicates one or more supported subprotocol, the first line found in any of the traversed +For example: +``` +tcp://localhost:5900 binary auto +unix:///tmp/app.sock text text +``` + +If the WebSocket client indicates one or more supported subprotocols, the first line found in any of the traversed files matching any of the indicated protocols is used as the connection peer. The special value `*` for the protocol always matches the first indicated protocol. If the client does not indicate a subprotocol, the first configuration line read will be used. @@ -31,3 +39,5 @@ This backend accepts the following configuration options: * `path`: The base path for the template expression list. All template evaluations will be appended to this path. * `expression`: Adds a template expression to the list. Specify multiple times to extend the list. Expressions are evaluated in the order they are specified. + +An [example configuration file](backend_file.cfg) is provided in the repository. |