3 .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
4 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
6 .\" Manual: Netatalk 3.0
7 .\" Source: Netatalk 3.0
10 .TH "AFP\&.CONF" "5" "18 Apr 2012" "Netatalk 3.0" "Netatalk 3.0"
11 .\" -----------------------------------------------------------------
12 .\" * set default formatting
13 .\" -----------------------------------------------------------------
14 .\" disable hyphenation
16 .\" disable justification (adjust text to left margin only)
18 .\" -----------------------------------------------------------------
19 .\" * MAIN CONTENT STARTS HERE *
20 .\" -----------------------------------------------------------------
22 afp.conf \- Netatalk configuration file
27 file is the configuration file for the
31 All AFP specific configuration and AFP volume definitions are done via this file\&.
34 The file consists of sections and parameters\&. A section begins with the name of the section in square brackets and continues until the next section begins\&. Sections contain parameters of the form:
40 \fIname\fR = \fIvalue \fR
47 The file is line\-based \- that is, each newline\-terminated line represents either a comment, a section name or a parameter\&.
49 Section and parameter names are case sensitive\&.
51 Only the first equals sign in a parameter is significant\&. Whitespace before or after the first equals sign is discarded\&. Leading, trailing and internal whitespace in section and parameter names is irrelevant\&. Leading and trailing whitespace in a parameter value is discarded\&. Internal whitespace within a parameter value is retained verbatim\&.
53 Any line beginning with a semicolon (\(lq;\(rq) or a hash (\(lq#\(rq) character is ignored, as are lines containing only whitespace\&.
57 is continued on the next line in the customary UNIX fashion\&.
59 The values following the equals sign in parameters are all either a string (no quotes needed) or a boolean, which may be given as yes/no, 1/0 or true/false\&. Case is not significant in boolean values, but is preserved in string values\&. Some items such as create masks are numeric\&.
62 \fBinclude = \fR\fB\fIpath\fR\fR
63 allows you to include one config file inside another\&. The file is included literally, as though typed in place\&. Nested includes are not supported\&.
64 .SH "SECTION DESCRIPTIONS"
66 Each section in the configuration file (except for the [Global] section) describes a shared resource (known as a
67 \(lqvolume\(rq)\&. The section name is the name of the volume and the parameters within the section define the volume attributes and options\&.
69 There are two special sections, [Global] and [Homes], which are described under
70 \fIspecial sections\fR\&. The following notes apply to ordinary section descriptions\&.
72 A volume consists of a directory to which access is being given plus a description of the access rights which are granted to the user of the service\&. For volumes the
74 option must specify the directory to share\&.
76 Any volume section without
78 option is considered a
80 which can be selected in other volume sections via the
82 option and constitutes defaults for the volume\&. For any option speficied both in a preset
84 in a volume section the volume section setting completly substitutes the preset option\&.
86 The access rights granted by the server are masked by the access rights granted to the specified or guest UNIX user by the host system\&. The server does not grant more access than the host system grants\&.
88 The following sample section defines an AFP volume\&. The user has full access to the path
89 /foo/bar\&. The share is accessed via the share name
103 .SH "SPECIAL SECTIONS"
104 .SS "The [Global] section"
106 Parameters in this section apply to the server as a whole\&. Parameters denoted by a (G) below are must be set in this section\&.
107 .SS "The [Homes] section"
109 This section enable sharing of the UNIX server user home directories\&. Specifying an optional
111 parameter means that not the whole user home will be shared but the subdirectory
112 \fBpath\fR\&. It is neccessary to define the
114 option\&. It should be a regex which matches the parent directory of the user homes\&. Parameters denoted by a (H) belong to volume sections\&. The optional parameter
116 can be used to change the AFP volume name which
118 by default\&. See below under VARIABLE SUBSTITUTIONS\&.
120 The following example illustrates this\&. Given all user home directories are stored under
129 basedir regex = /home
138 this results in an AFP home volume with a path of
139 /home/john/afp\-data\&.
142 Parameters define the specific attributes of sections\&.
144 Some parameters are specific to the [Global] section (e\&.g\&.,
145 \fIlog type\fR)\&. All others are permissible only in volume sections\&. The letter
147 in parentheses indicates that a parameter is specific to the [Global] section\&. The letter
149 indicates that a parameter can be specified in a volume specific section\&.
150 .SH "VARIABLE SUBSTITUTIONS"
152 You can use variables in volume names\&. The use of variables in paths is not supported for now\&.
162 if you specify an unknown variable, it will not get converted\&.
173 if you specify a known variable, but that variable doesn\'t have a value, it will get ignored\&.
176 The variables which can be used for substitutions are:
190 volume pathname on server
195 full name (contents of the gecos field in the passwd file)
210 client\'s ip, without port
215 server name (this can be the hostname)
220 user name (if guest, it is the user that guest is running as)
230 prints dollar sign ($)
232 .SH "EXPLANATION OF GLOBAL PARAMETERS"
233 .SS "Authentication Options"
235 admin auth user = \fIuser\fR \fB(G)\fR
237 Specifying eg "\fBadmin auth user = root\fR" whenever a normal user login fails, afpd will try to authenticate as the specified
238 \fBadmin auth user\fR\&. If this succeeds, a normal session is created for the original connecting user\&. Said differently: if you know the password of
239 \fBadmin auth user\fR, you can authenticate as any other user\&.
242 k5 keytab = \fIpath\fR \fB(G)\fR, k5 service = \fIservice\fR \fB(G)\fR, k5 realm = \fIrealm\fR \fB(G)\fR
244 These are required if the server supports the Kerberos 5 authentication UAM\&.
247 ldap auth method = \fInone|simple|sasl\fR \fB(G)\fR
249 Authentication method:
250 \fBnone | simple | sasl\fR
264 SASL\&. Not yet supported !
268 ldap auth dn = \fIdn\fR \fB(G)\fR
270 Distinguished Name of the user for simple bind\&.
274 ldap auth pw = \fIpassword\fR \fB(G)\fR
276 Distinguished Name of the user for simple bind\&.
280 ldap server = \fIhost\fR \fB(G)\fR
282 Name or IP address of your LDAP Server\&. This is only needed for explicit ACL support in order to be able to query LDAP for UUIDs\&.
286 to syntactically check your config\&.
289 ldap userbase = \fIbase dn\fR \fB(G)\fR
291 DN of the user container in LDAP\&.
295 ldap userscope = \fIscope\fR \fB(G)\fR
297 Search scope for user search:
298 \fBbase | one | sub\fR
302 ldap groupbase = \fIbase dn\fR \fB(G)\fR
304 DN of the group container in LDAP\&.
308 ldap groupscope = \fIscope\fR \fB(G)\fR
310 Search scope for user search:
311 \fBbase | one | sub\fR
315 ldap uuid attr = \fIdn\fR \fB(G)\fR
317 Name of the LDAP attribute with the UUIDs\&.
319 Note: this is used both for users and groups\&.
323 ldap name attr = \fIdn\fR \fB(G)\fR
325 Name of the LDAP attribute with the users short name\&.
329 ldap group attr = \fIdn\fR \fB(G)\fR
331 Name of the LDAP attribute with the groups short name\&.
335 nt domain = \fIDOMAIN\fR \fB(G)\fR, nt separator = \fISEPERATOR\fR \fB(G)\fR
337 Use for eg\&. winbind authentication, prepends both strings before the username from login and then tries to authenticate with the result through the availabel and active UAM authentication modules\&.
340 save password = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(G)\fR
342 Enables or disables the ability of clients to save passwords locally\&.
345 set password = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR
347 Enables or disables the ability of clients to change their passwords via chooser or the "connect to server" dialog\&.
350 uam list = \fIuam list\fR \fB(G)\fR
352 Space or comma separated list of UAMs\&. (The default is "uams_dhx\&.so uams_dhx2\&.so")\&.
354 The most commonly used UAMs are:
363 (uams_pam\&.so or uams_passwd\&.so) Allow logins with passwords transmitted in the clear\&. (legacy)
368 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 "\fBpasswd file\fR"\&. See
370 for details\&. (legacy)
375 (uams_dhx_pam\&.so or uams_dhx_passwd\&.so) Allow Diffie\-Hellman eXchange (DHX) for authentication\&.
380 (uams_dhx2_pam\&.so or uams_dhx2_passwd\&.so) Allow Diffie\-Hellman eXchange 2 (DHX2) for authentication\&.
385 Allow Kerberos V for authentication (optional)
389 uam path = \fIpath\fR \fB(G)\fR
391 Sets the default path for UAMs for this server (default is :LIBDIR:/netatalk)\&.
393 .SS "Charset Options"
395 With OS X Apple introduced the AFP3 protocol\&. One of the big changes was, that AFP3 uses Unicode names encoded as Decomposed UTF\-8 (UTF8\-MAC)\&. Previous AFP/OS versions used charsets like MacRoman, MacCentralEurope, etc\&.
397 To be able to serve AFP3 and older clients at the same time,
399 needs to be able to convert between UTF\-8 and Mac charsets\&. Even OS X clients partly still rely on the mac charset\&. As there\'s no way,
401 can detect the codepage a pre AFP3 client uses, you have to specify it using the
403 option\&. The default is MacRoman, which should be fine for most western users\&.
407 needs to interact with UNIX operating system as well, it need\'s to be able to convert from UTF8\-MAC / Mac charset to the UNIX charset\&. By default
410 \fIUTF8\fR\&. You can set the UNIX charset using the
412 option\&. If you\'re using extended characters in the configuration files for
413 \fBafpd\fR, make sure your terminal matches the
414 \fBunix charset\fR\&.
416 mac charset = \fICHARSET\fR \fB(G)/(V)\fR
418 Specifies the Mac clients charset, e\&.g\&.
419 \fIMAC_ROMAN\fR\&. 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
420 \fBmac charset\fR\&. Defaults to
424 unix charset = \fICHARSET\fR \fB(G)\fR
426 Specifies the servers unix charset, e\&.g\&.
429 \fIEUC\-JP\fR\&. This is used to convert strings to/from the systems locale, e\&.g\&. for authenthication, server messages and volume names\&. If
431 is set, the systems locale is used\&. Defaults to
435 vol charset = \fICHARSET\fR \fB(G)/(V)\fR
437 Specifies the encoding of the volumes filesystem\&. By default, it is the same as
438 \fBunix charset\fR\&.
440 .SS "Password Options"
442 passwd file = \fIpath\fR \fB(G)\fR
444 Sets the path to the Randnum UAM passwd file for this server (default is :ETCDIR:/afppasswd)\&.
447 passwd minlen = \fInumber\fR \fB(G)\fR
449 Sets the minimum password length, if supported by the UAM
451 .SS "Network Options"
453 advertise ssh = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR
455 Allows old Mac OS X clients (10\&.3\&.3\-10\&.4) 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
457 on the server to let things work\&.
463 .nr an-no-space-flag 1
470 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\&.
475 afp listen = \fIip address[:port] [ip adress[:port] \&.\&.\&.]\fR \fB(G)\fR
477 Specifies the IP address that the server should advertise
479 listens to\&. The default is advertise the first IP address of the system, but to listen for any incoming request\&. The network address may be specified either in dotted\-decimal format for IPv4 or in hexadecimal format for IPv6\&.
482 afp port = \fIport number\fR \fB(G)\fR
484 Allows a different TCP port to be used for AFP\&. The default is 548\&. Also sets the default port applied when none specified in an
489 cnid listen = \fIip address[:port] [ip adress[:port] \&.\&.\&.]\fR \fB(G)\fR
491 Specifies the IP address that the CNID server should listen on\&. The default is
492 \fBlocalhost:4700\fR\&.
495 disconnect time = \fInumber\fR \fB(G)\fR
497 Keep disconnected AFP sessions for
499 hours before dropping them\&. Default is 24 hours\&.
502 dsireadbuf = \fInumber\fR \fB(G)\fR
504 Scale factor that determines the size of the DSI/TCP readahead buffer, default is 12\&. This is multiplies with the DSI server quantum (default ~300k) to give the size of the buffer\&. Increasing this value might increase throughput in fast local networks for volume to volume copies\&.
505 \fINote\fR: This buffer is allocated per afpd child process, so specifying large values will eat up large amount of memory (buffer size * number of clients)\&.
508 fqdn = \fIname:port\fR \fB(G)\fR
510 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\&.
513 hostname = \fIname\fR \fB(G)\fR
515 Use this instead of the result from calling hostname for dertermening which IP address to advertise, therfore the hostname is resolved to an IP which is the advertised\&. This is NOT used for listening and it is also overwritten by
519 max connections = \fInumber\fR \fB(G)\fR
521 Sets the maximum number of clients that can simultaneously connect to the server (default is 200)\&.
524 server quantum = \fInumber\fR \fB(G)\fR
526 This specifies the DSI server quantum\&. The default value is 303840\&. The maximum value is 0xFFFFFFFFF, the minimum is 32000\&. If you specify a value that is out of range, the default value will be set\&. Do not change this value unless you\'re absolutely sure, what you\'re doing
529 sleep time = \fInumber\fR \fB(G)\fR
531 Keep sleeping AFP sessions for
533 hours before disconnecting clients in sleep mode\&. Default is 10 hours\&.
536 tcprcvbuf = \fInumber\fR \fB(G)\fR
538 Try to set TCP receive buffer using setsockpt()\&. Often OSes impose restrictions on the applications ability to set this value\&.
541 tcpsndbuf = \fInumber\fR \fB(G)\fR
543 Try to set TCP send buffer using setsockpt()\&. Often OSes impose restrictions on the applications ability to set this value\&.
546 use sendfile = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(G)\fR
548 Whether to use sendfile
549 syscall for sending file data to clients\&.
552 zeroconf = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(G)\fR
554 Whether to use automatic Zeroconf
555 service registration if Avahi or mDNSResponder were compiled in\&.
557 .SS "Miscellaneous Options"
559 admin group = \fIgroup\fR \fB(G)\fR
561 Allows users of a certain group to be seen as the superuser when they log in\&. This option is disabled by default\&.
564 basedir regex = \fIregex\fR \fB(H)\fR
566 Regular expression which matches the parent directory of the user homes\&. In the simple case this is just a path ie
567 \fBbasedir regex = /home\fR
570 close vol = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR
572 Whether to close volumes possibly opened by clients when they\'re removed from the configuration and the configuration is reloaded\&.
575 cnid server = \fIipaddress[:port]\fR \fB(G)/(V)\fR
577 Specifies the IP address and port of a cnid_metad server, required for CNID dbd backend\&. Defaults to localhost:4700\&. The network address may be specified either in dotted\-decimal format for IPv4 or in hexadecimal format for IPv6\&.\-
580 dircachesize = \fInumber\fR \fB(G)\fR
582 Maximum possible entries in the directory cache\&. The cache stores directories and files\&. It is used to cache the full path to directories and CNIDs which considerably speeds up directory enumeration\&.
584 Default size is 8192, maximum size is 131072\&. Given value is rounded up to nearest power of 2\&. Each entry takes about 100 bytes, which is not much, but remember that every afpd child process for every connected user has its cache\&.
587 fce listener = \fIhost[:port]\fR \fB(G)\fR
589 Enables sending FCE events to the specified
592 is 12250 if not specified\&. Specifying mutliple listeners is done by having this option once for each of them\&.
595 fce events = \fIfmod,fdel,ddel,fcre,dcre,tmsz\fR \fB(G)\fR
597 Speficies which FCE events are active, default is
598 \fIfmod,fdel,ddel,fcre,dcre\fR\&.
601 fce coalesce = \fIall|delete|create\fR \fB(G)\fR
603 Coalesce FCE events\&.
606 fce holdfmod = \fIseconds\fR \fB(G)\fR
608 This determines the time delay in seconds which is always waited if another file modification for the same file is done by a client before sending an FCE file modification event (fmod)\&. For example saving a file in Photoshop would generate multiple events by itself because the application is opening, modifying and closing a file mutliple times for every "save"\&. Defautl: 60 seconds\&.
611 guest account = \fIname\fR \fB(G)\fR
613 Specifies the user that guests should use (default is "nobody")\&. The name should be quoted\&.
616 home name = \fIname\fR \fB(H)\fR
618 AFP user home volume name\&. The default is
619 \fIusers\'s home\fR\&.
622 icon = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR
624 Use the platform\-specific icon\&. Mac OS X doesn\'t display it\&.
627 keep sessions = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR
629 Enable "Continuous AFP Service"\&. This means restarting AFP and CNID service daemons master processes, but keeping the AFP session processes\&. This can be used to install (most) updates to Netatalk without interruping active AFP sessions\&. Existing AFP sessions will still run the version from before updating, but new AFP sessions will run the updated code\&. After enabling this option when sending SIGQUIT to the
631 service controller process, the AFP and CNID daemons will exit and then the service controller will restart them\&. AFP session processes are notified of the master afpd shutdown, they will then sleep 15\-20 seconds and then try to reconnect their IPC channel to the master afpd process\&. The IPC channel between the AFP master service daemon and the AFP session child is used for keeping session state of AFP sessions in the AFP master process\&. The session state is needed when AFP clients experience eg network outages and try to reconnect to the AFP server\&.
634 login message = \fImessage\fR \fB(G)/(V)\fR
636 Sets a message to be displayed when clients logon to the server\&. The message should be in
638 and should be quoted\&. Extended characters are allowed\&.
641 map acls = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(G)\fR
643 Whether to map filesystem ACLs to effective permissions\&.
646 mimic model = \fImodel\fR \fB(G)\fR
648 Specifies the icon model that appears on clients\&. Defaults to off\&. Examples: RackMac (same as Xserve), PowerBook, PowerMac, Macmini, iMac, MacBook, MacBookPro, MacBookAir, MacPro, AppleTV1,1, AirPort\&.
651 signature = <text> \fB(G)\fR
653 Specify a server signature\&. The maximum length is 16 characters\&. This option is useful for clustered environments, to provide fault isolation etc\&. By default, afpd generate signature and saving it to
654 :STATEDIR:/netatalk/afp_signature\&.conf
655 automatically (based on random number)\&. See also asip\-status\&.pl(1)\&.
658 solaris share reservations = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(G)\fR
660 Use share reservations on Solaris\&. Solaris CIFS server uses this too, so this makes a lock coherent multi protocol server\&.
663 vol dbpath = \fIpath\fR \fB(G)\fR
665 Sets the database information to be stored in path\&. You have to specifiy a writable location, even if the volume is read only\&. The default is
666 :STATEDIR:/netatalk/CNID/\&.
669 volnamelen = \fInumber\fR \fB(G)\fR
671 Max length of UTF8\-MAC volume name for Mac OS X\&. Note that Hangul is especially sensitive to this\&.
677 73: limit of Mac OS X 10\&.1
678 80: limit of Mac OS X 10\&.4/10\&.5 (default)
679 255: limit of recent Mac OS X
685 Mac OS 9 and earlier are not influenced by this, because Maccharset volume name is always limitted to 27 bytes\&.
688 vol preset = \fIname\fR \fB(G)/(V)\fR
692 as option preset for all volumes (when set in the [Global] section) or for one volume (when set in that volume\'s section)\&.
694 .SS "Logging Options"
696 log file = \fIlogfile\fR \fB(G)\fR
698 If not specified Netatalk logs to syslogs daemon facilify\&. Otherwise it logs to
702 log level = \fItype:level [type:level \&.\&.\&.]\fR \fB(G)\fR, log level = \fItype:level,[type:level, \&.\&.\&.]\fR \fB(G)\fR
704 Specify that any message of a loglevel up to the given
708 By default afpd logs to syslog with a default logging setup equivalent to
711 logtypes: default, afpdaemon, logger, uamsdaemon
713 loglevels: severe, error, warn, note, info, debug, debug6, debug7, debug8, debug9, maxdebug
719 .nr an-no-space-flag 1
726 Both logtype and loglevels are case insensitive\&.
730 .SS "Debug Parameters"
732 These options are useful for debugging only\&.
734 tickleval = \fInumber\fR \fB(G)\fR
736 Sets the tickle timeout interval (in seconds)\&. Defaults to 30\&.
739 timeout = \fInumber\fR \fB(G)\fR
741 Specify the number of tickles to send before timing out a connection\&. The default is 4, therefore a connection will timeout after 2 minutes\&.
744 client polling = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR
746 With this option 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\&.
747 \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!
749 Do not use this option any longer as present Netatalk correctly supports server notifications, allowing connected clients to update folder listings in case another client changed the contents\&.
751 .SH "EXPLANATION OF VOLUME PARAMETERS"
754 The section name defines the volume name which is the name that appears in the Chooser or the "connect to server" dialog on Macintoshes to represent the appropriate share\&. No two volumes may have the same name\&. The volume name cannot contain the
756 character\&. The volume name is mangled if it is very long\&. Mac charset volume name is limited to 27 characters\&. UTF8\-MAC volume name is limited to volnamelen parameter\&.
758 path = \fIPATH\fR \fB(V)\fR
760 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\&.
762 The volume name is the name that appears in the Chooser ot the "connect to server" dialog on Macintoshes to represent the appropriate share\&. If volumename is unspecified, the last component of pathname is used\&. No two volumes may have the same name\&. If there are spaces in the name, it should be in quotes (i\&.e\&. "File Share")\&. The volume name cannot contain the
764 character\&. The volume name is mangled if it is very long\&. Mac charset volume name is limited to 27 characters\&. UTF8\-MAC volume name is limited to volnamelen parameter\&.
767 appledouble = \fIea|v2\fR \fB(V)\fR
769 Specify the format of the metadata files, which are used for saving Mac resource fork as well\&. Earlier versions used AppleDouble v2, the new default format is
773 vol size limit = \fIsize in MiB\fR \fB(V)\fR
775 Useful for Time Machine: limits the reported volume size, thus preventing Time Machine from using the whole real disk space for backup\&. Example: "vol size limit = 1000" would limit the reported disk space to 1 GB\&.
777 This is an approimated calculation taking into accout the contents of Time Machine sparsebundle images\&. Therefor you MUST NOT use this volume to store other content when using this option, because it would NOT be accounted\&. The calculation works by reading the band size from the Info\&.plist XML file of the sparsebundle, reading the bands/ directory counting the number of band files, and then multiplying one with the other\&.
780 valid users = \fIusers/groups\fR \fB(V)\fR
782 The allow option allows the users and groups that access a share to be specified\&. Users and groups are specified, delimited by spaces or commas\&. Groups are designated by a @ prefix\&. Example: "valid users = user1 user2 @group"
785 invalid users = \fIusers/groups\fR \fB(V)\fR
787 The deny option specifies users and groups who are not allowed access to the share\&. It follows the same format as the "valid users" option\&.
790 hosts allow = \fIIP host address/IP netmask bits [ \&.\&.\&. ]\fR \fB(V)\fR
792 Only listed hosts and networks are allowed, all others are rejected\&. The network address may be specified either in dotted\-decimal format for IPv4 or in hexadecimal format for IPv6\&.
794 Example: hosts allow = 10\&.1\&.0\&.0/16 10\&.2\&.1\&.100 2001:0db8:1234::/48
797 hosts deny = \fIIP host address/IP netmask bits [ \&.\&.\&. ]\fR \fB(V)\fR
799 Listed hosts and nets are rejected, all others are allowed\&.
801 Example: hosts deny = 192\&.168\&.100/24 10\&.1\&.1\&.1 2001:db8::1428:57ab
804 cnid scheme = \fIbackend\fR \fB(V)\fR
806 set the CNID backend to be used for the volume, default is [:DEFAULT_CNID_SCHEME:] available schemes: [:COMPILED_BACKENDS:]
809 ea = \fInone|auto|sys|ad\fR
811 Specify how Extended Attributes
820 (by setting an EA on the shared directory itself), fallback to
821 \fBad\fR\&. Requires writeable volume for perfoming test\&. "\fBread only = yes\fR" overwrites
824 \fBnone\fR\&. Use explicit "\fBea = sys|ad\fR" for read\-only volumes where appropiate\&.
829 Use filesystem Extended Attributes\&.
841 No Extended Attributes support\&.
845 mac charset = \fICHARSET\fR \fB(V)\fR
847 specifies the Mac client charset for this Volume, e\&.g\&.
849 \fIMAC_CYRILLIC\fR\&. If not specified the global setting is applied\&. This setting is only required if you need volumes, where the Mac charset differs from the one globally set in the [Global] section\&.
852 casefold = \fBoption\fR
854 The casefold option handles, if the case of filenames should be changed\&. The available options are:
857 \- Lowercases names in both directions\&.
860 \- Uppercases names in both directions\&.
863 \- Client sees lowercase, server sees uppercase\&.
866 \- Client sees uppercase, server sees lowercase\&.
869 password = \fIpassword\fR \fB(V)\fR
871 This option allows you to set a volume password, which can be a maximum of 8 characters long (using ASCII strongly recommended at the time of this writing)\&.
874 file perm = \fImode\fR \fB(V)\fR, directory perm = \fImode\fR \fB(V)\fR
876 Add(or) with the client requested permissions:
880 is for directories only\&. Don\'t use with "\fBunix priv = no\fR"\&.
882 \fBExample.\ \&Volume for a collaborative workgroup\fR
889 directory perm = 0770
897 umask = \fImode\fR \fB(V)\fR
899 set perm mask\&. Don\'t use with "\fBunix priv = no\fR"\&.
902 preexec = \fIcommand\fR \fB(V)\fR
904 command to be run when the volume is mounted, ignored for user defined volumes
907 postexec = \fIcommand\fR \fB(V)\fR
909 command to be run when the volume is closed, ignored for user defined volumes
912 root preexec = \fIcommand\fR \fB(V)\fR
914 command to be run as root when the volume is mounted, ignored for user defined volumes
917 root postexec = \fIcommand\fR \fB(V)\fR
919 command to be run as root when the volume is closed, ignored for user defined volumes
922 rolist = \fBusers/groups\fR \fB(V)\fR
924 Allows certain users and groups to have read\-only access to a share\&. This follows the allow option format\&.
927 rwlist = \fIusers/groups\fR \fB(V)\fR
929 Allows certain users and groups to have read/write access to a share\&. This follows the allow option format\&.
932 veto files = \fIvetoed names\fR \fB(V)\fR
934 hide files and directories,where the path matches one of the \'/\' delimited vetoed names\&. The veto string must always be terminated with a \'/\', eg\&. "veto1/", "veto1/veto2/"\&.
938 Boolean volume options\&.
940 acls = \fIBOOLEAN\fR (default: \fItrue\fR) \fB(V)\fR
942 Whether to flag volumes as supporting ACLs\&. If ACL support is compiled in, this is true by default\&.
945 cnid dev = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(V)\fR
947 Whether to use the device number in the CNID backends\&. Helps when the device number is not constant across a reboot, eg cluster, \&.\&.\&.
950 convert adouble = \fIBOOLEAN\fR (default: \fItrue\fR) \fB(V)\fR
952 Whether automatic conversion from
953 \fBappledouble = v2\fR
955 \fBappledouble = ea\fR
956 is performed when accessing filesystems from clients\&. This is generally useful, but costs some performance\&. It\'s recommdable to run
958 on volumes and do the conversion with that\&. Then this option can be set to no\&.
961 invisible dots = \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR
963 make dot files invisible\&.
966 network ids = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(V)\fR
968 Whether the server support network ids\&. Setting this to
970 will result in the client not using ACL AFP functions\&.
973 preexec close = \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR
975 A non\-zero return code from preexec close the volume being immediately, preventing clients to mount/see the volume in question\&.
978 read only = \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR
980 Specifies the share as being read only for all users\&. Overwrites
986 root preexec close= \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR
988 A non\-zero return code from root_preexec closes the volume immediately, preventing clients to mount/see the volume in question\&.
991 search db = \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR
993 Use fast CNID database namesearch instead of slow recursive filesystem search\&. Relies on a consistent CNID database, ie Samba or local filesystem access lead to inaccurate or wrong results\&. Works only for "dbd" CNID db volumes\&.
996 stat vol = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(V)\fR
998 Whether to stat volume path when enumerating volumes list, useful for automounting or volumes created by a preexec script\&.
1001 time machine = \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR
1003 Whether to enable Time Machine suport for this volume\&.
1006 unix priv = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(V)\fR
1008 Whether to use AFP3 UNIX privileges\&. This should be set for OS X clients\&. See also:
1010 \fBdirectory perm\fR
1016 The AFP protocol mostly refers to files and directories by ID and not by name\&. Netatalk needs a way to store these ID\'s in a persistent way, to achieve this several different CNID backends are available\&. The CNID Databases are by default located in the
1018 folder in the volume root\&.
1022 "Concurrent database", backend is based on Oracle Berkely DB\&. With this backend several
1024 deamons access the CNID database directly\&. Berkeley DB locking is used to synchronize access, if more than one
1026 process is active for a volume\&. The drawback is, that the crash of a single
1028 process might corrupt the database\&.
1033 Access to the CNID database is restricted to the
1037 processes communicate with the daemon for database reads and updates\&. If built with Berkeley DB transactions the probability for database corruption is practically zero, but performance can be slower than with
1043 This backend is an exception, in terms of ID persistency\&. ID\'s are only valid for the current session\&. This is basically what
1045 did in the 1\&.5 (and 1\&.6) versions\&. This backend is still available, as it is useful for e\&.g\&. sharing cdroms\&.
1047 \fBWarning\fR: It is
1049 recommended to use this backend for volumes anymore, as
1051 now relies heavily on a persistent ID database\&. Aliases will likely not work and filename mangling is not supported\&.
1055 \fB\&./configure \-\-help\fR
1056 might show that there are other CNID backends available, be warned those are likely broken or mainly used for testing\&. Don\'t use them unless you know what you\'re doing, they may be removed without further notice from future versions\&.
1057 .SH "CHARSET OPTIONS"
1059 With OS X Apple introduced the AFP3 protocol\&. One of the most important changes was that AFP3 uses unicode names encoded as UTF\-8 decomposed\&. Previous AFP/OS versions used codepages, like MacRoman, MacCentralEurope, etc\&.
1062 needs a way to preserve extended macintosh characters, or characters illegal in unix filenames, when saving files on a unix filesystem\&. Earlier versions used the the so called CAP encoding\&. An extended character (>0x7F) would be converted to a :xx sequence, e\&.g\&. the Apple Logo (MacRoman: 0xF0) was saved as
1063 :f0\&. Some special characters will be converted as to :xx notation as well\&. \'/\' will be encoded to
1066 is not specified, a leading dot \'\&.\' will be encoded as
1069 This version now uses UTF\-8 as the default encoding for names\&. \'/\' will be converted to \':\'\&.
1073 option will allow you to select another volume encoding\&. E\&.g\&. for western users another useful setting could be vol charset ISO\-8859\-15\&.
1077 provided charset\&. If a character cannot be converted from the
1080 \fBvol charset\fR, afpd will save it as a CAP encoded character\&. For AFP3 clients,
1082 will convert the UTF\-8
1085 first\&. If this conversion fails, you\'ll receive a \-50 error on the mac\&.
1087 \fINote\fR: Whenever you can, please stick with the default UTF\-8 volume format\&.
1092 \fBafp_signature.conf\fR(5),