blob: de92edc42801f354a993df27e4b37e84fbdc7c58 [file] [log] [blame]
Damien Millerb5f89271999-11-12 14:35:58 +110011. Prerequisites
2----------------
3
4You will need working installations of Zlib and OpenSSL.
5
6Zlib:
7http://www.cdrom.com/pub/infozip/zlib/
8
9OpenSSL:
10http://www.openssl.org/
11
12OpenSSH can utilise Pluggable Authentication Modules (PAM) if your system
13supports it. PAM is standard on Redhat and Debian Linux and on Solaris.
14
15PAM:
16http://www.kernel.org/pub/linux/libs/pam/
17
18If you wish to build the GNOME passphrase requestor, you will need the GNOME
19libraries and headers.
20
21GNOME:
22http://www.gnome.org/
23
24If you are planning to use OpenSSH on a Unix which lacks a Kernel random
25number generator (/dev/urandom), you will need to install the Entropy
26Gathering Daemon (or similar). You will also need to specify the
27--with-egd-pool option to ./configure.
28
29EGD:
30http://www.lothar.com/tech/crypto/
31
Damien Miller4d2f15f1999-11-23 12:36:29 +110032GNU Make:
33ftp://ftp.gnu.org/gnu/make/
34
35OpenSSH has only been tested with GNU make. It may work with other
36'make' programs, but you are on your own.
Damien Millerb5f89271999-11-12 14:35:58 +110037
382. Building / Installation
39--------------------------
40
41To install OpenSSH with default options:
42
43./configure
44make
45make install
46
47This will install the OpenSSH binaries in /usr/local/bin, configuration files
48in /usr/local/etc, the server in /usr/local/sbin, etc. To specify a different
49installation prefix, use the --prefix option to configure:
50
51./configure --prefix=/opt
52make
53make install
54
55Will install OpenSSH in /opt/{bin,etc,lib,sbin}. You can also override
56specific paths, for example:
57
58./configure --prefix=/opt --sysconfdir=/etc/ssh
59make
60make install
61
62This will install the binaries in /opt/{bin,lib,sbin}, but will place the
63configuration files in /etc/ssh.
64
Damien Miller294df781999-11-23 10:11:29 +110065If you are using PAM, you will need to manually install a PAM control
66file as "/etc/pam.d/sshd" (or wherever your system prefers to keep
67them). A generic PAM configuration is included as "sshd.pam.generic",
68you may need to edit it before using it on your system.
Damien Miller755c90c1999-11-22 16:12:31 +110069
Damien Millerb5f89271999-11-12 14:35:58 +110070There are a few other options to the configure script:
71
Damien Millerc0967271999-11-19 15:53:50 +110072--enable-gnome-askpass will build the GNOME passphrase dialog. You
73need a working installation of GNOME, including the development
74headers, for this to work.
Damien Millerb5f89271999-11-12 14:35:58 +110075
Damien Millerc0967271999-11-19 15:53:50 +110076--with-random=/some/file allows you to specify an alternate source of
77random numbers (the default is /dev/urandom). Unless you are absolutly
Damien Millerb5f89271999-11-12 14:35:58 +110078sure of what you are doing, it is best to leave this alone.
79
Damien Millerc0967271999-11-19 15:53:50 +110080--with-egd-pool=/some/file allows you to enable Entropy Gathering
81Daemon support and to specify a EGD pool socket. You will need to
82use this if your Unix does not support the /dev/urandom device (or
83similar).
Damien Millerb5f89271999-11-12 14:35:58 +110084
Damien Millerc0967271999-11-19 15:53:50 +110085--with-kerberos4 will enable Kerberos IV support. You will need to
86have the Kerberos libraries and header files installed for this to
87work.
88
89--with-afs will enable AFS support. You will need to have the Kerberos
90IV and the AFS libraries and header files installed for this to work.
91
92--with-skey will enable S/Key one time password support. You will need
93the S/Key libraries and header files installed for this to work.
94
95--with-tcp-wrappers will enable TCP Wrappers (/etc/hosts.allow|deny)
96support. You will need libwrap.a and tcpd.h installed.
97
98--with-md5-passwords will enable the use of MD5 passwords. Enable this
99if your operating system uses MD5 passwords without using PAM.
Damien Miller3d1b22c1999-11-12 15:46:08 +1100100
Damien Millerb5f89271999-11-12 14:35:58 +1100101
1023. Configuration
103----------------
104
105The runtime configuration files are installed by in ${prefix}/etc or
106whatever you specified as your --sysconfdir (/usr/local/etc by default).
107
108The default configuration should be instantly usable, though you should
109review it to ensure that it matches your security requirements.
110
Damien Miller2a9d9f61999-11-15 23:34:11 +1100111To generate a host key, issue the following command: (replacing
112/etc/ssh/ssh_host_key with an appropriate path)
113
114/usr/bin/ssh-keygen -b 1024 -f /etc/ssh/ssh_host_key -N ''
115
Damien Miller6ae00d61999-12-14 15:43:03 +1100116Replacing /etc/ssh with the correct path to the configuration directory.
117(${prefix}/etc or whatever you specified with --sysconfdir during
118configuration)
119
Damien Millerb5f89271999-11-12 14:35:58 +1100120For more information on configuration, please refer to the manual pages
121for sshd, ssh and ssh-agent.
122
Damien Miller6ae00d61999-12-14 15:43:03 +11001234. Problems?
124------------
125
126If you experience problems compiling, installing or running OpenSSH.
127Please refer to the "reporting bugs" section of the webpage at
128http://violet.ibs.com.au/openssh/
129