Skip to content
GitLab
Verified Commit b40b0794 authored by dockx thibault's avatar dockx thibault
Browse files

:sparkles: Feat(man) - Removes man pages from Core. 

Removes man pages from Core.
parent d798b1f7
dev 6342-update-the-locales-for-1-5 6344-template-issue-when-creating-a-template-with-empty-password-error-message-should-not-be-seen 6365-core-locking-mechanism-is-not-changing-the-mail-ressource-it-does-lock-the-mail-account 6365-core-when-lock-mechanism-is-trigger-the-user-should-not-be-editable-if-not-unlock core-php8 master fusiondirectory-1.5 fusiondirectory-1.4
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 0 additions and 930 deletions
+0 -930
contrib/man/fusiondirectory-insert-schema.1 deleted 100644 → 0
+ 0
− 217
View file @ d798b1f7
.\" 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-INSERT-SCHEMA 1"
.TH FUSIONDIRECTORY-INSERT-SCHEMA 1 "2017-05-29" "FusionDirectory 1.2" "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\-insert\-schema \- insert schema needed by FusionDirectory into the ldap server
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
fusiondirectory-insert-schema [\-y] [\-n] [\-c] [\-o options] [path] [\-h|\-l|\-i schema1 schema2|\-m schema1 schema2|\-e schema1 schema2]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This program will insert the schema needed by FusionDirectory into the ldap server, or the specified schemas
.SS "Options"
.IX Subsection "Options"
.IP "\-i" 6
.IX Item "-i"
This option insert the given list of schemas instead of the default list
.IP "\-m" 6
.IX Item "-m"
This option insert the given list of schemas, replacing already inserted versions of those schemas
.IP "\-e" 6
.IX Item "-e"
This option empty the given list of schemas, removing attributes and objectClasses from those.
This is useful because you cannot delete a schema without restarting slapd.
.IP "\-l" 6
.IX Item "-l"
This option list inserted schemas
.IP "\-n" 6
.IX Item "-n"
This option will make generated ldifs file to not be deleted after execution. Might be useful to understand errors.
.IP "\-c" 6
.IX Item "-c"
This option make the program continue even if an error occur
.IP "\-y" 6
.IX Item "-y"
This option answer yes to all questions. The only question right now is the confirmation one when you ask to empty a schema.
.IP "\-o" 6
.IX Item "-o"
This option allow you to specify specifics options to give to ldap commands such as ldapmodify,
but beware that you will not be able to see things like password prompts as the output of these commands is piped.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
.Vb 2
\& fusion@catbert$ fusiondirectory\-insert\-schema
\& Insert the core schemas in your LDAP directory
\&
\& fusion@catbert$ fusiondirectory\-insert\-schema \-i /etc/ldap/otherschema/myschema.ldif
\& Insert the schema /etc/ldap/otherschema/myschema.ldif
\&
\& fusion@catbert$ fusiondirectory\-insert\-schema \-i /etc/ldap/otherschema/myschema.schema
\& Convert /etc/ldap/otherschema/myschema.schema to ldif and insert it
\&
\& fusion@catbert$ fusiondirectory\-insert\-schema \-i myschema
\& Insert the schema myschema.ldif from working directory
\&
\& fusion@catbert$ fusiondirectory\-insert\-schema \-m /etc/ldap/otherschema/myschema.schema
\& Convert /etc/ldap/otherschema/myschema.schema to ldif and replace the existing schema by this one
\&
\& fusion@catbert$ fusiondirectory\-insert\-schema \-e myschema
\& Empty the schema myschema
\&
\& fusion@catbert$ fusiondirectory\-insert\-schema \-o "\-H ldap://my.ldap.com \-ZZ \-D \*(Aqcn=admin,cn=config\*(Aq \-w password \-x"
\& Connect to another ldap server to insert the schema
.Ve
.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 "AUTHOR"
.IX Header "AUTHOR"
Come Bernigaud
.SH "LICENCE AND COPYRIGHT"
.IX Header "LICENCE AND COPYRIGHT"
This code is part of FusionDirectory <http://www.fusiondirectory.org>
.IP "Copyright (C) 2011\-2017 FusionDirectory Project" 1
.IX Item "Copyright (C) 2011-2017 FusionDirectory Project"
.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.
contrib/man/fusiondirectory-setup.1 deleted 100644 → 0
+ 0
− 269
View file @ d798b1f7
.\" 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-SETUP 1"
.TH FUSIONDIRECTORY-SETUP 1 "2017-06-23" "FusionDirectory 1.2" "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\-setup \- FusionDirectory configuration management tool
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This script is designed to perform multiple checks on your FusionDirectory/LDAP architecture, and fix usual misconfiguration.
Some extra features allow you to install FusionDirectory's plugins, and change destinations directories.
.SS "Options"
.IX Subsection "Options"
.IP "\-\-update\-cache" 4
.IX Item "--update-cache"
This option update the /var/cache/fusiondirectory/class.cache file. Which contain \s-1PHP\s0 classes used in FusionDirectory, and their location.
.IP "\-\-update\-locales" 4
.IX Item "--update-locales"
This option update internalization, by generating a new .mo locales file for each language, with every .po files it found.
Needs \fImsgcat\fR and \fImsgfmt\fR to be installed.
.IP "\-\-check\-directories" 4
.IX Item "--check-directories"
This option perform a check on all FusionDirectory's files or directories.
.IP "\-\-check\-config" 4
.IX Item "--check-config"
This option perform a check on FusionDirectory's config file.
.IP "\-\-check\-ldap" 4
.IX Item "--check-ldap"
This option check your \s-1LDAP\s0 tree. Looking for admin account, and groups or people branch. If one of those don't exists, the script will ask you what to do.
.IP "\-\-check\-ids" 4
.IX Item "--check-ids"
This option check your \s-1LDAP\s0 tree for duplicated uidNumber or gidNumber among users and groups.
.IP "\-\-migrate\-users" 4
.IX Item "--migrate-users"
This option add FusionDirectory attributes to the people branch.
.IP "\-\-migrate\-phones" 4
.IX Item "--migrate-phones"
This option removes device objectClass for phones as fdPhones is now structural since \s-1FD 1.1.\s0
.IP "\-\-migrate\-systems" 4
.IX Item "--migrate-systems"
This option replace old systems objectClasses by new objectClasses from \s-1FD 1.1.\s0
.IP "\-\-migrate\-winstations" 4
.IX Item "--migrate-winstations"
This option replace old winstations objectClasses by new objectClasses from \s-1FD 1.1.\s0
.IP "\-\-migrate\-dhcp" 4
.IX Item "--migrate-dhcp"
This option moves \s-1DHCP\s0 configurations from systems branch to \s-1DHCP\s0 branch, which is necessary for FusionDirectory 1.0.17 and above.
.IP "\-\-delete\-gosa\-locks" 4
.IX Item "--delete-gosa-locks"
This option will delete old GOsa style lock tokens from 1.0.15 or older
.IP "\-\-install\-plugins" 4
.IX Item "--install-plugins"
This option will install the plugin from a tar.gz of the plugin. This option is intended for people wanting to install from the sources.
.IP "\-\-encrypt\-passwords" 4
.IX Item "--encrypt-passwords"
This option will encrypt the password inside your fusiondirectory.conf file, it need the headers module to be activated in your apache to work.
.IP "\-\-show\-version" 4
.IX Item "--show-version"
This option will parse the file variables_common.inc of FusionDirectory to find out which version of FusionDirectory is installed.
.IP "\-\-list_vars" 4
.IX Item "--list_vars"
This option will list the variables you can change to install FusionDirectory on another set of directories. This option is intended for people wanting to install from the sources.
.IP "\-\-write\-vars" 4
.IX Item "--write-vars"
This option will write back the variables.inc file with the updated variables and is only useful with \-\-set\-VAR=variable and for people installing from sources.
.IP "\-\-set\-VAR=variable" 4
.IX Item "--set-VAR=variable"
This option will change the variable for the FusionDirectory installation. it is only useful with \-\-install\-directories and for people installing from sources.
.IP "\-\-list\-deprecated" 4
.IX Item "--list-deprecated"
This option will list the deprecated attributes and objectclasses still in your schemas and no longer used by FusionDirectory.
.IP "\-\-check\-deprecated" 4
.IX Item "--check-deprecated"
This option will list the dn of \s-1LDAP\s0 entries using deprecated attributes or objectclasses and no longer used by FusionDirectory.
.IP "\-\-ldif\-deprecated" 4
.IX Item "--ldif-deprecated"
This option will print an \s-1LDIF\s0 to allow you to remove deprecated attributes from you ldap server. Be careful and check before applying.
.IP "\-\-show\-config" 4
.IX Item "--show-config"
This option will print a dump of the FusionDirectory configuration \s-1LDAP\s0 node.
.IP "\-\-set\-config\-VAR=value" 4
.IX Item "--set-config-VAR=value"
This option sets the value of a configuration field in the \s-1LDAP.\s0 The value needs to be in the correct \s-1LDAP\s0 format.
You cannot set multivalued field with this. The var name can be provided with or without the fd prefix.
.IP "\-\-yes" 4
.IX Item "--yes"
This flag will answer \*(L"yes\*(R" to every yes/no question asked by the script
.SH "EXAMPLE"
.IX Header "EXAMPLE"
.Vb 1
\& benoit@catbert$ fusiondirectory\-setup \-\-update\-cache \-\-update\-locales
\&
\& Update FusionDirectory class cache and update localization
\&
\& benoit@catbert$ fusiondirectory\-setup \-\-list\-vars
\& List possible vars to give \-\-set
\&locale_cache_dir [locale]
\&config_file [fusiondirectory.conf]
\&fd_cache [/var/cache/fusiondirectory]
\&fd_smarty_dir [/usr/share/php/smarty3]
\&fd_spool_dir [/var/spool/fusiondirectory]
\&fai_log_dir [fai]
\&tmp_dir [tmp]
\&secrets_file [fusiondirectory.secrets]
\&template_dir [template]
\&locale_dir [locale]
\&class_cache [class.cache]
\&fd_config_dir [/etc/fusiondirectory]
\&fd_home [/var/www/fusiondirectory]
\&
\&
\& benoit@catbert$ fusiondirectory\-setup \-\-set\-class_cache=class.cache \-\-write\-vars
\&
\& update the class.cache name and write back the variables.inc file
.Ve
.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 "AUTHORS"
.IX Header "AUTHORS"
Benjamin Carpentier
.PP
Come Bernigaud
.SH "LICENCE AND COPYRIGHT"
.IX Header "LICENCE AND COPYRIGHT"
This code is part of FusionDirectory (http://www.fusiondirectory.org/)
.IP "Copyright (C) 2011\-2017 FusionDirectory" 2
.IX Item "Copyright (C) 2011-2017 FusionDirectory"
.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.
contrib/man/fusiondirectory.conf.5 deleted 100644 → 0
+ 0
− 279
View file @ d798b1f7
.\" 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 "2017-05-29" "FusionDirectory 1.2" "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" base="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 web server 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" base="dc=example,dc=net"
\& admin="cn=fusiondirectory\-admin,dc=example,dc=net"
\& password="secret" />
.Ve
.PP
uri is a valid \s-1LDAP\s0 uri. base is 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\-2017 FusionDirectory project" 2
.IX Item "Copyright (C) 2011-2017 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.
contrib/man/fusiondirectory.conf.pod deleted 100644 → 0
+ 0
− 165
View file @ d798b1f7
=head1 NAME
fusiondirectory.conf - FusionDirectory configuration file
=head1 DESCRIPTION
The fusiondirectory.conf file is a XML 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 XML tags and should be encapsulated inside of <!-- --> tags.
The fusiondirectory.conf file can be used to configure the access control of the FusionDirectory webinterface.
=head2 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.
Layout example:
<?xml version="1.0"?>
<conf>
<!-- Global setup -->
<main>
<!-- Location specific setups -->
<location name="">
...
</location>
</main>
</conf>
=head2 Main section
The main section defines global settings, which might be overridden by each location definition inside of this global definition.
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>
=head2 Main section options
=over
=item B<forceSSL> I<bool>
The forceSSL statement enables PHP security checks to force encrypted access to the web interface. FusionDirectory will try to redirect to the same URL just with https://.
=item B<logging> I<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.
=item B<templateCompileDirectory> I<path>
The templateCompileDirectory statements defines the path, where the PHP templating engins smarty should store its compiled FusionDirectory templates for improved speed.
This path needs to be writeable by the user your web server is running with.
=item B<ignoreAcl> I<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.
=item B<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.
=back
=head2 Location section options
=over
=item B<name> I<string>
The name of this location section that will appear in the dropdown on FusionDirectory homepage
=item B<config> I<dn>
The config statement defines the LDAP base, where FusionDirectory stores management information, such as site wide locking and user notifications.
=item B<debuglevel> I<integer>
The debuglevel value tells FusionDirectory to display certain information on each page load. 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
=back
=head2 LDAP options
=over
=item B<ldapTLS> I<bool>
The ldapTLS statement enables or disables TLS operating on LDAP connections.
=item B<ldapFollowReferrals> I<bool>
The ldapFollowReferrals statement tells FusionDirectory to follow LDAP referrals.
=back
=head2 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" />
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 server to connect to.
=head1 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>
=head1 LICENCE AND COPYRIGHT
This code is part of FusionDirectory <http://www.fusiondirectory.org>
=over 2
=item Copyright (C) 2003-2010 GONICUS GmbH
=item Copyright (C) 2011-2018 FusionDirectory project
=back
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.
Supports Markdown
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