Evergreen virtual image README
==============================
This virtual image was built on OpenSRF 2.0.0-RC2 and Evergreen 2.0.3 on
2011-03-11. It was built using VirtualBox OSE 4.0.4 and exported into the Open
Virtualization Format (OVF). Use in VMWare products will require the VMWare OVF
Tool: see http://www.vmware.com/appliances/getting-started/learn/ovf.html

The underlying operating system is Debian Squeeze (6.0).

Accounts
--------

All accounts are expressed as `user name` / `password`.

  * UNIX accounts
    * root / evergreen
    * evergreen / evergreen
    * opensrf / evergreen
  * Database account
    * evergreen / evergreen
  * Evergreen account
    * admin / open-ils

Starting Evergreen
------------------

When the virtual image boots up, it does not automatically start Evergreen.
Start it as follows, starting as the root user:

---------------------------------------------------------------------------
su -                        # become the root user (password: "evergreen")
su - opensrf                # become the opensrf user
osrf_ctl.sh -l -a start_all # starts all Evergreen services
exit                        # become the root user
/etc/init.d/apache2 restart # restart the Apache server
---------------------------------------------------------------------------

Desktop environment
-------------------

This machine has been configured to run with a graphical desktop.  If you give
the virtual machine 1.5 GB of RAM, you should be able to run the desktop at the
same time as Evergreen.

The desktop includes a web browser (IceWeasel, the Debian version of Firefox)
and XULRunner 1.9. Once you start the desktop and Evergreen, you can connect
to Evergreen using the built-in staff client with the following commands:

---------------------------------------------------------------------------
cd /home/evergreen/Evergreen-ILS-2.0.3/Open-ILS
xulrunner-1.9 xul/staff_client/build/application.ini
---------------------------------------------------------------------------

Connect to host name `localhost` using the `admin` / `open-ils` account and
begin populating the data in your image.

Network connections
-------------------

This machine was configured with a NAT connection on the first Ethernet
adapter (`eth0`) and a host-only connection on the second Ethernet adapter
(`eth1`).

As the virtual machines tend to map virtual devices to real MAC addresses
on their host, you might need to clear that mapping before making a connection.
As root, run:

---------------------------------------------------------------------------
rm /etc/udev/rules.d/70-persistent-net.rules
reboot
---------------------------------------------------------------------------

The machine will normally connect to your network via DHCP, but you can try to
manually create a network connection by running the following command as
`root`:

---------------------------------------------------------------------------
dhclient eth0 # for a NAT connection
---------------------------------------------------------------------------

Host connections
----------------

The default configuration includes a host-only connection on the second
Ethernet adapter (`eth1`).

To create the host network connection, run the following command as `root`:

---------------------------------------------------------------------------
dhclient eth1 # for a host connection
---------------------------------------------------------------------------

To connect to your virtual machine from your host machine, create the host
connection and check the IP address of `eth1` using the `ifconfig` command:

---------------------------------------------------------------------------
/sbin/ifconfig eth1
---------------------------------------------------------------------------

The IP address will be listed in the inet_addr stanza as something like:

---------------------------------------------------------------------------
inet addr:192.168.56.101
---------------------------------------------------------------------------

Network connections for external staff clients
----------------------------------------------

While you can use the IP address to access the OPAC, the staff client needs
a hostname to connect to Evergreen. For the built-in staff client in the Linux
graphical desktop, you can just use `localhost`. But for external staff
clients, if your network does not assign a real hostname to the IP address for
the virtual image, you may need to alter the hosts file on your client
workstations to provide an alias for the IP address.

On Linux, the hosts file can be found in `/etc/hosts`

On Windows, the hosts file can be found in
`C:\WINDOWS\System32\drivers\etc\hosts`

External staff clients
----------------------

You can connect a staff client to the virtual image by getting your host-based
connection running (see previous section). Once you have a host-based
connection running, you can use the Windows 2.0.3 staff client
available from the following URL to connect to the virtual image from a
Windows machine:

http://evergreen-ils.org/downloads/evergreen-setup-rel_2_0_3.exe