Code

fd94ac56a92a9339d4fead4e7cc9443c5caef6df
[gosa.git] / gosa-si / server.conf.pod
2 =head1 NAME
4 gosa-si-server.conf - Configuration file for gosa-si-server.
7 =head1 DESCRIPTION
9 The gosa-si-server.conf file defines all parameter GOsa-SI-server needs for running. It is normally located in the /etc/gosa-si/ directory and is generated automatically by the gosa-si-server(1) program during installation. 
11 =head1 DIRECTIVES
14 =head2 [general]
16 =over 4
18 =item logfile = /var/log/gosa-si-server.log
20 Defines the location for the log file.
22 =item pid-file = /var/run/gosa-si-server.pid
23 Defines the location for the pid file.
25 =back
28 =head2 [server]
30 =over 4
32 =item ip = 1.2.3.4
34 Defines the ip address GOsa-SI-server should use. Default: GOsa-SI determines the the ip address based on the destination address.
36 =item port = 20081
38 Defines the port GOsa-SI-server is listening for incoming messages.
40 =item known-clients = /var/lib/gosa-si/clients.db
42 Defines the location for the local DB 'known_clients'.
44 =item known-server = /var/lib/gosa-si/servers.db
46 Defines the location for the local DB 'known_server'.
48 =item incoming = /var/lib/gosa-si/incoming.db
50 Defines the location for the local DB 'incoming'.
52 =item login-users = /var/lib/gosa-si/users.db
54 Defines the location for the local DB 'login_users'.
56 =item fai-server = /var/lib/gosa-si/fai_server.db
58 Defines the location for the local DB 'fai_server'.
60 =item fai-release = /var/lib/gosa-si/fai_release.db
62 Defines the location for the local DB 'fai_release'.
64 =item packages-list = /var/lib/gosa-si/packages.db
66 Defines the location for the local DB 'packages_list'.
68 =item messaging = /var/lib/gosa-si/messaging.db
70 Defines the location for the local DB 'messaging'.
72 =item foreign-clients = /var/lib/gosa-si/foreign_clients.db
74 Defines the location for the local DB 'foreign_clients'.
76 =item source-list = /etc/apt/sources.list
78 Defines the location for the sources file. 
80 =item repo-path = /srv/www/repository
82 Defines the location of the dak Archive or local Debian Mirror and is scanned for Debian Packages.
84 =item ldap-uri = 
86 Defines the LDAP uniform resource identifier.
88 =item ldap-base = 
90 Defines the LDAP base. 
92 =item ldap-admin-dn = 
94 Defines the distinguished name of the administrator.
96 =item ldap-admin-password = 
98 Defines the password of the administrator.
100 =item ldap-version = 3
102 Define the ldap protocol version used
104 =item gosa-unit-tag = 
106 Forces the Unit-Tag in a tagged environment. If not set, GOsa-SI tries to get the tag from the server entry in LDAP.
108 =item max-clients = 10
110 Defines the maximum number of GOsa-SI-clients connected to the GOsa-SI-server.
112 =item wol-password =
114 Defines the password for wake on LAN (WOL).
116 =back
118 =head2 [GOsaPackages]
120 =over 4
122 =item job-queue = /var/lib/gosa-si/jobs.db
124 Defines the location for the local DB 'job_queue'.
126 =item job-queue-loop-delay = 3
128 Defines the seconds the job queue is checked. 
130 =item messaging-db-loop-delay = 3
132 Defines the seconds the messaging queue is checked.
134 =item key = none
136 Defines the password incoming GOsaPackages messages should be encrypted. This has to be modified, default value will not work!!!
138 =item new-systems-ou = ou=workstations,ou=systems
140 Define the branch in your ldap tree where new systems should be put, only change if you know what you are doing !!!
142 =item dak-base = /srv/archive
144 Base Directory of the local dak Archive.
146 =item dak-keyring = /srv/archive/keyrings
148 Directory with keyrings that hold the gpg-keys the archive accepts when uploading Debian packages.
150 =item dak-queue = /srv/archive/queue
152 Directory with the different dak queues.
154 =item dak-usr = deb-dak
156 User that is used to access dak files. Only needed if you have manually changed the default.
158 =back
161 =head2 [ClientPackages]
163 =over 4
165 =item key = none
167 Defines the password incoming ClientPackages messages should be encrypted. This has to be modified, default value will not work!!!
169 =item user-date-of-expiry = 600
171 Lifetime of logged in user information. If no update information comes after n seconds,
172 the user is marked to be no longer logged in or the host is no longer running.
174 =back
177 =head2 [ServerPackages]
179 =over 4
181 =item address = 
183 Comma seperated list of GOsa-si-servers (1.2.3.4:20081,9.8.7.6:123) in network where this SI-server should register. These given SI-servers extend the list of SI-servers found in DNS. 
185 =item dns-lookup = true | false
187 Perform a DNS lookup for server registration
189 =item domain =
191 Forces the search domain used to get possible foreign servers from DNS. If not set, this server will search the domains found in domain or search statement in /etc/resolv.conf.
193 =item key = none
195 Defines the password incoming ServerPackages messages should be encrypted. This has to be modified, default value will not work!!!
197 =item key-lifetime = 120
199 Defines the lifetime in seconds of a GOsa-SI-server key. After expiring the key will be automatically renewed. 
201 =item job-synchronization-enabled = true | false
203 Defines whether job queue informations are be shared with other GOsa-SI-server in network.
205 =item synchronization-loog = 5
207 Defines in seconds after which time the job queue synchronization is being done. 
209 =back
212 =head2 [ArpHandler]
214 =over
216 =item enabled = true | false
218 Defines whether the ArpHandler is being activated at GOsa-SI-server start.
220 =item interface = all
222 Space- or comma-separated list of interfaces on which to start an ARP-Daemon. Enter 'all' to use all possible interfaces (Default).
224 =back
226 =head2 [Opsi]
228 =over 4
230 =item enabled = true | false
232 Defines wheter Opsi integration is being enabled or not.
234 =item server = localhost
236 Define the hostname of the Opsi server
238 =item admin = opsi-admin
240 Define the name of the opsi admin
242 =item password = 
244 Define the Opsi admin password
246 =back
248 =head1 BUGS 
250 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>
253 =head1 LICENCE AND COPYRIGHT
255 This code is part of GOsa (L<http://www.gosa-project.org>)
257 Copyright (C) 2003-2009 GONICUS GmbH
259 This program is distributed in the hope that it will be useful,
260 but WITHOUT ANY WARRANTY; without even the implied warranty of
261 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
262 GNU General Public License for more details.
266 =cut