.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.14)
.\"
.\" 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" ''
'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.
.ie \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.el \{\
. de IX
..
.\}
.\"
.\" 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 1"
.TH FUSIONDIRECTORY 1 "2013-04-23" "FusionDirectory 1.0" "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 \- FusionDirectory configuration parameters
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
FusionDirectory have lots of options that can alter the way it works, find informations or specific configuration can be achieved.
All those paarameters are configured with the help of the configuration plugin inside FusionDirectory and saved into the ldap tree.
.SS "Generic options"
.IX Subsection "Generic options"
.IP "\fBwarnSSL\fR \fIbool\fR" 4
.IX Item "warnSSL bool"
The warnSSL statement enables \s-1PHP\s0 security checks to detect non encrypted access to the web interface. FusionDirectory will display a warning in this case.
.IP "\fBmodificationDetectionAttribute\fR \fIstring\fR" 4
.IX Item "modificationDetectionAttribute string"
The modificationDetectionAttribute statement enables FusionDirectory to check if a entry currently being edited has been modified from someone else outside
FusionDirectory in the meantime. It will display an informative dialog then. It can be set to entryCSN for OpenLDAP based systems or contextCSN for Sun \s-1DS\s0 based systems.
.IP "\fBlogging\fR \fIstring\fR" 4
.IX Item "logging string"
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.
.Sp
FusionDirectory will not log anything, if the logging value is empty or set to false.
.IP "\fBloginAttribute\fR \fIstring\fR" 4
.IX Item "loginAttribute string"
The loginAttribute statement tells FusionDirectory which \s-1LDAP\s0 attribute is used as the login name during login. It can be set to uid, mail or both.
.IP "\fBcopyPaste\fR \fIbool\fR" 4
.IX Item "copyPaste bool"
The copyPaste statement enables copy and paste for \s-1LDAP\s0 entries managed with FusionDirectory.
.IP "\fBsnapshots\fR \fIbool\fR" 4
.IX Item "snapshots bool"
The snapshots statement enables a snapshot mechanism in FusionDirectory. This enables you to save certain states of entries and restore them later on.
.IP "\fBsnapshotBase\fR \fIdn\fR" 4
.IX Item "snapshotBase dn"
The snapshotBase statement defines the base where snapshots should be stored inside of the \s-1LDAP\s0.
.IP "\fBsnapshotURI\fR \fIuri\fR" 4
.IX Item "snapshotURI uri"
The snapshotURI variable defines the \s-1LDAP\s0 \s-1URI\s0 for the server which is used to do object snapshots.
.IP "\fBsnapshotAdminDn\fR \fIdn\fR" 4
.IX Item "snapshotAdminDn dn"
The snapshotAdminDn variable defines the user which is used to authenticate when connecting to snapshotURI.
.IP "\fBsnapshotAdminPassword\fR \fIstring\fR" 4
.IX Item "snapshotAdminPassword string"
The snapshotAdminPassword variable defines the credentials which are used in combination with snapshotAdminDn and snapshotURI in order to authenticate.
.IP "\fBtimezone\fR \fIstring\fR" 4
.IX Item "timezone string"
The timezone statements defines the timezone used inside of FusionDirectory to handle date related tasks, such as password expiery, vacation messages, etc. The timea\*^XX
zone value should be a unix conform timezone value like in /etc/timezone.
.IP "\fBhonourIvbbAttributes\fR \fIbool\fR" 4
.IX Item "honourIvbbAttributes bool"
The honourIvbbAttributes statement enables the \s-1IVBB\s0 mode inside of FusionDirectory. You need the ivbb.schema file from used by german authorities.
.IP "\fBstrictNamingRules\fR \fIbool\fR" 4
.IX Item "strictNamingRules bool"
The strictNamingRules statement enables strict checking of uids and group names. If you need characters like . or \- inside of your accounts, set this to false.
.IP "\fBallowUidProposalModification\fR \fIbool\fR" 4
.IX Item "allowUidProposalModification bool"
The allowUidProposalModification statement enables the abilitiy to modify uid proposals when creating a new user from a template.
.IP "\fBhonourUnitTags\fR \fIbool\fR" 4
.IX Item "honourUnitTags bool"
The honourUnitTags statement enables checking of unitTag attributes when using administrative units. If this is set to true FusionDirectory can only see objects inside
the administrative unit a user is logged into.
.IP "\fBrfc2307bis\fR \fIbool\fR" 4
.IX Item "rfc2307bis bool"
The rfc2307bis statement enables rfc2307bis style groups in FusionDirectory. You can use member attributes instead of memberUid in this case. To make it work on unix
systems, you've to adjust your \s-1NSS\s0 configuration to use rfc2307bis style groups, too.
.IP "\fBppdPath\fR \fIpath\fR" 4
.IX Item "ppdPath path"
The ppdPath variable defines where to store \s-1PPD\s0 files for the environment plugins.
.IP "\fBresolutions\fR \fIpath\fR" 4
.IX Item "resolutions path"
The resolutions variable defines a plain text file which contains additional resolutions to be shown in the environment and system plugins.
.IP "\fBhtaccessAuthentication\fR \fIbool\fR" 4
.IX Item "htaccessAuthentication bool"
The htaccessAuthentication variable tells FusionDirectory to use either htaccess authentication or \s-1LDAP\s0 authentication.
This can be used if you want to use i.e. kera\*^XXberos to authenticate the users.
.SS "Browser and display options"
.IX Subsection "Browser and display options"
.IP "\fBlistSummary\fR \fIbool\fR" 4
.IX Item "listSummary bool"
The listSummary statement determines whether a status bar will be shown on the bottom of FusionDirectory generated lists,
displaying a short summary of type and numberof elements in the list.
.IP "\fBiconsize\fR \fIsize value\fR" 4
.IX Item "iconsize size value"
The iconsize statement sets the icon size in the main menu. Its value should be something like 48x48.
.IP "\fBstoreFilterSettings\fR \fItrue/false\fR" 4
.IX Item "storeFilterSettings true/false"
The storeFilterSettings statement determines whether FusionDirectory should store filter and plugin settings inside of a cookie.
.IP "\fBlanguage\fR \fIstring\fR" 4
.IX Item "language string"
The language statement defines the default language used by FusionDirectory. Normally FusionDirectory autodetects the language
from the browser settings. If this is notworking or you want to force the language, just add the language code (i.e. de for german) here.
.IP "\fBtheme\fR \fIstring\fR" 4
.IX Item "theme string"
The theme statement defines what theme is used to display FusionDirectory pages. You can install some corporate identity
like theme and/or modify certain templates tofit your needs within themes. Take a look at the FusionDirectory \s-1FAQ\s0 for more information.
.IP "\fBsessionLifetime\fR \fIint\fR" 4
.IX Item "sessionLifetime int"
The sessionLifetime value defines when a session will expire in seconds. For Debian systems,
this will not work because the sessions will be removed by a cron jobinstead. Please modify the value inside of your php.ini instead.
.IP "\fBprimaryGroupFilter\fR \fIbool\fR" 4
.IX Item "primaryGroupFilter bool"
The primaryGroupFilter variable enables or disables the group filter to show primary user groups. It is time consuming to evaluate
which groups are primary and whichare not. So you may want to set it to false if your group plugin is slow.
.SS "Password options"
.IX Subsection "Password options"
.IP "\fBpasswordMinLength\fR \fIinteger\fR" 4
.IX Item "passwordMinLength integer"
The passwordMinLength statement determines whether a newly entered password has to be of a minimum length.
.IP "\fBpasswordMinDiffer\fR \fIinteger\fR" 4
.IX Item "passwordMinDiffer integer"
The passwordMinDiffer statement determines whether a newly entered password has to be checked to have at least n different characters.
.Sp
strictPasswordRules statement determines if we check for problematic unicode caracters in password creation
.IP "\fBhandleExpiredAccounts\fR \fIbool\fR" 4
.IX Item "handleExpiredAccounts bool"
The handleExpiredAccounts statement enables shadow attribute tests during the login to the FusionDirectory web interface and forces password renewal or account lockout.
.IP "\fBuseSaslForKerberos\fR \fIbool\fR" 4
.IX Item "useSaslForKerberos bool"
The useSaslForKerberos statement defines the way the kerberos realm is stored in the userPassword attribute.Set it to true in order to get
{sasl}user@REALM.NET, or tofalse to get {kerberos}user@REALM.NET. The latter is outdated, but may be needed from time to time.
.IP "\fBsaslRealm\fR \fIstring\fR" 4
.IX Item "saslRealm string"
The saslRealm statement defines the way the kerberos realm is stored in the userPassword attribute.
Set it to \s-1REALM\s0.NET in order to get {sasl}user@REALM.NET
.IP "\fBsaslExop\fR \fIstring\fR" 4
.IX Item "saslExop string"
The saslExop statement defines the attribute to be stored in the userPasword attribute. Set it to uid in order to get the {sasl}uid of the user
.SS "\s-1LDAP\s0 options"
.IX Subsection "LDAP options"
.IP "\fBldapMaxQueryTime\fR \fIinteger\fR" 4
.IX Item "ldapMaxQueryTime integer"
The ldapMaxQueryTime statement tells FusionDirectory to stop \s-1LDAP\s0 actions if there is no answer within the specified number of seconds.
.IP "\fBschemaCheck\fR \fIbool\fR" 4
.IX Item "schemaCheck bool"
The schemaCheck statement enables or disables schema checking during login. It is recommended to switch this on
in order to let FusionDirectory handle object creation more efficiently.
.IP "\fBaccountPrimaryAttribute\fR \fIcn/uid\fR" 4
.IX Item "accountPrimaryAttribute cn/uid"
The accountPrimaryAttribute option tells FusionDirectory how to create new accounts. Possible values are uid and cn.
.Sp
In the first case FusionDirectory creates uidstyle \s-1DN\s0 entries:
uid=superuser,ou=staff,dc=example,dc=net
.Sp
In the second case, FusionDirectory creates cn style \s-1DN\s0 entries:
cn=Foo Bar,ou=staff,dc=example,dc=net
.Sp
If you choose \*(L"cn\*(R" to be your accountPrimaryAttribute you can decide whether to include the personal title
in your dn by selecting personalTitleInDN.
.IP "\fBaccountRDN\fR \fIpattern\fR" 4
.IX Item "accountRDN pattern"
The accountRDN option tells FusionDirectory to use a placeholder pattern for generating account RDNs.
A pattern can include attribute names prefaced by a % and normal text:
.Sp
.Vb 1
\& accountRDN="cn=%sn %givenName"
.Ve
.Sp
This will generate a \s-1RDN\s0 consisting of cn=.... filled with surname and given name of the edited account.
This option disables the use of accountPrimaryAttribute and personalTitleInDn in your config.
The latter attributes are maintained for compatibility.
.IP "\fBpersonalTitleInDN\fR \fIbool\fR" 4
.IX Item "personalTitleInDN bool"
The personalTitleInDN option tells FusionDirectory to include the personal title in user DNs when accountPrimaryAttribute is set to \*(L"cn\*(R".
.IP "\fBuserRDN\fR \fIstring\fR" 4
.IX Item "userRDN string"
The userRDN statement defines the location where new accounts will be created inside of defined departments. The default is ou=people.
.IP "\fBgroupsRDN\fR string" 4
.IX Item "groupsRDN string"
The groupsRDN statement defines the location where new groups will be created inside of defined departments. The default is ou=groups.
.IP "\fBsudoRDN\fR \fIstring\fR" 4
.IX Item "sudoRDN string"
The sudoRDN statement defines the location where new groups will be created inside of defined departments. The default is ou=sudoers.
.IP "\fBsambaMachineAccountRDN\fR \fIstring\fR" 4
.IX Item "sambaMachineAccountRDN string"
This statement defines the location where FusionDirectory looks for new samba workstations.
.IP "\fBogroupRDN\fR \fIstring\fR" 4
.IX Item "ogroupRDN string"
This statement defines the location where FusionDirectory creates new object groups inside of defined departments. Default is ou=groups.
.IP "\fBserverRDN\fR \fIstring\fR" 4
.IX Item "serverRDN string"
This statement defines the location where FusionDirectory creates new servers inside of defined departments. Default is ou=servers.
.IP "\fBterminalRDN\fR \fIstring\fR" 4
.IX Item "terminalRDN string"
This statement defines the location where FusionDirectory creates new terminals inside of defined departments. Default is ou=terminals.
.IP "\fBworkstationRDN\fR \fIstring\fR" 4
.IX Item "workstationRDN string"
This statement defines the location where FusionDirectory creates new workstations inside of defined departments. Default is ou=workstations.
.IP "\fBprinterRDN\fR \fIstring\fR" 4
.IX Item "printerRDN string"
This statement defines the location where FusionDirectory creates new printers inside of defined departments. Default is ou=printers.
.IP "\fBcomponentRDN\fR \fIstring\fR" 4
.IX Item "componentRDN string"
This statement defines the location where FusionDirectory creates new network components inside of defined departments. Default is ou=components.
.IP "\fBphoneRDN\fR \fIstring\fR" 4
.IX Item "phoneRDN string"
This statement defines the location where FusionDirectory creates new phones inside of defined departments. Default is ou=phones.
.IP "\fBphoneConferenceRDN\fR \fIstring\fR" 4
.IX Item "phoneConferenceRDN string"
This statement defines the location where FusionDirectory creates new phone conferences inside of defined departments. Default is ou=conferences.
.IP "\fBphoneMacroRDN\fR \fIstring\fR" 4
.IX Item "phoneMacroRDN string"
This statement defines the location where FusionDirectory stores phone macros for use with the Asterisk phone server.
Default is ou=macros,ou=asterisk,ou=configs,ou=systems.
.IP "\fBfaxBlocklistRDN\fR \fIstring\fR" 4
.IX Item "faxBlocklistRDN string"
This statement defines the location where FusionDirectory creates new fax blocklists inside of defined departments. Default is ou=blocklists.
.IP "\fBsystemRDN\fR \fIstring\fR" 4
.IX Item "systemRDN string"
This statement defines the base location for servers, workstations, terminals, phones and components. Default is ou=systems.
.IP "\fBogroupRDN\fR \fIstring\fR" 4
.IX Item "ogroupRDN string"
This statement defines the location where FusionDirectory looks for object groups. Default is ou=groups.
.IP "\fBaclRoleRDN\fR \fIstring\fR" 4
.IX Item "aclRoleRDN string"
This statement defines the location where FusionDirectory stores \s-1ACL\s0 role definitions. Default is ou=aclroles.
.IP "\fBfaiBaseRDN\fR \fIstring\fR" 4
.IX Item "faiBaseRDN string"
This statement defines the location where FusionDirectory looks for \s-1FAI\s0 settings. Default is ou=fai,ou=configs,ou=systems.
.IP "\fBfaiScriptRDN, faiHookRDN, faiTemplateRDN, faiVariableRDN, faiProfileRDN, faiPackageRDN, faiPartitionRDN\fR \fIstring\fR" 4
.IX Item "faiScriptRDN, faiHookRDN, faiTemplateRDN, faiVariableRDN, faiProfileRDN, faiPackageRDN, faiPartitionRDN string"
These statement define the location where FusionDirectory stores \s-1FAI\s0 classes. The complete base for the corresponding class is an additive
of faiBaseRDN an and this value.
.IP "\fBdeviceRDN\fR \fIstring\fR" 4
.IX Item "deviceRDN string"
This statement defines the location where FusionDirectory looks for devices. Default is ou=devices.
.IP "\fBmimetypeRDN\fR \fIstring\fR" 4
.IX Item "mimetypeRDN string"
This statement defines the location where FusionDirectory stores mime type definitions.
Default is ou=mimetypes.
.IP "\fBapplicationRDN\fR \fIstring\fR" 4
.IX Item "applicationRDN string"
This statement defines the location where FusionDirectory stores application definitions. Default is ou=apps.
.IP "\fBldapFilterNestingLimit\fR \fIinteger\fR" 4
.IX Item "ldapFilterNestingLimit integer"
The ldapFilterNestingLimit statement can be used to speed up group handling for groups with several hundreds of members.
The default behaviour is, that FusionDirectory will resolv the memberUid values in a group to real names.
To achieve this, it writes a single filter to minimize searches. Some \s-1LDAP\s0 servers (namely Sun \s-1DS\s0) simply
crash when the filter gets too big. You can set a member limit, where FusionDirectory will stop to do these lookups.
.IP "\fBldapSizelimit\fR \fIinteger\fR" 4
.IX Item "ldapSizelimit integer"
The ldapSizelimit statement tells FusionDirectory to retrieve the specified maximum number of results. The user will get a warning, that not all entries were shown.
.IP "\fBldapFollowReferrals\fR \fIbool\fR" 4
.IX Item "ldapFollowReferrals bool"
The ldapFollowReferrals statement tells FusionDirectory to follow \s-1LDAP\s0 referrals.
.SS "Account creation options"
.IX Subsection "Account creation options"
.IP "\fBuidNumberBase\fR \fIinteger\fR" 4
.IX Item "uidNumberBase integer"
The uidNumberBase statement defines where to start looking for a new free user id.
This should be synced with your adduser.conf to avoid overlapping uidNumber values
between local and \s-1LDAP\s0 based lookups. The uidNumberBase can even be dynamic. Take a look at the baseIdHook definition below.
.IP "\fBgidNumberBase\fR \fIinteger\fR" 4
.IX Item "gidNumberBase integer"
The gidNumberBase statement defines where to start looking for a new free group id. This should be synced with your adduser.conf
to avoid overlapping gidNumber values between local and \s-1LDAP\s0 based lookups. The gidNumberBase can even be dynamic.
Take a look at the nextIdHook definition below.
.IP "\fBidAllocationMethod\fR \fItraditional/pool\fR" 4
.IX Item "idAllocationMethod traditional/pool"
The idAllocationMethod statement defines how FusionDirectory generates numeric user and group id values.
If it is set to traditional FusionDirectory will do create a lock and perform a search for the next free \s-1ID\s0.
The lock will be removed after the procedure completes.
If it is set to pool will use the sambaUnixIdPool objectclass settings inside your \s-1LDAP\s0.
This one is unsafe, because it does not check for concurrent \s-1LDAP\s0 access and already used IDs in this range.
On the other hand it is much faster.
.IP "\fBminId\fR \fIinteger\fR" 4
.IX Item "minId integer"
The minId statement defines the minimum assignable user or group id to avoid security leaks with uid 0 accounts. This is used for the traditional method
.IP "\fBuidNumberPoolMin/gidNumberPoolMin\fR \fIinteger\fR" 4
.IX Item "uidNumberPoolMin/gidNumberPoolMin integer"
The uidNumberPoolMin/gidNumberPoolMin statement defines the minimum assignable user/group id for use with the pool method.
.IP "\fBuidNumberPoolMax/gidNumberPoolMax\fR \fIinteger\fR" 4
.IX Item "uidNumberPoolMax/gidNumberPoolMax integer"
The uidNumberPoolMin/gidNumberPoolMin statement defines the highest assignable user/group id for use with the pool method.
.IP "\fBnextIdHook\fR \fIpath\fR" 4
.IX Item "nextIdHook path"
The nextIdHook statement defines a script to be called for finding the next free id for users or groups externaly.
It gets called with the current entry \*(L"dn\*(R" and the attribute to be \s-1ID\s0'd. It should return an integer value.
.IP "\fBhash\fR \fIstring\fR" 4
.IX Item "hash string"
The hash statement defines the default password hash to choose for new accounts.
Valid values are crypt/standard\-des, crypt/md5, crypt/enhanced\-des, crypt/blowfish, md5, sha, ssha, smd5, clear and sasl.
These values will be overridden when using templates.
.IP "\fBidGenerator\fR \fIstring\fR" 4
.IX Item "idGenerator string"
The idGenerator statement describes an automatic way to generate new user ids. There are two basic functions supported \- which can be combined:
.Sp
.Vb 1
\& a) using attributes
\&
\& You can specify LDAP attributes (currently only sn and givenName) in
\& braces {} and add a percent sign befor it. Optionally you can strip it
\& down to a number of characters, specified in []. I.e.
\&
\& idGenerator="{%sn}\-{%givenName[2\-4]}"
\&
\& will generate an ID using the full surname, adding a dash, and adding at
\& least the first two characters of givenName. If this ID is used, it\*(Aqll
\& use up to four characters. If no automatic generation is possible, a
\& input box is shown.
\&
\& b) using automatic id\*(Aqs
\&
\& I.e. specifying
\&
\& idGenerator="acct{id:3}"
\&
\& will generate a three digits id with the next free entry appended to
\& "acct".
\&
\& idGenerator="acct{id!1}"
\&
\& will generate a one digit id with the next free entry appended to
\& "acct" \- if needed.
\&
\& idGenerator="ext{id#3}"
\&
\&
\&
\& will generate a three digits random number appended to "ext".
.Ve
.SS "Samba options"
.IX Subsection "Samba options"
.IP "\fBsambaSID\fR \fIstring\fR" 4
.IX Item "sambaSID string"
The sambaSID statement defines a samba \s-1SID\s0 if not available inside of the \s-1LDAP\s0. You can retrieve the current sid by net getlocalsid.
.IP "\fBsambaRidBase\fR \fIinteger\fR" 4
.IX Item "sambaRidBase integer"
The sambaRidBase statement defines the base id to add to ordinary sid calculations \- if not available inside of the \s-1LDAP\s0.
.IP "\fBsambaidmapping\fR \fIbool\fR" 4
.IX Item "sambaidmapping bool"
The sambaidmapping statement tells FusionDirectory to maintain sambaIdmapEntry objects.
Depending on your setup this can drastically improve the windows login performance.
.SS "Asterisk options"
.IX Subsection "Asterisk options"
.IP "\fBctiHook\fR \fIpath\fR" 4
.IX Item "ctiHook path"
The ctiHook statement defines a script to be executed if someone clicks on a phone number inside of the addressbook plugin. It gets called with two parameters:
.Sp
.Vb 1
\& ctiHook $source_number $destination_number
\&
\& This script can be used to do automatted dialing from the addressbook.
.Ve
.IP "\fBasteriskParameterDelimiter\fR" 4
.IX Item "asteriskParameterDelimiter"
This defines the delimiter to be used when storing dialplan applications, since asterisk 1.8 the parameter delimiter for dialplan applications has changed from the pipe to comma, by default we use pipe.
.SS "Mail options"
.IX Subsection "Mail options"
.IP "\fBmailMethod Cyrus/SendmailCyrus/Kolab/Kolab22\fR \fIstring\fR" 4
.IX Item "mailMethod Cyrus/SendmailCyrus/Kolab/Kolab22 string"
The mailMethod statement tells FusionDirectory which mail method the setup should use to communicate with a possible mail server.
.Sp
Cyrus maintains accounts and sieve scripts in cyrus servers. Kolab/Kolab22 is like cyrus, but lets the kolab daemon maintain the accounts.
SendmailCyrus is based on sendmail \s-1LDAP\s0 attributes.
.IP "\fBcyrusUseSlashes\fR \fIbool\fR" 4
.IX Item "cyrusUseSlashes bool"
The cyrusUseSlashes statement determines if FusionDirectory should use \*(L"foo/bar\*(R" or \*(L"foo.bar\*(R" namespaces in \s-1IMAP\s0. Unix style is with slashes.
.IP "\fBcyrusDeleteMailbox\fR \fIbool\fR" 4
.IX Item "cyrusDeleteMailbox bool"
The cyrusDeleteMailbox statement determines if FusionDirectory should remove the mailbox from your \s-1IMAP\s0 server or keep it after the account is deleted in \s-1LDAP\s0.
.IP "\fBcyrusAutocreateFolders\fR \fIstring\fR" 4
.IX Item "cyrusAutocreateFolders string"
The cyrusAutocreateFolders statement contains a comma separated list of personal \s-1IMAP\s0 folders that should be created along initial account creation.
.IP "\fBmailAttribute\fR \fImail/uid\fR" 4
.IX Item "mailAttribute mail/uid"
The mailAttribute statement determines which attribute FusionDirectory will use to create accounts. Valid values are mail and uid.
.IP "\fBimapTimeout Integer\fR \fIinteger\fR" 4
.IX Item "imapTimeout Integer integer"
The imapTimeout statement sets the connection timeout for imap actions. Default 10 seconds
.IP "\fBmailFolderCreation\fR \fIstring\fR" 4
.IX Item "mailFolderCreation string"
Every mail method has its own way to create mail accounts like share/development or shared.development@example.com
which is used to identify the accounts, set quotas or add acls.
.Sp
To override the methods default account creation syntax, you can set the mailFolderCreation option.
.Sp
.Vb 1
\& Examples
\&
\& mailFolderCreation="%prefix%%cn%" => "shared.development"
\& mailFolderCreation="my\-prefix.%cn%%domain%" => "my\-prefix.development@example.com">
\&
\& Placeholders
\&
\& %prefix% The methods default prefix. (Depends on cyrusUseSlashes=FALSE/TRUE)
\& %cn% The groups/users cn.
\& %uid% The users uid.
\& %mail% The objects mail attribute.
\& %domain% The domain part of the objects mail attribute.
\& %mailpart% The user address part of the mail address.
\& %uattrib% Depends on mailAttribute="uid/mail".
.Ve
.IP "\fBmailUserCreation\fR \fIstring\fR" 4
.IX Item "mailUserCreation string"
This attribute allows to override the user account creation syntax, see the mailFolderCreation description for more details.
.Sp
.Vb 1
\& Examples
\&
\& mailUserCreation="%prefix%%uid%" => "user.foobar"
\& mailUserCreation=my\-prefix.%uid%%domain%" => "my\-prefix.foobar@example.com"
.Ve
.IP "\fBvacationTemplateDirectory\fR \fIpath\fR" 4
.IX Item "vacationTemplateDirectory path"
The vacationTemplateDirectory statement sets the path where FusionDirectory will look for vacation message templates.
Default is /var/cache/fusiondirectory/vacation.
.Sp
.Vb 1
\& Example template /varc/cache/fusiondirectory/vacation/business.txt:
\&
\& DESC:Away from desk
\& Hi, I\*(Aqm currently away from my desk. You can contact me on
\& my cell phone via %mobile.
\&
\& Greetings,
\& %givenName %sn
.Ve
.SS "Debug options"
.IX Subsection "Debug options"
.IP "\fBldapstats\fR \fIbool\fR" 4
.IX Item "ldapstats bool"
The ldapstats statement tells FusionDirectory to track \s-1LDAP\s0 timing statistics to the syslog.
This may help to find indexing problems or bad search filters.
.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 accidently dropped ACLs.
.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\-2013 FusionDirectory project" 2
.IX Item "Copyright (C) 2011-2013 FusionDirectory project"
.PD
.PP
This program is distributed in the hope that it will be useful,
but \s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied warranty of
\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0. See the
\&\s-1GNU\s0 General Public License for more details.
