From 86b9ffedf7af5d404b5c34ff831b25da871e4b7f Mon Sep 17 00:00:00 2001 From: Maxime Besson Date: Mon, 18 May 2020 09:56:39 +0200 Subject: [PATCH] doc: fix formatting --- doc/sources/admin/applications.rst | 64 +- doc/sources/admin/applications/adfs.rst | 2 +- doc/sources/admin/applications/alfresco.rst | 42 +- doc/sources/admin/applications/authbasic.rst | 4 +- doc/sources/admin/applications/aws.rst | 8 +- doc/sources/admin/applications/bugzilla.rst | 14 +- .../admin/applications/cornerstone.rst | 2 +- doc/sources/admin/applications/dokuwiki.rst | 18 +- doc/sources/admin/applications/drupal.rst | 18 +- doc/sources/admin/applications/gitlab.rst | 14 +- doc/sources/admin/applications/googleapps.rst | 14 +- doc/sources/admin/applications/grafana.rst | 6 +- doc/sources/admin/applications/guacamole.rst | 6 +- doc/sources/admin/applications/humhub.rst | 12 +- doc/sources/admin/applications/jitsimeet.rst | 8 +- doc/sources/admin/applications/liferay.rst | 28 +- doc/sources/admin/applications/limesurvey.rst | 20 +- doc/sources/admin/applications/mattermost.rst | 10 +- doc/sources/admin/applications/mediawiki.rst | 20 +- doc/sources/admin/applications/nextcloud.rst | 10 +- doc/sources/admin/applications/nginx.rst | 2 +- doc/sources/admin/applications/obm.rst | 16 +- .../admin/applications/phpldapadmin.rst | 16 +- doc/sources/admin/applications/roundcube.rst | 4 +- doc/sources/admin/applications/salesforce.rst | 4 +- .../admin/applications/simplesamlphp.rst | 10 +- doc/sources/admin/applications/sympa.rst | 24 +- doc/sources/admin/applications/tomcat.rst | 16 +- doc/sources/admin/applications/wekan.rst | 8 +- doc/sources/admin/applications/xwiki.rst | 4 +- doc/sources/admin/applications/zimbra.rst | 10 +- doc/sources/admin/authad.rst | 2 +- doc/sources/admin/authapache.rst | 16 +- doc/sources/admin/authcas.rst | 23 +- doc/sources/admin/authchoice.rst | 14 +- doc/sources/admin/authcombination.rst | 30 +- doc/sources/admin/authcustom.rst | 14 +- doc/sources/admin/authdbi.rst | 20 +- doc/sources/admin/authdemo.rst | 4 +- doc/sources/admin/authfacebook.rst | 16 +- doc/sources/admin/authgithub.rst | 12 +- doc/sources/admin/authgpg.rst | 4 +- doc/sources/admin/authkerberos.rst | 14 +- doc/sources/admin/authldap.rst | 43 +- doc/sources/admin/authlinkedin.rst | 12 +- doc/sources/admin/authmulti.rst | 2 +- doc/sources/admin/authopenid.rst | 16 +- doc/sources/admin/authopenidconnect.rst | 37 +- .../admin/authopenidconnect_franceconnect.rst | 2 +- .../admin/authopenidconnect_google.rst | 2 +- doc/sources/admin/authpam.rst | 4 +- doc/sources/admin/authproxy.rst | 4 +- doc/sources/admin/authradius.rst | 4 +- doc/sources/admin/authremote.rst | 6 +- doc/sources/admin/authrest.rst | 6 +- doc/sources/admin/authsaml.rst | 29 +- doc/sources/admin/authslave.rst | 2 +- doc/sources/admin/authssl.rst | 78 +- doc/sources/admin/authtwitter.rst | 12 +- doc/sources/admin/authwebid.rst | 2 +- doc/sources/admin/authyubikey.rst | 4 +- doc/sources/admin/autosignin.rst | 2 +- doc/sources/admin/behindproxyminihowto.rst | 8 +- .../admin/browseablesessionbackend.rst | 44 +- doc/sources/admin/bruteforceprotection.rst | 6 +- doc/sources/admin/captcha.rst | 2 +- doc/sources/admin/cda.rst | 16 +- doc/sources/admin/changesessionbackend.rst | 2 +- doc/sources/admin/checkstate.rst | 2 +- doc/sources/admin/checkuser.rst | 32 +- doc/sources/admin/cli_examples.rst | 12 +- doc/sources/admin/configapache.rst | 24 +- doc/sources/admin/configlocation.rst | 93 +- doc/sources/admin/configvhost.rst | 67 +- doc/sources/admin/contextswitching.rst | 6 +- doc/sources/admin/contribute.rst | 10 +- doc/sources/admin/customfunctions.rst | 8 +- doc/sources/admin/customhandlers.rst | 10 +- doc/sources/admin/decryptvalue.rst | 8 +- doc/sources/admin/devopshandler.rst | 12 +- doc/sources/admin/download.rst | 22 +- doc/sources/admin/error.rst | 10 +- doc/sources/admin/exportedvars.rst | 5 +- doc/sources/admin/extendedfunctions.rst | 72 +- doc/sources/admin/external2f.rst | 12 +- doc/sources/admin/fastcgi.rst | 2 +- doc/sources/admin/fastcgiserver.rst | 6 +- doc/sources/admin/features.rst | 6 +- doc/sources/admin/federationproxy.rst | 6 +- doc/sources/admin/fileconfbackend.rst | 6 +- doc/sources/admin/filesessionbackend.rst | 2 +- doc/sources/admin/formreplay.rst | 10 +- doc/sources/admin/globallogout.rst | 6 +- doc/sources/admin/handlerarch.rst | 4 +- doc/sources/admin/handlerauthbasic.rst | 20 +- .../admin/header_remote_user_conversion.rst | 12 +- doc/sources/admin/idpcas.rst | 17 +- doc/sources/admin/idpopenid.rst | 34 +- doc/sources/admin/idpopenidconnect.rst | 31 +- doc/sources/admin/idpsaml.rst | 24 +- doc/sources/admin/impersonation.rst | 26 +- doc/sources/admin/installdeb.rst | 32 +- doc/sources/admin/installrpm.rst | 28 +- doc/sources/admin/installsles.rst | 22 +- doc/sources/admin/installtarball.rst | 28 +- doc/sources/admin/issuerdbget.rst | 19 +- doc/sources/admin/jsonfileconfbackend.rst | 6 +- doc/sources/admin/kerberos.rst | 6 +- doc/sources/admin/ldapsessionbackend.rst | 16 +- doc/sources/admin/localconfbackend.rst | 2 +- doc/sources/admin/loginhistory.rst | 5 +- doc/sources/admin/logoutforward.rst | 6 +- doc/sources/admin/logs.rst | 10 +- doc/sources/admin/mail2f.rst | 4 +- doc/sources/admin/managerprotection.rst | 23 +- doc/sources/admin/memcachedsessionbackend.rst | 14 +- doc/sources/admin/mongodbconfbackend.rst | 4 +- doc/sources/admin/mongodbsessionbackend.rst | 9 +- doc/sources/admin/mysqlminihowto.rst | 4 +- doc/sources/admin/nodehandler.rst | 6 +- doc/sources/admin/notifications.rst | 48 +- doc/sources/admin/oauth2handler.rst | 2 +- doc/sources/admin/openidconnectclaims.rst | 16 +- doc/sources/admin/openidconnectservice.rst | 6 +- doc/sources/admin/parameterlist.rst | 1098 ++++++++--------- doc/sources/admin/passwordstore.rst | 10 +- doc/sources/admin/performances.rst | 107 +- doc/sources/admin/platformsoverview.rst | 10 +- doc/sources/admin/plugincustom.rst | 12 +- doc/sources/admin/portal.rst | 18 +- doc/sources/admin/portalcustom.rst | 23 +- doc/sources/admin/portalmenu.rst | 12 +- doc/sources/admin/prereq.rst | 18 +- doc/sources/admin/presentation.rst | 87 +- doc/sources/admin/psgi.rst | 8 +- doc/sources/admin/public_pages.rst | 2 +- doc/sources/admin/quickstart.rst | 8 +- doc/sources/admin/radius2f.rst | 4 +- doc/sources/admin/rbac.rst | 4 +- doc/sources/admin/redirections.rst | 6 +- doc/sources/admin/renater.rst | 12 +- doc/sources/admin/resetcertificate.rst | 36 +- doc/sources/admin/resetpassword.rst | 12 +- doc/sources/admin/rest2f.rst | 4 +- doc/sources/admin/restconfbackend.rst | 2 +- doc/sources/admin/restminihowto.rst | 8 +- doc/sources/admin/restservices.rst | 25 +- doc/sources/admin/restsessionbackend.rst | 19 +- doc/sources/admin/rules_examples.rst | 10 +- doc/sources/admin/samlservice.rst | 91 +- doc/sources/admin/secondfactor.rst | 10 +- doc/sources/admin/securetoken.rst | 10 +- doc/sources/admin/security.rst | 93 +- doc/sources/admin/selfmadeapplication.rst | 22 +- doc/sources/admin/servertoserver.rst | 2 +- doc/sources/admin/sessions.rst | 16 +- doc/sources/admin/sfextra.rst | 37 +- doc/sources/admin/smtp.rst | 8 +- doc/sources/admin/soapconfbackend.rst | 12 +- doc/sources/admin/soapminihowto.rst | 8 +- doc/sources/admin/soapservices.rst | 6 +- doc/sources/admin/soapsessionbackend.rst | 11 +- doc/sources/admin/sqlconfbackend.rst | 8 +- doc/sources/admin/sqlsessionbackend.rst | 32 +- doc/sources/admin/ssoaas.rst | 19 +- doc/sources/admin/ssocookie.rst | 12 +- doc/sources/admin/start.rst | 393 +++--- doc/sources/admin/status.rst | 6 +- doc/sources/admin/totp2f.rst | 8 +- doc/sources/admin/u2f.rst | 16 +- doc/sources/admin/upgrade.rst | 45 +- doc/sources/admin/utotp2f.rst | 4 +- doc/sources/admin/variables.rst | 4 +- doc/sources/admin/viewer.rst | 16 +- doc/sources/admin/webserviceprotection.rst | 12 +- doc/sources/admin/writingrulesand_headers.rst | 76 +- doc/sources/admin/yubikey2f.rst | 6 +- 177 files changed, 2253 insertions(+), 2166 deletions(-) diff --git a/doc/sources/admin/applications.rst b/doc/sources/admin/applications.rst index 68c8cd46c..8ce53e0da 100644 --- a/doc/sources/admin/applications.rst +++ b/doc/sources/admin/applications.rst @@ -35,42 +35,42 @@ Application list ================================================================= ==================================================== ============ ================ === ==== ==== Application Configuration guide HTTP headers Specific Handler CAS SAML OIDC ================================================================= ==================================================== ============ ================ === ==== ==== -.. image:: applications/microsoft-adfs.png :doc:`ADFS` ✔ -.. image:: applications/alfresco_logo.png :doc:`Alfresco` ✔ ✔ -.. image:: applications/logo_amazon_web_services.jpg :doc:`Amazon Web Services` ✔ -.. image:: applications/logo-awx.png :doc:`AWX (Ansible Tower)` ✔ -.. image:: applications/bugzilla_logo.png :doc:`Bugzilla` ✔ -.. image:: applications/csod_logo.png :doc:`Cornerstone` ✔ +.. image:: applications/microsoft-adfs.png :doc:`ADFS` ✔ +.. image:: applications/alfresco_logo.png :doc:`Alfresco` ✔ ✔ +.. image:: applications/logo_amazon_web_services.jpg :doc:`Amazon Web Services` ✔ +.. image:: applications/logo-awx.png :doc:`AWX (Ansible Tower)` ✔ +.. image:: applications/bugzilla_logo.png :doc:`Bugzilla` ✔ +.. image:: applications/csod_logo.png :doc:`Cornerstone` ✔ .. image:: applications/discourse.jpg :doc:`Discourse` ✔ ✔ -.. image:: applications/django_logo.png :doc:`Django` ✔ -.. image:: applications/dokuwiki_logo.png :doc:`Dokuwiki` ✔ -.. image:: applications/drupal_logo.png :doc:`Drupal` ✔ -.. image:: applications/fusiondirectory-logo.jpg :doc:`FusionDirectory` ✔ +.. image:: applications/django_logo.png :doc:`Django` ✔ +.. image:: applications/dokuwiki_logo.png :doc:`Dokuwiki` ✔ +.. image:: applications/drupal_logo.png :doc:`Drupal` ✔ +.. image:: applications/fusiondirectory-logo.jpg :doc:`FusionDirectory` ✔ .. image:: applications/gitlab_logo.png :doc:`Gitlab` ✔ ✔ -.. image:: applications/glpi_logo.png :doc:`GLPI` ✔ -.. image:: applications/googleapps_logo.png :doc:`Google Apps` ✔ +.. image:: applications/glpi_logo.png :doc:`GLPI` ✔ +.. image:: applications/googleapps_logo.png :doc:`Google Apps` ✔ .. image:: applications/grafana_logo.png :doc:`Grafana` ✔ -.. image:: applications/grr_logo.png :doc:`GRR` ✔ +.. image:: applications/grr_logo.png :doc:`GRR` ✔ .. image:: applications/guacamole.png :doc:`Apache Guacamole` ✔ ✔ ✔ .. image:: applications/humhub_logo.png :doc:`HumHub` ✔ -.. image:: applications/logo-jitsimeet.png :doc:`Jitsi Meet` ✔ -.. image:: applications/liferay_logo.png :doc:`Liferay` ✔ -.. image:: applications/limesurvey_logo.png :doc:`LimeSurvey` ✔ +.. image:: applications/logo-jitsimeet.png :doc:`Jitsi Meet` ✔ +.. image:: applications/liferay_logo.png :doc:`Liferay` ✔ +.. image:: applications/limesurvey_logo.png :doc:`LimeSurvey` ✔ .. image:: applications/mattermost_logo.png :doc:`Mattermost` ✔ -.. image:: applications/mediawiki_logo.png :doc:`Mediawiki` ✔ -.. image:: applications/nextcloud-logo.png :doc:`NextCloud` ✔ -.. image:: applications/obm_logo.png :doc:`OBM` ✔ -.. image:: applications/logo_office_365.png :doc:`Office 365` ✔ -.. image:: applications/phpldapadmin_logo.png :doc:`phpLDAPAdmin` ✔ -.. image:: applications/roundcube_logo.png :doc:`Roundcube` ✔ -.. image:: applications/salesforce-logo.jpg :doc:`SalesForce` ✔ -.. image:: applications/SAPLogo.gif :doc:`SAP` ✔ ✔ -.. image:: applications/simplesamlphp_logo.png :doc:`simpleSAMLphp` ✔ -.. image:: applications/spring_logo.png :doc:`Spring` ✔ -.. image:: applications/symfony_logo.png :doc:`Symfony` ✔ -.. image:: applications/sympa_logo.png :doc:`Sympa` ✔ -.. image:: applications/tomcat_logo.png :doc:`Tomcat` ✔ -.. image:: applications/wordpress_logo.png :doc:`Wordpress` ✔ -.. image:: applications/xwiki.png :doc:`XWiki` ✔ -.. image:: applications/zimbra_logo.png :doc:`Zimbra` ✔ +.. image:: applications/mediawiki_logo.png :doc:`Mediawiki` ✔ +.. image:: applications/nextcloud-logo.png :doc:`NextCloud` ✔ +.. image:: applications/obm_logo.png :doc:`OBM` ✔ +.. image:: applications/logo_office_365.png :doc:`Office 365` ✔ +.. image:: applications/phpldapadmin_logo.png :doc:`phpLDAPAdmin` ✔ +.. image:: applications/roundcube_logo.png :doc:`Roundcube` ✔ +.. image:: applications/salesforce-logo.jpg :doc:`SalesForce` ✔ +.. image:: applications/SAPLogo.gif :doc:`SAP` ✔ ✔ +.. image:: applications/simplesamlphp_logo.png :doc:`simpleSAMLphp` ✔ +.. image:: applications/spring_logo.png :doc:`Spring` ✔ +.. image:: applications/symfony_logo.png :doc:`Symfony` ✔ +.. image:: applications/sympa_logo.png :doc:`Sympa` ✔ +.. image:: applications/tomcat_logo.png :doc:`Tomcat` ✔ +.. image:: applications/wordpress_logo.png :doc:`Wordpress` ✔ +.. image:: applications/xwiki.png :doc:`XWiki` ✔ +.. image:: applications/zimbra_logo.png :doc:`Zimbra` ✔ ================================================================= ==================================================== ============ ================ === ==== ==== diff --git a/doc/sources/admin/applications/adfs.rst b/doc/sources/admin/applications/adfs.rst index 6f5c3fff2..aaa48eeda 100644 --- a/doc/sources/admin/applications/adfs.rst +++ b/doc/sources/admin/applications/adfs.rst @@ -11,7 +11,7 @@ Identity/Service Provider, compatible with several protocols, including SAML 2.0. -.. important:: +.. important:: This documentation does not explains how to setup ADFS, but give only tricks to make it works with LL::NG diff --git a/doc/sources/admin/applications/alfresco.rst b/doc/sources/admin/applications/alfresco.rst index 135b63580..db0f72d1f 100644 --- a/doc/sources/admin/applications/alfresco.rst +++ b/doc/sources/admin/applications/alfresco.rst @@ -17,7 +17,7 @@ Authentication against LL::NG can be done trough: - SAML 2 (LL::NG as SAML2 IDP) -.. tip:: +.. tip:: Alfresco now recommends SAML2 method @@ -30,10 +30,10 @@ Alfresco ~~~~~~~~ -.. tip:: +.. tip:: The official documentation can be found here: - http://docs.alfresco.com/4.0/tasks/auth-alfrescoexternal-sso.html\ + http://docs.alfresco.com/4.0/tasks/auth-alfrescoexternal-sso.html\ You need to find the following files in your Alfresco installation: @@ -102,7 +102,7 @@ the ````, change ```` value to You need to restart Tomcat to apply changes. -.. warning:: +.. warning:: Now you can log in with a simple HTTP header. You need to restrict access to Alfresco to LL::NG. @@ -171,13 +171,13 @@ Edit then ``share-config-custom.xml``: ... - + - + - + - + @@ -218,15 +218,15 @@ Edit then ``share-config-custom.xml``: - + - + - + @@ -295,7 +295,7 @@ Edit then ``share-config-custom.xml``: - + @@ -315,7 +315,7 @@ Edit then ``share-config-custom.xml``: - + @@ -332,7 +332,7 @@ Edit then ``share-config-custom.xml``: - + @@ -350,7 +350,7 @@ Edit then ``share-config-custom.xml``: - +