Code

Fix regression in #4271
[gosa.git] / trunk / gosa-si / client.conf.pod
2 =head1 NAME
4 gosa-si-client.conf - Configuration file for gosa-si-client.
7 =head1 DESCRIPTION
9 The gosa-si-client.conf file defines all parameter GOsa-SI-client needs for running and communication with GOsa-SI-server. It is normally located in the F</etc/gosa-si/> directory and is generated automatically by the gosa-si-client(1) program during installation. 
11 =head1 DIRECTIVES
13 =head2 [general]
15 =over 4
17 =item log-file = /var/run/gosa-si-client.log
19 Defines the location for the log file.
21 =item pid-file = /var/run/gosa-si-client.pid
23 Defines the location for the pid file.
25 =back
28 =head2 [client]
30 =over 4
32 =item port = 20083
34 Defines the port GOsa-SI-client is listening for incoming messages.
36 =item ip = 0.0.0.0
38 If set GOsa-SI-client is forced to use this ip address. If it is not set, an automated determination is tried.
40 =item mac-address = 00:00:00:00:00:00
42 If set GOsa-SI-client is forced to use this mac address. If it is not set, an automated determination is tried.
44 =item server-domain =
46 Forces the search domain used to get possible servers from DNS. If not set, the client will search the domains from $ENV.
48 =item ldap = 1 | 0
50 If set to '1', the client will get the LDAP-Configuration from the registration server (on every registration process). Under some circumstances this is not wanted, so setting to '0' disables this behavior.
52 =item ldap-config = /etc/ldap/ldap.conf
54 Defines the location for ldap.conf file.
56 =item pam-config = /etc/pam_ldap.conf
58 Defines the location for pam-ldap.conf file. 
60 =item nss-config = /etc/libnss-ldap.conf
62 Defines the location for libnss-ldap.conf file.
64 =item fai-logpath = /var/log/fai/fai.log
66 Defines the location for fai.log file.
68 =item force-hostname = false | true
70 If set to true, client will try to get the hostname for registration from $ENV. Used in FAI environments, when hostname gets set from DHCP.
72 =back
75 =head2 [server]
77 =over 4
79 =item ip = 127.0.0.1
81 If set GOsa-SI-client is forced to register at specified GOsa-SI-Server. If it is not set, GOsa-SI tries to register at GOsa-SI-servers found in DNS. 
83 =item port = 20081
85 Defines the port GOsa-SI-server is listening for incoming messages.
87 =item key = 
89 Defines the password GOsa-SI-server messages should be encrypted. This has to be modified, default value will usually not work!!!
91 =item timeout = 10
93 Defines in seconds the timeout GOsa-SI-client is waiting for the next try if all registraion efforts fails.
95 =item key-lifetime = 600
97 Defines in seconds the lifetime of the key GOsa-SI-server messages should be encrypted with. 
99 =back
102 =head1 BUGS 
104 Please report any bugs, or post any suggestions, to the GOsa mailing list <gosa-devel@oss.gonicus.de> or to <https://oss.gonicus.de/labs/gosa>
107 =head1 LICENCE AND COPYRIGHT
109 This code is part of GOsa (L<http://www.gosa-project.org>)
111 Copyright (C) 2003-2008 GONICUS GmbH
113 This program is distributed in the hope that it will be useful,
114 but WITHOUT ANY WARRANTY; without even the implied warranty of
115 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
116 GNU General Public License for more details.
118 =cut