Remove mailSpamOptOut ldap attribute - it isn't used anywhere.
[mirror/userdir-ldap.git] / doc / ud-generate.8.yo
1 mailto(admin@db.debian.org)
2 manpage(ud-generate)(1)(17 Sep 1999)(userdir-ldap)()
3 manpagename(ud-generate)(Produce machine specific formatted version of the
4 directory)
5
6 manpagesynopsis()
7   ud-generate
8
9 manpagedescription()
10
11 ud-generate prouces machine specific versions of the directory in the
12 following formats:
13
14 itemize(
15   it() passwd file [in normal and DB form]
16   it() shadow file [in normal and DB form]
17   it() group file [in normal and DB form]
18   it() Exim forwarding file [cdb]
19   it() XEarth makers file
20   it() SSH authorized key file [cdb and flat]
21   it() debian.net DNS zone
22 )
23
24 Generation of the files is controlled by the configuration file
25 bf(/etc/userdir-ldap/ud-generate.conf). The output is placed in
26 bf(/var/cache/userdir-ldap/hosts/<hostname>/). Each host listed in the
27 configuration file has its own home dir path and its own list of groups that
28 are allowed to login to the machine.
29
30 The format of the configuration file is a one line per host with these fields:
31 verb(host homedirpath group1 group2 ...)
32 Only users who are a member of the named groups or has a specific host acl 
33 are emitted to the output files.
34
35 The special groups bf([DNS]) and bf([PRIVATE]) control replication of the
36 debian.net zone and the debian-private subscription list.
37
38 Authorization to read protected entries from the directory is achieved by
39 reading a username and password from the pass- file in the userdir-ldap
40 directory.
41
42 manpagefiles()
43 itemize(
44   it() /etc/userdir-ldap/userdir-ldap.conf
45   Configuration variables to select what server and what base DN to use.
46   it() /etc/userdir-ldap/ud-generate.conf
47   Configuration variables to determine how hosts are generated.
48   it() /etc/userdir-ldap/pass-<uid>
49   Directory authentication credentials
50 )
51
52 manpageauthor()
53 userdir-ldap was written by Jason Gunthorpe <jgg@debian.org>.
54