
 Installing Osiris
 =================

  This document does not include an overview of Osiris components.  See the 
  README file included with this package, or see http://osiris.shmoo.com/docs 
  for detailed information about usage or background.

  All osiris applications require a version of OpenSSL 0.9.6j or newer.  Use
  the --with-ssl-dir configure option to specify a specific directory to use
  for OpenSSL headers and libraries; otherwise, the configure script will try
  to find one on the system.  For Windows, OpenSSL should be installed in the
  %System Root%\openssl directory and built as static libraries. 

  Binary versions and a graphical installer is available for Windows
  NT/2k/XP if installing from source seems too bothersome for you.


 Installing the Scanning Daemon and CLI management app.
 ===========================================================

    For UNIX systems:

    1. build the scanning daemon (osirisd) and the installer
       package for the desired platform(s).

	$ ./configure
	$ make osirisd
    $ make package

    2. Distribute and install the package.  The package is a tar.gz file
       located in: src/install/, something like: osiris-2.0.0a-Darwin.tar.gz

    3. unzip and run the installer script.

        $ tar xfz osiris-2.0.0a-Darwin.tar.gz
        $ cd osiris-2.0.0a
        $ sudo ./install.sh
	
    For Windows systems:

    1. Use the supplied graphical installer to do all of the following, or
       to build and install from source:

	c:\> ./makewin32.bat osirisd

    2. Next, create a root directory so that the scanning daemon can store
       any root certificates.  For example:

	c:\> md c:\WINNT\osiris

    3. Next, copy osirisd.exe to your system root, usually c:\WINNT\System32\

    4. Finally, install the daemon as a service, for example:

	c:\> \WINNT\System32\osirisd -i

        ** use the "-u" option to uninstall this service **


 Installing the Management daemon
 =============================================

    For UNIX systems:

    1. Build the deamon (osirismd).

	$ ./configure --prefix=PREFIX
	$ make
    $ sudo make install

    2. start the daemon or reboot the system.  Starting the daemon will vary
       depending upon the OS.  For example, Mac OS X installs a startup item
       that can be controlled as follows:
   
    $ sudo /System/Library/StartupItems/Osiris/Osiris start

    For Windows systems:

    1. Use the supplied graphical installer to do all of the following, or
       to build and install from source:

	c:\> ./makewin32.bat osirismd

    2. Next, create a root directory (if not already) so that the daemon can 
       store all hosts,configs,databases,logs,etc.  This should be in your
       windows root directory, either \windows or \winnt, for example:

	c:\> md c:\WINNT\osiris

    3. Next, copy osirismd.exe to your system root, usually c:\WINNT\System32\
       or c:\Windows\System32\

    4. Finally, install the daemon as a service, for example:

	c:\> \WINNT\System32\osirismd -i
 
        ** use the "-u" option to uninstall this service **


 Building from source on Windows 
 ===========================================

  To build Osiris from source on Windows NT/2K/XP, you will need: 

   1. Visual Studio 6.0 with SP5, at least.
   2. OpenSSL built (static libs)
   3. Active Perl (to build OpenSSL)
   4. NSIS installer

   Download and compile OpenSSL.  After building, move the OpenSSL source
   directory into the root drive, and name the folder "openssl".

   Download and install the NSIS installer from:
         http://www.nullsoft.com/free/nsis/

   After building osiris, to build the Osiris self extracting installer file,
   inside the osiris source tree, right click on the file:
      /src/install/windows/osiris_install.nsi and choose the "Compile NSI"
   option.  This will leave an .exe file in the same directory.

   It is recomended that you use this installer rather than performing the
   manual install steps specified below. 


 Requirements
 =================

     The following requirements exist for building Osiris:

     o  ANSI-C Compiler: 

        Make sure you have an ANSI-C compiler installed. The GNU C compiler
        (GCC) from the Free Software Foundation (FSF) is recommended ( version
        2.95 is fine ). If you don't have GCC then at least make sure your
        vendors compiler is ANSI compliant. You can find the homepage of GNU
        at http://www.gnu.org/ and the GCC distribution under
        http://www.gnu.org/order/ftp.html .

     o  OpenSSL:

        Osiris requires either an installed or system OpenSSL in order to
	    compile any of the applications.

     o  System compatibility:

        Osiris should compile and run on most major unix and Windows systems.
	The following is a list of platforms that this alpha version of Osiris
	has been tested on.
        
           - Darwin / Mac OS X
           - Linux
           - FreeBSD
           - OpenBSD
           - BSD/OS
	       - Windows 2000
           - Windows XP
           - Windows NT 4.0

 Support
 =================

     o If you want to be informed about new code releases, bug fixes, 
       security fixes, general news and information about osiris and scale
       subscribe to the osiris-dev mailing list as described under:
       
       http://osiris.shmoo.com/support

     o If you have a concrete bug report for osiris please submit
       a detailed message to: brian@shmoo.com

     Thanks for using Osiris.
                                          The Shmoo Group
                                          http://www.shmoo.com

