From 573f9cdbbe64cbb9bd1639320d96ccfe27ca1969 Mon Sep 17 00:00:00 2001 From: Maxime Besson Date: Sun, 24 May 2020 00:24:10 +0200 Subject: [PATCH] doc: Add toctree --- doc/sources/admin/applications.rst | 44 +++++++++++++++++++++++ doc/sources/admin/authopenidconnect.rst | 8 +++++ doc/sources/admin/index_advanced.rst | 28 +++++++++++++++ doc/sources/admin/index_afterinstall.rst | 10 ++++++ doc/sources/admin/index_authdb.rst | 44 +++++++++++++++++++++++ doc/sources/admin/index_beforeinstall.rst | 9 +++++ doc/sources/admin/index_configdb.rst | 15 ++++++++ doc/sources/admin/index_databases.rst | 9 +++++ doc/sources/admin/index_dev.rst | 10 ++++++ doc/sources/admin/index_exploitation.rst | 15 ++++++++ doc/sources/admin/index_firststeps.rst | 12 +++++++ doc/sources/admin/index_handler.rst | 15 ++++++++ doc/sources/admin/index_idp.rst | 11 ++++++ doc/sources/admin/index_installation.rst | 9 +++++ doc/sources/admin/index_maininstall.rst | 12 +++++++ doc/sources/admin/index_minihowtos.rst | 19 ++++++++++ doc/sources/admin/index_plugins.rst | 28 +++++++++++++++ doc/sources/admin/index_portal.rst | 19 ++++++++++ doc/sources/admin/index_presentation.rst | 10 ++++++ doc/sources/admin/index_protection.rst | 8 +++++ doc/sources/admin/index_protocols.rst | 9 +++++ doc/sources/admin/index_sessiondb.rst | 16 +++++++++ doc/sources/admin/monitoring.rst | 5 +++ doc/sources/admin/start.rst | 42 ++++++++++++++++++++-- 24 files changed, 405 insertions(+), 2 deletions(-) create mode 100644 doc/sources/admin/index_advanced.rst create mode 100644 doc/sources/admin/index_afterinstall.rst create mode 100644 doc/sources/admin/index_authdb.rst create mode 100644 doc/sources/admin/index_beforeinstall.rst create mode 100644 doc/sources/admin/index_configdb.rst create mode 100644 doc/sources/admin/index_databases.rst create mode 100644 doc/sources/admin/index_dev.rst create mode 100644 doc/sources/admin/index_exploitation.rst create mode 100644 doc/sources/admin/index_firststeps.rst create mode 100644 doc/sources/admin/index_handler.rst create mode 100644 doc/sources/admin/index_idp.rst create mode 100644 doc/sources/admin/index_installation.rst create mode 100644 doc/sources/admin/index_maininstall.rst create mode 100644 doc/sources/admin/index_minihowtos.rst create mode 100644 doc/sources/admin/index_plugins.rst create mode 100644 doc/sources/admin/index_portal.rst create mode 100644 doc/sources/admin/index_presentation.rst create mode 100644 doc/sources/admin/index_protection.rst create mode 100644 doc/sources/admin/index_protocols.rst create mode 100644 doc/sources/admin/index_sessiondb.rst diff --git a/doc/sources/admin/applications.rst b/doc/sources/admin/applications.rst index 8ce53e0da..0baef94e0 100644 --- a/doc/sources/admin/applications.rst +++ b/doc/sources/admin/applications.rst @@ -1,6 +1,49 @@ Applications ============ +.. toctree:: + :hidden: + + applications/adfs + applications/alfresco + applications/aws + applications/awx + applications/bugzilla + applications/cornerstone + applications/discourse + applications/django + applications/dokuwiki + applications/drupal + applications/fusiondirectory + applications/gitlab + applications/glpi + applications/googleapps + applications/grafana + applications/grr + applications/guacamole + applications/humhub + applications/jitsimeet + applications/liferay + applications/limesurvey + applications/mattermost + applications/mediawiki + applications/nextcloud + applications/obm + applications/office365 + applications/phpldapadmin + applications/roundcube + applications/salesforce + applications/sap + applications/simplesamlphp + applications/spring + applications/symfony + applications/sympa + applications/tomcat + applications/wekan + applications/wordpress + applications/xwiki + applications/zimbra + How to integrate ---------------- @@ -70,6 +113,7 @@ Application Configuration .. image:: applications/symfony_logo.png :doc:`Symfony` ✔ .. image:: applications/sympa_logo.png :doc:`Sympa` ✔ .. image:: applications/tomcat_logo.png :doc:`Tomcat` ✔ +.. image:: applications/wekan-logo.png :doc:`Wekan` ✔ .. 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/authopenidconnect.rst b/doc/sources/admin/authopenidconnect.rst index e1db1bf6a..9e9f10a2f 100644 --- a/doc/sources/admin/authopenidconnect.rst +++ b/doc/sources/admin/authopenidconnect.rst @@ -34,6 +34,14 @@ You can use this authentication module to link your LL::NG server to any OpenID Connect Provider. Here are some examples, witch their specific documentation: + +.. toctree:: + :hidden: + + authopenidconnect_google + authopenidconnect_franceconnect + + =============== ================== Google France Connect =============== ================== diff --git a/doc/sources/admin/index_advanced.rst b/doc/sources/admin/index_advanced.rst new file mode 100644 index 000000000..2cafdfa53 --- /dev/null +++ b/doc/sources/admin/index_advanced.rst @@ -0,0 +1,28 @@ +Advanced features +================= + +.. toctree:: + :maxdepth: 1 + + smtp + notifications + passwordstore + cda + rbac + customfunctions + extendedfunctions + resetpassword + register + logoutforward + securetoken + handlerauthbasic + ssoaas + servertoserver + safejail + loginhistory + fastcgi + fastcgiserver + psgi + managertests + rules_examples + parameterlist diff --git a/doc/sources/admin/index_afterinstall.rst b/doc/sources/admin/index_afterinstall.rst new file mode 100644 index 000000000..4ae3efec9 --- /dev/null +++ b/doc/sources/admin/index_afterinstall.rst @@ -0,0 +1,10 @@ +After installation +================== + +.. toctree:: + :maxdepth: 1 + + confignginx + configapache + configplack + diff --git a/doc/sources/admin/index_authdb.rst b/doc/sources/admin/index_authdb.rst new file mode 100644 index 000000000..06c8fbd13 --- /dev/null +++ b/doc/sources/admin/index_authdb.rst @@ -0,0 +1,44 @@ +Authentication, users and password databases +============================================ + +.. toctree:: + :maxdepth: 1 + + authad + authapache + authcas + authdbi + authdemo + authfacebook + authgithub + authgpg + authkerberos + authldap + authlinkedin + authnull + authopenidconnect + authpam + authproxy + authradius + authrest + authsaml + authslave + authssl + authtwitter + authwebid + authyubikey + authcustom + authchoice + authcombination + authmulti + authopenid + authremote + utotp2f + u2f + totp2f + mail2f + external2f + radius2f + rest2f + yubikey2f + sfextra diff --git a/doc/sources/admin/index_beforeinstall.rst b/doc/sources/admin/index_beforeinstall.rst new file mode 100644 index 000000000..f1ce4f827 --- /dev/null +++ b/doc/sources/admin/index_beforeinstall.rst @@ -0,0 +1,9 @@ +Before installation +=================== + +.. toctree:: + :maxdepth: 1 + + prereq + download + upgrade diff --git a/doc/sources/admin/index_configdb.rst b/doc/sources/admin/index_configdb.rst new file mode 100644 index 000000000..95a43b6b9 --- /dev/null +++ b/doc/sources/admin/index_configdb.rst @@ -0,0 +1,15 @@ +Configuration database +====================== + +.. toctree:: + :maxdepth: 1 + + changeconfbackend + fileconfbackend + yamlconfbackend + sqlconfbackend + ldapconfbackend + mongodbconfbackend + soapconfbackend + restconfbackend + localconfbackend diff --git a/doc/sources/admin/index_databases.rst b/doc/sources/admin/index_databases.rst new file mode 100644 index 000000000..873334823 --- /dev/null +++ b/doc/sources/admin/index_databases.rst @@ -0,0 +1,9 @@ +LemonLDAP::NG Databases +======================= + +.. toctree:: + :maxdepth: 2 + + index_configdb + index_sessiondb + diff --git a/doc/sources/admin/index_dev.rst b/doc/sources/admin/index_dev.rst new file mode 100644 index 000000000..b337730e5 --- /dev/null +++ b/doc/sources/admin/index_dev.rst @@ -0,0 +1,10 @@ +Development +=========== + +.. toctree:: + :maxdepth: 1 + + bugreport + contribute + handlerarch + customhandlers diff --git a/doc/sources/admin/index_exploitation.rst b/doc/sources/admin/index_exploitation.rst new file mode 100644 index 000000000..e569b57db --- /dev/null +++ b/doc/sources/admin/index_exploitation.rst @@ -0,0 +1,15 @@ +Exploitation +============ + +.. toctree:: + :maxdepth: 1 + + performances + security + selinux + status + checkstate + monitoring + logs + error + highavailability diff --git a/doc/sources/admin/index_firststeps.rst b/doc/sources/admin/index_firststeps.rst new file mode 100644 index 000000000..56b8f8cca --- /dev/null +++ b/doc/sources/admin/index_firststeps.rst @@ -0,0 +1,12 @@ +Configuration first steps +========================= + +.. toctree:: + :maxdepth: 1 + + configlocation + ssocookie + redirections + exportedvars + configvhost + sessions diff --git a/doc/sources/admin/index_handler.rst b/doc/sources/admin/index_handler.rst new file mode 100644 index 000000000..120988e74 --- /dev/null +++ b/doc/sources/admin/index_handler.rst @@ -0,0 +1,15 @@ +Handlers +======== + +.. toctree:: + :maxdepth: 1 + + handlerauthbasic + cda + ssoaas + servertoserver + oauth2handler + securetoken + servertoserver + devopshandler + devopssthandler diff --git a/doc/sources/admin/index_idp.rst b/doc/sources/admin/index_idp.rst new file mode 100644 index 000000000..72d22af07 --- /dev/null +++ b/doc/sources/admin/index_idp.rst @@ -0,0 +1,11 @@ +Identity provider +================= + +.. toctree:: + :maxdepth: 1 + + idpcas + idpsaml + idpopenid + idpopenidconnect + issuerdbget diff --git a/doc/sources/admin/index_installation.rst b/doc/sources/admin/index_installation.rst new file mode 100644 index 000000000..f3d9a83d6 --- /dev/null +++ b/doc/sources/admin/index_installation.rst @@ -0,0 +1,9 @@ +Installation +============ + +.. toctree:: + :maxdepth: 2 + + index_beforeinstall + index_maininstall + index_afterinstall diff --git a/doc/sources/admin/index_maininstall.rst b/doc/sources/admin/index_maininstall.rst new file mode 100644 index 000000000..bc33797b2 --- /dev/null +++ b/doc/sources/admin/index_maininstall.rst @@ -0,0 +1,12 @@ +Main installation +================= + +.. toctree:: + :maxdepth: 1 + + installtarball + installdeb + installrpm + installsles + docker + nodehandler diff --git a/doc/sources/admin/index_minihowtos.rst b/doc/sources/admin/index_minihowtos.rst new file mode 100644 index 000000000..acd2cc1a5 --- /dev/null +++ b/doc/sources/admin/index_minihowtos.rst @@ -0,0 +1,19 @@ +Mini Howtos +=========== + +.. toctree:: + :maxdepth: 1 + + cli_examples + managerprotection + mysqlminihowto + ldapminihowto + restminihowto + soapminihowto + activedirectoryminihowto + kerberos + federationproxy + header_remote_user_conversion + renater + behindproxyminihowto + useoutgoingproxy diff --git a/doc/sources/admin/index_plugins.rst b/doc/sources/admin/index_plugins.rst new file mode 100644 index 000000000..e649f1d6a --- /dev/null +++ b/doc/sources/admin/index_plugins.rst @@ -0,0 +1,28 @@ +Plugins +======= + +.. toctree:: + :maxdepth: 1 + + autosignin + bruteforceprotection + cda + checkstate + checkuser + viewer + contextswitching + plugincustom + decryptvalue + loginhistory + forcereauthn + globallogout + grantsession + impersonation + notifications + status + public_pages + refreshsessionapi + resetpassword + resetcertificate + restservices + soapservices diff --git a/doc/sources/admin/index_portal.rst b/doc/sources/admin/index_portal.rst new file mode 100644 index 000000000..b3460acb4 --- /dev/null +++ b/doc/sources/admin/index_portal.rst @@ -0,0 +1,19 @@ +Portal configuration +==================== + +.. toctree:: + :maxdepth: 1 + + portal + portalcustom + portalmenu + portalservers + captcha + public_pages + secondfactor + index_protocols + index_authdb + index_idp + index_protection + index_plugins + diff --git a/doc/sources/admin/index_presentation.rst b/doc/sources/admin/index_presentation.rst new file mode 100644 index 000000000..feed2441b --- /dev/null +++ b/doc/sources/admin/index_presentation.rst @@ -0,0 +1,10 @@ +Presentation +============ + +.. toctree:: + :maxdepth: 1 + + presentation + features + quickstart + platformsoverview diff --git a/doc/sources/admin/index_protection.rst b/doc/sources/admin/index_protection.rst new file mode 100644 index 000000000..fd82acd4e --- /dev/null +++ b/doc/sources/admin/index_protection.rst @@ -0,0 +1,8 @@ +Attacks and Protection +====================== + +.. toctree:: + :maxdepth: 1 + + bruteforceprotection + safejail diff --git a/doc/sources/admin/index_protocols.rst b/doc/sources/admin/index_protocols.rst new file mode 100644 index 000000000..81e147e96 --- /dev/null +++ b/doc/sources/admin/index_protocols.rst @@ -0,0 +1,9 @@ +Standard SSO protocols +====================== + +.. toctree:: + :maxdepth: 1 + + samlservice + openidconnectservice + diff --git a/doc/sources/admin/index_sessiondb.rst b/doc/sources/admin/index_sessiondb.rst new file mode 100644 index 000000000..ece8a762a --- /dev/null +++ b/doc/sources/admin/index_sessiondb.rst @@ -0,0 +1,16 @@ +Sessions database +================= + +.. toctree:: + :maxdepth: 1 + + changesessionbackend + filesessionbackend + restsessionbackend + sqlsessionbackend + ldapsessionbackend + nosqlsessionbackend + mongodbsessionbackend + browseablesessionbackend + restsessionbackend + soapsessionbackend diff --git a/doc/sources/admin/monitoring.rst b/doc/sources/admin/monitoring.rst index 774e0cfb8..ac852ce53 100644 --- a/doc/sources/admin/monitoring.rst +++ b/doc/sources/admin/monitoring.rst @@ -1,6 +1,11 @@ Monitoring ========== +.. toctree:: + :hidden: + + mrtg + Handler can be monitored by using MRTG. See :doc:`MRTG monitoring`. diff --git a/doc/sources/admin/start.rst b/doc/sources/admin/start.rst index f51f29d34..7c9352e10 100644 --- a/doc/sources/admin/start.rst +++ b/doc/sources/admin/start.rst @@ -1,6 +1,46 @@ Documentation for LemonLDAP::NG 2.0 =================================== +.. toctree:: + :caption: Getting started + :hidden: + + index_presentation + index_installation + +.. toctree:: + :caption: Configuration + :hidden: + + index_firststeps + index_portal + index_handler + index_databases + +.. toctree:: + :caption: Application protection + :hidden: + + writingrulesand_headers + variables + selfmadeapplication + formreplay + customhandlers + webserviceprotection + applications/authbasic + applications + + +.. toctree:: + :caption: Advanced topics + :hidden: + + index_advanced + index_minihowtos + index_exploitation + index_dev + + Presentation ------------ @@ -345,9 +385,7 @@ Backend Shareable :ref: :doc:`MongoDB` ✔ ✔ ✔ ✔ Must be secured by network access control. :doc:`Browseable (SQL, Redis or LDAP)` ✔ ✔ ✔ ✔ **Optimized** for :doc:`session explorer` and :doc:`single session` features. :doc:`REST` |new| ✔ ✔ ✔ ✔ Proxy backend to be used in conjunction with another session backend. - **Can be used to secure another backend** for remote servers. :doc:`SOAP` |deprecated| ✔ ✔ ✔ ✔ Proxy backend to be used in conjunction with another session backend. - **Can be used to secure another backend** for remote servers. ================================================================ ========= ================================================ ==================================================== ================== =================================================================================================================================================================================================