git.sur5r.net Git - openldap/blob - doc/man/man8/slurpd.8

   1 .TH SLURPD 8C "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2005 The OpenLDAP Foundation All Rights Reserved.
   4 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   5 .SH NAME
   6 slurpd \- Standalone LDAP Update Replication Daemon
   7 .SH SYNOPSIS
   8 .B LIBEXECDIR/slurpd [\-d debug\-level]
   9 .B [\-f slapd\-config\-file] [\-r slapd\-replog\-file]
  10 .B [\-t temp\-dir] [\-o] [\-k srvtab\-file]
  11 .B
  12 .SH DESCRIPTION
  13 .LP
  14 .B Slurpd
  15 is used to propagate changes from one slapd database to another.  If
  16 slapd is configured to produce a replication log,
  17 .B slurpd
  18 reads that
  19 replication log and sends the changes to the slave
  20 .B slapd
  21 instances
  22 via the LDAP protocol.
  23 .B slurpd
  24 is typically invoked at boot time, usually out of
  25 .BR  /etc/rc.local .
  26 .LP
  27 Upon startup,
  28 .B slurpd
  29 normally forks and disassociates itself from the invoking tty,
  30 then reads the replication log (given either by the
  31 .I replogfile
  32 directive in the
  33 .B slapd
  34 config file, or by the
  35 .RB \- r
  36 command-line option).
  37 If the replication log file does not exist or is empty,
  38 .B slurpd
  39 goes to sleep.  It periodically wakes up and checks to see if there
  40 are any changes to be propoagated.
  41 .LP
  42 When
  43 .B slurpd
  44 notices that there are changes to propagate to slave
  45 .B slapd
  46 instances, it locks the replication log, makes its own private copy,
  47 releases the lock, and forks one copy of itself for each replica
  48 .B slapd
  49 to be updated.  Each child process binds to the slave
  50 .B slapd
  51 as the
  52 DN given by the
  53 .I binddn
  54 option to the
  55 .I replica
  56 directive in the
  57 .B slapd
  58 config file, and sends the changes.
  59 .LP
  60 See
  61 .BR slapd (8)
  62 for details on the standalone LDAP daemon.
  63 .LP
  64 Note that slurpd reads
  65 .B replication
  66 directive from
  67 .BR slapd.conf (5),
  68 but uses
  69 .BR ldap.conf (5)
  70 to obtain other configuration settings (such as TLS settings).
  71 .SH OPTIONS
  72 .TP
  73 .BI \-d " debug\-level"
  74 Turn on debugging as defined by
  75 .I debug\-level.
  76 If this option is specified, even with a zero argument,
  77 .B slurpd
  78 will not fork or disassociate from the invoking terminal.  Some general
  79 operation and status messages are printed for any value of \fIdebug\-level\fP.
  80 \fIdebug\-level\fP is taken as a bit string, with each bit corresponding to a
  81 different kind of debugging information.  See <ldap.h> for details.
  82 .TP
  83 .BI \-f " slapd\-config\-file"
  84 Specifies the slapd configuration file.  The default is
  85 .BR ETCDIR/slapd.conf .
  86 .TP
  87 .BI \-r " slapd\-replog\-file"
  88 Specifies the name of the
  89 .B slapd
  90 replication logfile.  Normally, the name
  91 of the replication log file is read from the
  92 .B slapd
  93 configuration file.  The file should be located in a directory
  94 with limited read/write/execute access.
  95 The
  96 .B \-r
  97 option allows you to override this.  In conjunction with the
  98 .B \-o
  99 option, you can process a replication log file in a "one\-shot" mode.  For
 100 example, if
 101 .B slurpd
 102 has encountered errors in processing a replication log,
 103 you can run it in one\-shot mode and give the rejection file name as
 104 the argument to the \-r option, once you've resolved the problem which caused
 105 the replication to fail.
 106 .TP
 107 .B \-o
 108 Run in "one\-shot" mode.  Normally,
 109 .B slurpd
 110 processes the replog file
 111 and then watches for more replication entries to be appended.  In
 112 one\-shot mode,
 113 .B slurpd
 114 processes a replication log and exits.
 115 .TP
 116 .BI \-t " temp\-dir"
 117 .B slurpd
 118 copies the replication log to a working directory before processing it.
 119 The directory permissions should limit read/write/execute access as
 120 temporary files may contain sensitive information.
 121 This option allows you to specify the location of these temporary files.
 122 The default is
 123 .BR LOCALSTATEDIR/openldap-slurp .
 124 .TP
 125 .BI \-k " srvtab\-file"
 126 Specify the location of the kerberos srvtab file which contains keys
 127 for the replica
 128 .I slapd
 129 instances.  Overrides the srvtab argument to the
 130 replica directive in the
 131 .I slapd
 132 configuration file.
 133 .SH EXAMPLES
 134 To start
 135 .I slurpd
 136 and have it fork and detach from the terminal and process
 137 the replication logs generated by
 138 .I slapd,
 139 just type:
 140 .LP
 141 .nf
 142 .ft tt
 143         LIBEXECDIR/slurpd
 144 .ft
 145 .fi
 146 .LP
 147 To start
 148 .I slurpd
 149 with an alternate
 150 .I slapd
 151 configuration file, and turn
 152 on voluminous debugging which will be printed on standard error, type:
 153 .LP
 154 .nf
 155 .ft tt
 156         LIBEXECDIR/slurpd -f ETCDIR/slapd.conf -d 255
 157 .ft
 158 .fi
 159 .LP
 160 .SH "SEE ALSO"
 161 .BR ldap (3),
 162 .BR ldap.conf (5),
 163 .BR slapd.conf (5),
 164 .BR slapd.replog (5),
 165 .BR slapd (8)
 166 .LP
 167 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
 168 .SH ACKNOWLEDGEMENTS
 169 .B OpenLDAP
 170 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 171 .B OpenLDAP
 172 is derived from University of Michigan LDAP 3.3 Release.