$Id: INSTALL,v 1.1 1999/02/22 02:40:46 mahara Exp $
                     compile and install
-----------------------------------------------------------------
Table of contents
-----------------
* To necessary to compile
* Compile and install
* The first installation
* About setup file bjorb.conf
* Supplementation information on each OS

To necessary to compile
=======================

Install the following tools beforehand.

* SSLeay
    I confirmed the works of bjorb with SSLeay 0.8.0, 0.8.1b, 0.9.0b.
    You can get SSLeay at:
        ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL/

* C++ compiler (gcc-2.7.2.1)
    You can get gcc at:
        ftp://ftp.iij.ad.jp/pub/GNU/

* perl (perl 4.0 or later)
    You can get perl at:
        ftp://ftp.iij.ad.jp/pub/GNU/

Compile and install
===================

% ./configure
% make
% su
# make install

When the installation is done,  /usr/local/sbin/bjorb is made.

The first installation
======================

Execute following command when you install bjorb for the first time.

   (Example for FreeBSD)
   # make certificate
   # make install-freebsd
   # cp /usr/local/etc/bjorb.conf.sample /usr/local/etc/bjorb.conf
   # vi /usr/local/etc/bjorb.conf

1. When bjorb is operated as a server,  you need to make the SSL
   certificate.
   Execute follwing command:

   # make certificate

   Then /usr/local/etc/bjorb.pem is made.


2. Install the start script.
   Execute following command:

   For BSD/OS:     make install-bsd
   For FreeBSD:    make install-freebsd
   For Linux:      make install-linux
   For Solaris:    make install-solaris
   For SunOS4.1.*: make install-sunos


3. Make /usr/local/etc/bjorb.conf.
   If you don't make this file, bjorb doesn't start when OS is stated
   even if the startup script is  installed.

   You can copy and modify the sample setup file
   /usr/local/etc/bjorb.conf.sample. Or you can make one interactively
   by executing following command:

   # /usr/local/etc/rc.d/bjorb.sh setup

   Note that the name of the startup script is differ by OS.
         BSD/OS : /etc/rc.bjorb
         FreeBSD: /usr/local/etc/rc.d/bjorb.sh
         Solaris: /etc/rc2.d/S99bjorb
         SunOS  : /etc/rc.bjorb

   In default, this file interactively made relays a lot of
   communications: SSL telnet, SMTP, POP3, IMAP4, NNTP and LDAP.
   You should modify /usr/local/etc/bjorb.conf to relay
   only the communication you need to.

About setup file bjorb.conf
===========================

See doc/bjorb.conf.5.txt.

Supplementation information on each OS
======================================


* BSD/OS 3.0
    You can use gcc and perl command installed by default.
    You need to install SSleay.

    # make install-bsd
    
    is executed, startup script is installed by the name of
    /etc/rc.bjorb, and /etc/rc.local is configured to call this script.

    Add following entry if you want to relay LDAP.

    ldap            389/tcp    #Lightweight Directory Access Protocol
    
* FreeBSD
    You can use cc and perl comand installed by default.
    You need to install SSleay.

    # make install-freebsd

    is executed, startup script is installed by the name of
    /etc/local/etc/rc.d/bjorb.sh.

* HP-UX
    you CAN'T use cc command installed by default. 
    You need to install SSleay and gcc and perl.
    
* Solaris
* SunOS-4.1.*
    you CAN'T use cc command installed by default. 
    You need to install SSleay and gcc and perl.

    # make install-solaris

    is executed, startup script is installed by the name of
    /etc/rc2.d/S99bjorb.

    # make install-sunos

    is executed, startup script is installed by the named of
    /etc/rc.bjorb.

    Add following entries if you want to reply LDAP and IMAP4:

    ldap            389/tcp    #Lightweight Directory Access Protocol
    imap            143/tcp    imap2 imap4 #Interim Mail Access Protocol

* Turbo Linux

    You can use cc and perl comand installed by default.
    You need to install SSleay.

    # make install-sunos

    is executed, startup script is installed by the named of
    /etc/rc.d/rc2.d/S99bjorb.

    'pop3' is used in /usr/local/etc/bjorb.conf.sample though
    'pop-3' is defined in /etc/services.
    Change 'pop3' to 'pop-3' in bjorb.conf when you create bjorb.conf.
