Hesk-Plugin: LDAP

An unofficial plugin for the Hesk.com Help Desk
Go to hesk.com »

Report Bug · Request Feature

Table of Contents

1. Table of Contents
2. About The Project
   • Built With
3. Getting Started
   • Prerequisites
   • Installation
4. Usage
5. Contributing
6. License

About The Project

This is a unofficial plugin for the Hesk.com Help Desk.

You can use it to connect the Help Desk with your LDAP-Server to synchronize your agents. All the synchronized agents get the admin-role by default.

Here's why:

• An LDAP-Connection is a requested functionality in the community
• It's always a good idea to use LDAP 😄

(back to top)

Built With

• 

(back to top)

Getting Started

Just a few steps and you can use LDAP on Hesk.

Prerequisites

You need to enable the LDAP-extension in the php.ini

• Windows (XAMPP)

  extension=ldap

• Linux
  For Debian, the installation command would be apt-get install php-ldap.
  For RHEL based systems, the command would be yum install php-ldap.

  extension=php_ldap.so

  (/etc/php/[verion]/apache2/php.ini)
  Don't forget to restart the service after the changes: service apache2 restart

More »

Installation

1. Download and install hesk (Download · Step by step install guide)
2. Clone the repo

   git clone https://github.com/domidodo/HeskPlugin_LDAP.git

3. Copy the plugin-directory into your hest-root-directory

   cp -r HeskPlugin_LDAP/plugin/* /var/www/html/hesk/plugin/

4. Open ldap_settings.inc.php and setup your LDAP-connection

   nano plugin/ldap_settings.inc.php

5. Setup the Cronjob by crontab

   crontab -e

   and add this line:

   */5 * * * * curl -s http://127.0.0.1/hesk/plugin/ldap.php?key=[##URL Access Key##] > /dev/null # Every 5 minutes

   If you have URL Access Key set in Admin panel > Settings > Help desk > Security > URL Access Key (which you should), you will need to replace [##URL Access Key##] with it to access it via an URL addres.
6. reload Cronjob-service

   service cron reload

(back to top)

Usage

Your agents will by synchronized in the time interval specified in the cron job.

It is not posible to edit the LDAP-User-Password over the Hesk-UI. If yout try it, it will have no effect.

It is posible to add local Hesk-User. They can edit the password over the Hesk-UI.

If there is a LDAP-User with the same mail-address like a local Hesk-User, both accounts will be linked and the LDAP-user-password will be the valid one.

For the case that the LDAP server cannot be reached, the passwords are encrypted stored in the database.

(back to top)

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the Apache License 2.0 License. See LICENSE for more information.

(back to top)