Added INSTALL documentation

Minor other doc updates

diff --git a/ChangeLog b/ChangeLog
index 52c5950c1eb673905e1f0b278370456b1cbbe4ab..c610abc913849510e9b9b333ce4cc71798fb09f4 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -8,6 +8,8 @@
  - Grab server in gnome-ssh-askpass (Debian bug #49872)
  - Released 1.2pre10
 
+ - Added INSTALL documentation
+
 19991111
  - Added (untested) Entropy Gathering Daemon (EGD) support
  - Fixed /dev/urandom fd leak (Debian bug #49722)

diff --git a/INSTALL b/INSTALL
new file mode 100644 (file)
index 0000000..54d48e2
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,86 @@
+1. Prerequisites
+----------------
+
+You will need working installations of Zlib and OpenSSL.
+
+Zlib:
+http://www.cdrom.com/pub/infozip/zlib/
+
+OpenSSL:
+http://www.openssl.org/
+
+OpenSSH can utilise Pluggable Authentication Modules (PAM) if your system
+supports it. PAM is standard on Redhat and Debian Linux and on Solaris.
+
+PAM:
+http://www.kernel.org/pub/linux/libs/pam/
+
+If you wish to build the GNOME passphrase requestor, you will need the GNOME
+libraries and headers.
+
+GNOME:
+http://www.gnome.org/
+
+If you are planning to use OpenSSH on a Unix which lacks a Kernel random
+number generator (/dev/urandom), you will need to install the Entropy
+Gathering Daemon (or similar). You will also need to specify the 
+--with-egd-pool option to ./configure.
+
+EGD:
+http://www.lothar.com/tech/crypto/
+
+
+2. Building / Installation
+--------------------------
+
+To install OpenSSH with default options:
+
+./configure
+make
+make install
+
+This will install the OpenSSH binaries in /usr/local/bin, configuration files
+in /usr/local/etc, the server in /usr/local/sbin, etc. To specify a different
+installation prefix, use the --prefix option to configure:
+
+./configure --prefix=/opt
+make
+make install
+
+Will install OpenSSH in /opt/{bin,etc,lib,sbin}. You can also override 
+specific paths, for example:
+
+./configure --prefix=/opt --sysconfdir=/etc/ssh
+make
+make install
+
+This will install the binaries in /opt/{bin,lib,sbin}, but will place the
+configuration files in /etc/ssh.
+
+There are a few other options to the configure script:
+
+--enable-gnome-askpass will build the GNOME passphrase dialog. You need a 
+working installation of GNOME, including the development headers, for this
+to work.
+
+--with-random=/some/file allows you to specify an alternate source of 
+random numbers (the default is /dev/urandom). Unless you are absolutly 
+sure of what you are doing, it is best to leave this alone.
+
+--with-egd-pool=/some/file allows you to enable Entropy Gathering Daemon 
+support and to specify a EGD pool socket. You will need to use this if your
+Unix does not support the /dev/urandom device (or similar).
+
+
+3. Configuration
+----------------
+
+The runtime configuration files are installed by in ${prefix}/etc or 
+whatever you specified as your --sysconfdir (/usr/local/etc by default).
+
+The default configuration should be instantly usable, though you should 
+review it to ensure that it matches your security requirements.
+
+For more information on configuration, please refer to the manual pages 
+for sshd, ssh and ssh-agent.
+

diff --git a/README b/README
index 18d9e864c0440da42071a0c512bbe0abc7739018..4acfe7578e725bbf01c2061091f3c36a8f1f9158 100644 (file)
--- a/README
+++ b/README
@@ -32,14 +32,8 @@ send a message conststing of the word 'SUBSCRIBE' to
 openssh-unix-dev-request@mindrot.org. This mailing list is intended for
 developers.
 
-To build OpenSSH, use the configure script provided. For example:
-
-./configure --prefix=/opt/openssh
-make
-make install
-
-Will install the OpenSSH binaries in /opt/openssh/bin, the 
-configuration files in /opt/openssh/etc, and so forth.
+Please refer to the INSTALL document for information on how to install
+OpenSSH on your system.
 
 Damien Miller <djm@ibs.com.au>
 Internet Business Solutions

diff --git a/TODO b/TODO
index 118ef2d04002e969bcc5315d3fe7097721327361..e6a89d3a4aec4a63d8babf51e1a288d70f7e1354 100644 (file)
--- a/TODO
+++ b/TODO
@@ -4,8 +4,10 @@
 
 - Better documentation
 
-- Port to other platforms
+- Port to other platforms (Finish Solaris support)
 
 - Fix paths in manpages using autoconf
 
 - Enable libwrap support using autoconf switch
+
+- Better testing on non-PAM systems