man/man5/afp_ldap.conf.5.tmpl

   1 .\"     Title: afp_ldap.conf
   2 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
   3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
   4 .\"      Date: 31-01-2009
   5 .\"    Manual: Netatalk 2.0 Manual
   6 .\"    Source: :NETATALK_VERSION:
   7 .\"  Language: English
   8 .\"
   9 .TH "LDAP\&.CONF" "5" "31-01-2009" ":NETATALK_VERSION:" "Netatalk 2.0 Manual"
  10 .\" -----------------------------------------------------------------
  11 .\" * (re)Define some macros
  12 .\" -----------------------------------------------------------------
  13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  14 .\" BB/BE - put background/screen (filled box) around block of text
  15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  16 .de BB
  17 .if t \{\
  18 .sp -.5
  19 .br
  20 .in +2n
  21 .ll -2n
  22 .gcolor red
  23 .di BX
  24 .\}
  25 ..
  26 .de EB
  27 .if t \{\
  28 .if "\\$2"adjust-for-leading-newline" \{\
  29 .sp -1
  30 .\}
  31 .br
  32 .di
  33 .in
  34 .ll
  35 .gcolor
  36 .nr BW \\n(.lu-\\n(.i
  37 .nr BH \\n(dn+.5v
  38 .ne \\n(BHu+.5v
  39 .ie "\\$2"adjust-for-leading-newline" \{\
  40 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
  41 .\}
  42 .el \{\
  43 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
  44 .\}
  45 .in 0
  46 .sp -.5v
  47 .nf
  48 .BX
  49 .in
  50 .sp .5v
  51 .fi
  52 .\}
  53 ..
  54 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  55 .\" BM/EM - put colored marker in margin next to block of text
  56 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  57 .de BM
  58 .if t \{\
  59 .br
  60 .ll -2n
  61 .gcolor red
  62 .di BX
  63 .\}
  64 ..
  65 .de EM
  66 .if t \{\
  67 .br
  68 .di
  69 .ll
  70 .gcolor
  71 .nr BH \\n(dn
  72 .ne \\n(BHu
  73 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
  74 .in 0
  75 .nf
  76 .BX
  77 .in
  78 .fi
  79 .\}
  80 ..
  81 .\" -----------------------------------------------------------------
  82 .\" * set default formatting
  83 .\" -----------------------------------------------------------------
  84 .\" disable hyphenation
  85 .nh
  86 .\" disable justification (adjust text to left margin only)
  87 .ad l
  88 .\" -----------------------------------------------------------------
  89 .\" * MAIN CONTENT STARTS HERE *
  90 .\" -----------------------------------------------------------------
  91 .SH "Name"
  92 afp_ldap.conf \- Configuration file used by afpd(8) to configure a LDAP connection to an LDAP server\&. That is needed for ACL support in order to be able to query LDAP for UUIDs\&.
  93 .SH "Description"
  94 .PP
  95 \FC:ETCDIR:/ldap\&.conf\F[]
  96 is the configuration file used by
  97 \fBafpd\fR
  98 to set up an LDAP connection to an LDAP server\&.
  99 .PP
 100 Any line not prefixed with # is interpreted\&.
 101 .PP
 102 .if n \{\
 103 .sp
 104 .\}
 105 .RS 4
 106 .BM yellow
 107 .it 1 an-trap
 108 .nr an-no-space-flag 1
 109 .nr an-break-flag 1
 110 .br
 111 .ps +1
 112 \fBNote\fR
 113 .ps -1
 114 .br
 115 .PP
 116 You can use
 117 \fBafpldaptest\fR(1)
 118 to syntactically check your config
 119 .sp .5v
 120 .EM yellow
 121 .RE
 122 The required parameters and their meanings are:
 123 .SH "Parameter"
 124 .PP
 125 ldap_server
 126 .RS 4
 127 Name or IP address of your LDAP Server
 128 .sp
 129 .RE
 130 .PP
 131 ldap_auth_method
 132 .RS 4
 133 <none|simple|sasl>
 134 .PP
 135 none
 136 .RS 4
 137 anonymous LDAP bind
 138 .RE
 139 .PP
 140 simple
 141 .RS 4
 142 simple LDAP bind
 143 .RE
 144 .PP
 145 sasl
 146 .RS 4
 147 SASL\&. Not yet supported !
 148 .RE
 149 .RE
 150 .PP
 151 ldap_auth_dn
 152 .RS 4
 153 Distinguished Name of the user for simple bind\&.
 154 .sp
 155 .RE
 156 .PP
 157 ldap_auth_pw
 158 .RS 4
 159 Distinguished Name of the user for simple bind\&.
 160 .sp
 161 .RE
 162 .PP
 163 ldap_userbase
 164 .RS 4
 165 DN of the user container in LDAP\&.
 166 .sp
 167 .RE
 168 .PP
 169 ldap_groupbase
 170 .RS 4
 171 DN of the group container in LDAP\&.
 172 .sp
 173 .RE
 174 .PP
 175 ldap_uuuid_attr
 176 .RS 4
 177 Name of the LDAP attribute with the UUIDs\&.
 178 .sp
 179 Note: this is used both for users and groups\&.
 180 .sp
 181 .RE
 182 .PP
 183 ldap_name_attr
 184 .RS 4
 185 Name of the LDAP attribute with the users short name\&.
 186 .sp
 187 .RE
 188 .PP
 189 ldap_group_attr
 190 .RS 4
 191 Name of the LDAP attribute with the groups short name\&.
 192 .sp
 193 .RE
 194 .SH "Examples"
 195 .PP
 196 \fBExample.\ \&afp_ldap.conf setup with simple bind\fR
 197 .sp
 198 .if n \{\
 199 .RS 4
 200 .\}
 201 .fam C
 202 .ps -1
 203 .nf
 204 .BB lightgray
 205 ldap_server      = localhost
 206 ldap_auth_method = simple
 207 ldap_auth_dn     = cn=admin,dc=domain,dc=org
 208 ldap_auth_pw     = notthisone
 209 ldap_userbase    = ou=users,dc=domain,dc=org
 210 ldap_groupbase   = ou=groups,dc=domain,dc=org
 211 ldap_uuid_attr   = some_attribute
 212 ldap_name_attr   = cn
 213 ldap_group_attr  = cn
 214 .EB lightgray
 215 .fi
 216 .fam
 217 .ps +1
 218 .if n \{\
 219 .RE
 220 .\}
 221 .SH "See also"
 222 .PP
 223 \fBafpd\fR(8),
 224 \fBAppleVolumes.default\fR(5),\fBafpldaptest\fR(1)