diff --git a/doc/sources/admin/contribute.rst b/doc/sources/admin/contribute.rst index 78d916b6c..064713184 100644 --- a/doc/sources/admin/contribute.rst +++ b/doc/sources/admin/contribute.rst @@ -37,14 +37,14 @@ Go to your gitlab account : https://gitlab.ow2.org/profile/keys cat ~/.ssh/id_rsa.pub -copy id_rsa.pub content to key section and enter a name into "Title" -tans "Add key" button Test ssh connexion : +Copy id_rsa.pub content to key section and enter a name into "Title" and click "Add key" button. +Test ssh connexion : :: ssh -T git@gitlab.com -accept messages +Accept messages Install basic tools ------------------- @@ -52,13 +52,13 @@ Install basic tools Debian ^^^^^^ -*root :* +As *root :* :: apt install aptitude aptitude install vim make devscripts yui-compressor git git-gui libjs-uglify coffeescript cpanminus autopkgtest pkg-perl-autopkgtest - aptitude install libauth-yubikey-webclient-perl libnet-smtp-server-perl + aptitude install libauth-yubikey-webclient-perl libnet-smtp-server-perl libtime-fake-perl libtest-output-perl libtest-pod-perl libtest-leaktrace-perl cpanm Authen::U2F Authen::U2F::Tester Crypt::U2F::Server::Simple @@ -71,7 +71,7 @@ Debian Configure Git ^^^^^^^^^^^^^ -*user :* +As *user :* :: @@ -85,7 +85,7 @@ Configure Git Import Project and using Git ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -*user :* create directory in directory : +As *user*, create directory in directory: :: @@ -98,7 +98,7 @@ Import Project and using Git git checkout v2.0 # to change branch git fetch upstream -*import version branch* *on linux station :* +Import version branch on linux station: :: @@ -106,8 +106,7 @@ Import Project and using Git git fetch upstream git rebase upstream/v2.0 # to align to parent project remote branch -*on gitlab, create working branch, one per thematic* *on linux station -:* +On gitlab, create working branch, one per thematic on linux station: :: @@ -141,6 +140,12 @@ For SAML: Working Project --------------- +Configure hosts file +^^^^^^^^^^^^^^^^^^^^ +:: + + echo '127.0.0.1 auth.example.com manager.example.com test1.example.com test2.example.com' >> /etc/hosts + Unit tests ^^^^^^^^^^ diff --git a/doc/sources/admin/presentation.rst b/doc/sources/admin/presentation.rst index d1d9a0d7f..80f878ca0 100644 --- a/doc/sources/admin/presentation.rst +++ b/doc/sources/admin/presentation.rst @@ -26,7 +26,7 @@ Main components `CAS `__). Futhermore, Portal affordes many other features (see :doc:`portal` for more) -- **Handler**: used to protect applications which can read HTTP headers +- :doc:`Handler`: used to protect applications which can read HTTP headers or environment variables to get user information Databases @@ -36,7 +36,7 @@ Databases .. attention:: We call "database" a backend where we can read or write a data. - This can be a file, an LDAP directory, ... + This can be a file, an LDAP directory, etc. We split databases in two categories: @@ -130,12 +130,13 @@ Session expiration ~~~~~~~~~~~~~~~~~~ The session expires after 20 hours by default. +This duration can be set in the manager's Configuration tab (General Parameters > Sessions > Sessions Timeout). .. attention:: - Handlers have a session cache, with a default lifetime of 10 minutes. - So for Handlers on different physical servers than the Portal, a user - with an expired session can still be authorized till the cache + So for Handlers located on different physical servers than the Portal, a user + with an expired session can still be authorized until the cache expires. - Sessions are deleted by a scheduled task. Don't forget to install cron files ! diff --git a/doc/sources/admin/writingrulesand_headers.rst b/doc/sources/admin/writingrulesand_headers.rst index 4b1ff8c17..f1b7af388 100644 --- a/doc/sources/admin/writingrulesand_headers.rst +++ b/doc/sources/admin/writingrulesand_headers.rst @@ -1,7 +1,7 @@ Writing rules and headers ========================= -Lemonldap::NG manage applications by their hostname (Apache's +Lemonldap::NG manages applications by their hostname (Apache's virtualHosts). Rules are used to protect applications, headers are HTTP headers added to the request to give datas to the application (for logs, profiles,...). diff --git a/lemonldap-ng-handler/t/01-Lemonldap-NG-Handler-Main.t b/lemonldap-ng-handler/t/01-Lemonldap-NG-Handler-Main.t index 5ece1a328..44e8eb27f 100644 --- a/lemonldap-ng-handler/t/01-Lemonldap-NG-Handler-Main.t +++ b/lemonldap-ng-handler/t/01-Lemonldap-NG-Handler-Main.t @@ -14,7 +14,7 @@ use lib dirname( abs_path $0 ); ######################### # Insert your test code below, the Test::More module is used here so read -# its man page ( perldoc Test::More ) for help writing this test script. +# its man page (perldoc Test::More) for help writing this test script. my $h; $h = 'Lemonldap::NG::Handler::Test'; $ENV{SERVER_NAME} = "test1.example.com";