man/man5/afp_ldap.conf.5.tmpl

   1 '\" t
   2 .\"     Title: afp_ldap.conf
   3 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
   5 .\"      Date: 28 November 2009
   6 .\"    Manual: Netatalk 2.1
   7 .\"    Source: Netatalk 2.1
   8 .\"  Language: English
   9 .\"
  10 .TH "AFP_LDAP\&.CONF" "5" "28 November 2009" "Netatalk 2.1" "Netatalk 2.1"
  11 .\" -----------------------------------------------------------------
  12 .\" * set default formatting
  13 .\" -----------------------------------------------------------------
  14 .\" disable hyphenation
  15 .nh
  16 .\" disable justification (adjust text to left margin only)
  17 .ad l
  18 .\" -----------------------------------------------------------------
  19 .\" * MAIN CONTENT STARTS HERE *
  20 .\" -----------------------------------------------------------------
  21 .SH "NAME"
  22 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\&.
  23 .SH "DESCRIPTION"
  24 .PP
  25 :ETCDIR:/afp_ldap\&.conf
  26 is the configuration file used by
  27 \fBafpd\fR
  28 to set up an LDAP connection to an LDAP server\&.
  29 .PP
  30 Any line not prefixed with # is interpreted\&.
  31 .PP
  32 .if n \{\
  33 .sp
  34 .\}
  35 .RS 4
  36 .it 1 an-trap
  37 .nr an-no-space-flag 1
  38 .nr an-break-flag 1
  39 .br
  40 .ps +1
  41 \fBNote\fR
  42 .ps -1
  43 .br
  44 .PP
  45 You can use
  46 \fBafpldaptest\fR(1)
  47 to syntactically check your config
  48 .sp .5v
  49 .RE
  50 The required parameters and their meanings are:
  51 .SH "PARAMETER"
  52 .PP
  53 ldap_server
  54 .RS 4
  55 Name or IP address of your LDAP Server
  56 .sp
  57 .RE
  58 .PP
  59 ldap_auth_method
  60 .RS 4
  61 Authentication method:
  62 \fBnone | simple | sasl\fR
  63 .PP
  64 none
  65 .RS 4
  66 anonymous LDAP bind
  67 .RE
  68 .PP
  69 simple
  70 .RS 4
  71 simple LDAP bind
  72 .RE
  73 .PP
  74 sasl
  75 .RS 4
  76 SASL\&. Not yet supported !
  77 .RE
  78 .RE
  79 .PP
  80 ldap_auth_dn
  81 .RS 4
  82 Distinguished Name of the user for simple bind\&.
  83 .sp
  84 .RE
  85 .PP
  86 ldap_auth_pw
  87 .RS 4
  88 Distinguished Name of the user for simple bind\&.
  89 .sp
  90 .RE
  91 .PP
  92 ldap_userbase
  93 .RS 4
  94 DN of the user container in LDAP\&.
  95 .sp
  96 .RE
  97 .PP
  98 ldap_userscope
  99 .RS 4
 100 Search scope for user search:
 101 \fBbase | one | sub\fR
 102 .sp
 103 .RE
 104 .PP
 105 ldap_groupbase
 106 .RS 4
 107 DN of the group container in LDAP\&.
 108 .sp
 109 .RE
 110 .PP
 111 ldap_groupscope
 112 .RS 4
 113 Search scope for user search:
 114 \fBbase | one |\ \&sub\fR
 115 .sp
 116 .RE
 117 .PP
 118 ldap_uuuid_attr
 119 .RS 4
 120 Name of the LDAP attribute with the UUIDs\&.
 121 .sp
 122 Note: this is used both for users and groups\&.
 123 .sp
 124 .RE
 125 .PP
 126 ldap_name_attr
 127 .RS 4
 128 Name of the LDAP attribute with the users short name\&.
 129 .sp
 130 .RE
 131 .PP
 132 ldap_group_attr
 133 .RS 4
 134 Name of the LDAP attribute with the groups short name\&.
 135 .sp
 136 .RE
 137 .SH "EXAMPLES"
 138 .PP
 139 \fBExample.\ \&afp_ldap.conf setup with simple bind\fR
 140 .sp
 141 .if n \{\
 142 .RS 4
 143 .\}
 144 .nf
 145 ldap_server      = localhost
 146 ldap_auth_method = simple
 147 ldap_auth_dn     = cn=admin,dc=domain,dc=org
 148 ldap_auth_pw     = notthisone
 149 ldap_userbase    = ou=users,dc=domain,dc=org
 150 ldap_userscope   = one
 151 ldap_groupbase   = ou=groups,dc=domain,dc=org
 152 ldap_groupscope  = one
 153 ldap_uuid_attr   = some_attribute
 154 ldap_name_attr   = cn
 155 ldap_group_attr  = cn
 156 .fi
 157 .if n \{\
 158 .RE
 159 .\}
 160 .SH "SEE ALSO"
 161 .PP
 162 \fBafpd\fR(8),
 163 \fBAppleVolumes.default\fR(5),\fBafpldaptest\fR(1)