]> arthur.barton.de Git - netatalk.git/blob - config/afpd.conf
Initial revision
[netatalk.git] / config / afpd.conf
1 #
2 # CONFIGURATION FOR AFPD
3 #
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.
8 #
9 # Format:
10 #  - [options]                to specify options for the default server
11 #  "Server name" [options]   to specify an additional server
12 #
13 # The following options are available:
14 #   Transport Protocols:
15 #     -[no]tcp       Make AFP-over-TCP [not] available
16 #     -[no]ddp       Make AFP over AppleTalk [not] available. if you
17 #                    have -proxy specified, specify -uamlist "" to 
18 #                    prevent ddp connections from working.
19 #
20 #     -transall      Make both available (default)
21 #
22 #   Transport Options:
23 #     -ipaddr <w.x.y.z>   Specifies the IP address the server should respond
24 #                         to (default is the first IP address of the system)
25 #                         This option also allows one machine to advertise
26 #                         TCP/IP for another machine.
27 #     -server_quantum <number> 
28 #                         Specifies the DSI server quantum. The minimum
29 #                         value is 1MB. The max value is 0xFFFFFFFF. If you 
30 #                         specify a value that is out of range, you'll get 
31 #                         the default value (currently the minimum).
32 #     -ddpaddr x.y        Specifies the DDP address of the server. the 
33 #                         default is to auto-assign an address
34 #                         (0.0). this is only useful if you're running
35 #                         on a multihomed host.
36 #     -port <number>      Specifies the TCP port the server should respond
37 #                         to (default is 548)
38 #     -fqdn <name:port>   specify a fully-qualified domain name (+
39 #                         optional port). this gets discarded if the
40 #                         server can't resolve it. this is not honored
41 #                         by appleshare clients <= 3.8.3 (default: none)
42 #     -proxy              Run an AppleTalk proxy server for specified AFP/TCP
43 #                         server (if address/port aren't given, then
44 #                         first IP address of the system/548 will be used).
45 #                         if you don't want the proxy server to act as
46 #                         a ddp server as well, set -uamlist to an
47 #                         empty string.
48 #
49 #
50 #   Authentication Methods:
51 #     -uampath <path>  Use this path to look for User Authentication Modules.
52 #                      (default: :RESDIR:/uams)
53 #     -uamlist <a,b,c> Comma-separated list of UAMs. (default:
54 #                      uams_guest.so,uams_clrtxt.so,uams_dhx.so) 
55 #
56 #                      some commonly available UAMs:
57 #                      uams_guest.so: Allow guest logins
58 #
59 #                      uams_clrtxt.so: (uams_pam.so or uams_passwd.so)
60 #                                     Allow logins with passwords
61 #                                     transmitted in the clear. 
62 #
63 #                      uams_randnum.so: Allow Random Number and Two-Way
64 #                                      Random Number exchange for
65 #                                      authentication.
66 #
67 #                      uams_dhx.so: (uams_dhx_pam.so or uams_dhx_passwd.so)
68 #                                   Allow Diffie-Hellman eXchange
69 #                                   (DHX) for authentication.
70 #
71 #   Password Options:
72 #     -[no]savepassword   [Don't] Allow clients to save password locally
73 #     -passwdfile <path>  Use this path to store Randnum
74 #                         passwords. (default: ~/.passwd. the only other
75 #                         userful value is :RESDIR:/etc/afppasswd.)
76 #     -passwdminlen <#>   minimum password length. may be ignored.
77 #     -[no]setpassword    [Don't] Allow clients to change their passwords.
78 #     -loginmaxfail <#>   maximum number of failed logins. this may be
79 #                         ignored if the uam can't handle it.
80 #
81 #   AppleVolumes files:
82 #     -defaultvol <path>  Specifies path to AppleVolumes.default file
83 #                         (default :ETCDIR:/AppleVolumes.default,
84 #                         same as -f on command line)
85 #     -systemvol <path>   Specifies path to AppleVolumes.system file
86 #                         (default :ETCDIR:/AppleVolumes.system,
87 #                         same as -s on command line)
88 #     -[no]uservolfirst   [Don't] read the user's ~/AppleVolumes or
89 #                         ~/.AppleVolumes before reading
90 #                         :ETCDIR:/AppleVolumes.default
91 #                         (same as -u on command line)
92 #     -[no]uservol        [Don't] Read the user's volume file
93 #
94 #     -nlspath <path>     Prepend this path to each code page filename
95 #                         in volume options (default: :RESDIR:/nls).
96 #
97 #   Miscellaneous:
98 #     -guestname "user"   Specifies the user name for the guest login
99 #                         (default "nobody", same as -g on command line)
100 #     -loginmesg "Message"  Client will display "Message" upon logging in
101 #                         (no default, same as -l "Message" on commandline)
102 #     -nodebug            Switch off debugging
103 #     -tickleval <number> Specify the tickle timeout interval (in seconds)
104 #     -icon               Use the platform-specific icon.
105 #               
106 # Some examples:
107 #
108 #       The simplest case is to not have an afpd.conf.
109 #
110 #       4 servers w/ names server1-3 and one w/ the hostname. servers
111 #       1-3 get routed to different ports with server 3 being bound 
112 #       specifically to address 192.168.1.3
113 #               -
114 #               server1 -port 12000
115 #               server2 -port 12001
116 #               server3 -port 12002 -ipaddr 192.168.1.3
117 #
118 #       a dedicated guest server, a user server, and a special
119 #       ddp-only server:
120 #               "Guest Volume" -uamlist uams_guest.so -loginmesg "Welcome guest!"
121 #               "User Volume" -uamlist uams_clrtxt.so -port 12000
122 #               "special" -notcp -defaultvol <path> -systemvol <path>
123 #
124 # default:
125 # - -transall -uamlist uams_guest.so,uams_clrtxt.so,uams_dhx.so -nosavepassword