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 requester, you will need the GNOME
  19 libraries and headers.
  20
  21 GNOME:
  22 http://www.gnome.org/
  23
  24 Alternatively, Jim Knoble <jmknoble@pobox.com> has written an excellent X11
  25 passphrase requester. This is maintained separately at:
  26
  27 http://www.ntrnet.net/~jmknoble/software/x11-ssh-askpass/index.html
  28
  29 If you are planning to use OpenSSH on a Unix which lacks a Kernel random
  30 number generator (/dev/urandom), you will need to install the Entropy
  31 Gathering Daemon (or similar). You will also need to specify the
  32 --with-egd-pool option to ./configure.
  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 control
  71 file as "/etc/pam.d/sshd" (or wherever your system prefers to keep
  72 them). A generic PAM configuration is included as "sshd.pam.generic",
  73 you may need to edit it before using it on your system. If you are
  74 using a recent version of Redhat Linux, the config file in
  75 packages/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 absolutly
  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. You will need to
  97 use this if your Unix does not support the /dev/urandom device (or
  98 similar). The file argument refers to the EGD pool file, not the
  99 EGD program itself. Please refer to the EGD documentation.
 100
 101 --with-lastlog=FILE will specify the location of the lastlog file.
 102 ./configure searches a few locations for lastlog, but may not find
 103 it if lastlog is installed in a different place.
 104
 105 --without-lastlog will disable lastlog support entirely.
 106
 107 --with-kerberos4=PATH will enable Kerberos IV support. You will need
 108 to have the Kerberos libraries and header files installed for this
 109 to work. Use the optional PATH argument to specify the root of your
 110 Kerberos installation.
 111
 112 --with-afs=PATH will enable AFS support. You will need to have the
 113 Kerberos IV and the AFS libraries and header files installed for this
 114 to work.  Use the optional PATH argument to specify the root of your
 115 AFS installation. AFS requires Kerberos support to be enabled.
 116
 117 --with-skey will enable S/Key one time password support. You will need
 118 the S/Key libraries and header files installed for this to work.
 119
 120 --with-tcp-wrappers will enable TCP Wrappers (/etc/hosts.allow|deny)
 121 support. You will need libwrap.a and tcpd.h installed.
 122
 123 --with-md5-passwords will enable the use of MD5 passwords. Enable this
 124 if your operating system uses MD5 passwords without using PAM.
 125
 126 --with-utmpx enables utmpx support. utmpx support is automatic for
 127 some platforms.
 128
 129 --without-shadow disables shadow password support.
 130
 131 --with-ipaddr-display forces the use of a numeric IP address in the
 132 $DISPLAY environment variable. Some broken systems need this.
 133
 134 --with-default-path=PATH allows you to specify a default $PATH for sessions
 135 started by sshd.
 136
 137 --with-pid-dir=PATH specifies the directory in which the ssh.pid file is
 138 created.
 139
 140 --with-xauth=PATH specifies the location of the xauth binary
 141
 142 --with-ipv4-default instructs OpenSSH to use IPv4 by default for new
 143 connections. Normally OpenSSH will try attempt to lookup both IPv6 and
 144 IPv4 addresses. On Linux/glibc-2.1.2 this causes long delays in name
 145 resolution. If this option is specified, you can still attempt to
 146 connect to IPv6 addresses using the command line option '-6'.
 147
 148 --with-ssl-dir=DIR allows you to specify where your OpenSSL libraries
 149 are installed.
 150
 151 If you need to pass special options to the compiler or linker, you
 152 can specify these as enviornment variables before running ./configure.
 153 For example:
 154
 155 CFLAGS="-O -m486" LFLAGS="-s" ./configure
 156
 157 3. Configuration
 158 ----------------
 159
 160 The runtime configuration files are installed by in ${prefix}/etc or
 161 whatever you specified as your --sysconfdir (/usr/local/etc by default).
 162
 163 The default configuration should be instantly usable, though you should
 164 review it to ensure that it matches your security requirements.
 165
 166 To generate a host key, run "make host-key". Alternately you can do so
 167 manually using the following command:
 168
 169 /usr/bin/ssh-keygen -b 1024 -f /etc/ssh/ssh_host_key -N ''
 170
 171 Replacing /etc/ssh with the correct path to the configuration directory.
 172 (${prefix}/etc or whatever you specified with --sysconfdir during
 173 configuration)
 174
 175 If you have configured OpenSSH with EGD support, ensure that EGD is
 176 running and has collected some Entropy.
 177
 178 For more information on configuration, please refer to the manual pages
 179 for sshd, ssh and ssh-agent.
 180
 181 4. Problems?
 182 ------------
 183
 184 If you experience problems compiling, installing or running OpenSSH.
 185 Please refer to the "reporting bugs" section of the webpage at
 186 http://violet.ibs.com.au/openssh/
 187