man/man5/afpd.conf.5.tmpl

   1 '\" t
   2 .\"     Title: afpd.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: 1 Feb 2009
   6 .\"    Manual: Netatalk 2.0.4
   7 .\"    Source: Netatalk 2.0.4
   8 .\"  Language: English
   9 .\"
  10 .TH "AFPD\&.CONF" "5" "1 Feb 2009" "Netatalk 2\&.0\&.4" "Netatalk 2.0.4"
  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 afpd.conf \- Configuration file used by afpd(8) to determine the setup of its file sharing services
  23 .SH "DESCRIPTION"
  24 .PP
  25 :ETCDIR:/afpd\&.conf
  26 is the configuration file used by
  27 \fBafpd\fR
  28 to determine the behavior and configuration of the different virtual file servers that it provides\&.
  29 .PP
  30 Any line not prefixed with # is interpreted\&. The configuration lines are composed like: server name [ options ] If a
  31 \fB\-\fR
  32 is used instead of a server name, the default server is specified\&. Server names must be quoted if they contain spaces\&. They must not contain ":" or "@"\&. The path name must be a fully qualified path name, or a path name using either the ~ shell shorthand or any of the substitution variables, which are listed below\&.
  33 .PP
  34 .if n \{\
  35 .sp
  36 .\}
  37 .RS 4
  38 .it 1 an-trap
  39 .nr an-no-space-flag 1
  40 .nr an-break-flag 1
  41 .br
  42 .ps +1
  43 \fBNote\fR
  44 .ps -1
  45 .br
  46 .PP
  47 Each server has to be configured on a
  48 \fBsingle\fR
  49 line\&. Though newline escaping is supported\&.
  50 .sp .5v
  51 .RE
  52 The possible options and their meanings are:
  53 .SH "APPLEVOLUMES FILES"
  54 .PP
  55 \-defaultvol \fI[path]\fR
  56 .RS 4
  57 Specifies path to AppleVolumes\&.default file (default is
  58 :ETCDIR:/AppleVolumes\&.default)\&.
  59 .RE
  60 .PP
  61 \-systemvol \fI[path]\fR
  62 .RS 4
  63 Specifies path to AppleVolumes\&.system file (default is
  64 :ETCDIR:/AppleVolumes\&.system)\&.
  65 .RE
  66 .PP
  67 \-[no]uservol
  68 .RS 4
  69 Enables or disables reading of the users\' individual volumes file entirely\&.
  70 .RE
  71 .PP
  72 \-[no]uservolfirst
  73 .RS 4
  74 Enables or disables reading of the users\' individual volumes file before processing the global
  75 AppleVolumes\&.default
  76 file\&.
  77 .RE
  78 .SH "AUTHENTICATION METHODS"
  79 .PP
  80 \-uamlist \fI[uams list]\fR
  81 .RS 4
  82 Comma separated list of UAMs\&. (The default is uams_dhx\&.so,uams_dhx2\&.so)\&.
  83 .sp
  84 The most commonly used UAMs are:
  85 .PP
  86 uams_guest\&.so
  87 .RS 4
  88 allows guest logins
  89 .RE
  90 .PP
  91 uams_clrtxt\&.so
  92 .RS 4
  93 (uams_pam\&.so or uams_passwd\&.so) Allow logins with passwords transmitted in the clear\&.
  94 .RE
  95 .PP
  96 uams_randum\&.so
  97 .RS 4
  98 allows Random Number and Two\-Way Random Number Exchange for authentication (requires a separate file containing the passwords, either :ETCDIR:/afppasswd file or the one specified via
  99 \fB\-passwdfile\fR\&. See
 100 \fBafppasswd\fR(1)
 101 for details
 102 .RE
 103 .PP
 104 uams_dhx\&.so
 105 .RS 4
 106 (uams_dhx_pam\&.so or uams_dhx_passwd\&.so) Allow Diffie\-Hellman eXchange (DHX) for authentication\&.
 107 .RE
 108 .PP
 109 uams_dhx2\&.so
 110 .RS 4
 111 (uams_dhx2_pam\&.so or uams_dhx2_passwd\&.so) Allow Diffie\-Hellman eXchange 2 (DHX2) for authentication\&.
 112 .RE
 113 .PP
 114 uam_gss\&.so
 115 .RS 4
 116 Allow Kerberos V for authentication (optional)
 117 .RE
 118 .RE
 119 .PP
 120 \-uampath \fI[path]\fR
 121 .RS 4
 122 Sets the default path for UAMs for this server (default is :ETCDIR:/uams)\&.
 123 .RE
 124 .PP
 125 \-k5keytab \fI[path]\fR, \-k5service \fI[service]\fR, \-k5realm \fI[realm]\fR
 126 .RS 4
 127 These are required if the server supports the Kerberos 5 authentication UAM\&.
 128 .RE
 129 .SH "CODEPAGE OPTIONS"
 130 .PP
 131 With OS X Apple introduced the AFP3 protocol\&. One of the big changes was, that AFP3 uses Unicode names encoded as UTF\-8 decomposed\&. Previous AFP/OS versions used codepages like MacRoman, MacCentralEurope, etc\&.
 132 .PP
 133 To be able to serve AFP3 and older clients at the same time,
 134 \fBafpd\fR
 135 needs to be able to convert between UTF\-8 and Mac codepages\&. Even OS X clients partly still rely on codepages\&. As there\'s no way,
 136 \fBafpd\fR
 137 can detect the codepage a pre AFP3 client uses, you have to specify it using the
 138 \fB\-maccodepage\fR
 139 option\&. The default is MacRoman, which should be fine for most western users\&.
 140 .PP
 141 As
 142 \fBafpd\fR
 143 needs to interact with unix operating system as well, it need\'s to be able to convert from UTF\-8/MacCodepage to the unix codepage\&. By default
 144 \fBafpd\fR
 145 uses the systems LOCALE, or ASCII if your system doesn\'t support locales\&. You can set the unix codepage using the
 146 \fB\-unixcodepage\fR
 147 option\&. If you\'re using extended characters in the configuration files for
 148 \fBafpd\fR, make sure your terminal matches the
 149 \fB\-unixcodepage\fR\&.
 150 .PP
 151 \-unixcodepage [\fICODEPAGE\fR]
 152 .RS 4
 153 Specifies the servers unix codepage, e\&.g\&. "ISO\-8859\-15" or "UTF8"\&. This is used to convert strings to/from the systems locale, e\&.g\&. for authenthication, server messages and volume names\&. Defaults to LOCALE if your system supports it, otherwise ASCII will be used\&.
 154 .RE
 155 .PP
 156 \-maccodepage [\fICODEPAGE\fR]
 157 .RS 4
 158 Specifies the mac clients codepage, e\&.g\&. "MAC_ROMAN"\&. This is used to convert strings and filenames to the clients codepage for OS9 and Classic, i\&.e\&. for authentication and AFP messages (SIGUSR2 messaging)\&. This will also be the default for the volumes maccharset\&. Defaults to MAC_ROMAN\&.
 159 .RE
 160 .SH "PASSWORD OPTIONS"
 161 .PP
 162 \-loginmaxfail [\fInumber\fR]
 163 .RS 4
 164 Sets the maximum number of failed logins, if supported by the UAM (currently none)
 165 .RE
 166 .PP
 167 \-passwdfile [\fIpath\fR]
 168 .RS 4
 169 Sets the path to the Randnum UAM passwd file for this server (default is :ETCDIR:/afppasswd)\&.
 170 .RE
 171 .PP
 172 \-passwdminlen [\fInumber\fR]
 173 .RS 4
 174 Sets the minimum password length, if supported by the UAM
 175 .RE
 176 .PP
 177 \-[no]savepassword
 178 .RS 4
 179 Enables or disables the ability of clients to save passwords locally
 180 .RE
 181 .PP
 182 \-[no]setpassword
 183 .RS 4
 184 Enables or disables the ability of clients to change their passwords via chooser or the "connect to server" dialog
 185 .RE
 186 .SH "TRANSPORT PROTOCOLS"
 187 .PP
 188 \-[no]ddp
 189 .RS 4
 190 Enables or disables AFP\-over\-Appletalk\&. If
 191 \fB\-proxy\fR
 192 is specified, you must instead use
 193 \fB\-uamlist ""\fR
 194 to prevent DDP connections from working\&.
 195 .RE
 196 .PP
 197 \-[no]tcp
 198 .RS 4
 199 Enables or disables AFP\-over\-TCP
 200 .RE
 201 .PP
 202 \-transall
 203 .RS 4
 204 Make both available (default)
 205 .RE
 206 .SH "TRANSPORT OPTIONS"
 207 .PP
 208 \-advertise_ssh
 209 .RS 4
 210 Allows Mac OS X clients (10\&.3\&.3 or above) to automagically establish a tunneled AFP connection through SSH\&. If this option is set, the server\'s answers to client\'s FPGetSrvrInfo requests contain an additional entry\&. It depends on both client\'s settings and a correctly configured and running
 211 \fBsshd\fR(8)
 212 on the server to let things work\&.
 213 .if n \{\
 214 .sp
 215 .\}
 216 .RS 4
 217 .it 1 an-trap
 218 .nr an-no-space-flag 1
 219 .nr an-break-flag 1
 220 .br
 221 .ps +1
 222 \fBNote\fR
 223 .ps -1
 224 .br
 225 Setting this option is not recommended since globally encrypting AFP connections via SSH will increase the server\'s load significantly\&. On the other hand, Apple\'s client side implementation of this feature in MacOS X versions prior to 10\&.3\&.4 contained a security flaw\&.
 226 .sp .5v
 227 .RE
 228 .RE
 229 .PP
 230 \-ddpaddr \fI[ddp address]\fR
 231 .RS 4
 232 Specifies the DDP address of the server\&. The default is to auto\-assign an address (0\&.0)\&. This is only useful if you are running AppleTalk on more than one interface\&.
 233 .RE
 234 .PP
 235 \-fqdn \fI[name:port]\fR
 236 .RS 4
 237 Specifies a fully\-qualified domain name, with an optional port\&. This is discarded if the server cannot resolve it\&. This option is not honored by AppleShare clients <= 3\&.8\&.3\&. This option is disabled by default\&. Use with caution as this will involve a second name resolution step on the client side\&. Also note that afpd will advertise this name:port combination but not automatically listen to it\&.
 238 .RE
 239 .PP
 240 \-ipaddr \fI[ip address]\fR
 241 .RS 4
 242 Specifies the IP address that the server should advertise
 243 \fBand\fR
 244 listens to (the default is the first IP address of the system)\&. This option also allows to use one machine to advertise the AFP\-over\-TCP/IP settings of another machine via NBP
 245 when used together with the
 246 \fB\-proxy\fR
 247 option\&.
 248 .RE
 249 .PP
 250 \-port \fI[port number]\fR
 251 .RS 4
 252 Allows a different TCP port to be used for AFP\-over\-TCP\&. The default is 548\&.
 253 .RE
 254 .PP
 255 \-proxy
 256 .RS 4
 257 Runs an AppleTalk proxy server for the specified AFP\-over\-TCP server\&. If the address and port aren\'t given, then the first IP address of the system and port 548 will be used\&. If you don\'t want the proxy server to act as a DDP
 258 server as well, set
 259 \fB\-uamlist ""\fR\&.
 260 .RE
 261 .PP
 262 \-server_quantum \fI[number]\fR
 263 .RS 4
 264 This specifies the DSI server quantum\&. The minimum value is 303840 (0x4A2E0)\&. The maximum value is 0xFFFFFFFFF\&. If you specify a value that is out of range, the default value will be set (which is the minimum)\&. Do not change this value unless you\'re absolutely sure, what you\'re doing
 265 .RE
 266 .PP
 267 \-noslp
 268 .RS 4
 269 Do not register this server using the Service Location Protocol (if SLP
 270 support was compiled in)\&. This is useful if you are running multiple servers and want one to be hidden, perhaps because it is advertised elsewhere, ie\&. by a SLP Directory Agent\&.
 271 .RE
 272 .SH "MISCELLANEOUS OPTIONS"
 273 .PP
 274 \-admingroup \fI[group]\fR
 275 .RS 4
 276 Allows users of a certain group to be seen as the superuser when they log in\&. This option is disabled by default\&.
 277 .RE
 278 .PP
 279 \-authprintdir \fI[path]\fR
 280 .RS 4
 281 Specifies the path to be used (per server) to store the files required to do CAP\-style print authentication which papd will examine to determine if a print job should be allowed\&. These files are created at login and if they are to be properly removed, this directory probably needs to be umode 1777\&.
 282 .if n \{\
 283 .sp
 284 .\}
 285 .RS 4
 286 .it 1 an-trap
 287 .nr an-no-space-flag 1
 288 .nr an-break-flag 1
 289 .br
 290 .ps +1
 291 \fBNote\fR
 292 .ps -1
 293 .br
 294 \fB\-authprintdir\fR
 295 will only work for clients connecting via DDP\&. Almost all modern Clients will use TCP\&.
 296 .sp .5v
 297 .RE
 298 .RE
 299 .PP
 300 \-client_polling
 301 .RS 4
 302 With this switch enabled, afpd won\'t advertise that it is capable of server notifications, so that connected clients poll the server every 10 seconds to detect changes in opened server windows\&.
 303 \fINote\fR: Depending on the number of simultaneously connected clients and the network\'s speed, this can lead to a significant higher load on your network!
 304 .if n \{\
 305 .sp
 306 .\}
 307 .RS 4
 308 .it 1 an-trap
 309 .nr an-no-space-flag 1
 310 .nr an-break-flag 1
 311 .br
 312 .ps +1
 313 \fBNote\fR
 314 .ps -1
 315 .br
 316 Do not use this option any longer as Netatalk 2\&.0 correctly supports server notifications, allowing connected clients to update folder listings in case another client changed the contents\&.
 317 .sp .5v
 318 .RE
 319 .RE
 320 .PP
 321 \-cnidserver \fI[ipaddress:port]\fR
 322 .RS 4
 323 Specifies the IP address and port of a cnid_metad server, required for CNID dbd backend\&. Defaults to localhost:4700\&.
 324 .RE
 325 .PP
 326 \-guestname \fI[name]\fR
 327 .RS 4
 328 Specifies the user that guests should use (default is "nobody")\&. The name should be quoted\&.
 329 .RE
 330 .PP
 331 \-icon
 332 .RS 4
 333 Use the platform\-specific icon
 334 .RE
 335 .PP
 336 \-loginmesg \fI[message]\fR
 337 .RS 4
 338 Sets a message to be displayed when clients logon to the server\&. The message should be in
 339 \fBunixcodepage\fR
 340 and should be quoted\&. Extended characters are allowed\&.
 341 .RE
 342 .PP
 343 \-nodebug
 344 .RS 4
 345 Disables debugging\&.
 346 .RE
 347 .PP
 348 \-sleep \fI[number]\fR
 349 .RS 4
 350 AFP 3\&.x waits
 351 \fInumber\fR
 352 hours before disconnecting clients in sleep mode\&. Default is 10 hours\&.
 353 .RE
 354 .PP
 355 \-signature { user:<text> | host }
 356 .RS 4
 357 Specify a server signature\&. This option is useful while running multiple independent instances of afpd on one machine (eg\&. in clustered environments, to provide fault isolation etc\&.)\&. "host" signature type allows afpd generating signature automatically (based on machine primary IP address)\&. "user" signature type allows administrator to set up a signature string manually\&. The maximum length is 16 characters
 358 .PP
 359 \fBExample.\ \&Three server definitions using 2 different server signatures\fR
 360 .sp
 361 .if n \{\
 362 .RS 4
 363 .\}
 364 .nf
 365 first \-signature user:USERS
 366 second \-signature user:USERS
 367 third \-signature user:ADMINS
 368 .fi
 369 .if n \{\
 370 .RE
 371 .\}
 372
 373
 374 First two servers will appear as one logical AFP service to the clients \- if user logs in to first one and then connects to second one, session will be automatically redirected to the first one\&. But if client connects to first and then to third, will be asked for password twice and will see resources of both servers\&. Traditional method of signature generation causes two independent afpd instances to have the same signature and thus cause clients to be redirected automatically to server (s)he logged in first\&.
 375 .RE
 376 .SH "LOGGING OPTIONS"
 377 .if n \{\
 378 .sp
 379 .\}
 380 .RS 4
 381 .it 1 an-trap
 382 .nr an-no-space-flag 1
 383 .nr an-break-flag 1
 384 .br
 385 .ps +1
 386 \fBNote\fR
 387 .ps -1
 388 .br
 389 .PP
 390 Extended logging capabilities are only available if Netatalk was built using
 391 \fB\-\-with\-logfile\fR\&. As of Netatalk 2\&.0, the default is
 392 \fB\-\-without\-logfile\fR
 393 since the logger code is partially broken and needs a complete rewrite (the
 394 \fB\-setuplog\fR
 395 option might not work as expected)\&. If Netatalk was built without logger support then the daemons log to syslog\&.
 396 .sp .5v
 397 .RE
 398 .PP
 399 \-[un]setuplog "\fI<logtype> <loglevel> [<filename>]\fR"
 400 .RS 4
 401 Specify that the given loglevel should be applied to log messages of the given logtype and that these messages should be logged to the given file\&. If the filename is ommited the loglevel applies to messages passed to syslog\&. Each logtype may have a loglevel applied to syslog and a loglevel applied to a single file\&. Latter
 402 \fB\-setuplog\fR
 403 settings will override earlier ones of the same logtype (file or syslog)\&.
 404 .sp
 405 logtypes: Default, Core, Logger, CNID, AFP
 406 .sp
 407 Daemon loglevels: LOG_SEVERE, LOG_ERROR, LOG_WARN, LOG_NOTE, LOG_INFO, LOG_DEBUG, LOG_DEBUG6, LOG_DEBUG7, LOG_DEBUG8, LOG_DEBUG9, LOG_MAXDEBUG
 408 .PP
 409 \fBExample.\ \&Some ways to change afpd's logging behaviour via -[un]setuplog\fR
 410 Example:
 411 .sp
 412 .if n \{\
 413 .RS 4
 414 .\}
 415 .nf
 416 \-setuplog "logger log_maxdebug /var/log/netatalk\-logger\&.log"
 417 \-setuplog "afpdaemon log_maxdebug /var/log/netatalk\-afp\&.log"
 418 \-unsetuplog "default level file"
 419 \-setuplog "default log_maxdebug"
 420 .fi
 421 .if n \{\
 422 .RE
 423 .\}
 424
 425 .RE
 426 .SH "DEBUG OPTIONS"
 427 .PP
 428 These options are useful for debugging only\&.
 429 .PP
 430 \-tickleval \fI[number]\fR
 431 .RS 4
 432 Sets the tickle timeout interval (in seconds)\&. Defaults to 30\&.
 433 .RE
 434 .PP
 435 \-timeout \fI[number]\fR
 436 .RS 4
 437 Specify the number of tickles to send before timing out a connection\&. The default is 4, therefore a connection will timeout after 2 minutes\&.
 438 .RE
 439 .SH "EXAMPLES"
 440 .PP
 441 \fBExample.\ \&afpd.conf default configuration\fR
 442 .sp
 443 .if n \{\
 444 .RS 4
 445 .\}
 446 .nf
 447 \- \-transall \-uamlist uams_dhx\&.so,uams_dhx2\&.so
 448 .fi
 449 .if n \{\
 450 .RE
 451 .\}
 452 .PP
 453 \fBExample.\ \&afpd.conf MacCyrillic setup / UTF8 unix locale\fR
 454 .sp
 455 .if n \{\
 456 .RS 4
 457 .\}
 458 .nf
 459 \- \-transall \-maccodepage mac_cyrillic \-unixcodepage utf8
 460 .fi
 461 .if n \{\
 462 .RE
 463 .\}
 464 .PP
 465 \fBExample.\ \&afpd.conf setup for Kerberos V auth with newline escaping\fR
 466 .sp
 467 .if n \{\
 468 .RS 4
 469 .\}
 470 .nf
 471 \- \-transall \-uamlist uams_clrtxt\&.so,uams_dhx\&.so,uams_dhx2\&.so,uams_guest\&.so,uams_gss\&.so \e
 472 \-k5service afpserver \-k5keytab /path/to/afpserver\&.keytab \e
 473 \-k5realm YOUR\&.REALM \-fqdn your\&.fqdn\&.namel:548
 474 .fi
 475 .if n \{\
 476 .RE
 477 .\}
 478 .PP
 479 \fBExample.\ \&afpd.conf letting afpd appear as three servers on the net\fR
 480 .sp
 481 .if n \{\
 482 .RS 4
 483 .\}
 484 .nf
 485 "Guest Server" \-uamlist uams_guest\&.so \-loginmesg "Welcome guest!"
 486 "User Server" \-uamlist uams_dhx2\&.so \-port 12000
 487 "special" \-notcp \-defaultvol <path> \-systemvol <path>
 488 .fi
 489 .if n \{\
 490 .RE
 491 .\}
 492 .SH "SEE ALSO"
 493 .PP
 494 \fBafpd\fR(8),
 495 \fBafppasswd\fR(1),
 496 \fBAppleVolumes.default\fR(5)