--------------------------------------------------------------------- IBM (TM) eNetwork (TM) Communications Server - Web Administration Version 6.0 for OS/2 (TM) Warp --------------------------------------------------------------------- (C) Copyright IBM Corporation, 1997-1999. All rights reserved. -------- Contents -------- 1.0 Introduction 2.0 Software requirements - general 2.1 Software requirements - on the server 2.2 Software requirements - on the client 3.0 Hardware requirements - general 3.1 Hardware requirements - on the client 3.2 Hardware requirements - on the server 4.0 Security 5.0 Installing Web Administration using the Apache Web Server 6.0 Installing Web Administration using the Lotus Go Web Server (TM) 7.0 Installing Web Administration using Lotus Domino (TM) 8.0 Using other Web servers 8.1 Using other Web servers - virtual directory configuration 8.2 Using other Web servers - virtual directory protection 8.2.1 Lotus Go- or IBM ICS-type Web server example 8.2.2 Apache-type Web server example 9.0 Starting the Web Administration feature 10.0 Preventing FFST/2 (TM) pop-up messages 11.0 Navigation within the Web Administration feature 12.0 Removing the Web Administration feature 13.0 Notices 14.0 Trademarks ---------------- 1.0 Introduction ---------------- The Web Administration feature provides the Web administration function for eNetwork Communications Server for OS/2 (TM) Warp. You can use this feature to manage Communications Server over an intranet or the Internet. Using a Web browser, an administrator can query node status, obtain information about resources, modify resources, display configuration files, display message logs, and perform other administrative tasks. ----------------------------------- 2.0 Software requirements - general ----------------------------------- The Web Administration feature requires a Web server running with Communications Server for OS/2 Warp and a Web browser running on any system on your intranet or the Internet. Communication between the Web browser and Web server over your network requires TCP/IP. If your network does not support TCP/IP, you can use the Sockets over SNA function provided with Communications Server. ----------------------------------------- 2.1 Software requirements - on the server ----------------------------------------- Operating system software: - IBM OS/2 Warp version 4.0 or higher Communications Server software: - IBM eNetwork Communications Server for OS/2 Warp, Version 6.0 or higher Web server software: - Lotus Domino Web Server Version 4.6.1 or higher For information about Lotus Domino, visit http://www.lotus.com/home.nsf/welcome/domino/ - Lotus Go Web Server Version 4.6.2.5 or higher For information about Lotus Go, visit http://www.software.ibm.com/webservers/dgw/ - Apache Web Server Version 1.3 or higher For information about Apache, visit http://www.apache.org - For IBM Web Server Offerings, visit http://www.software.ibm.com/webservers/ ----------------------------------------- 2.2 Software requirements - on the client ----------------------------------------- Web browser software: - For OS/2 workstations - Netscape Navigator, Version 4.04 or higher with Java Version 1.1.6 - For Windows (TM) workstations - Netscape Navigator, Version 4.07 or higher - Microsoft (TM) Internet Explorer, Version 4.01 or higher You can use other browsers that support frames, Java 1.1.6 or higher and Java (TM) Script. The Web Administration feature's performance can be adversely affected by the capacity of your network connection or your choice of browser. Browser performance varies. If Web Administration performance is slow on your browser, try a different browser or a different client operating system. Screen painting problems have been reported on some versions of Netscape Navigator. If you experience screen painting problems, try a newer version of Netscape Navigator, a different browser, or a different client operating system. ----------------------------------- 3.0 Hardware requirements - general ----------------------------------- There are no unique hardware requirements to run Web Administration. ----------------------------------------- 3.1 Hardware requirements - on the client ----------------------------------------- Video display: - The minimum required screen resolution is 640 x 480 pixels. - The recommended screen resolution is 1024 x 768 pixels. - The minimum required color resolution is 256 colors. ----------------------------------------- 3.2 Hardware requirements - on the server ----------------------------------------- Memory: - 3 megabyte of RAM. This is in addition to Communications Server and Web server requirements. Disk: - 6 megabytes of disk space. This is in addition to Communications Server and Web server requirements. ------------ 4.0 Security ------------ Use of the Web server security mechanism should be implemented (but is not required). Most Web servers have instructions to add user ID and password authentication for specified directories. The Web Administration directory (x:\www\csc) and all sub-directories should have password protection. Unless a secure browser and secure server are used, the user ID and password will be transmitted in an encoded, but not encrypted, form over the network. While this is probably not a concern for an administrator using an internal network, unsecured usage over the open Internet could pose risks. ------------------------------------------------------------- 5.0 Installing Web Administration using the Apache Web Server ------------------------------------------------------------- These steps are performed using the Apache Web Server for OS/2 Warp as the Web server software. The only software installed on the client machine is a Web browser. The following steps are performed at the server machine. 1)___ Install Communications Server for OS/2 Warp. 2)___ Install the Web server software ( Apache ). 3)___ During the installation you might be prompted for an Administration ID and Password. Make a note of the ID and password. You will need them to access the Web server from your Web browser. 4)___ During the installation you might be asked if you want to enable Java Servlet support. Select YES. 5)___ Make a note of the TCP/IP address and host name of your Web server. If your network uses a TCP/IP DNS, the host name will be used by your Web browser. If your network does not use a TCP/IP DNS (domain name system)(or you are not sure) the IP address will be used by your Web browser. 6)___ Reboot after installing the Web server software. 7)___ Open an OS/2 window and change to the drive and directory where you downloaded WEBCON60.EXE. a) Type: WEBCON60 to create a sub-directory named CDIMAGE. b) Make CDIMAGE the current sub-directory (OS/2 command: CD CDIMAGE). c) Type: INSTALL for the installation program to install the Web Administration software and create a folder named "Communications Server Web Administration" on your desktop. The folder contains this README file and the Install Utility. 8)___ Test your access to the Web server. Before continuing, start (or restart) your Web server. For most servers, you can display the Web server information page by using your browser to open the page "hostname." In the following example, "hostname" is either the TCP/IP host name or the IP address recorded in Step 5. From your Web browser, access the following URL: http://hostname 9)___ Test your access to Web Administration. In the following example, "hostname" is either the TCP/IP host name or the IP address recorded in Step 5. From your Web browser, access the following URL: http://hostname/csc/ or http://hostname/csc/main.html or http://hostname/csc/index.html or http://hostname/csc/main The installation program sets up a default ID and password for you. The ID is 'admin' and and password is 'admin'. Use the Apache HTPASSWD.EXE utility to remove the default ID and password and add your personal ID. See section 8.2.2 for additional information. --------------------------------------------------------------- 6.0 Installing Web Administration using the Lotus Go Web Server --------------------------------------------------------------- These steps are performed using the Lotus Go Web Server for OS/2 Warp as the Web server software. The only software installed on the client machine is a Web browser. The following steps are performed at the server machine. 1)___ Install Communications Server for OS/2 Warp. 2)___ Install the Web server software ( Lotus Go ). 3)___ During the installation you might be prompted for an Administration ID and Password. Make a note of the ID and password. You will need them to access the Web server from your Web browser. 4)___ During the installation you might be asked if you want to enable Java Servlet support. Select YES. 5)___ Make a note of the TCP/IP address and host name of your Web server. If your network uses a TCP/IP DNS (domain name system), the host name will be used by your Web browser. If your network does not use a TCP/IP DNS (domain name system) (or you are not sure) the IP address will be used by your Web browser. 6)___ Reboot after installing the Web server software. 7)___ Open an OS/2 window and change to the drive and directory where you downloaded WEBCON60.EXE. a) Type: WEBCON60 to create a sub-directory named CDIMAGE. b) Make CDIMAGE the current sub-directory (OS/2 command: CD CDIMAGE). c) Type: INSTALL for the installation program to install the Web Administration software and create a folder named "Communications Server Web Administration" on your desktop. The folder contains this README file and the Install Utility. 8)___ Test your access to the Web server. Before continuing, start (or restart) your Web server. For most servers, you can display the Web server information page by using your browser to open the page "hostname." In the following example, "hostname" is either the TCP/IP host name or the IP address recorded in Step 5. From your Web browser, access the following URL: http://hostname 9)___ Test your access to Web Administration. In the following example, "hostname" is either the TCP/IP host name or the IP address recorded in Step 5. From your Web browser, access the following URL: http://hostname/csc/ or http://hostname/csc/main.html or http://hostname/csc/index.html or http://hostname/csc/main Use the ID and PASSWORD recorded during Step 3. ---------------------------------------------------- 7.0 Installing Web Administration using Lotus Domino ---------------------------------------------------- These steps are performed using the Lotus Domino Web Server for OS/2 Warp as the Web server software. The only software installed on the client machine is a Web browser. The following steps are performed at the server machine. 1)___ Install Communications Server for OS/2 Warp, Version 4.0 or higher. 2)___ Install the Web server software. For example, Lotus Domino Web Server. 3)___ Make a note of the TCP/IP address and host name of your Web server. If your network uses a TCP/IP DNS (domain name system), the host name will be used by your Web browser. If your network does not use a TCP/IP DNS (or you are not sure) the IP address will be used by your Web browser. 4)___ Reboot after installing the Web server software. 5)___ Open an OS/2 window and change to the drive and directory where you downloaded WEBCON60.EXE. a) Type: WEBCON60 to create a sub-directory named CDIMAGE. b) Make CDIMAGE the current sub-directory (OS/2 command: CD CDIMAGE). c) Type: INSTALL for the installation program to install the Web Administration software and create a folder named "Communications Server Web Administration" on your desktop. The folder contains this README file and the Install Utility. 6)___ If you do not already have a Domino Web Server Configuration database, create one using the Domino Web Server Configuration template (domcfg.ntf). The database must be named domcfg.nsf. From the Lotus Notes menu: a) Select: File b) Select: Database c) Select: New d) Type the Title: Domino Server Configuration e) Type the File Name: DOMCFG.NSF (type over the default name) f) Select: Domino Configuration g) Click: OK h) Press: Escape An icon named Domino Server Configuration will be added to your Lotus Notes desktop. 7)___ Update the URL to directory mapping. Open the Domino Server Configuration database by double-clicking the newly created icon from Step 6. From the Lotus Notes menu: a) Select: Create b) Select: Mapping URL -> Directory In the panel that appears, in the "Mapping" section, add each of the following mappings for the Web Administration directories. Because each mapping is a unique record in the configuration database, you must save and close each record before creating the next one. URL Path Directory Access ------------ ----------- -------- /csc x:\www\csc\html Read /csc-bin x:\www\csc\bin Execute Where x:\www is the drive and directory where the Web Administration files were installed. Note: Refer to the Lotus Domino documentation and password protect the x:\www\csc sub-directory. 8)___ Test your access to the Web server. Before continuing, start (or restart) your Web server. For most servers, you can display the Web server information page by using your browser to open the page "hostname." In the following example, "hostname" is either the TCP/IP host name or IP address recorded in Step 3. From your Web browser, access the following URL: http://hostname 9)___ Test access to Web Administration. In the following example, "hostname" is either the TCP/IP host name or IP address recorded in step 3. From your Web browser, access the following URL: http://hostname/csc/ or http://hostname/csc/main.html or http://hostname/csc/index.html or http://hostname/csc/main ------------------------------------------------------------- 8.0 Using other Web servers ------------------------------------------------------------- Other Web servers can support Communications Server Web administration. First, follow the installation instructions above. Then, modify the server configuration files (as described in your server documentation) to map virtual file requests to actual file directories. ------------------------------------------------------------- 8.1 Using other Web servers - virtual directory configuration ------------------------------------------------------------- Use the OS/2 enhanced editor ( EPM.EXE )to modify configuration files. The system editor ( E.EXE ) might append an EOF character to the modified file. The EOF character can cause problems for Apache-type Web servers. You can use the FIXCONF.EXE utility (found in x:\CMLIB) to remove the EOF character. To run the utility, switch to the sub-directory where ACCESS.CONF or HTTPD.CONF is located and type: fixconf access.conf or fixconf httpd.conf Virtual to real directory mapping: URL Path Directory Access ------------ ----------- -------- /csc x:\www\csc\html Read /csc-bin x:\www\csc\bin Execute Where x:\www is the drive and directory where the Web Administration files were installed. For Lotus Go or IBM ICS type web servers the entries look like this ( in file HTTPD.CNF ): Pass /csc/* x:\www\csc\html\* Exec /csc-bin/* x:\www\csc\bin\* For Apache type web servers the entries look like this ( in file ACCESS.CONF or HTTPD.CONF ): Alias /csc x:/www/csc/html ScriptAlias /csc-bin x:/www/csc/bin ---------------------------------------------------------- 8.2 Using other Web servers - virtual directory protection ---------------------------------------------------------- Other Web servers can support Communications Server Web administration. First, follow the installation instructions above. Then, modify the server configuration files (as described in the server's documentation)to password protect the Web Administration file directories. -------------------------------------------------- 8.2.1 Lotus Go- or IBM ICS-type Web server example -------------------------------------------------- In the following example, C:\MPTN\ETC is a resolve of the OS/2 %ETC% environment variable. The file HTTPD.CNF needs the following lines: Protection PROT-COMMSERVER { PasswdFile C:\MPTN\ETC\ADMIN.PWD Mask All@(*) PostMask All@(*) PutMask All@(*) GetMask All@(*) AuthType Basic ServerID Private_Authorization } Protect /csc/* PROT-COMMSERVER Protect /csc-bin/* PROT-COMMSERVER Note: If you already have a password file, you can replace the reference to ADMIN.PWD with your password file. ------------------------------------- 8.2.2 Apache-Type Web server example ------------------------------------- In the following example, d:\www is where Web Administration is located and d:\os2httpd\conf is where the Apache configuration files are located. The configuration file ACCESS.CONF or HTTPD.CONF needs the following lines: require valid-user authName COMMSERVER authType basic authUserFile d:/os2httpd/conf/commserver.users Alias /csc d:/www/csc/html ScriptAlias /csc-bin d:/www/csc/bin Use the HTPASSWD.EXE utility (shipped with Apache) to update the d:\os2httpd\conf\COMMSERVER.USERS password file. Note: If you already have a password file, you can replace the reference to COMMSERVER.USERS with your password file. ------------------------------------------- 9.0 Starting the Web Administration feature ------------------------------------------- After Web Administration and required Web software have been installed and configured, you can begin managing Communications Server from a Web browser. Use your browser to access the following page: http://hostname/csc/ or http://hostname/csc/main.html or http://hostname/csc/index.html or http://hostname/csc/main Where hostname is the TCP/IP host name or IP address of the system running the Web server. Enter the ID and password when requested. -------------------------------------- 10.0 Preventing FFST/2 pop-up messages -------------------------------------- Communications Server uses the error logging facilities of FFST/2. On an unattended, remotely administered server, it is not desirable to allow FFST/2 to display informational or error messages in pop-up windows. To turn this function off, go to the FFST/2 folder and start the "Message Console" (or type EPWCONS from an OS/2 window). From the Message Console menu, select "Option"-"Configuration" and set "Message pop-up" to "OFF". ----------------------------------------------------- 11.0 Navigation within the Web Administration feature ----------------------------------------------------- While using Web Administration, navigation is accomplished by using the navigation bar on the left side of your browser's display area. Since real-time information is being sent to your browser, avoid using the browser's "Forward" and "Backward" buttons. Use the navigation bar. -------------------------------------------- 12.0 Removing the Web Administration feature -------------------------------------------- The Install Utility, in the Communications Server Web Administration folder, can be used to remove the Web Administration software from the server. -------------------- 13.0 Notices -------------------- IBM Communications Server for OS/2 Warp Web Administration is provided on an "AS-IS" BASIS WITHOUT ANY WARRANTY OF ANY KIND, INCLUDING THE WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE WHICH ARE EXPRESSLY DISCLAIMED. -------------------- 14.0 Trademarks -------------------- eNetwork, FFST/2, IBM, and OS/2 are trademarks of International Business Machines Corporation in the United States and/or other countries. Lotus, Lotus Domino, and Lotus Go Web Server are trademarks of Lotus Development Corporation in the United States, other countries, or both. Java and all Java-based trademarks and logos are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both. Microsoft, and Windows are trademarks of Microsoft Corporation in the United States, other countries, or both. Other company, product, and service names might be trademarks of others.