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.
  81
  82 There are a few other options to the configure script:
  83
  84 --with-rsh=PATH allows you to specify the path to your rsh program.
  85 Normally ./configure will search the current $PATH for 'rsh'. You
  86 may need to specify this option if rsh is not in your path or has a
  87 different name.
  88
  89 --without-pam will disable PAM support. PAM is automatically detected
  90 and switched on if found.
  91
  92 --enable-gnome-askpass will build the GNOME passphrase dialog. You
  93 need a working installation of GNOME, including the development
  94 headers, for this to work.
  95
  96 --with-random=/some/file allows you to specify an alternate source of
  97 random numbers (the default is /dev/urandom). Unless you are absolutly
  98 sure of what you are doing, it is best to leave this alone.
  99
 100 --with-egd-pool=/some/file allows you to enable Entropy Gathering
 101 Daemon support and to specify a EGD pool socket. You will need to
 102 use this if your Unix does not support the /dev/urandom device (or
 103 similar). The file argument refers to the EGD pool file, not the
 104 EGD program itself. Please refer to the EGD documentation.
 105
 106 --with-lastlog=FILE will specify the location of the lastlog file.
 107 ./configure searches a few locations for lastlog, but may not find
 108 it if lastlog is installed in a different place.
 109
 110 --without-lastlog will disable lastlog support entirely.
 111
 112 --with-kerberos4=PATH will enable Kerberos IV support. You will need
 113 to have the Kerberos libraries and header files installed for this
 114 to work. Use the optional PATH argument to specify the root of your
 115 Kerberos installation.
 116
 117 --with-afs=PATH will enable AFS support. You will need to have the
 118 Kerberos IV and the AFS libraries and header files installed for this
 119 to work.  Use the optional PATH argument to specify the root of your
 120 AFS installation. AFS requires Kerberos support to be enabled.
 121
 122 --with-skey will enable S/Key one time password support. You will need
 123 the S/Key libraries and header files installed for this to work.
 124
 125 --with-tcp-wrappers will enable TCP Wrappers (/etc/hosts.allow|deny)
 126 support. You will need libwrap.a and tcpd.h installed.
 127
 128 --with-md5-passwords will enable the use of MD5 passwords. Enable this
 129 if your operating system uses MD5 passwords without using PAM.
 130
 131 --with-utmpx enables utmpx support. utmpx support is automatic for
 132 some platforms.
 133
 134 --without-shadow disables shadow password support.
 135
 136 --with-ipaddr-display forces the use of a numeric IP address in the
 137 $DISPLAY environment variable. Some broken systems need this.
 138
 139 --with-default-path=PATH allows you to specify a default $PATH for sessions
 140 started by sshd.
 141
 142 --with-dante[=DIR] will enable Dante SOCKS library support. If the Dante
 143 libsocks library isn't installed in a library searched by the compiler,
 144 add the directory name as the option.
 145
 146 If you need to pass special options to the compiler or linker, you
 147 can specify these as enviornment variables before running ./configure.
 148 For example:
 149
 150 CFLAGS="-O -m486" LFLAGS="-s" ./configure
 151
 152 3. Configuration
 153 ----------------
 154
 155 The runtime configuration files are installed by in ${prefix}/etc or
 156 whatever you specified as your --sysconfdir (/usr/local/etc by default).
 157
 158 The default configuration should be instantly usable, though you should
 159 review it to ensure that it matches your security requirements.
 160
 161 To generate a host key, issue the following command: (replacing
 162 /etc/ssh/ssh_host_key with an appropriate path)
 163
 164 /usr/bin/ssh-keygen -b 1024 -f /etc/ssh/ssh_host_key -N ''
 165
 166 Replacing /etc/ssh with the correct path to the configuration directory.
 167 (${prefix}/etc or whatever you specified with --sysconfdir during
 168 configuration)
 169
 170 If you have configured OpenSSH with EGD support, ensure that EGD is
 171 running and has collected some Entropy.
 172
 173 For more information on configuration, please refer to the manual pages
 174 for sshd, ssh and ssh-agent.
 175
 176 4. Problems?
 177 ------------
 178
 179 If you experience problems compiling, installing or running OpenSSH.
 180 Please refer to the "reporting bugs" section of the webpage at
 181 http://violet.ibs.com.au/openssh/
 182