config/afpd.conf.tmpl

   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 #     -admingroup <groupname>
  33 #                         Specifies the group of administrators who should all
  34 #                         be seen as the superuser when they log in.  Default
  35 #                         is disabled.
  36 #     -ddpaddr x.y        Specifies the DDP address of the server. the
  37 #                         default is to auto-assign an address
  38 #                         (0.0). this is only useful if you're running
  39 #                         on a multihomed host.
  40 #     -port <number>      Specifies the TCP port the server should respond
  41 #                         to (default is 548)
  42 #     -fqdn <name:port>   specify a fully-qualified domain name (+
  43 #                         optional port). this gets discarded if the
  44 #                         server can't resolve it. this is not honored
  45 #                         by appleshare clients <= 3.8.3 (default: none)
  46 #     -proxy              Run an AppleTalk proxy server for specified AFP/TCP
  47 #                         server (if address/port aren't given, then
  48 #                         first IP address of the system/548 will be used).
  49 #                         if you don't want the proxy server to act as
  50 #                         a ddp server as well, set -uamlist to an
  51 #                         empty string.
  52 #
  53 #
  54 #   Authentication Methods:
  55 #     -uampath <path>  Use this path to look for User Authentication Modules.
  56 #                      (default: :UAMS_PATH:)
  57 #     -uamlist <a,b,c> Comma-separated list of UAMs. (default:
  58 #                      uams_guest.so,uams_clrtxt.so,uams_dhx.so)
  59 #
  60 #                      some commonly available UAMs:
  61 #                      uams_guest.so: Allow guest logins
  62 #
  63 #                      uams_clrtxt.so: (uams_pam.so or uams_passwd.so)
  64 #                                     Allow logins with passwords
  65 #                                     transmitted in the clear.
  66 #
  67 #                      uams_randnum.so: Allow Random Number and Two-Way
  68 #                                      Random Number exchange for
  69 #                                      authentication.
  70 #
  71 #                      uams_dhx.so: (uams_dhx_pam.so or uams_dhx_passwd.so)
  72 #                                   Allow Diffie-Hellman eXchange
  73 #                                   (DHX) for authentication.
  74 #
  75 #   Password Options:
  76 #     -[no]savepassword   [Don't] Allow clients to save password locally
  77 #     -passwdfile <path>  Use this path to store Randnum
  78 #                         passwords. (Default: :ETCDIR:/afppasswd. The only
  79 #                         other useful value is ~/.passwd. See 'man afppasswd'
  80 #                         for details.)
  81 #     -passwdminlen <#>   minimum password length. may be ignored.
  82 #     -[no]setpassword    [Don't] Allow clients to change their passwords.
  83 #     -loginmaxfail <#>   maximum number of failed logins. this may be
  84 #                         ignored if the uam can't handle it.
  85 #
  86 #   AppleVolumes files:
  87 #     -defaultvol <path>  Specifies path to AppleVolumes.default file
  88 #                         (default :ETCDIR:/AppleVolumes.default,
  89 #                         same as -f on command line)
  90 #     -systemvol <path>   Specifies path to AppleVolumes.system file
  91 #                         (default :ETCDIR:/AppleVolumes.system,
  92 #                         same as -s on command line)
  93 #     -[no]uservolfirst   [Don't] read the user's ~/AppleVolumes or
  94 #                         ~/.AppleVolumes before reading
  95 #                         :ETCDIR:/AppleVolumes.default
  96 #                         (same as -u on command line)
  97 #     -[no]uservol        [Don't] Read the user's volume file
  98 #
  99 #     -nlspath <path>     Prepend this path to each code page filename
 100 #                         in volume options (default: :NLS_PATH:).
 101 #
 102 #   Miscellaneous:
 103 #     -authprintdir <path> Specifies the path to be used (per server) to
 104 #                          store the files required to do CAP-style
 105 #                          print authentication which papd will examine
 106 #                          to determine if a print job should be allowed.
 107 #                          These files are created at login and if they
 108 #                          are to be properly removed, this directory
 109 #                          probably needs to be umode 1777
 110 #     -guestname "user"   Specifies the user name for the guest login
 111 #                         (default "nobody", same as -g on command line)
 112 #     -loginmesg "Message"  Client will display "Message" upon logging in
 113 #                         (no default, same as -l "Message" on commandline)
 114 #     -nodebug            Switch off debugging
 115 #     -client_polling     With this switch enabled, afpd won't advertise
 116 #                         that it is capable of server notifications, so that
 117 #                         connected clients poll the server every 10 seconds
 118 #                         to detect changes in opened server windows.
 119 #                         Note: Depending on the number of simultaneously
 120 #                         connected clients and the network's speed, this can
 121 #                         lead to a significant higher load on your network!
 122 #     -tickleval <number> Specify the tickle timeout interval (in seconds).
 123 #                         Note, this defaults to 30 seconds, and really
 124 #                         shouldn't be changed.  If you want to control
 125 #                         the server idle timeout, use the -timeout option.
 126 #     -timeout <number>   Specify the number of tickles to send before
 127 #                         timing out a connection.  The default is 4, therefore
 128 #                         a connection will timeout in 2 minutes.
 129 #     -icon               Use the platform-specific icon.
 130 #
 131 # Some examples:
 132 #
 133 #       The simplest case is to not have an afpd.conf.
 134 #
 135 #       4 servers w/ names server1-3 and one w/ the hostname. servers
 136 #       1-3 get routed to different ports with server 3 being bound
 137 #       specifically to address 192.168.1.3
 138 #               -
 139 #               server1 -port 12000
 140 #               server2 -port 12001
 141 #               server3 -port 12002 -ipaddr 192.168.1.3
 142 #
 143 #       a dedicated guest server, a user server, and a special
 144 #       ddp-only server:
 145 #               "Guest Volume" -uamlist uams_guest.so -loginmesg "Welcome guest!"
 146 #               "User Volume" -uamlist uams_clrtxt.so -port 12000
 147 #               "special" -notcp -defaultvol <path> -systemvol <path>
 148 #
 149 # default:
 150 # - -transall -uamlist uams_clrtxt.so,uams_dhx.so -nosavepassword