
=================================
Using Sshtools SSHDaemon
=================================
	
1) First unzip the distribution file into the PATH_OF_YOUR_CHOICE which we refer to as $INSTALL_DIR.

2) If you downloaded the source distribution you must first build the binaries, see the build section
   at the end of this document.

3) Before starting the SSH server you need to generate a server host key, this can be achieved by usin
   the ssh-keygen script located in the $INSTALL_DIR/bin directory. Use the following command
   to generate a key, pressing return when prompted for a passphrase (the server host key must have
   and empty passphrase)

   ssh-keygen -b 1024 -t dsa dsa_host_key

4) Open the $INSTALL_DIR/server.xml configuration file and enter the generated key as a 
   server host key, the elements should be as follows, replacing the filenames with your
   chosen filename.

  <ServerHostKey AlgorithmName="ssh-dss" PrivateKeyFile="server_host_key"/>


5) The start the server execute the sshd-start script located in the $INSTALL_DIR/bin directory.

6) Stop the server by executing the sshd-stop script

7) The distribution file also contains the following dependencies in the
   directory $INSTALL_DIR/lib:


   log4j-1.2.6.jar
   sshtools-j2ssh-VERSION.jar

=========
JAR files
=========

The Sshtools distribution comes with one jar file: sshtools-1.0-alpha1.jar
under the $INSTALL_DIR/dist/lib/ directory.

This jar file contains all the class files of the Sshtools project.


=====================
Sshtools dependencies
=====================
   
Sshtools is based on JDK 1.4.0 with the following additional requirements:

    ----------------------------
    SSHTOOLS - J2SSH
    ----------------------------
    
    The Sshtools-apps project is based upon the latest alpha release of J2SSH. Source code
    for the J2SSH library can be downloaded from http://www.sshtools.com

    ----------------------------
    LOG4J Version 1.2.6 
    ----------------------------

    Logging has been implemented with the jakarta's Log4J.

    Log4J is distributed under The Apache Software License, Version 1.1, a copy
    of which can be found in the $INSTALL_DIR/lib directory in the file log4j-license.txt


=================
Building Sshtools
=================
    
If you downloaded the source distribution you need to build the binaries before
using sshtools. Like most java appilications today, Sshtools relies on ANT as 
its buildtool. ANT is availale from "http://jakarta.apache.org/ant/".  Please examine the
file build.txt from the source distribution for instructions on how to build from source.

The current ant build script DOES NOT build the required Win32 DLL for which the 
source is provided in the $INSTALL_DIR/jni/daemon/win32 directory. Both the source and binary
distributions provide a prebuild library, however if you want to build your own
you can do using the source and MSVC++ 6. Other compilers are currently not supported
but we would welcome any contributions from users that can either integrate the 
DLL building into ANT or provide makefiles for different C++ development environments.

In case of problems send an e-mail lee@sshtools.com. 
