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