2 # CONFIGURATION FOR AFPD
4 # Each single line defines a virtual server that should be available.
5 # Though, using "\" character, newline escaping is supported.
6 # Empty lines and lines beginning with `#' are ignored.
7 # Options in this file will override both compiled-in defaults
8 # and command line options.
14 # - [options] to specify options for the default server
15 # "Server name" [options] to specify an additional server
20 # The following options are available:
21 # Transport Protocols:
22 # -[no]tcp Make "AFP over TCP" [not] available
23 # -[no]ddp Make "AFP over AppleTalk" [not] available.
24 # If you have -proxy specified, specify -uamlist "" to
25 # prevent ddp connections from working.
27 # -transall Make both available
30 # -ipaddr <ipaddress> Specifies the IP address that the server should
31 # advertise and listens to. The default is advertise
32 # the first IP address of the system, but to listen
33 # for any incoming request. The network address may
34 # be specified either in dotted-decimal format for
35 # IPv4 or in hexadecimal format for IPv6.
36 # This option also allows to use one machine to
37 # advertise the AFP-over-TCP/IP settings of another
38 # machine via NBP when used together with the -proxy
40 # -server_quantum <number>
41 # Specifies the DSI server quantum. The minimum
42 # value is 1MB. The max value is 0xFFFFFFFF. If you
43 # specify a value that is out of range, you'll get
44 # the default value (currently the minimum).
45 # -admingroup <groupname>
46 # Specifies the group of administrators who should
47 # all be seen as the superuser when they log in.
48 # Default is disabled.
49 # -ddpaddr x.y Specifies the DDP address of the server.
50 # the default is to auto-assign an address (0.0).
51 # this is only useful if you're running on
53 # -port <number> Specifies the TCP port the server should respond
55 # -fqdn <name:port> specify a fully-qualified domain name (+optional
56 # port). this gets discarded if the server can't
57 # resolve it. this is not honored by appleshare
58 # clients <= 3.8.3 (default: none)
59 # -hostname <name> Use this instead of the result from calling
60 # hostname for dertermening which IP address to
61 # advertise, therfore the hostname is resolved to
62 # an IP which is the advertised. This is NOT used for
63 # listening and it is also overwritten by -ipaddr.
64 # -proxy Run an AppleTalk proxy server for specified
65 # AFP/TCP server (if address/port aren't given,
66 # then first IP address of the system/548 will
68 # if you don't want the proxy server to act as
69 # a ddp server as well, set -uamlist to an empty
71 # -slp Register this server with the Service Location
72 # Protocol (if SLP support was compiled in).
73 # -advertise_ssh Allows Mac OS X clients (10.3.3-10.4) to
74 # automagically establish a tunneled AFP connection
75 # through SSH. This option is not so significant
76 # for the recent Mac OS X. See the Netatalk Manual
80 # Authentication Methods:
81 # -uampath <path> Use this path to look for User Authentication Modules.
82 # (default: :UAMS_PATH:)
83 # -uamlist <a,b,c> Comma-separated list of UAMs.
84 # (default: uams_dhx.so,uams_dhx2.so)
86 # some commonly available UAMs:
87 # uams_guest.so: Allow guest logins
89 # uams_clrtxt.so: (uams_pam.so or uams_passwd.so)
90 # Allow logins with passwords
91 # transmitted in the clear.
93 # uams_randnum.so: Allow Random Number and Two-Way
94 # Random Number exchange for
97 # uams_dhx.so: (uams_dhx_pam.so or uams_dhx_passwd.so)
98 # Allow Diffie-Hellman eXchange
99 # (DHX) for authentication.
101 # uams_dhx2.so: (uams_dhx2_pam.so or uams_dhx2_passwd.so)
102 # Allow Diffie-Hellman eXchange 2
103 # (DHX2) for authentication.
106 # -[no]savepassword [Don't] Allow clients to save password locally
107 # -passwdfile <path> Use this path to store Randnum passwords.
108 # (Default: :ETCDIR:/afppasswd. The only other
109 # useful value is ~/.passwd. See 'man afppasswd'
111 # -passwdminlen <#> minimum password length. may be ignored.
112 # -[no]setpassword [Don't] Allow clients to change their passwords.
113 # -loginmaxfail <#> maximum number of failed logins. this may be
114 # ignored if the uam can't handle it.
116 # AppleVolumes files:
117 # -defaultvol <path> Specifies path to AppleVolumes.default file
118 # (default :ETCDIR:/AppleVolumes.default,
119 # same as -f on command line)
120 # -systemvol <path> Specifies path to AppleVolumes.system file
121 # (default :ETCDIR:/AppleVolumes.system,
122 # same as -s on command line)
123 # -[no]uservolfirst [Don't] read the user's ~/AppleVolumes or
124 # ~/.AppleVolumes before reading
125 # :ETCDIR:/AppleVolumes.default
126 # (same as -u on command line)
127 # -[no]uservol [Don't] Read the user's volume file
128 # -closevol Immediately unmount volumes removed from
129 # AppleVolumes files on SIGHUP sent to the afp
133 # -authprintdir <path> Specifies the path to be used (per server) to
134 # store the files required to do CAP-style
135 # print authentication which papd will examine
136 # to determine if a print job should be allowed.
137 # These files are created at login and if they
138 # are to be properly removed, this directory
139 # probably needs to be umode 1777
140 # -guestname "user" Specifies the user name for the guest login
141 # (default "nobody", same as -g on command line)
142 # -loginmesg "Message" Client will display "Message" upon logging in
143 # (no default, same as -l "Message" on commandline)
144 # -nodebug Switch off debugging
145 # -client_polling With this switch enabled, afpd won't advertise
146 # that it is capable of server notifications, so that
147 # connected clients poll the server every 10 seconds
148 # to detect changes in opened server windows.
149 # Note: Depending on the number of simultaneously
150 # connected clients and the network's speed, this can
151 # lead to a significant higher load on your network!
152 # -sleep <number> AFP 3.x wait number hours before disconnecting
153 # clients in sleep mode. Default 10 hours
154 # -tickleval <number> Specify the tickle timeout interval (in seconds).
155 # Note, this defaults to 30 seconds, and really
156 # shouldn't be changed. If you want to control
157 # the server idle timeout, use the -timeout option.
158 # -timeout <number> Specify the number of tickles to send before
159 # timing out a connection.
160 # The default is 4, therefore a connection will
161 # timeout in 2 minutes.
162 # -[no]icon [Don't] Use the platform-specific icon. Recent
163 # Mac OS don't display it any longer.
164 # -volnamelen <number>
165 # Max length of UTF8-MAC volume name for Mac OS X.
166 # Note that Hangul is especially sensitive to this.
168 # 80: limit of generic Mac OS X (default)
169 # 73: limit of Mac OS X 10.1, if >= 74
170 # Finder crashed and restart repeatedly.
171 # Mac OS 9 and earlier is not influenced by this,
172 # Maccharset volume names are always limitted to 27.
173 # -[un]setuplog "<logtype> <loglevel> [<filename>]"
174 # Specify that any message of a loglevel up to the
175 # given loglevel should be logged to the given file.
176 # If the filename is ommited the loglevel applies to
177 # messages passed to syslog.
179 # By default (no explicit -setuplog and no buildtime
180 # configure flag --with-logfile) afpd logs to syslog
181 # with a default logging setup equivalent to
182 # "-setuplog default log_info".
184 # If build with --with-logfile[=somefile]
185 # (default logfile /var/log/netatalk.log) afpd
186 # defaults to a setup that is equivalent to
187 # "-setuplog default log_info [netatalk.log|somefile]"
189 # logtypes: Default, AFPDaemon, Logger, UAMSDaemon
190 # loglevels: LOG_SEVERE, LOG_ERROR, LOG_WARN,
191 # LOG_NOTE, LOG_INFO, LOG_DEBUG,
192 # LOG_DEBUG6, LOG_DEBUG7, LOG_DEBUG8,
193 # LOG_DEBUG9, LOG_MAXDEBUG
195 # Example: Useful default config
196 # -setuplog "default log_info /var/log/afpd.log"
199 # -setuplog "default log_maxdebug /var/log/afpd.log"
201 # -signature { user:<text> | auto }
202 # Specify a server signature. This option is useful
203 # while running multiple independent instances of
204 # afpd on one machine (eg. in clustered environments,
205 # to provide fault isolation etc.).
207 # "auto" signature type allows afpd generating
208 # signature and saving it to afp_signature.conf
209 # automatically (based on random number).
210 # "host" signature type switches back to "auto"
211 # because it is obsoleted.
212 # "user" signature type allows administrator to
213 # set up a signature string manually.
214 # Examples: three servers running on one machine:
215 # first -signature user:USERS
216 # second -signature user:USERS
217 # third -signature user:ADMINS
218 # First two servers will act as one logical AFP
219 # service. If user logs in to first one and then
220 # connects to second one, session will be
221 # automatically redirected to the first one. But if
222 # client connects to first and then to third,
223 # will be asked for password twice and will see
224 # resources of both servers.
225 # Traditional method of signature generation causes
226 # two independent afpd instances to have the same
227 # signature and thus cause clients to be redirected
228 # automatically to server (s)he logged in first.
230 # -k5service <service>
232 # These are required if the server supports
233 # Kerberos 5 authentication
236 # Use for eg. winbind authentication, prepends
237 # both strings before the username from login and
238 # then tries to authenticate with the result
239 # through the availabel and active UAM authentication
243 # -unixcodepage <CODEPAGE> Specifies the servers unix codepage,
244 # e.g. "ISO-8859-15" or "UTF8".
245 # This is used to convert strings to/from
246 # the systems locale, e.g. for authenthication.
247 # Defaults to LOCALE if your system supports it,
248 # otherwise ASCII will be used.
250 # -maccodepage <CODEPAGE> Specifies the mac clients codepage,
252 # This is used to convert strings to the
253 # systems locale, e.g. for authenthication
254 # and SIGUSR2 messaging. This will also be
255 # the default for volumes maccharset.
257 # CNID related options:
258 # -cnidserver <ipaddress:port>
259 # Specifies the IP address and port of a
260 # cnid_metad server, required for CNID dbd
261 # backend. Defaults to localhost:4700.
262 # The network address may be specified either
263 # in dotted-decimal format for IPv4 or in
264 # hexadecimal format for IPv6.
271 # The simplest case is to not have an afpd.conf.
273 # 4 servers w/ names server1-3 and one w/ the hostname. servers
274 # 1-3 get routed to different ports with server 3 being bound
275 # specifically to address 192.168.1.3
278 # server1 -port 12000
279 # server2 -port 12001
280 # server3 -port 12002 -ipaddr 192.168.1.3
282 # a dedicated guest server, a user server, and a special
283 # AppleTalk-only server:
285 # "Guest Server" -uamlist uams_guest.so \
286 # -loginmesg "Welcome guest! I'm a public server."
287 # "User Server" -uamlist uams_dhx2.so -port 12000
288 # "special" -ddp -notcp -defaultvol <path> -systemvol <path>
293 # - -tcp -noddp -uamlist uams_dhx.so,uams_dhx2.so -nosavepassword