Portal menu

Note

The menu is displayed if authentication is successful.

Menu modules

LemonLDAP::NG portal menu proposes 5 modules:

• Application list: display categories and applications allowed for the user

• Login history: display user’s last logins and failed logins

• Password change: form to change password

• OIDC consents: display user’s OpenId Connect consents

• OIDC offline tokens: display user’s OpenId Connect sessions with offline tokens (needs offline session tab plugin to be enabled)

• Logout: logout button

• Display order: list used for sorting modules (default: Appslist ChangePassword LoginHistory OidcConsents Logout)

Each module can be activated through a rule, using user session information. These rules can be set through Manager: General Parameters > Portal > Menu > Modules activation.

You can use 0 or 1 to disable/enable the module, or use a more complex rule. For example, to display the password change form only for user authenticated through LDAP or DBI:

$_auth eq LDAP or $_auth eq DBI

You can sort menu tabs by setting the module order option for each module.

Categories and applications

Configuring the virtual hosts is not enough to display an application in applications menu. Indeed, a virtual host can serve several applications (http://vhost.example.com/appli1, http://vhost.example.com/appli2).

In Manager, you can configure categories and applications by using General Parameters > Portal > Menu > Categories and applications.

Application parameters:

• Name: display text

• Description

• URI: URL of the application

• Tooltip: information display on mouse over the button

• Translation key: optional, see below

• Logo: file name to use as logo (you can also use a Font Awesome icon code)

• Display application:

  • Enabled: always displayed

  • Disabled: never displayed

  • Automatic: displayed only if the user can access it

  • Special rule: define a rule or “sp: <name>” where “name” is the key name of the service provider, the corresponding rule will be applied (available for CAS, SAML or OpenID-Connect)

Tip

Categories and applications are displayed in alphabetical order. Applications are displayed based on access rule only to propose the reauthentication mechanism. It means that authentication level is not taken into account. To hide applications depending on authentication level, you have to append an authentication level condition like this: $uid eq ‘dwho’ && $authenticationLevel == 5

Tip

The chosen logo file must be in portal applications logos directory (portal/htdocs/static/common/apps/). You can set a custom logo by setting the logo file name directly in the field, and copy the logo file in portal applications logos directory

Translating categories and applications

New in version 2.23.5.

Categories and applications are displayed as configured, in every language. To translate one of them, give it a Translation key in the Manager (letters, digits and underscores only), then define this key in a lang file of the skin templates directory (see portal customization). For an application whose key is myApp:

• myApp translates its name

• myApp_desc translates its description

• myApp_tip translates its tooltip (if no tooltip is set in the Manager, the tooltip is the name, translated by myApp)

The name, the description and the tooltip set in the Manager are used when there is no translation in the current language.

A category only uses its key. For example templates/bootstrap/fr.json:

{
  "myCategory": "Mes applications",
  "myApp": "Mon application",
  "myApp_desc": "Une application de démonstration"
}

An application without description in the Manager only has a description in the languages that define its _desc key. The categories and applications of the default configuration use keys starting with menu that are already translated.