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 Alternatly Jim Knoble <jmknoble@pobox.com> has written an excellent X11
  31 passphrase requester. This is maintained seperatly at:
  32
  33 http://www.pobox.com/~jmknoble/jmk/
  34
  35
  36 If you are planning to use OpenSSH on a Unix which lacks a Kernel random
  37 number generator (/dev/urandom), you will need to install the Entropy
  38 Gathering Daemon (or similar). You will also need to specify the
  39 --with-egd-pool option to ./configure.
  40
  41 EGD:
  42 http://www.lothar.com/tech/crypto/
  43
  44 GNU Make:
  45 ftp://ftp.gnu.org/gnu/make/
  46
  47 OpenSSH has only been tested with GNU make. It may work with other
  48 'make' programs, but you are on your own.
  49
  50 2. Building / Installation
  51 --------------------------
  52
  53 To install OpenSSH with default options:
  54
  55 ./configure
  56 make
  57 make install
  58
  59 This will install the OpenSSH binaries in /usr/local/bin, configuration files
  60 in /usr/local/etc, the server in /usr/local/sbin, etc. To specify a different
  61 installation prefix, use the --prefix option to configure:
  62
  63 ./configure --prefix=/opt
  64 make
  65 make install
  66
  67 Will install OpenSSH in /opt/{bin,etc,lib,sbin}. You can also override
  68 specific paths, for example:
  69
  70 ./configure --prefix=/opt --sysconfdir=/etc/ssh
  71 make
  72 make install
  73
  74 This will install the binaries in /opt/{bin,lib,sbin}, but will place the
  75 configuration files in /etc/ssh.
  76
  77 If you are using PAM, you will need to manually install a PAM control
  78 file as "/etc/pam.d/sshd" (or wherever your system prefers to keep
  79 them). A generic PAM configuration is included as "sshd.pam.generic",
  80 you may need to edit it before using it on your system. If you are
  81 using a recent version of Redhat Linux, the config file in
  82 packages/redhat/sshd.pam should be more useful.
  83
  84 There are a few other options to the configure script:
  85
  86 --with-rsh=PATH allows you to specify the path to your rsh program.
  87 Normally ./configure will search the current $PATH for 'rsh'. You
  88 may need to specify this option if rsh is not in your path or has a
  89 different name.
  90
  91 --without-pam will disable PAM support. PAM is automatically detected
  92 and switched on if found.
  93
  94 --enable-gnome-askpass will build the GNOME passphrase dialog. You
  95 need a working installation of GNOME, including the development
  96 headers, for this to work.
  97
  98 --with-random=/some/file allows you to specify an alternate source of
  99 random numbers (the default is /dev/urandom). Unless you are absolutly
 100 sure of what you are doing, it is best to leave this alone.
 101
 102 --with-egd-pool=/some/file allows you to enable Entropy Gathering
 103 Daemon support and to specify a EGD pool socket. You will need to
 104 use this if your Unix does not support the /dev/urandom device (or
 105 similar). The file argument refers to the EGD pool file, not the
 106 EGD program itself. Please refer to the EGD documentation.
 107
 108 --with-lastlog=FILE will specify the location of the lastlog file.
 109 ./configure searches a few locations for lastlog, but may not find
 110 it if lastlog is installed in a different place.
 111
 112 --without-lastlog will disable lastlog support entirely.
 113
 114 --with-kerberos4=PATH will enable Kerberos IV support. You will need
 115 to have the Kerberos libraries and header files installed for this
 116 to work. Use the optional PATH argument to specify the root of your
 117 Kerberos installation.
 118
 119 --with-afs=PATH will enable AFS support. You will need to have the
 120 Kerberos IV and the AFS libraries and header files installed for this
 121 to work.  Use the optional PATH argument to specify the root of your
 122 AFS installation. AFS requires Kerberos support to be enabled.
 123
 124 --with-skey will enable S/Key one time password support. You will need
 125 the S/Key libraries and header files installed for this to work.
 126
 127 --with-tcp-wrappers will enable TCP Wrappers (/etc/hosts.allow|deny)
 128 support. You will need libwrap.a and tcpd.h installed.
 129
 130 --with-md5-passwords will enable the use of MD5 passwords. Enable this
 131 if your operating system uses MD5 passwords without using PAM.
 132
 133 --with-utmpx enables utmpx support. utmpx support is automatic for
 134 some platforms.
 135
 136 --without-shadow disables shadow password support.
 137
 138 --with-ipaddr-display forces the use of a numeric IP address in the
 139 $DISPLAY environment variable. Some broken systems need this.
 140
 141 --with-default-path=PATH allows you to specify a default $PATH for sessions
 142 started by sshd.
 143
 144 --with-pid-dir=PATH specifies the directory in which the ssh.pid file is
 145 created.
 146
 147 --with-xauth=PATH specifies the location of the xauth binary
 148
 149 --with-dante[=DIR] will enable Dante SOCKS library support. If the Dante
 150 libsocks library isn't installed in a library searched by the compiler,
 151 add the directory name as the option.
 152
 153 If you need to pass special options to the compiler or linker, you
 154 can specify these as enviornment variables before running ./configure.
 155 For example:
 156
 157 CFLAGS="-O -m486" LFLAGS="-s" ./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, issue the following command: (replacing
 169 /etc/ssh/ssh_host_key with an appropriate path)
 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://violet.ibs.com.au/openssh/
 189