Introduction

EMuWeb provides a web based, query only interface to EMu. Using a web browser it is possible to search the collection and view listings and details about matching records. EMuWeb has been designed as a series of simple objects that web designers can use to create their own web pages as required. EMu provides a standard set of pages that may be used as an "out of the box" system.

The EMuWeb interface uses the PHP scripting language to dynamically build web pages based on the results of queries. In order for EMuWeb to be operational it is necessary to have a functional web server that is capable of interpreting PHP code. For UNIX based systems we recommend the use of Apache as the web server with PHP installed as a dynamically loaded module.

EMuWeb may be installed on the same machine as EMu or it may be installed on a separate web server and access EMu via a socket connection. The installation notes below detail both the local installation (installed on same machine as EMu) and the remote installation (installed on web server machine different from EMu server).

The term ~emu is used to refer to the user emu's home directory. This is typically /home/emu.

Requirements

• Apache Version 1.3 or greater.
• PHP Version 5.2 or greater installed under Apache

Installation Notes (EMuWeb - TexXMLServer)

1. Log in as emu.
2. Enter client  clientname
   where clientname is the KE EMu environment to be configured.
3. Enter emuweb  stop
4. Enter vi  etc/config
5. Locate the lines containing EMUXMLSERVERS and EMUXMLSERVICE. The value for EMUXMLSERVERS is the number of EMu servers that will handle web requests. Modify the settings to:
   EMUXMLSERVERS=3
   EMUXMLSERVICE=emuwebclientname
   where clientname is the name of the EMu environment being configured.
   If you want to disable the EMuWeb interface set EMUXMLSERVERS to zero.
6. Save the file.
7. Enter vi  etc/texxmlserver.conf
8. Locate the line AllowedHost=. Modify the line to:
   AllowedHost=machine name of web server  
   For a local installation set the machine name to localhost and for remote installations use the machine name of the remote web server.
9. Save the file.
10. Enter client  clientname
11. Enter emuweb start
12. Log out.

Installation Notes (EMuWeb - local UNIX)

1. Log in as root.
2. Enter cd  documentroot where documentroot is the DocumentRoot directory set in the Apache configuration file httpd.conf. The location of the Apache configuration file is installation dependent however the following locations are commonly used:
   

   Location	Operating System
   /usr/local/apache/etc	Many Unix versions
   /usr/local/etc/apache	FreeBSD
   /etc/httpd/conf	RedHat Linux
   /etc/apache	Solaris

   
   Note that if you are running virtual servers then use the DocumentRoot set for the virtual server that will service KE EMuWeb requests. 
3. Enter ln  -s  ~emu/clientname/web  emuwebclientname
4. Stay logged in and continue with KE EMuWeb - Initialisation.

Installation Notes (EMuWeb - remote UNIX)

The instructions below assume that the remote web server is on a Unix machine running Apache. If the remote web server is a Windows IIS machine then please see the Installation Notes (KE EMuWeb - remote IIS).

1. Log in as emu.
2. Enter client  clientname
3. Enter tar  cvf  emuweb.tar  web to create a backup of the web directory.
4. Log out.
5. Log in to the remote web server as root.
6. Enter cd  documentroot
   where documentroot is the DocumentRoot directory set in the Apache configuration file httpd.conf.
7. Transfer the file emuweb.tar from the KE EMu server into the document root directory on the web server machine.
8. Enter tar  xvf  emuweb.tar
9. Enter mv  web  emuwebclientname
10. Enter chown  -R  owner:group  emuwebclientname where owner and group are the owner name and group name respectively for files accessible by Apache. See the User and Group settings in the Apache configuration file httpd.conf for the correct values.
11. Stay logged in and continue with EMuWeb - Initialisation.

Installation Notes (EMuWeb - Initialisation)

1. Enter chmod  666  emuwebclientname/objects/cache/system.php
2. Enter vi  emuwebclientname/CONFIG.php
3. Locate the lines containing $XML_SERVER_HOST, $XML_SERVER_PORT and $WEB_DIR_NAME. Modify the settings to:
   $XML_SERVER_HOST=machine name of KE EMu server
   $XML_SERVER_PORT=port number of emuwebclientname service on KE EMu server
   $WEB_DIR_NAME=emuwebclientname 
   For a local installation name set the machine name to localhost and for remote installations use the machine name of the remote web server.
4. Save the file.
5. Log out.
6. Start up your web browser and open http://yourserver/emuwebclientname/objects/admin/index.php
   The EMuWeb administration login page is displayed.
7. Enter the default password keemu and click Login.
   The KE EMuWeb Admin page is displayed.
8. Click the Reload button in the web page.
   A page containing Initialise Complete should be displayed.
9. Shutdown your web browser.

URL Setup

In order to test your setup the following URL can be used:
http://yourserver/emuwebclientname/pages/cataloguetype/Query.php
where cataloguetype is the type of catalogue used in the installation (e.g. gallery, rbg, mv, etc.).