shisa.conf.in

   1 # shisa.conf --- Database configuration file for Shishi.             -*- sh -*-
   2 # Copyright 2002, 2003, 2004  Simon Josefsson
   3 #
   4 # Copying and distribution of this file, with or without modification,
   5 # are permitted in any medium without royalty provided the copyright
   6 # notice and this notice are preserved.
   7 #
   8 # If the first non white space character of a line is a '#', the line
   9 # is ignored.  Empty lines are also ignored.
  10 #
  11 # See the manual for a complete list of options.
  12
  13 # db [OPTIONS] <TYPE> [LOCATION] [PARAMETERS ...]
  14
  15 # Specify the data sources for Shisa data.  Multiple entries, even of
  16 # the same data source type, are allowed.  The data sources are
  17 # accessed in the same sequence as they are defined here.  If an entry
  18 # is found in one data source, it will be used for the operations,
  19 # without searching the remaining data sources.  Valid OPTIONS
  20 # include:
  21
  22 # --read-only       No data is written to this data source.
  23 # --ignore-errors   Ignore failures in this backend.
  24
  25 # The default (when the configuration file is empty) uses one "file"
  26 # data source (see below), but for a larger installation you may want
  27 # to combine several data sources.  Here is an example.
  28
  29 # db --read-only file /var/local/master
  30 # db --ignore-errors ldap kdc.example.org ca=/etc/shisa/kdc-ca.pem
  31 # db --read-only file /var/cache/ldap-copy
  32
  33 # This demonstrate how you can store critical principals on local disk
  34 # (the first entry, /var/local/master) that will always be found
  35 # without looking in the LDAP directory.  The critical principals
  36 # could be, e.g., krbtgt/EXAMPLE.ORG.  The second entry denote a LDAP
  37 # server that could hold user principals.  As you can see, Shisa will
  38 # not let the caller know about errors with the LDAP source (they will
  39 # be logged, however).  Instead, if for instance the LDAP server has
  40 # crashed, Shisa would continue and read from the /var/cache/ldap-copy
  41 # file source.  That file source may have been set up to contain a
  42 # copy of the data in the LDAP server, perhaps made on an hourly
  43 # basis, so that your server will be able to serve recent data even in
  44 # case of a crash.  Any updates or passwords change requests will
  45 # however not be possible while the LDAP server is inaccessible, to
  46 # reduce the problem of synchronizing data back into the LDAP server
  47 # once it is online again.
  48
  49 # Currently only the "file" data source is supported, and denote a
  50 # data source that use the standard file system for storage.
  51 #
  52 # Valid syntaxes for the "file" database:
  53 # db file FILENAME
  54 #
  55 # Examples:
  56 # db file /var/shishi
  57 # db file /usr/share/shishi read-only
  58 #
  59 # If nothing is specified, the default will be:
  60 # db file /usr/local/var/shishi/shisa.db