From 1a846d61ae07bf01dace834c92b61b4b236772aa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damir=20Jeli=C4=87?= Date: Wed, 11 Sep 2019 14:02:00 +0200 Subject: [PATCH] README: Document the single sign-on setup. --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 06f843d..355a96c 100644 --- a/README.md +++ b/README.md @@ -153,6 +153,19 @@ Configuration is completed primarily through the Weechat interface. First start /save +## Single sign-on: + +Single sign-on is supported using a helper script, the script found under +[contrib/matrix_sso_helper](https://github.com/poljar/weechat-matrix/blob/master/contrib/matrix_sso_helper) +should be installed under your `PATH`. + +For single sign-on to be the preferred leave the servers username and password +empty. + +After connecting a URL will be presented which needs to be used to perform the +sign on. Please note that the helper script spawns a HTTP server which waits for +the sign-on token to be passed back. This makes it necessary to do the sign on +on the same host as Weechat. ## Bar items