joshua
/
websockify
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Added a couple of paragraphs about plugins and the new options to the README.

This commit is contained in:
josedpedroso 2018-07-05 00:55:12 +01:00
parent af85184e28
commit 08b402d111
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -109,6 +109,19 @@ These are not necessary for the basic operation.
This functionality is activated with the `--log-file FILE` option
where FILE is the file where the logs should be saved.
* Authentication plugins: websockify can demand authentication for
websocket connections and, if you use `--web-auth`, also for normal
web requests. This functionality is activated with the
`--auth-plugin CLASS` and `--auth-source ARG` options, where CLASS is
usually one from auth_plugins.py and ARG is the plugin's configuration.
* Token plugins: a single instance of websockify can connect clients to
multiple different pre-configured targets, depending on the token sent
by the client using the `token` URL parameter or the hostname, if you
use `--host-token`. This functionality is activated with the
`--token-plugin CLASS` and `--token-source ARG` options, where CLASS is
usually one from token_plugins.py and ARG is the plugin's configuration.
### Implementations of websockify
The primary implementation of websockify is in python. There are