.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "FUSIONDIRECTORY.CONF 1"
.TH FUSIONDIRECTORY.CONF 1 "2016-11-02" "FusionDirectory 1.0.19" "FusionDirectory Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
fusiondirectory.conf \- FusionDirectory configuration file
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The fusiondirectory.conf file is a \s-1XML\s0 style configuration file. It is parsed by FusionDirectory during log in.  The file may contain extra tabs and newlines for formatting purposes.  Tag keywords in the file are case-insensitive. Comments should be placed outside of \s-1XML\s0 tags and should  be  encapsulated  inside  of <!\-\- \-\-> tags.
.PP
The fusiondirectory.conf file can be used to configure the access control of the FusionDirectory webinterface.
.SS "Configuration layout"
.IX Subsection "Configuration layout"
The configuration has to be specified inside of the <conf> tags. It is composed by a main configuration \- including information about several locations.
.PP
Layout example:
.PP
<?xml version=\*(L"1.0\*(R"?>
.PP
.Vb 1
\&   <conf>
\&
\&     <!\-\- Global setup \-\->
\&     <main>
\&
\&        <!\-\- Location specific setups \-\->
\&        <location name="">
\&    ...
\&        </location>
\&
\&     </main>
\&
\&   </conf>
.Ve
.SS "Main section"
.IX Subsection "Main section"
The main section defines global settings, which might be overridden by each location definition inside of this global definition.
.PP
Example layout:
.PP
<main default=\*(L"Example Net\*(R" listSummary=\*(L"false\*(R" ... >
.PP
.Vb 4
\&   <location name="Example Net"
\&      logging="TRUE"
\&      forceSSL="TRUE"
\&       ...
\&
\&       <referral uri="ldaps://ldap.example.net:636/dc=example,dc=net"
\&           admin="cn=fusiondirectory\-admin,dc=example,dc=net"
\&           password="secret" />
\&
\&    </location>
.Ve
.PP
</main>
.SS "Main section options"
.IX Subsection "Main section options"
.IP "\fBforceSSL\fR \fIbool\fR" 4
.IX Item "forceSSL bool"
The forceSSL statement enables \s-1PHP\s0 security checks to force encrypted access to the web interface. FusionDirectory will try to redirect to the same \s-1URL\s0 just  with https://.
.IP "\fBlogging\fR \fIbool\fR" 4
.IX Item "logging bool"
The logging statement enables event logging on FusionDirectory side. Setting it to true, FusionDirectory will log every action a user performs via syslog.  If  you  use rsyslog and configure it to mysql logging, you can browse all events within FusionDirectory.
FusionDirectory will not log anything, if the logging value is empty or set to false.
.IP "\fBtemplateCompileDirectory\fR \fIpath\fR" 4
.IX Item "templateCompileDirectory path"
The templateCompileDirectory statements defines the path, where the \s-1PHP\s0 templating engins smarty should store its compiled FusionDirectory templates for improved speed.
This path needs to be writeable by the user your webserver is running with.
.IP "\fBignoreAcl\fR \fIdn\fR" 4
.IX Item "ignoreAcl dn"
The ignoreAcl value tells FusionDirectory to ignore complete \s-1ACL\s0 sets for the given \s-1DN.\s0 Add your \s-1DN\s0 here and you'll be able to restore accidentally dropped ACLs.
.IP "\fBdisplayerrors\fR bool" 4
.IX Item "displayerrors bool"
The  displayerrors  statement tells FusionDirectory to show \s-1PHP\s0 errors in the upper part of the screen. This should be disabled in productive deployments, because there
might be some important passwords around.
.SS "Location section options"
.IX Subsection "Location section options"
.IP "\fBname\fR \fIstring\fR" 4
.IX Item "name string"
The name of this location section that will appear in the dropdown on FusionDirectory homepage
.IP "\fBconfig\fR \fIdn\fR" 4
.IX Item "config dn"
The config statement defines the \s-1LDAP\s0 base, where FusionDirectory stores management information, such as site wide locking and user notifications.
.IP "\fBdebuglevel\fR \fIinteger\fR" 4
.IX Item "debuglevel integer"
The debuglevel value tells FusionDirectory to display certain information on each page load. Value is an \s-1OR\s0 combination of the following byte values :
.Sp
\&\s-1DEBUG_TRACE   \s0 = 1
.Sp
\&\s-1DEBUG_LDAP    \s0 = 2
.Sp
\&\s-1DEBUG_DB      \s0 = 4
.Sp
\&\s-1DEBUG_SHELL   \s0 = 8
.Sp
\&\s-1DEBUG_POST    \s0 = 16
.Sp
\&\s-1DEBUG_SESSION \s0 = 32
.Sp
\&\s-1DEBUG_CONFIG  \s0 = 64
.Sp
\&\s-1DEBUG_ACL     \s0 = 128
.Sp
\&\s-1DEBUG_ARGONAUT\s0 = 256
.Sp
\&\s-1DEBUG_MAIL    \s0 = 512
.SS "\s-1LDAP\s0 options"
.IX Subsection "LDAP options"
.IP "\fBldapTLS\fR \fIbool\fR" 4
.IX Item "ldapTLS bool"
The ldapTLS statement enables or disables \s-1TLS\s0 operating on \s-1LDAP\s0 connections.
.IP "\fBldapFollowReferrals\fR \fIbool\fR" 4
.IX Item "ldapFollowReferrals bool"
The ldapFollowReferrals statement tells FusionDirectory to follow \s-1LDAP\s0 referrals.
.SS "\s-1LDAP\s0 resource definition"
.IX Subsection "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.
.PP
Example:
.PP
.Vb 3
\&   <referral uri="ldap://ldap.example.net/dc=example,dc=net"
\&       admin="cn=fusiondirectory\-admin,dc=example,dc=net"
\&       password="secret" />
.Ve
.PP
uri is a valid \s-1LDAP\s0 uri extendet by the base this referral is responsible for.  admin is the \s-1DN\s0 which has the permission to write \s-1LDAP\s0 entries. And password is the corresponding password for this \s-1DN.\s0
You can define a set of referrals if you have several server to connect to.
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs, or post any suggestions, to the fusiondirectory mailing list fusiondirectory-users or to <https://forge.fusiondirectory.org/projects/fdirectory/issues/new>
.SH "LICENCE AND COPYRIGHT"
.IX Header "LICENCE AND COPYRIGHT"
This code is part of FusionDirectory <http://www.fusiondirectory.org>
.IP "Copyright (C) 2003\-2010 \s-1GONICUS\s0 GmbH" 2
.IX Item "Copyright (C) 2003-2010 GONICUS GmbH"
.PD 0
.IP "Copyright (C) 2011\-2016 FusionDirectory project" 2
.IX Item "Copyright (C) 2011-2016 FusionDirectory project"
.PD
.PP
This program is distributed in the hope that it will be useful, but \s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of \s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE. \s0 See the \s-1GNU\s0 General Public License for more details.