Commit b9caa2fe authored by bmortier's avatar bmortier
Browse files

Merge branch '170-document-the-mailinblack-plugin' into '1.4'

Resolve "document the mailinblack plugin"

Closes #170

See merge request fusiondirectory/user-manual!319
parents fbd80c59 f208a3be
......@@ -35,6 +35,7 @@ FusionDirectory Plugins
ldapdump/index
ldapmanager/index
mail/index
mailinblack/index
migration-mailrouting/index
mixedgroups/index
netgroups/index
......
Description
===========
The mailinblack plugin manage the status of the users in the `Mailinblack`_ solution
.. _`Mailinblack`: https://www.mailinblack.com/
.. include:: /globals.rst
Functionalities
===============
* Edit a user
In FusionDirectory, click on users icon
.. image:: images/personal-user.png
:alt: Picture of users icon in FusionDirectory
This will bring you to the users overview
.. image:: images/personal-users-tab.png
:alt: Picture of users overview in FusionDirectory
Click on a user and go to mailinblack tab
.. image:: images/mailinblack-tab.png
:alt: Picture of mailinblack tab in FusionDirectory
In this example, I selected peter antoine's profile
.. image:: images/personal-peter-antoine.png
:alt: Picture of peter antoine user in FusionDirectory
Activate the mailinblack tab
.. image:: images/user-mailinblackuser-main.png
:alt: Screenshot of section Mailinblack of tab Mailinblack of type User
* Protect: Whether this user is in protect mode in Mailinblack
Click on "Apply" button bottom right
.. image:: images/personal-apply-button.png
:alt: Picture of Apply button in FusionDirectory
Now, if you go back to user list, you will see a new icon that defines that the mailinblack plugin is activated for your user
.. image:: images/mailinblack-icon.png
:alt: Picture of Mailinblack icon in FusionDirectory
In FusionDirectory, you get a Mailinblack tab on users, which you should activate on users you want synchronized. Then you can check the checkbox if you want the user to be protected.
LDAP Filters
^^^^^^^^^^^^
In mailinblack use :
* ``(objectClass=fdMailInBlackUser)`` as synchronisation filter
* ``(fdMailInBlackProtect=TRUE)`` as protection filter.
mailinblack
===========
FusionDirectory Plugins Mailinblack
.. toctree::
:maxdepth: 2
description
installation
functionalities
Installation
============
Install packages
----------------
Debian
^^^^^^
.. code-block:: bash
apt-get install fusiondirectory-plugin-mailinblack
apt-get install fusiondirectory-plugin-mailinblack-schema
RHEL
^^^^
.. code-block:: bash
yum install fusiondirectory-plugin-mailinblack
yum install fusiondirectory-plugin-mailinblack-schema
Install schemas
---------------
Debian
^^^^^^
.. code-block:: bash
fusiondirectory-insert-schema -i /etc/ldap/schema/fusiondirectory/mailinblack-fd.schema
RHEL
^^^^
.. code-block:: bash
fusiondirectory-insert-schema -i /etc/ldap/schema/fusiondirectory/mailinblack-fd.schema
[Dolphin]
Timestamp=2019,6,7,9,50,25
Version=3
ViewMode=2
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment