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 #     -noslp              Don't register this server with the Service
  53 #                         Location Protocol.
  54 #
  55 #
  56 #   Authentication Methods:
  57 #     -uampath <path>  Use this path to look for User Authentication Modules.
  58 #                      (default: :UAMS_PATH:)
  59 #     -uamlist <a,b,c> Comma-separated list of UAMs. (default:
  60 #                      uams_guest.so,uams_clrtxt.so,uams_dhx.so)
  61 #
  62 #                      some commonly available UAMs:
  63 #                      uams_guest.so: Allow guest logins
  64 #
  65 #                      uams_clrtxt.so: (uams_pam.so or uams_passwd.so)
  66 #                                     Allow logins with passwords
  67 #                                     transmitted in the clear.
  68 #
  69 #                      uams_randnum.so: Allow Random Number and Two-Way
  70 #                                      Random Number exchange for
  71 #                                      authentication.
  72 #
  73 #                      uams_dhx.so: (uams_dhx_pam.so or uams_dhx_passwd.so)
  74 #                                   Allow Diffie-Hellman eXchange
  75 #                                   (DHX) for authentication.
  76 #
  77 #   Password Options:
  78 #     -[no]savepassword   [Don't] Allow clients to save password locally
  79 #     -passwdfile <path>  Use this path to store Randnum
  80 #                         passwords. (Default: :ETCDIR:/afppasswd. The only
  81 #                         other useful value is ~/.passwd. See 'man afppasswd'
  82 #                         for details.)
  83 #     -passwdminlen <#>   minimum password length. may be ignored.
  84 #     -[no]setpassword    [Don't] Allow clients to change their passwords.
  85 #     -loginmaxfail <#>   maximum number of failed logins. this may be
  86 #                         ignored if the uam can't handle it.
  87 #
  88 #   AppleVolumes files:
  89 #     -defaultvol <path>  Specifies path to AppleVolumes.default file
  90 #                         (default :ETCDIR:/AppleVolumes.default,
  91 #                         same as -f on command line)
  92 #     -systemvol <path>   Specifies path to AppleVolumes.system file
  93 #                         (default :ETCDIR:/AppleVolumes.system,
  94 #                         same as -s on command line)
  95 #     -[no]uservolfirst   [Don't] read the user's ~/AppleVolumes or
  96 #                         ~/.AppleVolumes before reading
  97 #                         :ETCDIR:/AppleVolumes.default
  98 #                         (same as -u on command line)
  99 #     -[no]uservol        [Don't] Read the user's volume file
 100 #     -closevol           After an AppleVolumes change, disconnect immediatly
 101 #                         removed volumes.
 102 #
 103 #
 104 #   Miscellaneous:
 105 #     -authprintdir <path> Specifies the path to be used (per server) to
 106 #                          store the files required to do CAP-style
 107 #                          print authentication which papd will examine
 108 #                          to determine if a print job should be allowed.
 109 #                          These files are created at login and if they
 110 #                          are to be properly removed, this directory
 111 #                          probably needs to be umode 1777
 112 #     -guestname "user"   Specifies the user name for the guest login
 113 #                         (default "nobody", same as -g on command line)
 114 #     -loginmesg "Message"  Client will display "Message" upon logging in
 115 #                         (no default, same as -l "Message" on commandline)
 116 #     -nodebug            Switch off debugging
 117 #     -client_polling     With this switch enabled, afpd won't advertise
 118 #                         that it is capable of server notifications, so that
 119 #                         connected clients poll the server every 10 seconds
 120 #                         to detect changes in opened server windows.
 121 #                         Note: Depending on the number of simultaneously
 122 #                         connected clients and the network's speed, this can
 123 #                         lead to a significant higher load on your network!
 124 #     -sleep   <number>   AFP 3.x wait number hours before disconnecting
 125 #                         clients in sleep mode. Default 10 hours
 126 #     -tickleval <number> Specify the tickle timeout interval (in seconds).
 127 #                         Note, this defaults to 30 seconds, and really
 128 #                         shouldn't be changed.  If you want to control
 129 #                         the server idle timeout, use the -timeout option.
 130 #     -timeout <number>   Specify the number of tickles to send before
 131 #                         timing out a connection.  The default is 4, therefore
 132 #                         a connection will timeout in 2 minutes.
 133 #     -icon               Use the platform-specific icon.
 134 #     -volnamelen <number>
 135 #                         Max length of UTF8-MAC volume name for Mac OS X.
 136 #                         Note that Hangul is especially sensitive to this.
 137 #                           31:  conservative default
 138 #                           80:  limit for Mac OS X 10.5
 139 #                           255: limit of spec
 140 #                         Mac OS 9 and earlier are not influenced by this,
 141 #                         Maccharset volume name is always 27 limit.
 142 #     -[un]setuplog "<logtype> <loglevel> [<filename>]"
 143 #                         Specify that any message of a loglevel up to the given loglevel
 144 #                         should be logged to the given file. If the filename is ommited the
 145 #                         loglevel applies to messages passed to syslog. Latter -setuplog
 146 #                         settings will override earlier ones of the same logtype (file or
 147 #                         syslog).
 148 #
 149 #                         By default (no explicit -setuplog and no buildtime configure flag
 150 #                         --with-logfile) all netatalk daemons log to syslog with a default
 151 #                         logging setup equivalent to "-setuplog default log_debug".
 152 #
 153 #                         If build with --with-logfile (default logfile
 154 #                         /var/log/netatalk.log) or --with-logfile=somefile all daemons
 155 #                         default to a setup that is equivalent to "-setuplog default
 156 #                         log_info [netatalk.log|somefile]"
 157 #
 158 #                Example: Useful default config
 159 #                         -setuplog "default log_info /var/log/afpd.log"
 160 #
 161 #                         Debugging config
 162 #                         -setuplog "default log_maxdebug /var/log/afpd.log"
 163 #
 164 #     -signature { user:<text> | host }
 165 #                         Specify a server signature. This option is useful while
 166 #                         running multiple independent instances of afpd on one
 167 #                         machine (eg. in clustered environments, to provide fault
 168 #                         isolation etc.). "host" signature type allows afpd generating
 169 #                         signature automatically (based on machine primary IP address).
 170 #                         "user" signature type allows administrator to set up a signature
 171 #                         string manually. Examples: three servers running on one machine:
 172 #           first       -signature user:USERS
 173 #           second      -signature user:USERS
 174 #           third       -signature user:ADMINS
 175 #                First two servers will act as one logical AFP service - if user logs in to
 176 #                first one and then  connects to second one, session will be automatically
 177 #                redirected to the first one. But if client connects to first and then to third,
 178 #                will be asked for password twice and will see  resources of both servers.
 179 #                Traditional method of signature generation causes two independent afpd instances
 180 #                to have the same signature and thus cause clients to be redirected automatically
 181 #                to server (s)he logged in first.
 182 #     -k5service <service>
 183 #     -k5realm <realm>
 184 #                These are required if the server supports Kerberos 5 authentication
 185 #
 186 #   Codepage Options:
 187 #      -unixcodepage <CODEPAGE>     Specifies the servers unix codepage, e.g. "ISO-8859-15" or "UTF8".
 188 #                                   This is used to convert strings to/from the systems locale, e.g.
 189 #                                   for authenthication. Defaults to LOCALE if your system supports it,
 190 #                                   otherwise ASCII will be used.
 191 #
 192 #      -maccodepage <CODEPAGE>      Specifies the mac clients codepage, e.g. "MAC_ROMAN".
 193 #                                   This is used to convert strings to the systems locale, e.g.
 194 #                                   for authenthication and SIGUSR2 messaging. This will also be
 195 #                                   the default for volumes maccharset.
 196 #
 197 #   CNID related options:
 198 #      -cnidserver ipaddress:port   Specifies the IP address and port of a cnid_metad server.
 199 #
 200
 201
 202 #
 203 # Some examples:
 204 #
 205 #       The simplest case is to not have an afpd.conf.
 206 #
 207 #       4 servers w/ names server1-3 and one w/ the hostname. servers
 208 #       1-3 get routed to different ports with server 3 being bound
 209 #       specifically to address 192.168.1.3
 210 #               -
 211 #               server1 -port 12000
 212 #               server2 -port 12001
 213 #               server3 -port 12002 -ipaddr 192.168.1.3
 214 #
 215 #       a dedicated guest server, a user server, and a special
 216 #       ddp-only server:
 217 #               "Guest Volume" -uamlist uams_guest.so -loginmesg "Welcome guest!"
 218 #               "User Volume" -uamlist uams_clrtxt.so -port 12000
 219 #               "special" -notcp -defaultvol <path> -systemvol <path>
 220 #
 221 # default:
 222 # - -transall -uamlist uams_clrtxt.so,uams_dhx.so -nosavepassword