INSTALL

   1 1. Prerequisites
   2 ----------------
   3
   4 You will need working installations of Zlib and OpenSSL.
   5
   6 Zlib:
   7 http://www.freesoftware.com/pub/infozip/zlib/
   8
   9 OpenSSL 0.9.5a or greater:
  10 http://www.openssl.org/
  11
  12 RPMs of OpenSSL are available at http://violet.ibs.com.au/openssh/files/support
  13
  14 OpenSSH can utilise Pluggable Authentication Modules (PAM) if your system
  15 supports it. PAM is standard on Redhat and Debian Linux and on Solaris.
  16
  17 PAM:
  18 http://www.kernel.org/pub/linux/libs/pam/
  19
  20 If you wish to build the GNOME passphrase requester, you will need the GNOME
  21 libraries and headers.
  22
  23 GNOME:
  24 http://www.gnome.org/
  25
  26 Alternatively, Jim Knoble <jmknoble@pobox.com> has written an excellent X11
  27 passphrase requester. This is maintained separately at:
  28
  29 http://www.ntrnet.net/~jmknoble/software/x11-ssh-askpass/index.html
  30
  31 The Entropy Gathering Daemon (EGD) is supported if you have a system which
  32 lacks /dev/random and don't want to use OpenSSH's internal entropy collection.
  33
  34 EGD:
  35 http://www.lothar.com/tech/crypto/
  36
  37 GNU Make:
  38 ftp://ftp.gnu.org/gnu/make/
  39
  40 OpenSSH has only been tested with GNU make. It may work with other
  41 'make' programs, but you are on your own.
  42
  43 2. Building / Installation
  44 --------------------------
  45
  46 To install OpenSSH with default options:
  47
  48 ./configure
  49 make
  50 make install
  51
  52 This will install the OpenSSH binaries in /usr/local/bin, configuration files
  53 in /usr/local/etc, the server in /usr/local/sbin, etc. To specify a different
  54 installation prefix, use the --prefix option to configure:
  55
  56 ./configure --prefix=/opt
  57 make
  58 make install
  59
  60 Will install OpenSSH in /opt/{bin,etc,lib,sbin}. You can also override
  61 specific paths, for example:
  62
  63 ./configure --prefix=/opt --sysconfdir=/etc/ssh
  64 make
  65 make install
  66
  67 This will install the binaries in /opt/{bin,lib,sbin}, but will place the
  68 configuration files in /etc/ssh.
  69
  70 If you are using PAM, you will need to manually install a PAM
  71 control file as "/etc/pam.d/sshd" (or wherever your system
  72 prefers to keep them). A generic PAM configuration is included as
  73 "contrib/sshd.pam.generic", you may need to edit it before using it on
  74 your system. If you are using a recent version of Redhat Linux, the
  75 config file in contrib/redhat/sshd.pam should be more useful.
  76 Failure to install a valid PAM file may result in an inability to
  77 use password authentication.
  78
  79 There are a few other options to the configure script:
  80
  81 --with-rsh=PATH allows you to specify the path to your rsh program.
  82 Normally ./configure will search the current $PATH for 'rsh'. You
  83 may need to specify this option if rsh is not in your path or has a
  84 different name.
  85
  86 --without-pam will disable PAM support. PAM is automatically detected
  87 and switched on if found.
  88
  89 --enable-gnome-askpass will build the GNOME passphrase dialog. You
  90 need a working installation of GNOME, including the development
  91 headers, for this to work.
  92
  93 --with-random=/some/file allows you to specify an alternate source of
  94 random numbers (the default is /dev/urandom). Unless you are absolutely
  95 sure of what you are doing, it is best to leave this alone.
  96
  97 --with-egd-pool=/some/file allows you to enable Entropy Gathering
  98 Daemon support and to specify a EGD pool socket. Use this if your
  99 Unix lacks /dev/random and you don't want to use OpenSSH's builtin
 100 entropy collection support.
 101
 102 --with-lastlog=FILE will specify the location of the lastlog file.
 103 ./configure searches a few locations for lastlog, but may not find
 104 it if lastlog is installed in a different place.
 105
 106 --without-lastlog will disable lastlog support entirely.
 107
 108 --with-kerberos4=PATH will enable Kerberos IV support. You will need
 109 to have the Kerberos libraries and header files installed for this
 110 to work. Use the optional PATH argument to specify the root of your
 111 Kerberos installation.
 112
 113 --with-afs=PATH will enable AFS support. You will need to have the
 114 Kerberos IV and the AFS libraries and header files installed for this
 115 to work.  Use the optional PATH argument to specify the root of your
 116 AFS installation. AFS requires Kerberos support to be enabled.
 117
 118 --with-skey will enable S/Key one time password support. You will need
 119 the S/Key libraries and header files installed for this to work.
 120
 121 --with-tcp-wrappers will enable TCP Wrappers (/etc/hosts.allow|deny)
 122 support. You will need libwrap.a and tcpd.h installed.
 123
 124 --with-md5-passwords will enable the use of MD5 passwords. Enable this
 125 if your operating system uses MD5 passwords without using PAM.
 126
 127 --with-utmpx enables utmpx support. utmpx support is automatic for
 128 some platforms.
 129
 130 --without-shadow disables shadow password support.
 131
 132 --with-ipaddr-display forces the use of a numeric IP address in the
 133 $DISPLAY environment variable. Some broken systems need this.
 134
 135 --with-default-path=PATH allows you to specify a default $PATH for sessions
 136 started by sshd. This replaces the standard path entirely.
 137
 138 --with-pid-dir=PATH specifies the directory in which the ssh.pid file is
 139 created.
 140
 141 --with-xauth=PATH specifies the location of the xauth binary
 142
 143 --with-ipv4-default instructs OpenSSH to use IPv4 by default for new
 144 connections. Normally OpenSSH will try attempt to lookup both IPv6 and
 145 IPv4 addresses. On Linux/glibc-2.1.2 this causes long delays in name
 146 resolution. If this option is specified, you can still attempt to
 147 connect to IPv6 addresses using the command line option '-6'.
 148
 149 --with-ssl-dir=DIR allows you to specify where your OpenSSL libraries
 150 are installed.
 151
 152 --with-4in6 Check for IPv4 in IPv6 mapped addresses and convert them to
 153 real (AF_INET) IPv4 addresses. Works around some quirks on Linux.
 154
 155 If you need to pass special options to the compiler or linker, you
 156 can specify these as environment variables before running ./configure.
 157 For example:
 158
 159 CFLAGS="-O -m486" LDFLAGS="-s" LIBS="-lrubbish" LD="/usr/foo/ld" ./configure
 160
 161 3. Configuration
 162 ----------------
 163
 164 The runtime configuration files are installed by in ${prefix}/etc or
 165 whatever you specified as your --sysconfdir (/usr/local/etc by default).
 166
 167 The default configuration should be instantly usable, though you should
 168 review it to ensure that it matches your security requirements.
 169
 170 To generate a host key, run "make host-key". Alternately you can do so
 171 manually using the following commands:
 172
 173     ssh-keygen -b 1024 -f /etc/ssh/ssh_host_key -N ""
 174     ssh-keygen -d -f /etc/ssh/ssh_host_dsa_key -N ""
 175
 176 Replacing /etc/ssh with the correct path to the configuration directory.
 177 (${prefix}/etc or whatever you specified with --sysconfdir during
 178 configuration)
 179
 180 If you have configured OpenSSH with EGD support, ensure that EGD is
 181 running and has collected some Entropy.
 182
 183 For more information on configuration, please refer to the manual pages
 184 for sshd, ssh and ssh-agent.
 185
 186 4. Problems?
 187 ------------
 188
 189 If you experience problems compiling, installing or running OpenSSH.
 190 Please refer to the "reporting bugs" section of the webpage at
 191 http://www.openssh.com/
 192