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