Installing Apache on TPF

# Installing the Apache 1.3 HTTP Server on TPF

[ Setup | Compilation | Installation | VisualAge ]

This document outlines the steps needed to install Apache onto a TPF system.

You should first read htdocs/manual/readme-tpf.html for basic information on the port of Apache to TPF including required PUT level and supported functions & modules.

## Setup

Due to the use of EBCDIC on MVS OS/390 Open Edition (later referred to simply as "Open Edition"), we've found that the most reliable method for loading Apache onto your system is to unzip and tar the distribution file on your PC, and then copy the extracted files to Open Edition via an NFS client capable of transferring the data in EBCDIC format.

Before moving the distribution to an Open Edition environment, verify that the NFS drive will transfer the filenames with upper/lower case preserved.

Since Open Edition is not the ultimate destination of the files, the only required files and subdirectories that need to be moved to Open Edition are in /src.

WARNING: If you are using a product such as WinZip on your PC, verify that the "TAR File Smart CR/LF Conversion" option is NOT checked. You can find this in WinZip under Options, Configuration. Since you had to tar and unzip the file to read this document, you need to re-tar and -unzip if the CR/LF option was checked. This will save you lots of headaches later on.

WARNING: Editing files on a PC before moving them to Open Edition may result in the loss/addition of unprintable characters. Files of concern include shell scripts and src/Configuration. The most common problems are with tab characters and CR/LF characters. Most editors will handle the CR/LF problem correctly but none seem to handle tab characters. If you need to edit files, edit them in a UNIX editor such as vi or emacs.

## Compilation

Apache supports the notion of "optional modules". However, the server has to know which modules are compiled into it. In order for those modules to be effective, it is necessary to generate a short bit of code ("modules.c") which simply has a list of them. If you are using the make and Configure utility, "modules.c" will be created for you.

The provided scripts assume a c89 compiler and have only been tested on an Open Edition environment. If you are using a platform other that Open Edition you may need to modify src/os/tpf/TPFExport and src/Configure to match your environment.

Note that UNIX/Open Edition commands in this section are shown in `bold`, are case sensitive, and must be made from the "src" directory.

1. Overlay src/Configuration with src/Configuration.tmpl: `cp Configuration.tmpl Configuration`
2. Edit src/Configuration. It contains the list and settings of various "Rules" and an additional section at the bottom that determines which modules to compile:
   1. Adjust the Rules and `EXTRA_CFLAGS|LIBS|LDFLAGS|INCLUDES` if you feel so inclined.
   2. Comment out (by preceding the line with a "#") lines corresponding to those modules you DO NOT wish to include. At present the following modules MUST be commented out as they are not yet supported on TPF: mod_actions, mod_auth, mod_cgi, mod_env, mod_include, & mod_status.
   3. Uncomment (by removing the initial "#", if present) lines corresponding to those optional modules you wish to include or add new lines corresponding to any custom modules you have written. The htdocs/manual/readme-tpf.html document lists the modules that have been tested on TPF.
3. Set the TPF environment variables: `. os/tpf/TPFExport`
   (The initial period and blank on the command are required to ensure the environment variables exist beyond the scope of the shell script.) This script will set the environment variables required to compile the programs for TPF. Verify that the export variables are valid for your installation, in particular, the system include file directories. The system include files must reside on your Open Edition system in the appropriate file structure similar to /usr/include and /usr/include/sys. DO NOT modify the `TPF=YES` export variable. If this is changed, the "Configure" script will not recognize TPF.
4. Run the "Configure" script: `Configure`
   The output will look something like this...

             Using config file: Configuration
             Creating Makefile
              + configured for TPF platform
              + setting C compiler to c89
              + setting C pre-processor to c89 -E
              + checking for system header files
              + adding selected modules
             Creating Makefile in support
             Creating Makefile in main
             Creating Makefile in ap
             Creating Makefile in regex
             Creating Makefile in os/tpf
             Creating Makefile in modules/standard
             Creating Makefile in modules/example
             $ _

   This generates modules.c and new versions of the Makefiles.
   If you want to maintain multiple configurations, you can say, e.g.,
   `Configure -file Configuration.ai`

             Using config file: Configuration.ai
             Creating Makefile
              + configured for <whatever> platform
              + setting C compiler to <whatever>
             et cetera

   If you receive an error such as "`Configure 146: FSUM7351 not found`" the most likely explanation is that one or more of the make related files were edited on a non-UNIX platform, corrupting the end-of-line marks. Verify that lines ending with "\" in the flagged file do not have trailing spaces. Using the vi editor and the sample error above as an example...

                   pull up the flagged file:       vi Configure
                   turn on punctuation:            :set list
                   go to the line in question:     146G
                      or find a line with a "\":   /\\

   The end of line should display as "`\$`". If it is displayed as "`\ $`" (with a blank between \ and $) then you should revert to the distributed version of the file and make the site-specific changes again using a UNIX compatible editor such as vi or emacs. Then try the Configure command again.

                   close the file:                 :q  (or

       :quit!)

5. Now compile the programs: `make`
   The modules placed in the Apache distribution are the ones that have been tested and are used regularly by various members of the Apache development group. Additional modules contributed by members or third parties with specific needs or functions are available at http://www.apache.org/dist/contrib/modules/. There are instructions on that page for linking these modules into the core Apache code.
   If during compilation you get a warning about a missing 'regex.h', set `WANTHSREGEX=yes` in the src/Configuration file and start back at the `Configure` step.

## Installation

1. After compilation, you will have all the object files required to build an "httpd" loadset. The next step is to link the object files and create a loadset to be stored in a PDS. Sample JCL for linking and loadsets has been included in src/os/tpf/samples as "linkdll.jcl" and "loadset.jcl". You can submit these jobs from CMS or directly from Open Edition if you have the proper authority. After the jobs have completed, you can `ZOLDR LOAD` them to your TPF system.
   NOTE: The `mod_xxx.o` files in the linkdll.jcl file must correspond to the `mod_xxx.o` lines in the src/Configuration file.
2. Apache requires a configuration file to initialize itself during activation. (Previously three configuration files were used.) Copy the distribution version, /conf/httpd.conf-dist, to /conf/httpd.conf and then edit the /conf/httpd.conf copy with your site specific information. This first release of Apache for TPF only runs under the "inetd" model so you must change `ServerType` from `standalone` to `inetd`.
   General documentation for Apache is located at http://www.apache.org/docs/ and in the HTML pages included with this distribution under the /htdocs/manual directory.
3. On TPF activate ZCLAW and update INETD using ZINET entries, the common case:

           ZINET ADD S-TFTP   PGM-CTFT PORT-69 PROTOCOL-UDP MODEL-NOWAIT
           ZINET ADD S-APACHE PGM-pppp PORT-80 PROTOCOL-TCP MODEL-NOWAIT

   Please refer to IBM Transaction Processing Facility Transmission Control Protocol/Internet Protocol Version 4 Release 1 for more information on ZCLAW, INETD, and TFTP.
4. Prior to sending a request to your Apache server from a browser, TFTP the configuration file, log, icons and web pages to your TPF system. A typical directory structure for Apache is as follows:

            /usr/local/apache/conf
            /usr/local/apache/logs
            /usr/local/apache/icons
            /usr/local/apache/htdocs

   The logs directory must exist in order to avoid an `fopen` error while running Apache. TFTP an empty file into the logs subdirectory to create it. All gif, jpg, and zip files should be TFTP'd as binary; conf files and html pages should be TFTP'd as text.

## Compiling with VisualAge TPF

It is not required that "make" be used to compile Apache for TPF: Individual programs may be compiled using IBM's VisualAge TPF product. This is particularly useful when compiling selected programs for the Debug Tool.
The following VisualAge compile settings are required:

- "DEFINE - Define preprocessor macro name(s)" must include `TPF, CHARSET_EBCDIC, _POSIX_SOURCE,` and `USE_HSREGEX`
- "LSEARCH - Path for user include files" must include `../src/include` and `../src/os/tpf`
- "DLL - Generate DLL code" must be checked
- "LONGNAME - Support long names" must be checked

[ top | Setup | Compilation | Installation | VisualAge ]