gosa-core/contrib/gosa.conf.5

   1 .TH gosa.conf 5
   2 .SH NAME
   3 gosa.conf - GOsa configuration file
   4 .SH DESCRIPTION
   5 The gosa.conf file contains configuration information for
   6 .IR GOsa,
   7 a powerful GPL'ed framework for managing accounts and systems in
   8 LDAP databases.
   9 .PP
  10 The gosa.conf file is a XML style configuration file. It is parsed by
  11 the GOsa web application during log in.  The file may contain
  12 extra tabs and newlines for formatting purposes.  Tag keywords in the
  13 file are case-insensitive. Comments should be placed outside of XML
  14 tags and should be encapsulated inside of <!-- --> tags.
  15 .PP
  16 The gosa.conf file can be used to configure the look and feel, behaviour
  17 and access control of the GOsa webinterface.
  18 .SH Configuration layout
  19
  20 The configuration has to be specified inside of the <conf> tags. It
  21 basically consists of three main parts: menu definition, definition
  22 of subdialogs (tabbed dialogs) and the main configuration - including
  23 information about several locations.
  24
  25 .B Layout example:
  26
  27 .nf
  28   <?xml version="1.0"?>
  29
  30   <conf config_version="...." >
  31     <!-- Menu definition -->
  32     <menu>
  33     ...
  34     </menu>
  35
  36     <!-- Tabbed dialog definitions -->
  37     ...
  38
  39     <!-- Global setup -->
  40     <main>
  41
  42        <!-- Location specific setups -->
  43        <location name="">
  44          ...
  45        </location>
  46
  47     </main>
  48
  49   </conf>
  50 .fi
  51
  52 .SH Menu definition
  53
  54 This tag defines the side and icon menu inside the
  55 interface. Defining an entry here is no guarantie to get it shown,
  56 though. Only entries with matching ACL's get shown.
  57
  58 There are two types of entries inside of the menu: section and plugin
  59
  60 .B Defining a section
  61
  62 Open a
  63 .I <section>
  64 tag including a
  65 .I name
  66 attribute. This will show up in the menu as a new section later on.
  67 Own entries are not handled via I18N by default. Close the
  68 .I </section>
  69 tag after your plugin definitions.
  70
  71 .B Defining a plugin
  72
  73 Open a
  74 .I <plugin>
  75 tag including a
  76 .I "class"
  77 attribute. The
  78 .I "class"
  79 should be present inside your GOsa setup - the entry will be ignored if it is not.
  80
  81 Plugins should have an
  82 .I "acl"
  83 entry, that allows GOsa to decide wether a user is allowed to see a plugin or not.
  84 The
  85 .I "acl"
  86 string matches with an ACL definition done inside of GOsa.
  87
  88 You can override an icon by specifying the
  89 .I "icon"
  90 attribute.
  91
  92 For every plugin, you can provide at least four additional hooks:
  93 .I postcreate,
  94 .I postdelete,
  95 .I postmodify
  96 and
  97 .I check.
  98 These can be used to perform special actions when a plugins gets
  99 a create, delete, modify or check request. As a parameter, these
 100 keywords get a shell script or program to the task.
 101
 102 .I The
 103 .B create / delete / modify
 104 .I keywords
 105
 106 These keywords take a full executable path of a script. You can
 107 provide certain parameters in form of LDAP attributes. '%uid'
 108 will pass the current user id, '%dn' the current object dn, etc.
 109
 110 The script gets executed after create, delete or modify tasks.
 111
 112 .I The
 113 .B check
 114 .I keyword
 115
 116 This keyword takes a full executable path of a script. Check is
 117 triggered after you press the
 118 -I "Apply"
 119 or
 120 -I "OK"
 121 button. The complete LDAP entry as it will be written to the
 122 LDAP is passed to your script. If parts of the entry do not
 123 match some logic of your script, just print an error message
 124 to STDOUT. GOsa will show this message and abort the current
 125 process of saving the entry to the LDAP.
 126
 127 .B Example menu definition:
 128
 129 .nf
 130   <menu>
 131     <section name="My account">
 132       <plugin acl="users/user:self" class="user" check="/usr/local/bin/test_user.sh" />
 133       <plugin acl="users/samba:self" class="sambaAccount" postcreate="/usr/local/bin/create_share '%uid'" />
 134     </section>
 135   </menu>
 136 .fi
 137
 138 .SH Tabbed dialog definitions
 139
 140 Tab definitions define the sub plugins which get included for certain
 141 tabbed dialogs. If you change something here, never (!) remove the
 142 primary (the first) "tab" tag which is defined. Most tabbed dialogs
 143 need a primary plugin.
 144
 145 .I "*tab"
 146 should be looked for by a defined plugin. This one will take
 147 every
 148 .I "tab"
 149 defined
 150 .I "class"
 151 and will show it inside of a tabbed dialog
 152 with the header defined in
 153 .I "name".
 154
 155 .B Example tabbed dialog definition:
 156
 157 .nf
 158   <grouptabs>
 159     <tab class="group" name="Generic" />
 160     <tab class="environment" name="Environment" />
 161     <tab class="appgroup" name="Applications" />
 162     <tab class="mailgroup" name="Mail" />
 163   </grouptabs>
 164 .fi
 165
 166 .SH Main section
 167
 168 The main section defines global settings, which might be overridden by
 169 each location definition inside of this global definition.
 170
 171 .B Example layout:
 172
 173 .nf
 174   <main default="Example Net"
 175         list_summary="false"
 176         ... >
 177
 178         <location name="Example Net"
 179                   hash="md5"
 180                   dnmode="cn"
 181                   ...
 182
 183                   <referral url="ldaps://ldap.example.net:636/dc=example,dc=net"
 184                             admin="cn=gosa-admin,dc=example,dc=net"
 185                             password="secret" />
 186
 187         </location>
 188
 189   </main>
 190
 191 .fi
 192
 193 .PP
 194 .B Generic options
 195
 196 .PP
 197 .B forceglobals
 198 .I bool
 199 .PP
 200 The
 201 .I forceglobals
 202 statement enables PHP security checks to force register_global settings to
 203 be switched off.
 204 .PP
 205
 206 .B forcessl
 207 .I bool
 208 .PP
 209 The
 210 .I forceglobals
 211 statement enables PHP security checks to force encrypted access to the web
 212 interface. GOsa will try to redirect to the same URL - just with https://.
 213 .PP
 214
 215 .B warnssl
 216 .I bool
 217 .PP
 218 The
 219 .I warnssl
 220 statement enables PHP security checks to detect non encrypted access to
 221 the web interface. GOsa will display a warning in this case.
 222 .PP
 223
 224 .B uniq_identifier
 225 .I string
 226 .PP
 227 The
 228 .I uniq_identifier
 229 statement enables GOsa to check if a entry currently being edited has
 230 been modified from someone else outside GOsa in the meantime. It will
 231 display an informative dialog then. It can be set to
 232 .I entryCSN
 233 for OpenLDAP based systems or
 234 .I contextCSN
 235 for Sun DS based systems.
 236 .PP
 237
 238 .B logging
 239 .I string
 240 .PP
 241 The
 242 .I logging
 243 statement enables event logging on GOsa side. Setting it to
 244 .I syslog,
 245 GOsa will log every action a user performs via syslog. Setting it to
 246 .I mysql,
 247 GOsa will log every action to a mysql server, defined in the
 248 GOsa systems plugin. Both values can be combined as a comma seperated
 249 list.
 250
 251 GOsa will not log anything, if the logging value is empty.
 252 .PP
 253
 254 .B login_attribute
 255 .I string
 256 .PP
 257 The
 258 .I login_attribute
 259 statement tells GOsa which LDAP attribute is used as the login name
 260 during login. It can be set to
 261 .I uid, mail
 262 or
 263 .I both.
 264 .PP
 265
 266 .B enableCopyPaste
 267 .I bool
 268 .PP
 269 The
 270 .I enableCopyPaste
 271 statement enables copy and paste for LDAP entries managed with GOsa.
 272 .PP
 273
 274 .B enable_snapshot
 275 .I bool
 276 .PP
 277 The
 278 .I enable_snapshot
 279 statement enables a snapshot mechaism in GOsa. This enables you to save
 280 certain states of entries and restore them later on.
 281 .PP
 282
 283 .B snapshot_base
 284 .I dn
 285 .PP
 286 The
 287 .I snapshot_base
 288 statement defines the base where snapshots should be stored inside of
 289 the LDAP.
 290 .PP
 291
 292 .B snapshot_server
 293 .I url
 294 .PP
 295 The
 296 .I snapshot_server
 297 variable defines the LDAP URL for the server which is used to do object
 298 snapshots.
 299 .PP
 300
 301 .B snapshot_user
 302 .I dn
 303 .PP
 304 The
 305 .I snapshot_user
 306 variable defines the user which is used to authenticate when connecting
 307 to
 308 .I snapshot_server.
 309 .PP
 310
 311 .B snapshot_password
 312 .I string
 313 .PP
 314 The
 315 .I snapshot_password
 316 variable defines the credentials which are used in combination with
 317 .I snapshot_user
 318 and
 319 .I snapshot_server
 320 in order to authenticate.
 321 .PP
 322
 323 .B config
 324 .I dn
 325 .PP
 326 The
 327 .I config
 328 statement defines the LDAP base, where GOsa stores management information,
 329 such as site wide locking and user notifications.
 330 .PP
 331
 332 .B compile
 333 .I path
 334 .PP
 335 The
 336 .I compile
 337 statements defines the path, where the PHP templating engins
 338 .I smarty
 339 should store its compiled GOsa templates for improved speed. This path
 340 needs to be writeable by the user your webserver is running with.
 341 .PP
 342
 343 .B timezone
 344 .I string
 345 .PP
 346 The
 347 .I timezone
 348 statements defines the timezone used inside of GOsa to handle date
 349 related tasks, such as password expiery, vacation messages, etc.
 350 The
 351 .I timezone
 352 value should be a unix conform timezone value like in /etc/timezone.
 353 .PP
 354
 355 .B governmentmode
 356 .I bool
 357 .PP
 358 The
 359 .I governmentmode
 360 statement enables the IVBB mode inside of GOsa. You need the ivbb.schema
 361 file from used by german authorities.
 362 .PP
 363
 364 .B strict
 365 .I bool
 366 .PP
 367 The
 368 .I strict
 369 statement enables strict checking of uids and group names. If you need
 370 characters like . or - inside of your accounts, set this to
 371 .I false.
 372 .PP
 373
 374 .B strict_units
 375 .I bool
 376 .PP
 377 The
 378 .I strict_units
 379 statement enables checking of
 380 .I unitTag
 381 attributes when using administrative units. If this is set to
 382 .I true
 383 GOsa can only see objects inside the administrative unit a
 384 user is logged into.
 385 .PP
 386
 387 .B rfc2307bis
 388 .I bool
 389 .PP
 390 The
 391 .I rfc2307bis
 392 statement enables rfc2307bis style groups in GOsa. You can use
 393 .I member
 394 attributes instead of memberUid in this case. To make it work
 395 on unix systems, you've to adjust your NSS configuration to
 396 use rfc2307bis style groups, too.
 397 .PP
 398
 399 .B ppd_path
 400 .I path
 401 .PP
 402 The
 403 .I ppd_path
 404 variable defines where to store PPD files for the GOto environment plugins.
 405 .PP
 406 .PP
 407
 408
 409 .B Browser and display options
 410
 411 .B list_summary
 412 .I true/false
 413 .PP
 414 The
 415 .I list_summary
 416 statement determines whether a status bar will be shown on the bottom of
 417 GOsa generated lists, displaying a short summary of type and number of
 418 elements in the list.
 419 .PP
 420
 421 .B compressed
 422 .I true/false
 423 .PP
 424 The
 425 .I compressed
 426 statement determines whether PHP should send compressed HTML pages to
 427 browsers or not. This may increase or decrease the performance, depending
 428 on your network.
 429 .PP
 430
 431 .B save_filter
 432 .I true/false
 433 .PP
 434 The
 435 .I save_filter
 436 statement determines whether GOsa should store filter and plugin settings
 437 inside of a cookie.
 438 .PP
 439
 440 .B lang
 441 .I string
 442 .PP
 443 The
 444 .I lang
 445 statement defines the default language used by GOsa. Normally GOsa autodetects
 446 the language from the browser settings. If this is not working or you want to
 447 force the language, just add the language code (i.e. de for german) here.
 448 .PP
 449
 450 .B theme
 451 .I string
 452 .PP
 453 The
 454 .I theme
 455 statement defines what theme is used to display GOsa pages. You can install some
 456 corporate identity like theme and/or modify certain templates to fit your needs
 457 within themes. Take a look at the GOsa
 458 .I FAQ
 459 for more information.
 460 .PP
 461
 462 .B session_lifetime
 463 .I int
 464 .PP
 465 The
 466 .I session_lifetime
 467 value defines when a session will expire in seconds. For Debian systems, this will
 468 not work because the sessions will be removed by a cron job instead. Please modify
 469 the value inside of your php.ini instead.
 470 .PP
 471
 472 .B noprimarygroup
 473 .I bool
 474 .PP
 475 The
 476 .I noprimarygroup
 477 variable enables or disables the group filter to show primary user groups. It is
 478 time consuming to evaluate which groups are primary and which are not. So you may
 479 want to set it to
 480 .I true
 481 if your group plugin is slow.
 482 .PP
 483 .PP
 484
 485 .B Password options
 486 .PP
 487 .B pwminlen
 488 .I integer
 489 .PP
 490 The
 491 .I pwminlen
 492 statement determines whether a newly entered password has to be of
 493 a minimum length.
 494 .PP
 495
 496 .B pwdiffer
 497 .I integer
 498 .PP
 499 The
 500 .I pwdiffer
 501 statement determines whether a newly entered password has to be checked
 502 to have at least n different characters.
 503 .PP
 504
 505 .B externalpwdhook
 506 .I path
 507 .PP
 508 The
 509 .I externalpwdhook
 510 can specify an external script to handle password settings at some other
 511 location besides the LDAP. It will be called this way:
 512
 513 .nf
 514 /path/to/your/script "username" "oldpassword" "newpassword"
 515 .fi
 516
 517 .B account_expiration
 518 .I bool
 519 .PP
 520 The
 521 .I account_expiration
 522 statement enables shadow attribute tests during the login to the GOsa web
 523 interface and forces password renewal or account lockout.
 524 .PP
 525
 526 .B krbsasl
 527 .I bool
 528 .PP
 529 The
 530 .I krbsasl
 531 statement defines the way the kerberos realm is stored in the
 532 .I userPassword
 533 attribute. Set it to
 534 .I true
 535 in order to get {sasl}user@REALM.NET, or to
 536 .I false
 537 to get {kerberos}user@REALM.NET. The latter is outdated, but may be
 538 needed from time to time.
 539 .PP
 540
 541
 542
 543
 544
 545 .SH AUTHOR
 546 .B gosa.conf(5)
 547 was written by Cajus Pollmeier for
 548 the GOsa project (
 549 .B http://www.gosa-project.org
 550 ).