artefactual / atom-docs

Access to Memory (AtoM) documentation
https://www.accesstomemory.org/docs
Creative Commons Attribution Share Alike 4.0 International
17 stars 26 forks source link

Problem: LDAP documentation does not tell users that an additional PHP extension is required #255

Open fiver-watson opened 7 months ago

fiver-watson commented 7 months ago

Documentation version

Relevant documentation pages

Issue description

Per this recent discussion in the user forum from 2024-01-29:

It seems that an additional PHP extension is required to be able configure LDAP: the php-ldap package. See:

This can be installed with:

sudo apt-get install php-ldap

The suggestion of installing this extension came from Santi (via Slack, also on Jan 29). The forum user who prompted this question later PM'ed to confirm that installing the PHP extension did resolve the issue and allow her to configure the LDAP module.

However, this requirement is not documented anywhere.

Suggested fix

Add an IMPORTANT admonition at the beginning of the LDAP configuration instructions clarifying that the php-ldap extension must be installed first. Include the install command for Ubuntu, and the link provided above (or similar) for more information about the extension itself.