dani/lemonldap-ng
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Add toctree

Browse Source
This commit is contained in:
Maxime Besson 2020-05-24 00:24:10 +02:00
parent c9cb92f0cb
commit 573f9cdbbe
24 changed files with 405 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
doc/sources/admin/applications.rst
View File

@ -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<applications/symfony>` ✔
.. image:: applications/sympa_logo.png :doc:`Sympa<applications/sympa>` ✔
.. image:: applications/tomcat_logo.png :doc:`Tomcat<applications/tomcat>` ✔
.. image:: applications/wekan-logo.png :doc:`Wekan<applications/wekan>` ✔
.. image:: applications/wordpress_logo.png :doc:`Wordpress<applications/wordpress>` ✔
.. image:: applications/xwiki.png :doc:`XWiki<applications/xwiki>` ✔
.. image:: applications/zimbra_logo.png :doc:`Zimbra<applications/zimbra>` ✔

8
doc/sources/admin/authopenidconnect.rst
View File

@ -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
=============== ==================

28
doc/sources/admin/index_advanced.rst Normal file
View File

@ -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

10
doc/sources/admin/index_afterinstall.rst Normal file
View File

@ -0,0 +1,10 @@
After installation
==================
.. toctree::
:maxdepth: 1
confignginx
configapache
configplack

44
doc/sources/admin/index_authdb.rst Normal file
View File

@ -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

9
doc/sources/admin/index_beforeinstall.rst Normal file
View File

@ -0,0 +1,9 @@
Before installation
===================
.. toctree::
:maxdepth: 1
prereq
download
upgrade

15
doc/sources/admin/index_configdb.rst Normal file
View File

@ -0,0 +1,15 @@
Configuration database
======================
.. toctree::
:maxdepth: 1
changeconfbackend
fileconfbackend
yamlconfbackend
sqlconfbackend
ldapconfbackend
mongodbconfbackend
soapconfbackend
restconfbackend
localconfbackend

9
doc/sources/admin/index_databases.rst Normal file
View File

@ -0,0 +1,9 @@
LemonLDAP::NG Databases
=======================
.. toctree::
:maxdepth: 2
index_configdb
index_sessiondb

10
doc/sources/admin/index_dev.rst Normal file
View File

@ -0,0 +1,10 @@
Development
===========
.. toctree::
:maxdepth: 1
bugreport
contribute
handlerarch
customhandlers

15
doc/sources/admin/index_exploitation.rst Normal file
View File

@ -0,0 +1,15 @@
Exploitation
============
.. toctree::
:maxdepth: 1
performances
security
selinux
status
checkstate
monitoring
logs
error
highavailability

12
doc/sources/admin/index_firststeps.rst Normal file
View File

@ -0,0 +1,12 @@
Configuration first steps
=========================
.. toctree::
:maxdepth: 1
configlocation
ssocookie
redirections
exportedvars
configvhost
sessions

15
doc/sources/admin/index_handler.rst Normal file
View File

@ -0,0 +1,15 @@
Handlers
========
.. toctree::
:maxdepth: 1
handlerauthbasic
cda
ssoaas
servertoserver
oauth2handler
securetoken
servertoserver
devopshandler
devopssthandler

11
doc/sources/admin/index_idp.rst Normal file
View File

@ -0,0 +1,11 @@
Identity provider
=================
.. toctree::
:maxdepth: 1
idpcas
idpsaml
idpopenid
idpopenidconnect
issuerdbget

9
doc/sources/admin/index_installation.rst Normal file
View File

@ -0,0 +1,9 @@
Installation
============
.. toctree::
:maxdepth: 2
index_beforeinstall
index_maininstall
index_afterinstall

12
doc/sources/admin/index_maininstall.rst Normal file
View File

@ -0,0 +1,12 @@
Main installation
=================
.. toctree::
:maxdepth: 1
installtarball
installdeb
installrpm
installsles
docker
nodehandler

19
doc/sources/admin/index_minihowtos.rst Normal file
View File

@ -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

28
doc/sources/admin/index_plugins.rst Normal file
View File

@ -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

19
doc/sources/admin/index_portal.rst Normal file
View File

@ -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

10
doc/sources/admin/index_presentation.rst Normal file
View File

@ -0,0 +1,10 @@
Presentation
============
.. toctree::
:maxdepth: 1
presentation
features
quickstart
platformsoverview

8
doc/sources/admin/index_protection.rst Normal file
View File

@ -0,0 +1,8 @@
Attacks and Protection
======================
.. toctree::
:maxdepth: 1
bruteforceprotection
safejail

9
doc/sources/admin/index_protocols.rst Normal file
View File

@ -0,0 +1,9 @@
Standard SSO protocols
======================
.. toctree::
:maxdepth: 1
samlservice
openidconnectservice

16
doc/sources/admin/index_sessiondb.rst Normal file
View File

@ -0,0 +1,16 @@
Sessions database
=================
.. toctree::
:maxdepth: 1
changesessionbackend
filesessionbackend
restsessionbackend
sqlsessionbackend
ldapsessionbackend
nosqlsessionbackend
mongodbsessionbackend
browseablesessionbackend
restsessionbackend
soapsessionbackend

5
doc/sources/admin/monitoring.rst
View File

@ -1,6 +1,11 @@
Monitoring
==========
.. toctree::
:hidden:
mrtg
Handler can be monitored by using MRTG. See
:doc:`MRTG monitoring<mrtg>`.

42
doc/sources/admin/start.rst
View File

@ -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<mongodbsessionbackend>` ✔ ✔ ✔ ✔ Must be secured by network access control.
:doc:`Browseable (SQL, Redis or LDAP)<browseablesessionbackend>` ✔ ✔ ✔ ✔ **Optimized** for :doc:`session explorer<features>` and :doc:`single session<features>` features.
:doc:`REST<restsessionbackend>` |new| ✔ ✔ ✔ ✔ Proxy backend to be used in conjunction with another session backend.
**Can be used to secure another backend** for remote servers.
:doc:`SOAP<soapsessionbackend>` |deprecated| ✔ ✔ ✔ ✔ Proxy backend to be used in conjunction with another session backend.
**Can be used to secure another backend** for remote servers.
================================================================ ========= ================================================ ==================================================== ================== =================================================================================================================================================================================================