Append @DOMAIN to username when authenticating. Useful in Active Directory environments that otherwise would require the user to enter the full user@domain string.

Specifying e.g. "admin auth user = root" whenever a normal user login fails, afpd will try to authenticate as the specified admin auth user. If this succeeds, a normal session is created for the original connecting user. Said differently: if you know the password of admin auth user, you can authenticate as any other user.

Allows users of a certain group to be seen as the superuser when they log in. This option is disabled by default.

This specifies a UNIX user name that will be assigned as the default user for all users connecting to this server. This is useful for sharing files. You should also use it carefully as using it incorrectly can cause security problems.

This specifies a UNIX group name that will be assigned as the default primary group for all users connecting to this server.

These are required if the server supports the Kerberos 5 authentication UAM.

Use for e.g. winbind authentication, prepends both strings before the username from login and then tries to authenticate with the result through the available and active UAM authentication modules.

Enables or disables the ability of clients to save passwords locally.

Enables or disables the ability of clients to change their passwords via chooser or the "connect to server" dialog.

Space or comma separated list of UAMs. (The default is "uams_dhx.so uams_dhx2.so").

The most commonly used UAMs are:

Sets the default path for UAMs for this server.

Specifies the Mac clients charset, 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 mac charset. Defaults to MAC_ROMAN.

Specifies the servers unix charset, e.g. ISO-8859-15 or EUC-JP. This is used to convert strings to/from the systems locale, e.g. for authentication, server messages and volume names. If LOCALE is set, the systems locale is used. Defaults to UTF8.

Specifies the encoding of the volumes filesystem. By default, it is the same as unix charset.

Sets the path to the Randnum UAM passwd file for this server.

Sets the minimum password length, if supported by the UAM

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 sshd(8) on the server to let things work.

Specifies the network interfaces that the server should listens on. The default is advertise the first IP address of the system, but to listen for any incoming request.

Specifies the IP address that the server should advertise and 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.

IPv6 address + port combination must use URL the format using square brackets [IPv6]:port

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 afp listen option.

Enables support for AFP-over-Appletalk. This option requires that your operating system supports the AppleTalk networking protocol.

Specifies the IP address that the CNID server should listen on. The default is localhost:4700.

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.

Specifies the AppleTalk zone to register the server in. The default is to register the server in the default zone of the last interface configured by the system.

Keep disconnected AFP sessions for number hours before dropping them. Default is 24 hours.

Scale factor that determines the size of the DSI/TCP readahead buffer, default is 12. This is multiplies with the DSI server quantum (default 1MiB) to give the size of the buffer. Increasing this value might increase throughput in fast local networks for volume to volume copies. Note: This buffer is allocated per afpd child process, so specifying large values will eat up large amount of memory (buffer size * number of clients).

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.

Use this instead of the result from calling hostname for determining which IP address to advertise, therefore the hostname is resolved to an IP which is the advertised. This is NOT used for listening and it is also overwritten by afp listen.

Sets the maximum number of clients that can simultaneously connect to the server (default is 200).

This specifies the DSI server quantum. The default value is 0x100000 (1 MiB). 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

Keep sleeping AFP sessions for number hours before disconnecting clients in sleep mode. Default is 10 hours.

Try to set TCP receive buffer using setsockopt(). Often OSes impose restrictions on the applications ability to set this value.

Try to set TCP send buffer using setsockopt(). Often OSes impose restrictions on the applications ability to set this value.

Whether to use splice() on Linux for receiving data.

Maximum number of bytes spliced.

Whether to use sendfile syscall for sending file data to clients.

Whether to use automatic Zeroconf service registration if Avahi or mDNSResponder were compiled in.

Whether to apply locks to the byte region read in FPRead calls. The AFP spec mandates this, but it's not really in line with UNIX semantics and is a performance hug.

Whether to provide AFP runtime statistics (connected users, open volumes) via dbus.

Regular expression which matches the parent directory of the user homes. If basedir regex contains symlink, you must set the canonicalized absolute path. In the simple case this is just a path i.e. basedir regex = /home

Advanced permission control that deals with ACLs.

Whether to close volumes possibly opened by clients when they're removed from the configuration and the configuration is reloaded.

name or address of a MySQL server for use with the mysql CNID backend.

MySQL user for authentication with the server.

Password for MySQL server.

Name of an existing database for which the specified user has full privileges.

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.-

Sets the path to dbus-daemon binary used by Spotlight feature. The default value ["/opt/homebrew/bin/dbus-daemon"] is determined when building netatalk.

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.

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.

Sets the path to the file which defines file extension type/creator mappings.

Writing metadata xattr on directories with the sticky bit set may fail even though we may have write access to a directory, because if the sticky bit is set only the owner is allowed to write xattrs.

By enabling this option Netatalk will write the metadata xattr as root.

Specifies the user that guests should use (default is nobody). The name must be a valid user on the host system.

AFP user home volume name. The default is $u's home. The name must contain "$u".

Specify a set of file and directory attributes that shall be ignored by the server, all includes all the other options.

In OS X when the Finder sets a lock on a file/directory or you set the BSD uchg flag in the Terminal, all three attributes are used. Thus in order to ignore the Finder lock/BSD uchg flag, add set ignored attributes = all.

Sets the shared volume icon displayed in the Finder in Classic Mac OS. Note that some versions of Classic Mac OS ignores this icon. Examples of valid icon styles:

Sets a message to be displayed when clients logon to the server. The message should be in unix charset. Extended characters are allowed.

Specifies a custom icon for the mounted AFP volume on macOS / Mac OS X clients. Default is to let macOS choose. Requires netatalk to be built with Zeroconf. Examples:

A complete set of supported model codes by a macOS client can be found by inspecting /System/Library/CoreServices/CoreTypes.bundle/Contents/Info.plist (as of macOS 14 Sonoma).

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 generates a signature and saves it to a file called afp_signature.conf automatically (based on random numbers). See also asip-status(1).

Use share reservations on Solaris. Solaris CIFS server uses this too, so this makes a lock coherent multi protocol server.

Impose a limit on the number of results queried from Tracker or LocalSearch via SPARQL queries.

Whether to enable Spotlight searches. Note: once the global option is enabled, any volume that is not enabled won't be searchable at all. See also dbus daemon option.

A list of attributes that are allowed to be used in Spotlight searches. By default all attributes can be searched, passing a string limits attributes to elements of the string. Example:

spotlight attributes = *,kMDItemTextContent

Whether to allow the use of logic expression in searches.

Whether to start a dbus instance for use with Tracker or LocalSearch.

Whether to start Tracker or LocalSearch with "tracker daemon -s" or "localsearch daemon -s". In case of old Tracker, "tracker-control -s" is used instead.

Send optional AFP messages for vetoed files. Then whenever a client tries to access any file or directory with a vetoed name, it will be sent an AFP message indicating the name and the directory.

Sets the path where the database information will be stored. You have to specify a writable location, even if the volume is read only.

Setting this option to true brings back Netatalk 2 behaviour of storing the CNID database in a folder called .AppleDB inside the volume root of each share.

Max length of UTF8-MAC volume name for Mac OS X. Note that Hangul is especially sensitive to this.

73: limit of Mac OS X 10.1
80: limit of Mac OS X 10.4/10.5 (default)
255: limit of recent Mac OS X

Mac OS 9 and earlier are not influenced by this, because Maccharset volume name is always limited to 27 bytes.

Use section name as option preset for all volumes (when set in the [Global] section) or for one volume (when set in that volume's section).

Specifies a human-readable name that uniquely describes registered services. The zeroconf name is advertised as UTF-8, up to 63 octets (bytes) in length. Defaults to hostname. Note that netatalk must support Zeroconf.

Write logs to logfile on the file system. If not specified, Netatalk logs to the syslog daemon facility.

Specify that any message of a loglevel up to the given log level should be logged.

By default afpd logs to syslog with a default logging setup equivalent to default:note

logtypes: default, afpdaemon, logger, uamsdaemon

loglevels: severe, error, warn, note, info, debug, debug6, debug7, debug8, debug9, maxdebug

Log timestamps with accuracy down to microseconds. If disabled, the timestamps record only whole seconds. Only takes effect when used in tandem with the log file option.

Enables sending FCE events to the specified host, default port is 12250 if not specified. Specifying multiple listeners is done by having this option once for each of them.

FCE protocol version, default is 1. You need version 2 for the fmov, dmov, login or logout events.

Specifies which FCE events are active, default is fmod,fdel,ddel,fcre,dcre.

Coalesce FCE events.

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 multiple times for every "save". Default: 60 seconds.

Defines a delay in milliseconds between the emission of each FCE event. Use this if you are experiencing lost FCE events when creating or deleting a very large number of files at once. The deluge of events that such an operation triggers can lead to UDP buffer overflow and subsequently to packet loss. Has to be a number between 0 and 999. Default: 0 milliseconds.

Slash delimited list of filenames for which FCE events shall not be generated. Default: .DS_Store.

Comma delimited list of directories for which FCE events shall not be generated. Default: empty.

Script which will be executed for every FCE event, see contrib/shell_utils/fce_ev_script.sh from the Netatalk sources for an example script.

Sets the tickle timeout interval (in seconds). Defaults to 30.

Specify the number of tickles to send before timing out a connection. The default is 4, therefore a connection will timeout after 2 minutes.

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. Note: Depending on the number of simultaneously connected clients and the network's speed, this can lead to a significant higher load on your network!

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.

Authentication method: none | simple | sasl

Distinguished Name of the user for simple bind.

Password for simple bind.

Specifies the LDAP URI of the server to connect to. The URI scheme may be ldap, ldapi or ldaps, specifying LDAP over TCP, ICP or TLS respectively (if supported by the LDAP library). This is only needed for explicit ACL support in order to be able to query LDAP for UUIDs.

You can use afpldaptest(1) to syntactically check your config.

DN of the user container in LDAP.

Search scope for user search: base | one | sub

DN of the group container in LDAP.

Search scope for group search: base | one | sub

Name of the LDAP attribute with the UUIDs.

Note: this is used both for users and groups.

Name of the LDAP attribute with the users short name.

Name of the LDAP attribute with the groups short name.

Format of the uuid string in the directory. A series of x and -, where every x denotes a value 0-9a-f and every - is a separator.

Default: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Format of the UUID of the LDAP attribute, allows usage of the binary objectGUID fields from Active Directory. If left unspecified, string is the default, which passes through the ASCII UUID returned by most other LDAP stores. If set to ms-guid, the internal UUID representation is converted to and from the binary format used in the objectGUID attribute found on objects in Active Directory when interacting with the server.

See also the options ldap user filter and ldap group filter.

Optional LDAP filter that matches user objects. This is necessary for Active Directory environments where users and groups are stored in the same directory subtree.

Recommended setting for Active Directory: objectClass=user.

Optional LDAP filter that matches group objects. This is necessary for Active Directory environments where users and groups are stored in the same directory subtree.

Recommended setting for Active Directory: objectClass=group.

The path name must be a fully qualified path name.

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 ea.

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. IMPORTANT: This is an approximated calculation taking into account the contents of Time Machine sparsebundle images. Therefore you MUST NOT use this volume to store other content when using this option, because it would NOT be accounted for. 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.

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 = user @group

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.

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.

Example: hosts allow = 10.1.0.0/16 10.2.1.100 2001:0db8:1234::/48

Listed hosts and nets are rejected, all others are allowed.

Example: hosts deny = 192.168.100/24 10.1.1.1 2001:db8::1428:57ab

set the CNID backend to be used for the volume, default is ["dbd"] available schemes: ["dbd last mysql"]

Specify how Extended Attributes are stored. auto is the default.

specifies the Mac client charset for this Volume, e.g. MAC_ROMAN, MAC_CYRILLIC. 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.

The casefold option handles, if the case of filenames should be changed. The available options are:

tolower - Lowercases names in both directions.

toupper - Uppercases names in both directions.

xlatelower - Client sees lowercase, server sees uppercase.

xlateupper - Client sees uppercase, server sees lowercase.

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).

Add(or) with the client requested permissions: file perm is for files only, directory perm is for directories only. Don't use with "unix priv = no".

file perm = 0660 directory perm =
              0770

set perm mask. Don't use with "unix priv = no".

command to be run when the volume is mounted

command to be run when the volume is closed

command to be run as root when the volume is mounted

command to be run as root when the volume is closed

Allows certain users and groups to have read-only access to a share. This follows the allow option format.

Allows certain users and groups to have read/write access to a share. This follows the allow option format.

hide files and directories,where the path matches one of the '/' delimited vetoed names. The veto string must always be terminated with a '/', e.g. "veto files = veto1/", "veto files = veto1/veto2/".

Whether to flag volumes as supporting ACLs. If ACL support is compiled in, this is yes by default.

Whether to flag volumes as supporting case-sensitive filenames. If the filesystem is case-insensitive, set to no. However, it is not fully verified.

Whether to use the device number in the CNID backends. Helps when the device number is not constant across a reboot, e.g. cluster, ...

Whether automatic conversion from appledouble = v2 to appledouble = ea is performed when accessing filesystems from clients. This is generally useful, but costs some performance. It's recommendable to run dbd on volumes and do the conversion with that. Then this option can be set to no.

This option is used when Netatalk is attempting to delete a directory that contains one or more vetoed files or directories (see the veto files option). If this option is set to no (the default) then if a directory contains any non-vetoed files or directories then the directory delete will fail. This is usually what you want.

If this option is set to yes, then Netatalk will attempt to recursively delete any files and directories within the vetoed directory.

The default setting is false thus symlinks are not followed on the server. This is the same behaviour as OS X's AFP server. Setting the option to true causes afpd to follow symlinks on the server. symlinks may point outside of the AFP volume, currently afpd doesn't do any checks for "wide symlinks".

make dot files invisible. WARNING: enabling this option will lead to unwanted sideeffects were OS X applications when saving files to a temporary file starting with a dot first, then renaming the temp file to its final name, result in the saved file being invisible. The only thing this option is useful for is making files that start with a dot invisible on Mac OS 9. It's completely useless on Mac OS X, as both in Finder and in Terminal files starting with a dot are hidden anyway.

Limit disk size reporting to 2GB for legacy clients. This can be used for older Macintoshes running System 7.1 or earlier and using newer AppleShare clients.

Whether the server support network ids. Setting this to no will result in the client not using ACL AFP functions.

A non-zero return code from preexec close the volume being immediately, preventing clients to mount/see the volume in question.

Enable ProDOS support. This option should only be enabled for volumes you expect to netboot an Apple II from. In addition to setting the boot flag on the volume, it restricts the volume free space shown to 32MB.

Specifies the share as being read only for all users. Overwrites ea = auto with ea = none

A non-zero return code from root_preexec closes the volume immediately, preventing clients to mount/see the volume in question.

Use fast CNID database namesearch instead of slow recursive filesystem search. Relies on a consistent CNID database, i.e. Samba or local filesystem access lead to inaccurate or wrong results. Works only for "dbd" CNID db volumes.

Whether to stat volume path when enumerating volumes list, useful for automounting or volumes created by a preexec script.

Whether to enable Time Machine support for this volume.

Whether to use AFP3 UNIX privileges. This should be set for OS X clients. See also: file perm, directory perm and umask.