From 08b402d111200315346d58bdbf46f84dd959ab8c Mon Sep 17 00:00:00 2001 From: josedpedroso Date: Thu, 5 Jul 2018 00:55:12 +0100 Subject: [PATCH] Added a couple of paragraphs about plugins and the new options to the README. --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 6755779..fb545d9 100644 --- a/README.md +++ b/README.md @@ -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