INSTALL

   1 1. Prerequisites
   2 ----------------
   3
   4 You will need working installations of Zlib and OpenSSL.
   5
   6 Zlib:
   7 http://www.cdrom.com/pub/infozip/zlib/
   8
   9 OpenSSL:
  10 http://www.openssl.org/
  11
  12 OpenSSH can utilise Pluggable Authentication Modules (PAM) if your system
  13 supports it. PAM is standard on Redhat and Debian Linux and on Solaris.
  14
  15 PAM:
  16 http://www.kernel.org/pub/linux/libs/pam/
  17
  18 If you wish to build the GNOME passphrase requestor, you will need the GNOME
  19 libraries and headers.
  20
  21 GNOME:
  22 http://www.gnome.org/
  23
  24 If you are planning to use OpenSSH on a Unix which lacks a Kernel random
  25 number generator (/dev/urandom), you will need to install the Entropy
  26 Gathering Daemon (or similar). You will also need to specify the
  27 --with-egd-pool option to ./configure.
  28
  29 EGD:
  30 http://www.lothar.com/tech/crypto/
  31
  32 GNU Make:
  33 ftp://ftp.gnu.org/gnu/make/
  34
  35 OpenSSH has only been tested with GNU make. It may work with other
  36 'make' programs, but you are on your own.
  37
  38 2. Building / Installation
  39 --------------------------
  40
  41 To install OpenSSH with default options:
  42
  43 ./configure
  44 make
  45 make install
  46
  47 This will install the OpenSSH binaries in /usr/local/bin, configuration files
  48 in /usr/local/etc, the server in /usr/local/sbin, etc. To specify a different
  49 installation prefix, use the --prefix option to configure:
  50
  51 ./configure --prefix=/opt
  52 make
  53 make install
  54
  55 Will install OpenSSH in /opt/{bin,etc,lib,sbin}. You can also override
  56 specific paths, for example:
  57
  58 ./configure --prefix=/opt --sysconfdir=/etc/ssh
  59 make
  60 make install
  61
  62 This will install the binaries in /opt/{bin,lib,sbin}, but will place the
  63 configuration files in /etc/ssh.
  64
  65 If you are using PAM, you will need to manually install a PAM control
  66 file as "/etc/pam.d/sshd" (or wherever your system prefers to keep
  67 them). A generic PAM configuration is included as "sshd.pam.generic",
  68 you may need to edit it before using it on your system.
  69
  70 There are a few other options to the configure script:
  71
  72 --enable-gnome-askpass will build the GNOME passphrase dialog. You
  73 need a working installation of GNOME, including the development
  74 headers, for this to work.
  75
  76 --with-random=/some/file allows you to specify an alternate source of
  77 random numbers (the default is /dev/urandom). Unless you are absolutly
  78 sure of what you are doing, it is best to leave this alone.
  79
  80 --with-egd-pool=/some/file allows you to enable Entropy Gathering
  81 Daemon support and to specify a EGD pool socket. You will need to
  82 use this if your Unix does not support the /dev/urandom device (or
  83 similar).
  84
  85 --with-kerberos4 will enable Kerberos IV support. You will need to
  86 have the Kerberos libraries and header files installed for this to
  87 work.
  88
  89 --with-afs will enable AFS support. You will need to have the Kerberos
  90 IV and the AFS libraries and header files installed for this to work.
  91
  92 --with-skey will enable S/Key one time password support. You will need
  93 the S/Key libraries and header files installed for this to work.
  94
  95 --with-tcp-wrappers will enable TCP Wrappers (/etc/hosts.allow|deny)
  96 support. You will need libwrap.a and tcpd.h installed.
  97
  98 --with-md5-passwords will enable the use of MD5 passwords. Enable this
  99 if your operating system uses MD5 passwords without using PAM.
 100
 101
 102 3. Configuration
 103 ----------------
 104
 105 The runtime configuration files are installed by in ${prefix}/etc or
 106 whatever you specified as your --sysconfdir (/usr/local/etc by default).
 107
 108 The default configuration should be instantly usable, though you should
 109 review it to ensure that it matches your security requirements.
 110
 111 To generate a host key, issue the following command: (replacing
 112 /etc/ssh/ssh_host_key with an appropriate path)
 113
 114 /usr/bin/ssh-keygen -b 1024 -f /etc/ssh/ssh_host_key -N ''
 115
 116 For more information on configuration, please refer to the manual pages
 117 for sshd, ssh and ssh-agent.
 118