FUSIONDIRECTORY.CONF(1)

📦 version 1.3, in ubuntu jammy

💖 FUSIONDIRECTORY.CONF(1) 💖

okay so bestie, welcome to the FusionDirectory Documentation, page one, section one — this is the fusiondirectory.conf manual and honestly? it's giving main character energy. grab a snack 🍓, we're doing this.

✨ NAME ✨

fusiondirectory.conf — the FusionDirectory configuration file. that's it, that's the name, slay 💅

🌸 DESCRIPTION 🌸

okay so the fusiondirectory.conf file is a XML style configuration file. FusionDirectory parses it during log in. it's super chill about formatting — the file may contain extra tabs and newlines purely for formatting purposes, no stress 🦋. tag keywords in the file are case-insensitive (iykyk). comments should live outside of XML tags and should be wrapped up inside <!-- --> tags.

the fusiondirectory.conf file can be used to configure the access control of the FusionDirectory webinterface. periodt.

🎀 Configuration layout 🎀

the configuration has to be specified inside of the <conf> tags. it's composed by a main configuration — including information about several locations.

layout example, no cap:

<?xml version="1.0"?>

   <conf>

     <!-- Global setup -->
     <main>

        <!-- Location specific setups -->
        <location name="">
    ...
        </location>

     </main>

   </conf>

🦋 Main section 🦋

the main section defines global settings, which might be overridden by each location definition inside of this global definition. (the way that it's a whole override hierarchy... obsessed.)

example layout:

<main default="Example Net" listSummary="false" ... >

   <location name="Example Net"
      logging="TRUE"
      forceSSL="TRUE"
       ...

       <referral uri="ldaps://ldap.example.net:636" base="dc=example,dc=net"
           admin="cn=fusiondirectory-admin,dc=example,dc=net"
           password="secret" />

    </location>

</main>

💅 Main section options 💅

  • forceSSL bool — the forceSSL statement turns on PHP security checks so encrypted access to the web interface is forced. FusionDirectory will try to redirect to the same URL just with https://. secure queen 🔒
  • logging bool — the logging statement enables event logging on the FusionDirectory side. set it to true and FusionDirectory will log every action a user performs via syslog. if you use rsyslog and configure it to mysql logging, you can browse all those events right inside FusionDirectory. and if the logging value is empty or set to false, FusionDirectory will log nothing. fr fr.
  • templateCompileDirectory path — the templateCompileDirectory statement defines the path where the PHP templating engine smarty should store its compiled FusionDirectory templates for improved speed. ⚠️ this path needs to be writeable by the user your webserver is running with.
  • ignoreAcl dn — the ignoreAcl value tells FusionDirectory to ignore complete ACL sets for the given DN. add your DN here and you'll be able to restore accidentally dropped ACLs. lifesaver behavior honestly 🫶
  • displayerrors bool — the displayerrors statement tells FusionDirectory to show PHP errors in the upper part of the screen. > this should be disabled in productive deployments, because there might be some important passwords around. 💀 do not leave this on in prod bestie.

🌈 Location section options 🌈

  • name string — the name of this location section that will appear in the dropdown on the FusionDirectory homepage. it's the little label, the vibe check of the location ✨
  • config dn — the config statement defines the LDAP base where FusionDirectory stores management information, such as site wide locking and user notifications.
  • debuglevel integer — the debuglevel value tells FusionDirectory to display certain information on each page load. the value is an OR combination of the following byte values:
    • DEBUG_TRACE = 1
    • DEBUG_LDAP = 2
    • DEBUG_DB = 4
    • DEBUG_SHELL = 8
    • DEBUG_POST = 16
    • DEBUG_SESSION = 32
    • DEBUG_CONFIG = 64
    • DEBUG_ACL = 128
    • DEBUG_ARGONAUT = 256
    • DEBUG_MAIL = 512

⭐ LDAP options ⭐

  • ldapTLS bool — the ldapTLS statement enables or disables TLS operating on LDAP connections. 🔐
  • ldapFollowReferrals bool — the ldapFollowReferrals statement tells FusionDirectory to follow LDAP referrals. go where the directory points, bestie 🧚

🧚 LDAP resource definition 🧚

for every location you define inside your fusiondirectory.conf, you need at least one entry of the type referral. these entries define the way how to connect to some directory service.

example:

<referral uri="ldap://ldap.example.net" base="dc=example,dc=net"
    admin="cn=fusiondirectory-admin,dc=example,dc=net"
    password="secret" />

so: uri is a valid LDAP uri. base is the base this referral is responsible for. admin is the DN which has the permission to write LDAP entries. and password is the corresponding password for this DN. 🔑 you can define a set of referrals if you have several servers to connect to — collect them like stickers.

💀 BUGS 💀

please report any bugs, or post any suggestions, to the fusiondirectory mailing list fusiondirectory-users or to https://gitlab.fusiondirectory.org/fusiondirectory/fd/issues/new. they wanna hear from you, no cap 🙈

this code is part of FusionDirectory http://www.fusiondirectory.org

  • Copyright (C) 2003-2010 GONICUS GmbH
  • Copyright (C) 2011-2018 FusionDirectory project

this program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. see the GNU General Public License for more details.

and that's the whole page, bestie!! 🎀 this was FusionDirectory 1.3, dated 2019-02-07 — shoutout to the FUSIONDIRECTORY.CONF(1) footer for the receipts. go configure something iconic 💖✨🦋

📦 where this page comes from