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 PHP scripting language is used to dynamically build web pages based on the results of queries. 

Microsoft IIS (Internet Information Server) is facility that services HTTP (Web), FTP (file transfer) and SMTP (mail) protocols. It is provided with Windows 2003 Server, Windows XP Professional, Windows 2000 Professional and Server. Updates can be downloaded from www.microsoft.com. The EMuWeb interface has been designed to function within the IIS web server environment.

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).

In the notes below clientname refers to the name of the client directory for the current installation. The term ~emu is used to refer to the user emu's home directory (in DOS format). This is normally c:\home\emu.

Requirements

• Microsoft IIS, version 5.0 or greater.
  - Windows 2003 Server:  IIS can be installed under Start->Control Panel->Add/Remove Programs->Add/Remove Windows Components
  - Windows XP:  IIS can be installed under Start->Control Panel->Add/Remove Programs->Add/Remove Windows Components
  - Windows 2000: IIS can be installed under Start->Settings->Control Panel->Add/Remove Programs->Windows Components
• PHP, version 4.0.4 or greater.

Windows XP/2003 Pre-Installation Check - PHP

1. Log in as local Administrator.
2. Select Start>Search. The Search Results dialog box will appear.
3. Select All files and folders from the search list on the right.
4. Enter php.exe into the All or part of the filename: box.
5. Click Search. If the file is not found then PHP has not been installed on your system. Please visit www.php.net to get the latest version of the software and installation instructions.

Windows 2000 Pre-Installation Check - PHP

1. Log in as local Administrator.
2. Select Start>Search>For Files and Folders. The Find dialog box will appear.
3. Enter php.exe into the Named: box.
4. Click Find Now. If the file is not found then PHP has not been installed on your system. Please visit www.php.net to get the latest version of the software and installation instructions.

 EMuWeb - TexXMLServer Installation

1. Log in to the Windows machine as emu on the KE EMu server.
2. Start a Korn Shell with Start>Programs>Windows Services for UNIX>Korn Shell.
3. Enter client  clientname where client is the KE EMu environment to be configured.
4. Enter emuweb  stop
5. Enter vi  etc/config
6. Locate the lines containing EMUXMLSERVERS and EMUXMLSERVICE. The value for EMUXMLSERVERS is the number of KE EMu servers that will handle web requests. Modify the settings to:
   EMUXMLSERVERS=3
   EMUXMLSERVICE=emuwebclientname
   where client is the name of the KE EMu environment being configured.
   If you want to disable the KE EMuWeb interface set EMUXMLSERVERS to zero.
7. Save the file.
8. Enter vi  etc/texxmlserver.conf
9. 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.
10. Save the file.
11. Enter client clientname
12. Enter emuweb start
13. Enter exit to terminate the shell.
14. Log out.

EMuWeb - local IIS Installation

Follow the notes in this section if you are running IIS on the same machine as you have installed the KE EMu server.

1. Log in as local Administrator.
2. Windows 2003: Start Internet Information Services Manager (Start>Settings>Control Panel>Administrative Tools>Internet Information Services (IIS) Manager).
   -OR-
   Windows XP: Start Internet Information Services (Start>Settings>Control Panel>Administrative Tools>Internet Information Services).
   -OR-
   Windows 2000: Start Internet Service Manager (Start>Settings>Control Panel>Administrative Tools>Internet Service Manager).
3. The Management Console program will appear.
4. Find the Web Site that will be used to access KE EMu. The notes below assume the Default Web Site.
5. Right click on the Default Web Site and under the New entry select Virtual Directory.
6. Windows XP/2003: The New Virtual Directory Wizard will appear. Click Next>. Enter emuwebclientname in the Alias: edit box.
   -OR-
   Windows 2000: The New Virtual Directory Wizard will appear. Enter emuwebclientname in the Alias to be used: edit box.
7. Windows XP/2003: Click Next>. Enter c:\home\emu\clientname\web into the Directory: edit box.
   -OR-
   Windows NT/2000: Click Next>. Enter c:\home\emu\clientname\web into the Enter the physical path: edit box.
8. Click Next>. A list of access permissions will appear.
9. Alter the permissions so that Read and Run Scripts are the only privileges allocated. Click Next>, then click Finish.
10. Select Exit under the Console menu.
11. Log out.
12. Log in to the Windows machine as user emu.
13. Start a Korn Shell with Start>Programs>Windows Services for UNIX>Korn Shell.
14. Enter client  clientname
15. Enter cd  web
16. If the file CONFIG.php does not exist then enter cp  CONFIG.sample.php  CONFIG.php
17. Enter vi CONFIG.php.
18. Locate the lines containing $XML_SERVER_HOST, $XML_SERVER_PORT and $WEB_DIR_NAME. Modify the settings to:
    $XML_SERVER_HOST=localhost
    $XML_SERVER_PORT=port number of emuwebclientname service on KE EMu server
    $WEB_DIR_NAME=emuwebclient  
19. Save the file.
20. Enter cd  objects/cache
21. Enter cacls  system.php  /E  /G  Everyone:W
22. Enter exit to close the Korn Shell window.
23. Continue with EMuWeb - Initialisation.

EMuWeb - remote IIS Installation

Follow the notes in this section if you are running IIS on a different machine to the one you have installed the EMu server.

The instructions below assume that ftp (File Transfer Protocol) is installed on the EMu server and that it is enabled. If ftp is not enabled you will need to find some mechanism for copying over the EMuWeb tree from the EMu server to the Web Server machine. The tree is located in the ~emu/clientname/web directory.

1. Log in as local Administrator on the IIS Web Server machine
2. Start Windows Explorer.
3. Click in the Address drop down list and enter:
   ftp://emu@emuserver   where emuserver is the name of the EMu server.
4. The Log On As dialog box will appear. Enter the emu password at the Password: prompt and click Log on.
5. In the right pane of the Windows Explorer double click on the client directory for the system to be installed.
6. Click on the web directory to get it highlighted. Then right click and select Copy from the popup menu.
7. Navigate in Windows Explorer to the Document Root directory for IIS (generally C:\Inetpub\wwwroot). Right click in the right window pane in Windows Explorer and select Paste from the popup menu. The EMuWeb document tree is now copied onto your IIS Web Server.
8. Right click on the web directory that was copied into your Document Root and select Rename from the popup menu. Change the name of the directory to emuwebclientname.
9. Close Windows Explorer.
10. Windows 2003: Start Internet Information Services Manager (Start>Settings>Control Panel>Administrative Tools>Internet Information Services (IIS) Manager).
      -OR-
    Windows XP: Start Internet Information Services (Start>Settings>Control Panel>Administrative Tools>Internet Information Services).
      -OR-
    Windows 2000: Start Internet Service Manager (Start>Settings>Control Panel>Administrative Tools>Internet Service Manager).
11. The Management Console program will appear.
12. Find the Web Site that will be used to access EMu. The notes below assume the Default Web Site.
13. Right click on the emuwebclientname directory in the right pane and select Properties from the popup menu.
14. The emuwebclientname Properties dialog will appear.
15. IIS 5.0: Alter the permissions so that Read permission and Scripts only execute permissions are enabled. Click OK.
16. Select Exit under the Console menu.
17. Start Windows Explorer.
18. Navigate to the location where EMuWeb has been installed (generally C:\Inetpub\wwwroot).
19. Double click on the emuwebclientname virtual directory.
20. Check if the file CONFIG.php exists. If not, copy CONFIG.sample.php to CONFIG.php.
21. In the right pane, right click on CONFIG.php and Open the file with Wordpad or your preferred Windows based text editor.
22. 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 emuwebclient service on KE EMu server
    $WEB_DIR_NAME=emuwebclient  
23. Save the file and close the editor application.
24. Navigate in Windows Explorer to emuwebclientname\objects\cache directory.
25. Right click on system.php and select Properties from the popup menu.
26. The system.php Properties dialog will appear.
27. Alter the file permissions so that  user IUSR_HOSTNAME has Read and Write permissions on the file.
28. Close the system.php Properties dialog box.
29. Close Windows Explorer.
30. Continue with KE EMuWeb - Initialisation.

EMuWeb - Initialisation

1. Start up your web browser and open http://yourserver/emuwebclientname/objects/admin/index.php
2. The EMuWeb administration login page is displayed. Enter the default password keemu and click Login.
3. The KE EMuWeb Admin page is displayed. Click the Reload button in the web page.
4. A page containing Initialise Complete should be displayed.
5. 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.).