tituspijean / flarum-ext-auth-ldap
Allow users to log in through LDAP.
Installs: 4 647
Dependents: 0
Suggesters: 0
Security: 0
Stars: 20
Watchers: 6
Forks: 12
Open Issues: 9
Language:JavaScript
Type:flarum-extension
Requires
- directorytree/ldaprecord: v2.11.1
- flarum/core: ^1.0
- dev-testing
- dev-master
- v1.0.0-p6
- v1.0.0-p5
- v1.0.0-p4
- v1.0.0-p3
- v1.0.0-p2
- v1.0.0-p1
- v0.1.0-beta.16-1
- v0.1.0-beta.13-5
- v0.1.0-beta.13-4
- v0.1.0-beta.13-3
- v0.1.0-beta.13-2
- v0.1.0-beta.13-1
- v0.1.0-beta.12-2
- v0.1.0-beta.12-1
- v0.1.0-beta.12
- dev-dependabot/npm_and_yarn/js/testing/webpack-5.91.0
- dev-optional-email
This package is auto-updated.
Last update: 2024-11-20 20:42:16 UTC
README
This extension enables users to log into Flarum through LDAP.
How to install
composer require tituspijean/flarum-ext-auth-ldap
and activate it in Flarum's administration panel.
Languages
This extension is translated in French and English.
Configuration
LDAP server name
: sets the end of theLogin with
link at the top of the forum:LDAP domains or server IP adresses (comma separated)
: list of LDAP servers to use.Base DNs (semicolon separated)
: list of base DNs to search users in.Filter to apply (optional)
: Additional filtering, for example require users to be in a specific group.Port
: LDAP server portFollow referrals
,Use SSL
,Use TLS
: LDAP server settingsLDAP admin distinguished name
andLDAP admin password (leave empty for anonymous binding)
: if needed, specific the DN and password of the user allowed to perform searches in the LDAP server.LDAP user search fields (comma separed)
: list of the LDAP fields used to look for the users. The extension will try all combinations of base DNs and search fields.LDAP user mail field
: name of the field containing the user's email address. The extension will use the first email found for the user's registration in Flarum.LDAP username field
: name of the field containing the username that uniquely identifies the user. Can beuid
orsAMAccountname
, for example.Disable Flarum login and only use LDAP authentication
: merely hides the standard login links and buttons. Users can still use the standard login method through the API.
Development (With docker)
- Clone the repository
- Copy docker.conf :
cp docker/.docker.conf.dist docker/.docker.conf
- Change UID in
docker/.docker.conf
if needed. - Start dockers :
./install.sh install
- Open http://flarum.localhost
- MySQL host: mysql
- MySQL DB: flarum
- MySQL user: flarum
- MySQL password: flarum
- Go to Admin panel and enable extension
- LDAP domain: ldap
- LDAP DN: dc=flarum,dc=com
- Check connect with Ldap admin
- LDAP admin: cn=admin,dc=flarum,dc=com
- LDAP admin password: flarum
- LDAP search user fields: cn,mail
- LDAP user mail: mail
- LDAP user username: cn
- Add and user on : http://localhost:8081/
- Login: cn=admin,dc=flarum,dc=com
- Password: flarum
- Create a new entry -> Default -> inetOrgPerson