.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "LDAP-GIT-BACKUP 1"
.TH LDAP-GIT-BACKUP 1 "2021-01-06" "1.0.8" "User Commands"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
ldap\-git\-backup \- check in LDIF from an LDAP server into a GIT repository
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
ldap-git-backup [options]
.PP
ldap-git-backup \-\-help
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
ldap-git-backup takes an \s-1LDIF\s0 dump of an \s-1LDAP\s0 server and updates a \s-1GIT\s0 repository
that serves as a versioned backup.
.PP
ldap-git-backup splits the \s-1LDIF\s0 data into separate entries.  It constructs
unique but stable file names using a combination of the creation time stamp for
ordering and the \s-1DN\s0 as the unique key for an entry.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-\-ldif\-cmd <dump_ldif_command>\fR" 4
.IX Item "--ldif-cmd <dump_ldif_command>"
Specify a command to create a complete \s-1LDIF\s0 dump of the \s-1LDAP\s0 directory suitable
for a backup.  It should contain all entries necessary to restore the \s-1LDAP\s0
database.  By default \f(CW\*(C`/usr/sbin/safe\-ldif\*(C'\fR is taken which calls
\&\f(CW\*(C`/usr/sbin/slapcat\*(C'\fR from OpenLDAP.
.Sp
If you have access to an \s-1LDAP\s0 server over the network you can use ldapsearch as
your \f(CW\*(C`\-\-ldif\-cmd\*(C'\fR.  Example:
.RS 4
.Sp
.Vb 2
\&  \-\-ldif\-cmd \*(Aqldapsearch \-u \-x \-o ldif\-wrap=no \e
\&  \-H ldaps://ldap.example.org \-b dc=example,dc=org\*(Aq
.Ve
.RE
.RS 4
.Sp
If you need to log in to a certain server first you would use something along
the lines of
.Sp
.Vb 2
\&  \-\-ldif\-cmd \*(Aqssh host.example.org ldapsearch \-u \-x \-o ldif\-wrap=no \e
\&  \-H ldaps://ldap.example.org \-b dc=example,dc=org\*(Aq
.Ve
.RE
.RS 4
.Sp
You can make this as complicated as you like as long as it fits into a one line
command.  If you need more you may want to create a script for the purpose.
.RE
.IP "\fB\-\-backup\-dir <backup_directory>\fR" 4
.IX Item "--backup-dir <backup_directory>"
Specify the directory where the \s-1GIT\s0 repository for the versioned backup is held.
Default: \fI/var/backups/ldap\fR
.IP "\fB\-\-commit\-msg <commit_string>\fR" 4
.IX Item "--commit-msg <commit_string>"
Specify a custom commit message.  Default: ldap-git-backup
.Sp
Example:
.RS 4
.Sp
.Vb 1
\&  \-\-commit\-msg "Import $(date \-\-rfc\-3339=seconds)"
.Ve
.RE
.RS 4
.RE
.IP "\fB\-\-commit\-date <date_string>\fR" 4
.IX Item "--commit-date <date_string>"
.PD 0
.IP "\fB\-\-commit\-date <file>\fR" 4
.IX Item "--commit-date <file>"
.PD
Specify a custom commit date.  If a file is given its modification time is used.
.IP "\fB\-\-no\-gc\fR" 4
.IX Item "--no-gc"
Do not perform a garbage collection (git gc) after checking in the new backup.
By default gc is done so as to keep the size of the backup down.  You may want
to skip gc for the occasional backup run but leave it on for the scheduled
backups.
.IP "\fB\-\-help\fR" 4
.IX Item "--help"
Prints this page.
.SH "AUTHOR"
.IX Header "AUTHOR"
Elmar S. Heeb <elmar@heebs.ch>