Code

Updated si xml_parser
[gosa.git] / gosa-core / contrib / gosa.conf.5
index 6e0fb2da225f8bf9288ca7fe959f3c8820fab069..e4eea1301a1393cb6a32ba3d6c23cfa58aa30cda 100644 (file)
@@ -1,4 +1,4 @@
-.TH gosa.conf 5
+.TH gosa.conf 5 "2008-04-07" "GOsa v2.6" "Debian"
 .SH NAME
 gosa.conf - GOsa configuration file
 .SH DESCRIPTION
 .SH NAME
 gosa.conf - GOsa configuration file
 .SH DESCRIPTION
@@ -403,6 +403,38 @@ The
 .I ppd_path
 variable defines where to store PPD files for the GOto environment plugins.
 .PP
 .I ppd_path
 variable defines where to store PPD files for the GOto environment plugins.
 .PP
+
+.B resolutions
+.I path
+.PP
+The
+.I pppd_pathpd_path
+variable defines a plain text file which contains additional resolutions
+to be shown in the environment and system plugins.
+.PP
+
+.B htaccess_auth
+.I bool
+.PP
+The
+.I htaccess_auth
+variable tells GOsa to use either htaccess authentication or LDAP authentication. This
+can be used if you want to use i.e. kerberos to authenticate the users.
+.PP
+
+.B gosa_si
+.I bool
+.PP
+The
+.I gosa_si
+defines the major gosa-si server host and the password for GOsa to connect to it.
+can be used if you want to use i.e. kerberos to authenticate the users.
+
+The format is:
+
+.nf
+credentials@host:port
+.fi
 .PP
 
 
 .PP
 
 
@@ -418,6 +450,15 @@ GOsa generated lists, displaying a short summary of type and number of
 elements in the list.
 .PP
 
 elements in the list.
 .PP
 
+.B iconsize
+.I size value
+.PP
+The
+.I iconsize
+statement sets the icon size in the main menu. Its value should be something
+like 48x48.
+.PP
+
 .B compressed
 .I true/false
 .PP
 .B compressed
 .I true/false
 .PP
@@ -837,6 +878,7 @@ statement describes an automatic way to generate new user ids. There are two bas
 functions supported - which can be combined:
 
  a) using attributes
 functions supported - which can be combined:
 
  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.
     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.
@@ -851,6 +893,7 @@ functions supported - which can be combined:
     input box is shown.
 
  b) using automatic id's
     input box is shown.
 
  b) using automatic id's
+
     I.e. specifying
 
 .nf
     I.e. specifying
 
 .nf
@@ -910,7 +953,7 @@ If you don't have mkntpasswd from the samba distribution installed, you can use
 perl to generate the hash:
 
 .nf
 perl to generate the hash:
 
 .nf
-perl -MCrypt::SmbHash -e "print join(q[:], ntlmgen \$ARGV[0]), $/;"
+perl -MCrypt::SmbHash -e "print join(q[:], ntlmgen \\$ARGV[0]), $/;"
 .if
 .PP
 
 .if
 .PP
 
@@ -921,8 +964,182 @@ The
 .I sambaidmapping
 statement tells GOsa to maintain sambaIdmapEntry objects. Depending on your
 setup this can drastically improve the windows login performance.
 .I sambaidmapping
 statement tells GOsa to maintain sambaIdmapEntry objects. Depending on your
 setup this can drastically improve the windows login performance.
+.PP
+.PP
+
+.B Asterisk options
+.PP
+.B ctihook
+.I path
+.PP
+The
+.I 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:
+
+.nf
+ctihook $source_number $destination_number
+.fi
+
+This script can be used to do automatted dialing from the addressbook.
+.PP
+.PP
+
+.B Mail options
+.PP
+.B mailMethod
+.I cyrus/kolab/golab/sendmail
+.PP
+The
+.I mailMethod
+statement tells GOsa which mail method the setup should use to communicate
+with a possible mail server. Leave this undefined if your mail method does
+not match the predefined ones.
+
+.I cyrus
+maintains accounts and sieve scripts in cyrus servers.
+.I kolab
+is like cyrus, but lets the kolab daemon maintain the accounts.
+.I golab is like cyrus - just with kolab attributes.
+.I sendmail just disables everything which is IMAP dependent.
+.PP
+
+.B cyrusunixstyle
+.I bool
+.PP
+The
+.I cyrusunixstyle
+statement determines if GOsa should use "foo/bar" or "foo.bar" namespaces
+in IMAP. Unix style is with slashes.
+
+.B additionalrestrictionfilters
+.I path
+.PP
+The
+.I additionalrestrictionfilters
+statement defines a file to include for the postfix module in order
+to display user defined restriction filters.
+
+.B additionalprotocols
+.I path
+.PP
+The
+.I additionalprotocols
+statement defines a file to include for the postfix module in order
+to display user defined protocols.
+
+.B mail_attrib
+.I mail/uid
+.PP
+The
+.I mail_attrib
+statement determines which attribute GOsa will use to create accounts.
+Valid values are
+.I mail
+and
+.I uid.
+
+.B vacationdir
+.I path
+.PP
+The
+.I vacationdir
+statement sets the path where GOsa will look for vacation message
+templates. Default is /etc/gosa/vacation.
+
+Example template /etc/gosa/vacation/business.txt:
 
 
+.nf
+   DESC:Away from desk
+   Hi, I'm currently away from my desk. You can contact me on
+   my cell phone via %mobile.
+
+   Greetings,
+   %givenName %sn
+.fi
+.PP
+
+
+.B Debug options
+.PP
+.B displayerrors
+.I bool
+.PP
+The
+.I displayerrors
+statement tells GOsa 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 arround.
+.PP
+
+.B ldapstats
+.I bool
+.PP
+The
+.I ldapstats
+statement tells GOsa to track LDAP timing statistics to the syslog. This may
+help to find indexing problems or bad search filters.
+.PP
 
 
+.B ignore_acl
+.I dn
+.PP
+The
+.I ignore_acl
+value tells GOsa to ignore complete ACL sets for the given DN. Add your
+DN here and you'll be able to restore accidently dropped ACLs.
+.PP
+
+.B debuglevel
+.I integer
+.PP
+The
+.I debuglevel
+value tells GOsa to display certain information on each page load. Value
+is an AND combination of the following byte values:
+
+DEBUG_TRACE   = 1
+
+DEBUG_LDAP    = 2
+
+DEBUG_MYSQL   = 4
+
+DEBUG_SHELL   = 8
+
+DEBUG_POST    = 16
+
+DEBUG_SESSION = 32
+
+DEBUG_CONFIG  = 64
+
+DEBUG_ACL     = 128
+.PP
+
+
+.SH LDAP resource definition
+
+For every location you define inside your gosa.conf, you need at least
+one entry of the type
+.I referral.
+These entries define the way how to connect to some directory service.
+
+.B Example:
+
+.nf
+  <referral url="ldap://ldap.example.net/dc=example,dc=net"
+            admin="cn=gosa-admin,dc=example,dc=net"
+            password="secret" />
+.fi
+
+.I url
+is a valid LDAP url extendet by the base this referral is responsible for.
+.I admin
+is the DN which has the permission to write LDAP entries. And
+.I password
+is the corresponding password for this DN.
+
+You can define a set of referrals if you have several server to
+connect to.
 
 .SH AUTHOR
 .B gosa.conf(5)
 
 .SH AUTHOR
 .B gosa.conf(5)