From b15b358b3e152870a9150e91eb4b24cab5858e70 Mon Sep 17 00:00:00 2001 From: Paul Curie Date: Thu, 1 Apr 2021 21:13:25 +0200 Subject: [PATCH 1/3] wiki.js doc --- doc/sources/admin/applications/wiki.js.svg | 157 +++++++++++++++++++++ doc/sources/admin/applications/wikijs.rst | 58 ++++++++ 2 files changed, 215 insertions(+) create mode 100644 doc/sources/admin/applications/wiki.js.svg create mode 100644 doc/sources/admin/applications/wikijs.rst diff --git a/doc/sources/admin/applications/wiki.js.svg b/doc/sources/admin/applications/wiki.js.svg new file mode 100644 index 000000000..8a0bfad4b --- /dev/null +++ b/doc/sources/admin/applications/wiki.js.svg @@ -0,0 +1,157 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/sources/admin/applications/wikijs.rst b/doc/sources/admin/applications/wikijs.rst new file mode 100644 index 000000000..204ed0975 --- /dev/null +++ b/doc/sources/admin/applications/wikijs.rst @@ -0,0 +1,58 @@ +Wiki.js +===== + +|image0| + +Presentation +------------ + +Wiki.js is an open-source wiki. + +See `the official Wiki.js website `__ for a +complete presentation. + +It feature an OpenID Connect login feature that work with LemonLDAP::NG + +Configuring Wiki.js +----------------- + +Connect to your wiki.js instance with an Admin user, in the admin panel, go to "Authentication". + +Click on "Add Strategy" and Chose "Generic OpenID Connect / OAuth2". + +Choose a Display Name. + +Define a Client ID and a Client Secret. + +* Authorization Endpoint URL : https://auth.example.com/oauth2/authorize +* Token Endpoint URL : https://auth.example.com/oauth2/token +* User info Endpoint URL : https://auth.example.com/oauth2/userinfo +* Issuer : https://auth.example.com +* Logout URL : https://auth.example.com/oauth2/logout + +Make a note of the "Callback URL" and the bottom of the screen and save the configuration. + +Configuring LemonLDAP +~~~~~~~~~~~~~~~~~~~~~ + +We now have to configure LemonLDAP::NG to recognize Wekan as a valid +OAuth2 relaying party and send it the information it needs to recognize +a user. + +Add a :doc:`new OpenID Connect relaying party<..//idpopenidconnect>` +with the following parameters: + +* **Client ID**: the same you set in Wiki.js configuration. +* **Client Secret**: the same you set in Wiki.js configuration. +* **Allowed redirection addresses for login**: The "Callback URL". + +\_Portal with internal CA +^^^^^^^^^^^^^^^^^^ + +.. danger:: + + OIDC login fails when your LemonLDAP portal doesn't use a publicaly recognized certificate (Internal Corporate CA), this is because nodejs use it's own keystore. + You'll need to pass "NODE_EXTRA_CA_CERTS=" to your wiki installation. If done in docker you will have to create a new image from the official one, add your CA certificates into it, and use the env variable to use it in your wiki.js container. + +.. |image0| image:: /applications/wiki.js.svg + :class: align-center From 12ed2e799866b0e60376ef7e76e53793dd74de2a Mon Sep 17 00:00:00 2001 From: Paul Curie Date: Thu, 1 Apr 2021 21:20:06 +0200 Subject: [PATCH 2/3] wiki.js doc, typos --- doc/sources/admin/applications/wikijs.rst | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/doc/sources/admin/applications/wikijs.rst b/doc/sources/admin/applications/wikijs.rst index 204ed0975..dad881e6c 100644 --- a/doc/sources/admin/applications/wikijs.rst +++ b/doc/sources/admin/applications/wikijs.rst @@ -11,14 +11,14 @@ Wiki.js is an open-source wiki. See `the official Wiki.js website `__ for a complete presentation. -It feature an OpenID Connect login feature that work with LemonLDAP::NG +It feature an OpenID Connect login that work with LemonLDAP::NG. Configuring Wiki.js ----------------- Connect to your wiki.js instance with an Admin user, in the admin panel, go to "Authentication". -Click on "Add Strategy" and Chose "Generic OpenID Connect / OAuth2". +Click on "Add Strategy" and Choose "Generic OpenID Connect / OAuth2". Choose a Display Name. @@ -35,16 +35,14 @@ Make a note of the "Callback URL" and the bottom of the screen and save the conf Configuring LemonLDAP ~~~~~~~~~~~~~~~~~~~~~ -We now have to configure LemonLDAP::NG to recognize Wekan as a valid -OAuth2 relaying party and send it the information it needs to recognize -a user. +We now have to configure LemonLDAP::NG to recognize wiki.js as a valid OIDC relaying party. Add a :doc:`new OpenID Connect relaying party<..//idpopenidconnect>` -with the following parameters: +with the following parameters (Options -> Basic) : * **Client ID**: the same you set in Wiki.js configuration. * **Client Secret**: the same you set in Wiki.js configuration. -* **Allowed redirection addresses for login**: The "Callback URL". +* **Allowed redirection addresses for login**: The "Callback URL" defined in wiki.js. \_Portal with internal CA ^^^^^^^^^^^^^^^^^^ From 4a04e7fb6d986f4de812b1afaea098edf47fe69d Mon Sep 17 00:00:00 2001 From: Paul Curie Date: Thu, 1 Apr 2021 21:32:44 +0200 Subject: [PATCH 3/3] add wiki.js in applications list --- doc/sources/admin/applications.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/sources/admin/applications.rst b/doc/sources/admin/applications.rst index 5c9fbcb80..4cc7b4b0a 100644 --- a/doc/sources/admin/applications.rst +++ b/doc/sources/admin/applications.rst @@ -43,6 +43,7 @@ Applications applications/sympa applications/tomcat applications/wekan + applications/wikijs applications/wordpress applications/xwiki applications/zimbra @@ -120,6 +121,7 @@ Application Configuration .. image:: applications/sympa_logo.png :doc:`Sympa` ✔ .. image:: applications/tomcat_logo.png :doc:`Tomcat` ✔ .. image:: applications/wekan-logo.png :doc:`Wekan` ✔ +.. image:: applications/wiki.js.svg :doc:`Wekan` ✔ .. image:: applications/wordpress_logo.png :doc:`Wordpress` ✔ .. image:: applications/xwiki.png :doc:`XWiki` ✔ .. image:: applications/zimbra_logo.png :doc:`Zimbra` ✔