ITS#10059 - Add configuration example for slapo-homedir(5)

diff --git a/doc/man/man5/slapo-homedir.5 b/doc/man/man5/slapo-homedir.5
index a843b44452ceb731b22a3472fd5bdb97d29bb34f..cb1ac5b101995e8db0a23dde9e4f7dafac4a2a39 100644 (file)
--- a/doc/man/man5/slapo-homedir.5
+++ b/doc/man/man5/slapo-homedir.5
@@ -90,6 +90,32 @@ for more information on configure syncrepl.
 
 Partial replication (e.g. with filters) is especially useful for
 providing different provisioning options to different sets of users.
+.SH EXAMPLE
+The following LDIF could be used to add this overlay to
+.B cn=config
+(adjust to suit)
+.LP
+.RS
+.nf
+dn: cn=module{0},cn=config
+changetype: modify
+add: olcModuleLoad
+olcModuleLoad: homedir
+
+dn: olcOverlay=homedir,olcDatabase={1}mdb,cn=config
+changetype: add
+objectClass: olcOverlayConfig
+objectClass: olcHomedirConfig
+olcOverlay: homedir
+olcSkeletonPath: /etc/skel
+olcMinimumUidNumber: 1000
+olcHomedirRegexp: ^(/home/[-_/a-z0-9]+)$ /export/$1
+olcHomedirDeleteStyle: ARCHIVE
+olcHomedirArchivePath: /archive
+.fi
+.RE
+.LP
+
 .SH BUGS
 DELETE, MOD, and MODRDN operations that remove the unix attributes
 when delete style is set to DELETE will recursively delete the (regex
@@ -113,6 +139,7 @@ resolve uid/gid into symbolic names.
 
 No attempt is made to try to mkdir() the parent directories needed for
 a given home directory or archive path.
+
 .SH FILES
 .TP
 ETCDIR/slapd.conf