Code

Added opsi module
[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 port = 20081
34 Defines the port GOsa-SI-server is listening for incoming messages.
36 =item known-clients = /var/lib/gosa-si/clients.db
38 Defines the location for the local DB 'known_clients'.
40 =item known-server = /var/lib/gosa-si/servers.db
42 Defines the location for the local DB 'known_server'.
44 =item incoming = /var/lib/gosa-si/incoming.db
46 Defines the location for the local DB 'incoming'.
48 =item login-users = /var/lib/gosa-si/users.db
50 Defines the location for the local DB 'login_users'.
52 =item fai-server = /var/lib/gosa-si/fai_server.db
54 Defines the location for the local DB 'fai_server'.
56 =item fai-release = /var/lib/gosa-si/fai_release.db
58 Defines the location for the local DB 'fai_release'.
60 =item packages-list = /var/lib/gosa-si/packages.db
62 Defines the location for the local DB 'packages_list'.
64 =item messaging = /var/lib/gosa-si/messaging.db
66 Defines the location for the local DB 'messaging'.
68 =item foreign-clients = /var/lib/gosa-si/foreign_clients.db
70 Defines the location for the local DB 'foreign_clients'.
72 =item source-list = /etc/apt/sources.list
74 Defines the location for the sources file. 
76 =item repo-path = /srv/www/repository
78 Defines the location of the dak Archive or local Debian Mirror and is scanned for Debian Packages.
80 =item ldap-uri = 
82 Defines the LDAP uniform resource identifier.
84 =item ldap-base = 
86 Defines the LDAP base. 
88 =item ldap-admin-dn = 
90 Defines the distinguished name of the administrator.
92 =item ldap-admin-password = 
94 Defines the password of the administrator.
96 =item gosa-unit-tag = 
98 Forces the Unit-Tag in a tagged environment. If not set, GOsa-SI tries to get the tag from the server entry in LDAP.
100 =item max-clients = 10
102 Defines the maximum number of GOsa-SI-clients connected to the GOsa-SI-server.
104 =item wol-password =
106 Defines the password for wake on LAN (WOL).
108 =back
110 =head2 [GOsaPackages]
112 =over 4
114 =item job-queue = /var/lib/gosa-si/jobs.db
116 Defines the location for the local DB 'job_queue'.
118 =item job-queue-loop-delay = 3
120 Defines the seconds the job queue is checked. 
122 =item messaging-db-loop-delay = 3
124 Defines the seconds the messaging queue is checked.
126 =item key = none
128 Defines the password incoming GOsaPackages messages should be encrypted. This has to be modified, default value will not work!!!
130 =item dak-base = /srv/archive
132 Base Directory of the local dak Archive.
134 =item dak-keyring = /srv/archive/keyrings
136 Directory with keyrings that hold the gpg-keys the archive accepts when uploading Debian packages.
138 =item dak-queue = /srv/archive/queue
140 Directory with the different dak queues.
142 =item dak-usr = deb-dak
144 User that is used to access dak files. Only needed if you have manually changed the default.
146 =back
149 =head2 [ClientPackages]
151 =over 4
153 =item key = none
155 Defines the password incoming ClientPackages messages should be encrypted. This has to be modified, default value will not work!!!
157 =back
160 =head2 [ServerPackages]
162 =over 4
164 =item address = 
166 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. 
168 =item domain =
170 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.
172 =item key = none
174 Defines the password incoming ServerPackages messages should be encrypted. This has to be modified, default value will not work!!!
176 =item key-lifetime = 120
178 Defines the lifetime in seconds of a GOsa-SI-server key. After expiring the key will be automatically renewed. 
180 =item job-synchronization-enabled = true | false
182 Defines whether job queue informations are be shared with other GOsa-SI-server in network.
184 =item synchronization-loog = 5
186 Defines in seconds after which time the job queue synchronization is being done. 
188 =back
191 =head2 [ArpHandler]
193 =over
195 =item enabled = true | false
197 Defines whether the ArpHandler is being activated at GOsa-SI-server start.
199 =item interface = all
201 Space- or comma-separated list of interfaces on which to start an ARP-Daemon. Enter 'all' to use all possible interfaces (Default).
203 =back
206 =head1 BUGS 
208 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>
211 =head1 LICENCE AND COPYRIGHT
213 This code is part of GOsa (L<http://www.gosa-project.org>)
215 Copyright (C) 2003-2008 GONICUS GmbH
217 This program is distributed in the hope that it will be useful,
218 but WITHOUT ANY WARRANTY; without even the implied warranty of
219 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
220 GNU General Public License for more details.
224 =cut