doc/INSTALL

   1 Basic Installation
   2 ==================
   3
   4 Netatalk is known to run on at least five operating systems:
   5
   6         OS      Versions        Hardware        Notes
   7         --      --------        --------        -----
   8         Solaris 2.5-8           Sparc
   9         Linux   1.3.x,2.x       PC
  10         FreeBSD 2.2-current     PC              after 12 Sept 96
  11         NetBSD  1.3             PC
  12         OpenBSD 2.2             PC
  13         SunOS   4.1+            Sparc           kernel must have VDDRV
  14                                                 option installed
  15         Ultrix  4.[1-4]         3100,5000
  16         Tru64   4.0             Alpha           afpd only
  17
  18 See ./doc/README.platforms for more information.
  19
  20 Quickly:
  21 $> ./autogen.sh
  22 $> ./configure [options]
  23 $> make
  24 $> make install
  25
  26
  27 1. ./autogen.sh (Not necessary for a release tarball.)
  28 This shell script runs libtoolize, aclocal, autoheader, automake and
  29 autoconf. This sets up all the conditions for the next step. You may
  30 or may not have to do this. If you downloaded a release tarball, or if
  31 your download contains a ./configure file then this has already been
  32 run for you.
  33
  34 2. ./configure
  35 This step reads the options to the ./configure program and checks your
  36 system against the requirements of those options. It generally fails
  37 if your system doesn't meet the requirements. You should read check
  38 the DEVELOPER file because some of these options require external
  39 sources to function correctly. (PAM, SSL, Berkeley DB3, TCP Wrappers,
  40 etc).
  41
  42 Netatalk options to the ./configure script: Use ./configure --help for
  43 a complete list.
  44
  45 --disable-admin-group: disable admin group (default on),
  46
  47 --disable-ddp: disable DDP support (AppleTalk),
  48
  49 --enable-debug: enable debugging messages in syslog,
  50
  51 --enable-dropkludge: enable the experimental dropbox fix
  52         (INSECURE!),
  53
  54 --enable-cnid-db: use persistent cnid database per volume
  55         (EXPERIMENTAL),
  56
  57 --with-db3=PATH: specify path to Berkeley DB3 installation,
  58
  59 --with-did=[scheme]: set DID scheme (last,mtab),
  60
  61 --with-msg-dir=path: path to message files [default=/etc/msg],
  62
  63 --enable-srvloc: Turn on Server Location Protocol support (EXPERIMENTAL),
  64
  65 --with-pam: enable pluggable authentication modules support,
  66         PAM provides a flexible mechanism for authenticating
  67         users. PAM was invented by SUN Microsystems.
  68
  69         Linux-PAM is a suite of shared libraries that enable the local
  70         system administrator to choose how applications authenticate users.
  71         You can get the Linux PAM documentation and sources from
  72         http://www.kernel.org/pub/linux/libs/pam/
  73
  74 --with-shadow: enable shadow password support,
  75
  76 --disable-shell-check: disable checking for a valid shell,
  77
  78 --with-flock-locks: enable flock locks support,
  79
  80 --with-tcp-wrappers: enable TCP wrappers support.
  81         Wietse Venema's network logger, also known as TCPD or
  82         LOG_TCP. These programs log the client host name of incoming
  83         telnet, ftp, rsh, rlogin, finger etc. requests. Security
  84         options are: access control per host, domain and/or service;
  85         detection of host name spoofing or host address spoofing;
  86         booby traps to implement an early-warning system.  TCP
  87         Wrappers can be gotten at
  88         ftp://ftp.porcupine.org/pub/security/
  89
  90 --with-ssl-dirs=[PATH]: specify path to OpenSSL installation.
  91         NOTE: This is dependent on the same directory layout as the
  92         source distribution of Openssl. That is: ./include/ and
  93         ./lib/ to be on the same level. Many .rpm formats do not
  94         have their files laid out in this format.
  95         The OpenSSL Project is a collaborative effort to develop a
  96         robust, commercial-grade, full-featured, and Open Source
  97         toolkit implementing the Secure Sockets Layer (SSL v2/v3)
  98         and Transport Layer Security (TLS v1) protocols as well as a
  99         full-strength general purpose cryptography library.
 100         This is required to enable DHX login support.
 101         Get everything at http://www.openssl.org/
 102
 103 --with-lastdid: Recreate version 37b behaviour where
 104         directory id's are incrementally calculated versus the new
 105         hash method. Unfortunately for machines that have a lot of
 106         devices, and/or a lot of inodes the hash can fail with
 107         multiple directories resolving to the same DID.
 108
 109 --with-uams-path=path: path to UAMs [default=PKGCONF/uams]
 110
 111 --enable-fhs: use Filesystem Hierarchy Standard (FHS) compatibility
 112
 113 --with-ssl-dir=PATH: specify path to openssl installation (must contain
 114         lib and include dirs)
 115
 116 --enable-pgp-uam: enable build of PGP UAM module
 117
 118 --enable-krb4-uam: enable build of Kerberos v4 UAM module
 119
 120 --enable-overwrite: Overwrite configuration files in PKGCONFDIR
 121
 122
 123 3. ./make
 124
 125 Compile all of the programs
 126
 127 4. ./make install
 128 Install the programs in the places specified by the ./configure process.