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
  77 There are a few other options to the configure script:
  78
  79 --with-rsh=PATH allows you to specify the path to your rsh program.
  80 Normally ./configure will search the current $PATH for 'rsh'. You
  81 may need to specify this option if rsh is not in your path or has a
  82 different name.
  83
  84 --without-pam will disable PAM support. PAM is automatically detected
  85 and switched on if found.
  86
  87 --enable-gnome-askpass will build the GNOME passphrase dialog. You
  88 need a working installation of GNOME, including the development
  89 headers, for this to work.
  90
  91 --with-random=/some/file allows you to specify an alternate source of
  92 random numbers (the default is /dev/urandom). Unless you are absolutely
  93 sure of what you are doing, it is best to leave this alone.
  94
  95 --with-egd-pool=/some/file allows you to enable Entropy Gathering
  96 Daemon support and to specify a EGD pool socket. Use this if your
  97 Unix lacks /dev/random and you don't want to use OpenSSH's builtin
  98 entropy collection support.
  99
 100 --with-lastlog=FILE will specify the location of the lastlog file.
 101 ./configure searches a few locations for lastlog, but may not find
 102 it if lastlog is installed in a different place.
 103
 104 --without-lastlog will disable lastlog support entirely.
 105
 106 --with-kerberos4=PATH will enable Kerberos IV support. You will need
 107 to have the Kerberos libraries and header files installed for this
 108 to work. Use the optional PATH argument to specify the root of your
 109 Kerberos installation.
 110
 111 --with-afs=PATH will enable AFS support. You will need to have the
 112 Kerberos IV and the AFS libraries and header files installed for this
 113 to work.  Use the optional PATH argument to specify the root of your
 114 AFS installation. AFS requires Kerberos support to be enabled.
 115
 116 --with-skey will enable S/Key one time password support. You will need
 117 the S/Key libraries and header files installed for this to work.
 118
 119 --with-tcp-wrappers will enable TCP Wrappers (/etc/hosts.allow|deny)
 120 support. You will need libwrap.a and tcpd.h installed.
 121
 122 --with-md5-passwords will enable the use of MD5 passwords. Enable this
 123 if your operating system uses MD5 passwords without using PAM.
 124
 125 --with-utmpx enables utmpx support. utmpx support is automatic for
 126 some platforms.
 127
 128 --without-shadow disables shadow password support.
 129
 130 --with-ipaddr-display forces the use of a numeric IP address in the
 131 $DISPLAY environment variable. Some broken systems need this.
 132
 133 --with-default-path=PATH allows you to specify a default $PATH for sessions
 134 started by sshd. This replaces the standard path entirely.
 135
 136 --with-pid-dir=PATH specifies the directory in which the ssh.pid file is
 137 created.
 138
 139 --with-xauth=PATH specifies the location of the xauth binary
 140
 141 --with-ipv4-default instructs OpenSSH to use IPv4 by default for new
 142 connections. Normally OpenSSH will try attempt to lookup both IPv6 and
 143 IPv4 addresses. On Linux/glibc-2.1.2 this causes long delays in name
 144 resolution. If this option is specified, you can still attempt to
 145 connect to IPv6 addresses using the command line option '-6'.
 146
 147 --with-ssl-dir=DIR allows you to specify where your OpenSSL libraries
 148 are installed.
 149
 150 --with-4in6 Check for IPv4 in IPv6 mapped addresses and convert them to
 151 real (AF_INET) IPv4 addresses. Works around some quirks on Linux.
 152
 153 If you need to pass special options to the compiler or linker, you
 154 can specify these as environment variables before running ./configure.
 155 For example:
 156
 157 CFLAGS="-O -m486" LFLAGS="-s" LIBS="-lrubbish" LD="/usr/foo/ld" ./configure
 158
 159 3. Configuration
 160 ----------------
 161
 162 The runtime configuration files are installed by in ${prefix}/etc or
 163 whatever you specified as your --sysconfdir (/usr/local/etc by default).
 164
 165 The default configuration should be instantly usable, though you should
 166 review it to ensure that it matches your security requirements.
 167
 168 To generate a host key, run "make host-key". Alternately you can do so
 169 manually using the following command:
 170
 171 /usr/bin/ssh-keygen -b 1024 -f /etc/ssh/ssh_host_key -N ''
 172
 173 Replacing /etc/ssh with the correct path to the configuration directory.
 174 (${prefix}/etc or whatever you specified with --sysconfdir during
 175 configuration)
 176
 177 If you have configured OpenSSH with EGD support, ensure that EGD is
 178 running and has collected some Entropy.
 179
 180 For more information on configuration, please refer to the manual pages
 181 for sshd, ssh and ssh-agent.
 182
 183 4. Problems?
 184 ------------
 185
 186 If you experience problems compiling, installing or running OpenSSH.
 187 Please refer to the "reporting bugs" section of the webpage at
 188 http://www.openssh.com/
 189