From: Joshua Slive Date: Wed, 22 Aug 2001 00:14:00 +0000 (+0000) Subject: Be gone old cruft! X-Git-Tag: 2.0.25~203 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=aabd58554d14053385ffeb8bf28dff3b26c11ff4;p=apache Be gone old cruft! git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@90480 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/manual/index.html.en b/docs/manual/index.html.en index cc68b7b7e8..11c8af9f27 100644 --- a/docs/manual/index.html.en +++ b/docs/manual/index.html.en @@ -110,8 +110,6 @@ Modules: By Type or Platform Specific Notes Microsoft Windows - -Other Platform Specific Notes diff --git a/docs/manual/install-tpf.html b/docs/manual/install-tpf.html deleted file mode 100644 index 8ff7d26082..0000000000 --- a/docs/manual/install-tpf.html +++ /dev/null @@ -1,342 +0,0 @@ - - - -Installing Apache on TPF - - - - -
Warning: -This document has not been updated to take into account changes -made in the 2.0 version of the Apache HTTP Server. Some of the -information may still be relevant, but please use it -with care. -
- -

- Installing the Apache 1.3 HTTP Server on TPF -

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

-

Download

-Releases of the Apache server are compressed into a "tarball" file and stored on the Apache web site. -You will need to choose a version and download the corresponding tarball to your PC. -Additionally the source code from the tarball will need to be copied onto an MVS OS/390 Open Edition machine -(later referred to simply as "Open Edition") for compiling. -So here are all the details on how to get Apache and how to get it where it needs to be: -
    -
  1. Download - the gzipped Apache files (the "tarball") to your PC. - The file name on the web site will be something like apache_1.3.x.tar.gz. -
    TIP: Be sure to keep the .tar.gz extension - when choosing the name of the PC file. -

    -
  2. Decompress the tarball on your PC using WinZip or some other PC decompression tool. -
    TIP: If you are using WinZip verify that the - "TAR File Smart CR/LF Conversion" option (under Options, Configuration) is NOT checked.
    - This is what you can expect if you use WinZip: -
      -
    • open the tarball with WinZip (this can usually be done simply by double-clicking - on the downloaded tarball) -
    • you will be told that the archive contains one file (such as apache_1.3.x.tar) - - allow WinZip to decompress it to a temporary folder -
    • extract the archived files onto your PC - - you'll be using files from the conf, htdocs, and icons directories later in the install phase -
    -
    -
  3. FTP the tarball to your Open Edition machine using binary mode: -
      -
    • activate FTP in an MSDOS window: ftp your.open.edition.machine.com -
    • sign in -
    • set mode to binary: binary -
    • send the file to Open Edition:
      -    send c:\downloaded_filename.tar.gz open_edition_filename.tar.gz -
    • exit FTP: bye -
    -
    TIP: - Open Edition and UNIX file names are case sensitive. If you use an NFS client to transfer files - from your PC to Open Edition (instead of using FTP as described above) verify that the NFS drive will transfer the - file names with upper/lower case preserved.
    -
    -
  4. Decompress the gzipped file on Open Edition: gunzip open_edition_filename.tar.gz -
    Note that the .tar.gz file will be replaced by the gunzipped .tar archive file. -

    -
  5. Extract the archived files necessary for compiling Apache: -
      -
    • pax -rvkf open_edition_filename.tar -o from=ISO8859-1,to=IBM-1047 "*/src" -
    • switch to the source code subdirectory of the newly extracted apache directory: cd apache-1.3/src -
    • remove unnecessary subdirectories: - rm -r os/bs2000 os/mpeix os/netware os/os2 os/os390 os/win32 -
    -
-
-

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 Configure utility -and make, modules.c and other necessary files will be created for you automatically. -

-

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

-TIP: -Editing files on your PC prior to 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 prior to moving them to Open Edition, -edit them in a UNIX editor such as vi or emacs.
-

-Note that 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: -

    -
      -
    • Adjust the Rules and EXTRA_CFLAGS|LIBS|LDFLAGS|INCLUDES - if you feel so inclined. -

      -
    • Comment out (by preceding the line with a "#") lines corresponding - to those modules you DO NOT wish to include. -

      -
    • 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. -
    -
    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/httpd/contrib/modules/. - There are instructions on that page for linking these modules into the core Apache - code. -

    -
  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 -
    - This generates modules.c, include/ap_config_auto.h, and necessary Makefiles: -
    -      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
    -       + checking sizeof various data types
    -      Creating Makefile in support
    -      Creating Makefile in regex
    -      Creating Makefile in os/tpf
    -      Creating Makefile in ap
    -      Creating Makefile in main
    -      Creating Makefile in modules/standard
    -      $ _
    -      
    - 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. Edit include/ap_config.h if you would like the scoreboard kept in shared - memory instead of file or system heap.
    - The default behavior for Apache on all platforms except TPF is to use the - file system for maintaining the scoreboard (which holds current Apache children status). - The default behavior for Apache on TPF is to use system heap. Available with - PUT10 is the use of shared memory for the scoreboard in place of the file system. - This reduces file activity for the parent Apache ECB and improves performance. - To activate shared memory, uncomment or add the directive - #define USE_SHMGET_SCOREBOARD - and comment out or remove the directive #define USE_TPF_SCOREBOARD - both of which are in the TPF section in ap_config.h. - This change will only take effect after Apache is (re)compiled. -

    - If you prefer to use the file system instead of system heap or shared memory, ensure that both - USE_TPF_SCOREBOARD and USE_SHMGET_SCOREBOARD are commented out or removed. - This change will only take effect after Apache is (re)compiled. - -
     
    -
  6. Edit include/ap_config.h if you plan on using the ZINET DAEMON model instead of the NOLISTEN model.
    - The default behavior is to let Apache check the server status (active/inactive) with ZINET - and shut itself down when appropriate. The default behavior also includes checking Apache's activation number. - Available with PUT11 (PJ25761) ZINET can perform these functions instead of Apache by using the DAEMON model. - This model offers increased reliability and is preferred over the NOLISTEN model. - If Apache goes down while running under the NOLISTEN model ZINET will not reactivate it nor alert the operator. - To use the DAEMON model you must modify the default behavior of Apache by uncommenting or adding the directive - #define USE_TPF_DAEMON within the TPF section in ap_config.h. - This directive is also recommend when starting Apache from the command line (APAR PJ26515). - This change will only take effect after Apache is (re)compiled. -

    - - -
  7. Now compile the programs: make
    - Besides compiling, make also runs main/gen_test_char.c and main/gen_uri_delims.c - in order to create main/test_char.h and main/uri_delims.h respectively

    - 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. Link the compiled object files into a DLL. - Sample link JCL has been included as src/os/tpf/samples/linkdll.jcl. - You will need to modify this JCL: -
      -
    • Change the IDs, data set names, and libraries for your particular site. -
    • Add/remove mod_xxx.o files so they correspond to the - mod_xxx.o lines in your src/Configuration file. -
    -
    TIP: - Do NOT include gen_test_char.o or gen_uri_delims.o in the link JCL since these files are only - used during the make step. -

    -
  2. Create a loadset. Sample loadset JCL has been included as src/os/tpf/samples/loadset.jcl. - You will need to modify this JCL for your particular site. -

    -
  3. Load (ZOLDR LOAD) and activate (ZOLDR ACT) the loadset on your test system. -

    -
  4. Ensure that the program name you are using for Apache has RESTRICT and KEY0 authorization. - zdpat pppp (c-c) will display allocation information. - You can use zapat pppp restrict key0 (c-c) to alter the - authorization. - Note that if the program name is unallocated, you must have the loadset for it activated or you will receive - INVALID PROGRAM NAME from the zdpat/zapat entries. -

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

    - General documentation for Apache is located at - http://www.apache.org/docs/ - and in the HTML pages included with the distribution (tarball) under the - /htdocs/manual directory. -

    -
  6. 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 MODEL-NOLISTEN
    -    or ZINET ADD S-APACHE PGM-pppp MODEL-DAEMON USER-root (see notes above regarding the DAEMON model)
    - Please refer to IBM Transaction Processing Facility Transmission Control - Protocol/Internet Protocol Version 4 Release 1 for more information - on ZCLAW, INETD, and TFTP. -

    -
  7. 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
    - All gif, jpg, and zip files should be TFTP'd as binary; conf files and html pages should be TFTP'd as text. -
    The logs directory must exist in order to avoid an fopen error while running Apache. - If you're running a PUT10 or higher version of TPF make the directory using the - zfile mkdir /usr/local/apache/logs functional entry. - If you're running TPF version PUT09 TFTP an empty file into the logs subdirectory to create it. -

    -
  8. Start the server using the ZINET START S-APACHE command. -
-  -

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: -

- -
-
top -  | Download -  | Compilation -  | Installation -  | VisualAge ] -
- - - diff --git a/docs/manual/location.html b/docs/manual/location.html deleted file mode 100644 index 1f7d8e25e7..0000000000 --- a/docs/manual/location.html +++ /dev/null @@ -1,68 +0,0 @@ - - - -Access Control by URL - - - - - -

Access Control by URL

- -

The <Location> Directive

- -Syntax: <Location URL prefix>
-Context: server config, virtual host
-Status: core
- -

The <Location> directive provides for access control by -URL. It is comparable to the <Directory> directive, and -should be matched with a </Location> directive. Directives that -apply to the URL given should be listed -between them. <Location> sections are processed in the -order they appear in the configuration file, after the -<Directory> sections and .htaccess files are -read.

- -

Note that, due to the way HTTP functions, URL prefix -should, save for proxy requests, be of the form /path/, -and should not include the http://servername. It doesn't -necessarily have to protect a directory (it can be an individual -file, or a number of files), and can include wild-cards. In a wild-card -string, `?' matches any single character, and `*' matches any -sequences of characters. - -

This functionality is especially useful when combined with the -SetHandler -directive. For example, to enable status requests, but allow them only -from browsers at foo.com, you might use: - -

-    <Location /status>
-    SetHandler server-status
-    Order Deny,Allow
-    Deny from all
-    Allow from .foo.com
-    </Location>
-
- - - - - diff --git a/docs/manual/misc/client_block_api.html b/docs/manual/misc/client_block_api.html deleted file mode 100644 index f2b55132a6..0000000000 --- a/docs/manual/misc/client_block_api.html +++ /dev/null @@ -1,95 +0,0 @@ - - - -Reading Client Input in Apache 1.2 - - - - - - -
Warning: -This document has not been updated to take into account changes -made in the 2.0 version of the Apache HTTP Server. Some of the -information may still be relevant, but please use it -with care. -
- -

Reading Client Input in Apache 1.2

- -
- -

Apache 1.1 and earlier let modules handle POST and PUT requests by -themselves. The module would, on its own, determine whether the -request had an entity, how many bytes it was, and then called a -function (read_client_block) to get the data. - -

However, HTTP/1.1 requires several things of POST and PUT request -handlers that did not fit into this module, and all existing modules -have to be rewritten. The API calls for handling this have been -further abstracted, so that future HTTP protocol changes can be -accomplished while remaining backwards-compatible.

- -
- -

The New API Functions

- -
-   int ap_setup_client_block (request_rec *, int read_policy);
-   int ap_should_client_block (request_rec *);
-   long ap_get_client_block (request_rec *, char *buffer, int buffer_size);
-
- -
    -
  1. Call ap_setup_client_block() near the beginning of the request - handler. This will set up all the necessary properties, and - will return either OK, or an error code. If the latter, - the module should return that error code. The second parameter - selects the policy to apply if the request message indicates a - body, and how a chunked - transfer-coding should be interpreted. Choose one of -
    -    REQUEST_NO_BODY          Send 413 error if message has any body
    -    REQUEST_CHUNKED_ERROR    Send 411 error if body without Content-Length
    -    REQUEST_CHUNKED_DECHUNK  If chunked, remove the chunks for me.
    -    REQUEST_CHUNKED_PASS     Pass the chunks to me without removal.
    -
    - In order to use the last two options, the caller MUST provide a buffer - large enough to hold a chunk-size line, including any extensions. - - - -
  2. When you are ready to possibly accept input, call - ap_should_client_block(). - This will tell the module whether or not to read input. If it is 0, - the module should assume that the input is of a non-entity type - (e.g., a GET request). A nonzero response indicates that the module - should proceed (to step 3). - This step also sends a 100 Continue response - to HTTP/1.1 clients, so should not be called until the module - is *definitely* ready to read content. (otherwise, the - point of the - 100 response is defeated). Never call this function more than once. - -
  3. Finally, call ap_get_client_block in a loop. Pass it a - buffer and its - size. It will put data into the buffer (not necessarily the full - buffer, in the case of chunked inputs), and return the length of - the input block. When it is done reading, it will - return 0 if EOF, or -1 if there was an error. - -
- -

As an example, please look at the code in -mod_cgi.c. This is properly written to the new API -guidelines.

- - - - diff --git a/docs/manual/misc/compat_notes.html b/docs/manual/misc/compat_notes.html deleted file mode 100644 index 438d90ecec..0000000000 --- a/docs/manual/misc/compat_notes.html +++ /dev/null @@ -1,135 +0,0 @@ - - - -Apache HTTP Server: Notes about Compatibility with NCSA's Server - - - - - -
Warning: -This document has not been updated to take into account changes -made in the 2.0 version of the Apache HTTP Server. Some of the -information may still be relevant, but please use it -with care. -
- - -

Compatibility Notes with NCSA's Server

- -
- -While Apache is for the most part a drop-in replacement for NCSA's -httpd, there are a couple gotcha's to watch out for. These are mostly -due to the fact that the parser for config and access control files -was rewritten from scratch, so certain liberties the earlier servers -took may not be available here. These are all easily fixable. If you -know of other problems that belong here, let us know. - -

Please also check the known -client problems page. - -

    -
  1. As of Apache 1.3.1, methods named in a - <Limit> - section must be listed in upper-case. Lower- or mixed-case - method names will result in a configuration error. -

    -

    -
  2. - -
  3. The basic mod_auth AuthGroupFile-specified group file - format allows commas between user names - Apache does not. - -

    -

  4. If you follow the NCSA guidelines for setting up access - restrictions based on client domain, you may well have added - entries for AuthType, AuthName, AuthUserFile or - AuthGroupFile. None of these are - needed (or appropriate) for restricting access based on client - domain. When Apache sees AuthType it (reasonably) - assumes you are using some authorization type based on username - and password. Please remove AuthType, it's - unnecessary even for NCSA. - -

    -

  5. OldScriptAlias is no longer supported. - -

    -

  6. exec cgi="" produces reasonable malformed - header responses when used to invoke non-CGI scripts.
    - The NCSA code ignores the missing header (bad idea). -
    Solution: write CGI to the CGI spec and use - include virtual, or use exec cmd="" instead. - -

    -

  7. Icons for FancyIndexing broken - well, no, they're not broken, - we've just upgraded the icons from flat .xbm files to pretty and - much smaller .gif files, courtesy of Kevin Hughes at EIT. If you are using the same - srm.conf from an old distribution, make sure you add the new AddIcon, AddIconByType, - and DefaultIcon - directives. - -

    -

  8. Apache versions before 1.2b1 will ignore the last line of configuration - files if the last line does not have a trailing newline. This affects - configuration files (httpd.conf, access.conf and srm.conf), and - htpasswd and htgroup files. - -

    -

  9. Apache does not permit commas delimiting the methods in <Limit>. - -

    -

  10. Apache's <VirtualHost> treats all addresses as - "optional" (i.e., the server should continue booting if it can't - resolve the address). Whereas in NCSA the default is to fail - booting unless an added optional keyword is included. - -

    -

  11. Apache does not implement OnDeny; use - ErrorDocument - instead. - -

    -

  12. Apache (as of 1.3) always performs the equivalent of - HostnameLookups minimal. minimal is not an - option to - HostnameLookups. - -

    -

  13. To embed spaces in directive arguments NCSA used a backslash - before the space. Apache treats backslashes as normal characters. To - embed spaces surround the argument with double-quotes instead. - -

    -

  14. Apache does not implement the NCSA referer - directive. See - PR#968 for a few brief suggestions on alternative ways to - implement the same thing under Apache. - -

    -

  15. Apache does not allow ServerRoot settings inside a VirtualHost - container. There is only one global ServerRoot in Apache; any desired - changes in paths for virtual hosts need to be made with the explicit - directives, e.g., DocumentRoot, TransferLog, etc. - -
- -More to come when we notice them.... - - - - diff --git a/docs/manual/misc/howto.html b/docs/manual/misc/howto.html deleted file mode 100644 index 57c9f2dfa8..0000000000 --- a/docs/manual/misc/howto.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - -Apache HOWTO documentation - - - - - -

Apache HOWTO documentation

- -How to: - - -
-

How to redirect an entire server or directory to a -single URL

- -

There are two chief ways to redirect all requests for an entire -server to a single location: one which requires the use of -mod_rewrite, and another which uses a CGI script. - -

First: if all you need to do is migrate a server from one name to -another, simply use the Redirect directive, as supplied -by mod_alias: - -

-  Redirect / http://www.apache.org/
-
- -

Since Redirect will forward along the complete path, -however, it may not be appropriate - for example, when the directory -structure has changed after the move, and you simply want to direct people -to the home page. - -

The best option is to use the standard Apache module -mod_rewrite. -If that module is compiled in, the following lines - -

RewriteEngine On
-RewriteRule /.* http://www.apache.org/ [R]
-
- -will send an HTTP 302 Redirect back to the client, and no matter -what they gave in the original URL, they'll be sent to -"http://www.apache.org/". - -

The second option is to set up a ScriptAlias pointing to -a CGI script which outputs a 301 or 302 status and the -location -of the other server.

- -

By using a CGI script you can intercept various requests -and -treat them specially, e.g., you might want to intercept -POST -requests, so that the client isn't redirected to a script on the other -server which expects POST information (a redirect will lose the POST -information.) You might also want to use a CGI script if you don't -want to compile mod_rewrite into your server. - -

Here's how to redirect all requests to a script... In the server -configuration file, -

ScriptAlias / /usr/local/httpd/cgi-bin/redirect_script/
-
- -and here's a simple perl script to redirect requests: - -
-#!/usr/local/bin/perl
-
-print "Status: 302 Moved Temporarily\r\n" .
-      "Location: http://www.some.where.else.com/\r\n" .
-      "\r\n";
-
-
- -
- -

How to reset your log files

- -

Sooner or later, you'll want to reset your log files (access_log and -error_log) because they are too big, or full of old information you don't -need.

- -

access.log typically grows by 1Mb for each 10,000 requests.

- -

Most people's first attempt at replacing the logfile is to just move the -logfile or remove the logfile. This doesn't work.

- -

Apache will continue writing to the logfile at the same offset as before the -logfile moved. This results in a new logfile being created which is just -as big as the old one, but it now contains thousands (or millions) of null -characters.

- -

The correct procedure is to move the logfile, then signal Apache to tell -it to reopen the logfiles.

- -

Apache is signaled using the SIGHUP (-1) signal. -e.g. -

-mv access_log access_log.old
-kill -1 `cat httpd.pid` -
- -

Note: httpd.pid is a file containing the -process id -of the Apache httpd daemon, Apache saves this in the same directory as the log -files.

- -

Many people use this method to replace (and backup) their logfiles on a -nightly or weekly basis.

-
- -

How to stop or restrict robots

- -

Ever wondered why so many clients are interested in a file called -robots.txt which you don't have, and never did have?

- -

These clients are called robots (also known as crawlers, -spiders and other cute names) - special automated clients which -wander around the web looking for interesting resources.

- -

Most robots are used to generate some kind of web index which -is then used by a search engine to help locate information.

- -

robots.txt provides a means to request that robots limit their -activities at the site, or more often than not, to leave the site alone.

- -

When the first robots were developed, they had a bad reputation for -sending hundreds/thousands of requests to each site, often resulting -in the site being overloaded. Things have improved dramatically since -then, thanks to -Guidelines for Robot Writers, but even so, some robots may exhibit -unfriendly behavior which the webmaster isn't willing to tolerate, and -will want to stop.

- -

Another reason some webmasters want to block access to robots, is to -stop them indexing dynamic information. Many search engines will use the -data collected from your pages for months to come - not much use if you're -serving stock quotes, news, weather reports or anything else that will be -stale by the time people find it in a search engine.

- -

If you decide to exclude robots completely, or just limit the areas -in which they can roam, create a robots.txt file; refer -to the robot information pages provided by Martijn Koster for the syntax.

- -
-

How to proxy SSL requests through - your non-SSL Apache server -
- (submitted by David Sedlock) -

-

-SSL uses port 443 for requests for secure pages. If your browser just -sits there for a long time when you attempt to access a secure page -over your Apache proxy, then the proxy may not be configured to handle -SSL. You need to instruct Apache to listen on port 443 in addition to -any of the ports on which it is already listening: -

-
-    Listen 80
-    Listen 443
-
-

-Then set the security proxy in your browser to 443. That might be it! -

-

-If your proxy is sending requests to another proxy, then you may have -to set the directive ProxyRemote differently. Here are my settings: -

-
-    ProxyRemote http://nicklas:80/ http://proxy.mayn.franken.de:8080
-    ProxyRemote http://nicklas:443/ http://proxy.mayn.franken.de:443
-
-

-Requests on port 80 of my proxy nicklas are forwarded to -proxy.mayn.franken.de:8080, while requests on port 443 are -forwarded to proxy.mayn.franken.de:443. -If the remote proxy is not set up to -handle port 443, then the last directive can be left out. SSL requests -will only go over the first proxy. -

-

-Note that your Apache does NOT have to be set up to serve secure pages -with SSL. Proxying SSL is a different thing from using it. -

- - - diff --git a/docs/manual/misc/index.html b/docs/manual/misc/index.html index 2893b456c4..99e53c089a 100644 --- a/docs/manual/misc/index.html +++ b/docs/manual/misc/index.html @@ -32,19 +32,6 @@
Frequently-Asked Questions concerning the Apache project and server.
-
Reading Client Input in Apache 1.2 -
-
Describes differences between Apache 1.1 and 1.2 in how modules - read information from the client. -
-
Compatibility with NCSA -
-
Notes about Apache's compatibility with the NCSA server. -
How to use XSSI and Negotiation for custom ErrorDocuments
@@ -65,13 +52,6 @@
A description of the causes of Apache processes going into the FIN_WAIT_2 state, and what you can do about it.
-
"How-To" -
-
Instructions about how to accomplish some commonly-desired server - functionality changes. -
Known Client Problems diff --git a/docs/manual/platform/netware.html b/docs/manual/platform/netware.html deleted file mode 100644 index 6e3aa68b0a..0000000000 --- a/docs/manual/platform/netware.html +++ /dev/null @@ -1,285 +0,0 @@ - - - -Using Apache with Novell NetWare 5 - - - - - - -
Warning: -This document has not been updated to take into account changes -made in the 2.0 version of the Apache HTTP Server. Some of the -information may still be relevant, but please use it -with care. -
- -

Using Apache With Novell NetWare 5

- -

This document explains how to install, configure and run - Apache 1.3 under Novell NetWare 5. Please note that at - this time, NetWare support is entirely experimental, and is - recommended only for experienced users. The Apache Group does not - guarantee that this software will work as documented, or even at - all. If you find any bugs, or wish to contribute in other ways, please - use our bug reporting - page.

- -

Warning: Apache on NetWare has not yet been optimized for performance. -Apache still performs best, and is most reliable on Unix platforms. Over -time we will improve NetWare performance. Folks doing comparative reviews -of webserver performance are asked to compare against Apache -on a Unix platform such as Solaris, FreeBSD, or Linux.

- -

- -Most of this document assumes that you are installing Apache from a -binary distribution. If you want to compile Apache yourself (possibly -to help with development, or to track down bugs), see the section on -Compiling Apache for NetWare below. - -


- - - -
- -

Requirements

- -Apache 1.3 is designed to run on NetWare 5.0 and 5.1. -

- -If running on NetWare 5.0 you must install Service Pack 4. - -

-

- -Service pack 4 is available here. - -

Downloading Apache for NetWare 5

- -

Information on the latest version of Apache can be found on the -Apache web server at http://www.apache.org/. This will -list the current release, any more recent alpha or beta-test releases, -together with details of mirror web and anonymous ftp sites.

- -

-

Installing Apache for NetWare

- -There is no Apache install program for NetWare currently. You will need -to compile apache and copy the files over to the server manually. An -install program will be posted at a later date. -

-Follow these steps to install Apache on NetWare (assuming you will install to sys:/apache): - -

- -

Apache may be installed to other volumes besides the default sys volume. - -

Running Apache for NetWare

- -To start Apache just type apache at the console. This -will load apache in the OS address space. If you prefer to load -Apache in a protected address space you may specify the address space -with the load statement as follows: -

-

-    load address space = apache apache
-
-

-This will load Apache into an address space called apache. Running multiple instances -of Apache concurrently on NetWare is possible by loading each instance into its own -protected address space. - -

-After starting Apache it will be listening to port 80 (unless you -changed the Port, Listen or -BindAddress directives in the configuration files). -To connect to the server and access the default page, launch a browser -and enter the server's name or address. - -This should respond with a welcome page, and a link to the Apache -manual. If nothing happens or you get an error, look in the -error_log file in the logs directory. - -

- -Once your basic installation is working, you should configure it -properly by editing the files in the conf directory. - -

-To unload Apache running in the OS address space just type the -following at the console: -

-    unload apache
-
-If apache is running in a protected address space specify the -address space in the unload statement: -
-    unload address space = apache apache
-
- -

-When working with Apache it is important to know how it will find the -configuration files. You can specify a configuration file on the command line -in two ways: - -

-
    apache -f "vol:/my server/conf/my.conf"
-
    apache -f test/test.conf
- -In these cases, the proper ServerRoot should be set in the configuration file. - -

- -If you don't specify a configuration file name with -f, Apache will -use the file name compiled into the server, usually "conf/httpd.conf". Invoking -Apache with the -V switch will display this value labeled as SERVER_CONFIG_FILE. -Apache will then determine its ServerRoot by trying the following, in this order: - -

- -

-The server root compiled into the server is usually "sys:/apache". -invoking apache with the -V switch will display this value -labeled as HTTPD_ROOT. - -

Configuring Apache for NetWare

- -Apache is configured by files in the conf -directory. These are the same as files used to configure the Unix -version, but there are a few different directives for Apache on -NetWare. See the Apache documentation for all the -available directives. - -

- -The main differences in Apache for NetWare are: - -

- -

Compiling Apache for NetWare

- -

Compiling Apache requires MetroWerks CodeWarrior 5 to be properly - installed. - -

First, unpack the Apache distribution into an appropriate - directory. Then go to the src subdirectory of the Apache - distribution and unzip ApacheNW.mcp.gz. You may use a - recent version of WinZip to accomplish this or gzip for Windows. The main - Metrowerks project file for Apache (ApacheNW.mcp) is now ready - to use. Just double click on it from within explorer and it should - automatically launch MetroWerks CodeWarrior. -

- -

All major pieces of Apache may be built using the ApacheNW.mcp project - file. This includes modules such as status, info, and proxy. In addition, - the following project files have been provided as well:

- -
   
-       /apache-1.3/src/support/htpasswd.mcp.gz
-       /apache-1.3/src/support/htdigest.mcp.gz
-
- -

htpasswd.mcp.gz and htdigest.mcp.gz will also need -to be unzipped before they can be used with MetroWerks CodeWarrior.

- -

Once Apache has been compiled, it needs to be installed in its server - root directory. The default is the sys:/Apache - directory.

-

-Before running the server you must fill out the conf directory. -Copy the *.conf-dist-nw from the distribution conf directory -and rename *.conf. Edit the ServerRoot entries to your -actual server root (for example "sys:/apache"). Copy over -the conf/magic and conf/mime.types files as well.

- - - - - diff --git a/docs/manual/platform/perf-bsd44.html b/docs/manual/platform/perf-bsd44.html deleted file mode 100644 index dd94d677e0..0000000000 --- a/docs/manual/platform/perf-bsd44.html +++ /dev/null @@ -1,262 +0,0 @@ - - - -Running a High-Performance Web Server for BSD - - - - - - - -
Warning: -This document has not been updated to take into account changes -made in the 2.0 version of the Apache HTTP Server. Some of the -information may still be relevant, but please use it -with care. -
- - -

Running a High-Performance Web Server for BSD

- -Like other OS's, the listen queue is often the first limit -hit. The -following are comments from "Aaron Gifford <agifford@InfoWest.COM>" -on how to fix this on BSDI 1.x, 2.x, and FreeBSD 2.0 (and earlier): - -

- -Edit the following two files: -

/usr/include/sys/socket.h
- /usr/src/sys/sys/socket.h
-In each file, look for the following: -
-    /*
-     * Maximum queue length specifiable by listen.
-     */
-    #define SOMAXCONN       5
-
- -Just change the "5" to whatever appears to work. I bumped the two -machines I was having problems with up to 32 and haven't noticed the -problem since. - -

- -After the edit, recompile the kernel and recompile the Apache server -then reboot. - -

- -FreeBSD 2.1 seems to be perfectly happy, with SOMAXCONN -set to 32 already. - -

- - -Addendum for very heavily loaded BSD servers
-
-from Chuck Murcko <chuck@telebase.com> - -

- -If you're running a really busy BSD Apache server, the following are useful -things to do if the system is acting sluggish:

- -

- -These utilities give you an idea what you'll need to tune in your kernel, -and whether it'll help to buy more RAM. - -Here are some BSD kernel config parameters (actually BSDI, but pertinent to -FreeBSD and other 4.4-lite derivatives) from a system getting heavy usage. -The tools mentioned above were used, and the system memory was increased to -48 MB before these tuneups. Other system parameters remained unchanged. - -

- -

-maxusers        256
-
- -Maxusers drives a lot of other kernel parameters: - - - -The actual formulae for these derived parameters are in -/usr/src/sys/conf/param.c. -These calculated parameters can also be overridden (in part) by specifying -your own values in the kernel configuration file: - -
-# Network options. NMBCLUSTERS defines the number of mbuf clusters and
-# defaults to 256. This machine is a server that handles lots of traffic,
-# so we crank that value.
-options         NMBCLUSTERS=4096        # mbuf clusters at 4096
-
-#
-# Misc. options
-#
-options         CHILD_MAX=512           # maximum number of child processes
-options         OPEN_MAX=512            # maximum fds (breaks RPC svcs)
-
- -

- -In many cases, NMBCLUSTERS must be set much larger than would appear -necessary at first glance. The reason for this is that if the browser -disconnects in mid-transfer, the socket fd associated with that particular -connection ends up in the TIME_WAIT state for several minutes, during -which time its mbufs are not yet freed. Another reason is that, on server -timeouts, some connections end up in FIN_WAIT_2 state forever, because -this state doesn't time out on the server, and the browser never sent -a final FIN. For more details see the -FIN_WAIT_2 page. - -

- -Some more info on mbuf clusters (from sys/mbuf.h): -

-/*
- * Mbufs are of a single size, MSIZE (machine/machparam.h), which
- * includes overhead.  An mbuf may add a single "mbuf cluster" of size
- * MCLBYTES (also in machine/machparam.h), which has no additional overhead
- * and is used instead of the internal data area; this is done when
- * at least MINCLSIZE of data must be stored.
- */
-
- -

- -CHILD_MAX and OPEN_MAX are set to allow up to 512 child processes (different -than the maximum value for processes per user ID) and file descriptors. -These values may change for your particular configuration (a higher OPEN_MAX -value if you've got modules or CGI scripts opening lots of connections or -files). If you've got a lot of other activity besides httpd on the same -machine, you'll have to set NPROC higher still. In this example, the NPROC -value derived from maxusers proved sufficient for our load. - -

- -To increase the size of the listen() queue, you need to -adjust the value of SOMAXCONN. SOMAXCONN is not derived from maxusers, -so you'll always need to increase that yourself. We use a value guaranteed -to be larger than Apache's default for the listen() of 128, currently. -The actual value for SOMAXCONN is set in sys/socket.h. -The best way to adjust this parameter is run-time, rather than changing -it in this header file and thus hardcoding a value in the kernel and -elsewhere. To do this, edit /etc/rc.local and add the -following line: -

-    /usr/sbin/sysctl -w kern.somaxconn=256
-
- -

- -We used 256 but you can tune it for your own setup. In -many cases, however, even the default value of 128 (for -later versions of FreeBSD) is OK. - -

- -Caveats - -

- -Be aware that your system may not boot with a kernel that is configured -to use more resources than you have available system RAM. -ALWAYS -have a known bootable kernel available when tuning your system this way, -and use the system tools beforehand to learn if you need to buy more -memory before tuning. - -

- -RPC services will fail when the value of OPEN_MAX is larger than 256. -This is a function of the original implementations of the RPC library, -which used a byte value for holding file descriptors. BSDI has partially -addressed this limit in its 2.1 release, but a real fix may well await -the redesign of RPC itself. - -

- -Finally, there's the hard limit of child processes configured in Apache. - -

- -For versions of Apache later than 1.0.5 you'll need to change the -definition for HARD_SERVER_LIMIT in httpd.h and -recompile if you need to run more than the default 150 instances of httpd. - -

- -From conf/httpd.conf-dist: - -

-# Limit on total number of servers running, i.e., limit on the number
-# of clients who can simultaneously connect --- if this limit is ever
-# reached, clients will be LOCKED OUT, so it should NOT BE SET TOO LOW.
-# It is intended mainly as a brake to keep a runaway server from taking
-# Unix with it as it spirals down...
-
-MaxClients 150
-
- -Know what you're doing if you bump this value up, and make sure you've -done your system monitoring, RAM expansion, and kernel tuning beforehand. -Then you're ready to service some serious hits! - -

- -Thanks to Tony Sanders and Chris Torek at BSDI for their -helpful suggestions and information. - -

- -"M. Teterin" <mi@ALDAN.ziplink.net> writes:

-

It really does help if your kernel and frequently used utilities -are fully optimized. Rebuilding the FreeBSD kernel on an AMD-133 -(486-class CPU) web-server with
- -m486 -fexpensive-optimizations -fomit-frame-pointer -O2
-helped reduce the number of "unable" errors, because the CPU was -often maxed out.
-

- -


- -

More welcome!

- -If you have tips to contribute, send mail to -apache@apache.org - - - - diff --git a/docs/manual/platform/perf-dec.html b/docs/manual/platform/perf-dec.html deleted file mode 100644 index e2b8c30d2b..0000000000 --- a/docs/manual/platform/perf-dec.html +++ /dev/null @@ -1,286 +0,0 @@ - - - -Performance Tuning Tips for Digital Unix - - - - -

Performance Tuning Tips for Digital Unix

- -Below is a set of newsgroup posts made by an engineer from DEC in -response to queries about how to modify DEC's Digital Unix OS for more -heavily loaded web sites. Copied with permission. - -
- -

Update

-From: Jeffrey Mogul <mogul@pa.dec.com>
-Date: Fri, 28 Jun 96 16:07:56 MDT
- -
    -
  1. The advice given in the README file regarding the - "tcbhashsize" variable is incorrect. The largest value - this should be set to is 1024. Setting it any higher - will have the perverse result of disabling the hashing - mechanism. - -
  2. Patch ID OSF350-146 has been superseded by -
    - Patch ID OSF350-195 for V3.2C
    - Patch ID OSF360-350195 for V3.2D -
    - Patch IDs for V3.2E and V3.2F should be available soon. - There is no known reason why the Patch ID OSF360-350195 - won't work on these releases, but such use is not officially - supported by Digital. This patch kit will not be needed for - V3.2G when it is released. -
-
- - -
-From           mogul@pa.dec.com (Jeffrey Mogul)
-Organization   DEC Western Research
-Date           30 May 1996 00:50:25 GMT
-Newsgroups     comp.unix.osf.osf1
-Message-ID     <4oirch$bc8@usenet.pa.dec.com>
-Subject        Re: Web Site Performance
-References     1
-
-
-
-In article <skoogDs54BH.9pF@netcom.com> skoog@netcom.com (Jim Skoog) writes:
->Where are the performance bottlenecks for Alpha AXP running the
->Netscape Commerce Server 1.12 with high volume internet traffic?
->We are evaluating network performance for a variety of Alpha AXP
->running DEC UNIX 3.2C, which run DEC's seal firewall and behind
->that Alpha 1000 and 2100 webservers.
-
-Our experience (running such Web servers as altavista.digital.com
-and www.digital.com) is that there is one important kernel tuning
-knob to adjust in order to get good performance on V3.2C.  You
-need to patch the kernel global variable "somaxconn" (use dbx -k
-to do this) from its default value of 8 to something much larger.
-
-How much larger?  Well, no larger than 32767 (decimal).  And
-probably no less than about 2048, if you have a really high volume
-(millions of hits per day), like AltaVista does.
-
-This change allows the system to maintain more than 8 TCP
-connections in the SYN_RCVD state for the HTTP server.  (You
-can use "netstat -An |grep SYN_RCVD" to see how many such
-connections exist at any given instant).
-
-If you don't make this change, you might find that as the load gets
-high, some connection attempts take a very long time.  And if a lot
-of your clients disconnect from the Internet during the process of
-TCP connection establishment (this happens a lot with dialup
-users), these "embryonic" connections might tie up your somaxconn
-quota of SYN_RCVD-state connections.  Until the kernel times out
-these embryonic connections, no other connections will be accepted,
-and it will appear as if the server has died.
-
-The default value for somaxconn in Digital UNIX V4.0 will be quite
-a bit larger than it has been in previous versions (we inherited
-this default from 4.3BSD).
-
-Digital UNIX V4.0 includes some other performance-related changes
-that significantly improve its maximum HTTP connection rate.  However,
-we've been using V3.2C systems to front-end for altavista.digital.com
-with no obvious performance bottlenecks at the millions-of-hits-per-day
-level.
-
-We have some Webstone performance results available at
-        http://www.digital.com/info/alphaserver/news/webff.html
-
-[The document referenced above is no longer at that URL -- Ed.]
-
-I'm not sure if these were done using V4.0 or an earlier version
-of Digital UNIX, although I suspect they were done using a test
-version of V4.0.
-
--Jeff
-
- -
- -
----------------------------------------------------------------------------
-
-From           mogul@pa.dec.com (Jeffrey Mogul)
-Organization   DEC Western Research
-Date           31 May 1996 21:01:01 GMT
-Newsgroups     comp.unix.osf.osf1
-Message-ID     <4onmmd$mmd@usenet.pa.dec.com>
-Subject        Digital UNIX V3.2C Internet tuning patch info
-
-----------------------------------------------------------------------------
-
-Something that probably few people are aware of is that Digital
-has a patch kit available for Digital UNIX V3.2C that may improve
-Internet performance, especially for busy web servers.
-
-This patch kit is one way to increase the value of somaxconn,
-which I discussed in a message here a day or two ago.
-
-I've included in this message the revised README file for this
-patch kit below.  Note that the original README file in the patch
-kit itself may be an earlier version; I'm told that the version
-below is the right one.
-
-Sorry, this patch kit is NOT available for other versions of Digital
-UNIX.  Most (but not quite all) of these changes also made it into V4.0,
-so the description of the various tuning parameters in this README
-file might be useful to people running V4.0 systems.
-
-This patch kit does not appear to be available (yet?) from
-        http://www.service.digital.com/html/patch_service.html
-so I guess you'll have to call Digital's Customer Support to get it.
-
--Jeff
-
-DESCRIPTION: Digital UNIX Network tuning patch
-
-             Patch ID: OSF350-146
-
-             SUPERSEDED PATCHES: OSF350-151, OSF350-158
-
-        This set of files improves the performance of the network
-        subsystem on a system being used as a web server.  There are
-        additional tunable parameters included here, to be used
-        cautiously by an informed system administrator.
-
-TUNING
-
-        To tune the web server, the number of simultaneous socket
-        connection requests are limited by:
-
-        somaxconn               Sets the maximum number of pending requests
-                                allowed to wait on a listening socket.  The
-                                default value in Digital UNIX V3.2 is 8.
-                                This patch kit increases the default to 1024,
-                                which matches the value in Digital UNIX V4.0.
-
-        sominconn               Sets the minimum number of pending connections
-                                allowed on a listening socket.  When a user
-                                process calls listen with a backlog less
-                                than sominconn, the backlog will be set to
-                                sominconn.  sominconn overrides somaxconn.
-                                The default value is 1.
-
-        The effectiveness of tuning these parameters can be monitored by
-        the sobacklog variables available in the kernel:
-
-        sobacklog_hiwat         Tracks the maximum pending requests to any
-                                socket.  The initial value is 0.
-
-        sobacklog_drops         Tracks the number of drops exceeding the
-                                socket set backlog limit.  The initial
-                                value is 0.
-
-        somaxconn_drops         Tracks the number of drops exceeding the
-                                somaxconn limit.  When sominconn is larger
-                                than somaxconn, tracks the number of drops
-                                exceeding sominconn.  The initial value is 0.
-
-        TCP timer parameters also affect performance. Tuning the following
-        require some knowledge of the characteristics of the network.
-
-        tcp_msl                 Sets the tcp maximum segment lifetime.
-                                This is the maximum lifetime in half
-                                seconds that a packet can be in transit
-                                on the network.  This value, when doubled,
-                                is the length of time a connection remains
-                                in the TIME_WAIT state after a incoming
-                                close request is processed.  The unit is
-                                specified in 1/2 seconds, the initial
-                                value is 60.
-
-        tcp_rexmit_interval_min
-                                Sets the minimum TCP retransmit interval.
-                                For some WAN networks the default value may
-                                be too short, causing unnecessary duplicate
-                                packets to be sent.  The unit is specified
-                                in 1/2 seconds, the initial value is 1.
-
-        tcp_keepinit            This is the amount of time a partially
-                                established connection will sit on the listen
-                                queue before timing out (e.g., if a client
-                                sends a SYN but never answers our SYN/ACK).
-                                Partially established connections tie up slots
-                                on the listen queue.  If the queue starts to
-                                fill with connections in SYN_RCVD state,
-                                tcp_keepinit can be decreased to make those
-                                partial connects time out sooner.  This should
-                                be used with caution, since there might be
-                                legitimate clients that are taking a while
-                                to respond to SYN/ACK.  The unit is specified
-                                in 1/2 seconds, the default value is 150
-                                (ie. 75 seconds).
-
-        The hashlist size for the TCP inpcb lookup table is regulated by:
-
-        tcbhashsize             The number of hash buckets used for the
-                                TCP connection table used in the kernel.
-                                The initial value is 32.  For best results,
-                                should be specified as a power of 2.  For
-                                busy Web servers, set this to 2048 or more.
-
-        The hashlist size for the interface alias table is regulated by:
-
-        inifaddr_hsize          The number of hash buckets used for the
-                                interface alias table used in the kernel.
-                                The initial value is 32.  For best results,
-                                should be specified as a power of 2.
-
-        ipport_userreserved     The maximum number of concurrent non-reserved,
-                                dynamically allocated ports.  Default range
-                                is 1025-5000.  The maximum value is 65535.
-                                This limits the number of times you can
-                                simultaneously telnet or ftp out to connect
-                                to other systems.
-
-        tcpnodelack             Don't delay acknowledging TCP data; this
-                                can sometimes improve performance of locally
-                                run CAD packages.  Default is value is 0,
-                                the enabled value is 1.
-
-                           Digital UNIX version:
-
-                                  V3.2C
-Feature                    V3.2C  patch  V4.0
-=======                    =====  =====  ====
-somaxconn                   X      X      X
-sominconn                   -      X      X
-sobacklog_hiwat             -      X      -
-sobacklog_drops             -      X      -
-somaxconn_drops             -      X      -
-tcpnodelack                 X      X      X
-tcp_keepidle                X      X      X
-tcp_keepintvl               X      X      X
-tcp_keepcnt                 -      X      X
-tcp_keepinit                -      X      X
-TCP keepalive per-socket    -      -      X
-tcp_msl                     -      X      -
-tcp_rexmit_interval_min     -      X      -
-TCP inpcb hashing           -      X      X
-tcbhashsize                 -      X      X
-interface alias hashing     -      X      X
-inifaddr_hsize              -      X      X
-ipport_userreserved         -      X      -
-sysconfig -q inet           -      -      X
-sysconfig -q socket         -      -      X
-
- - - - diff --git a/docs/manual/platform/perf.html b/docs/manual/platform/perf.html deleted file mode 100644 index 73bd5b5b20..0000000000 --- a/docs/manual/platform/perf.html +++ /dev/null @@ -1,175 +0,0 @@ - - - -Hints on Running a High-Performance Web Server - - - - - -

Hints on Running a High-Performance Web Server

- -Running Apache on a heavily loaded web server, one often encounters -problems related to the machine and OS configuration. "Heavy" is -relative, of course - but if you are seeing more than a couple hits -per second on a sustained basis you should consult the pointers on -this page. In general the suggestions involve how to tune your kernel -for the heavier TCP load, hardware/software conflicts that arise, etc. - - - -
- -

-A/UX (Apple's UNIX) -

- -If you are running Apache on A/UX, a page that gives some helpful -performance hints (concerning the listen() queue and using -virtual hosts) -can be found here - -


- -

-BSD-based (BSDI, FreeBSD, etc) -

- -Quick and -detailed -performance tuning hints for BSD-derived systems. - -


- -

-Digital UNIX -

- - - -


- -

-Linux -

- -There are no known problems with heavily loaded systems running Linux -kernels 2.0.32 or later. Earlier kernels have some problems, and an -upgrade to the latest 2.0.x is a good idea to eliminate various security -and denial of service attacks. - -


- -

-Solaris 2.4 -

- -The Solaris 2.4 TCP implementation has a few inherent limitations that -only became apparent under heavy loads. This has been fixed to some -extent in 2.5 (and completely revamped in 2.6), but for now consult -the following URL for tips on how to expand the capabilities if you -are finding slowdowns and lags are hurting performance. - -

- -Other links: - -

- -


- -

-SunOS 4.x -

- -More information on tuning SOMAXCONN on SunOS can be found at - -http://www.islandnet.com/~mark/somaxconn.html. - -


- -

-SVR4 -

- -Some SVR4 versions waste three system calls on every -gettimeofday() call. Depending on the syntactic -form of the TZ environment variable, these -systems have several different algorithms to determine the -local time zone (presumably compatible with -something). The following example uses the central european -time zone to demonstrate this: -
-
TZ=:MET -
This form delegates the knowledge of the time zone - information to an external compiled zoneinfo file - (à la BSD).
- Caveat: Each time the gettimeofday() - function is called, the external zone info is read in - again (at least on some SVR4 systems). That results in - three wasted system calls with every apache request - served.
-     open("/usr/lib/locale/TZ/MET", O_RDONLY) = 3
-     read(3, "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0"..., 7944) = 778
-     close(3)                                = 0
- -
TZ=MET-1MDT,M3.5.0/02:00:00,M10.5.0/03:00:00 -
This syntax form (à la SYSV) contains all the - knowledge about time zone beginning and ending times in - its external representation. It has to be parsed each - time it is evaluated, resulting in a slight computing - overhead, but it requires no system call. Though the - table lookup à la BSD is the more sophisticated - technical solution, the bad SVR4 implementation makes - this the preferred syntax on systems which otherwise - access the external zone info file repeatedly. -
-You should use the truss utility on a -single-process apache server (started with the -X -debugging switch) to determine whether your system can profit -from the second form of the TZ environment -variable. If it does, you could integrate the setting of the -preferred TZ syntax into the httpd startup -script, which is usually simply a copy of (or symbolic link -to) the apachectl utility script, or into the -system's /etc/TIMEZONE script. - -


- -

More welcome!

- -If you have tips to contribute, send mail to apache@apache.org - - - - diff --git a/docs/manual/platform/readme-tpf.html b/docs/manual/platform/readme-tpf.html deleted file mode 100644 index 6c89faee64..0000000000 --- a/docs/manual/platform/readme-tpf.html +++ /dev/null @@ -1,214 +0,0 @@ - - - -The Apache TPF Port - - - -
Warning: -This document has not been updated to take into account changes -made in the 2.0 version of the Apache HTTP Server. Some of the -information may still be relevant, but please use it -with care. -
-

Overview of the Apache TPF Port

-
-
Configuration Files -  | What's Available -  | Porting Notes ] -
-
-
- -

- This version of Apache includes changes allowing it to run on - IBM's EBCDIC-based - TPF - (Transaction Processing Facility) operating system. - Unless otherwise noted TPF version 4.1 PUT09 is required. -

- Refer to htdocs/manual/install-tpf.html - for step-by-step installation instructions. -

- As this is the first cut at making Apache run on TPF, - performance tuning has not been done. -

- This port builds upon the EBCDIC changes - previously made to Apache. -
-

- -  -

Apache Configuration Files

-

- The distributed configuration files (httpd.conf-dist and - mime.types, both located in the conf subdirectory) - work on TPF. Performance considerations may dictate setting KeepAlive to "Off" - (the default is "On") or lowering the Timeout value from the default - 300 seconds (5 minutes) in order to reduce the number of active ECBs on your system. -

- -  -

What's Available in this Version

- - (The Apache organization provides - online documentation - describing the various modules and components of the server.) - -

Components/modules tested on TPF:

- -
    -
  • alloc.c -
  • ap_base64.c -
  • ap_checkpass.c -
  • ap_cpystrn.c -
  • ap_fnmatch.c -
  • ap_md5c.c -
  • ap_sha1.c -
  • ap_signal.c -
  • ap_slack.c -
  • ap_snprintf.c -
  • buff.c -
  • buildmark.c -
  • ebcdic.c -
  • gen_test.char.c -
  • gen_uri_delims.c -
  • htpasswd.c (requires PUT10) -
  • http_config.c -
  • http_core.c -
  • http_log.c -
  • http_main.c -
  • http_protocol.c -
  • http_request.c -
  • http_vhost.c -
  • logresolve.c (requires PUT10) -
  • mod_access.c (see note 1) -
  • mod_actions.c -
  • mod_alias.c -
  • mod_asis.c -
  • mod_auth.c -
  • mod_auth_anon.c -
  • mod_autoindex.c -
  • mod_cern_meta.c -
  • mod_cgi.c (requires PUT10) -
  • mod_digest.c -
  • mod_dir.c -
  • mod_env.c -
  • mod_example.c -
  • mod_expires.c -
  • mod_headers.c -
  • mod_imap.c -
  • mod_include.c (see note 2) -
  • mod_info.c -
  • mod_log_agent.c -
  • mod_log_config.c -
  • mod_log_referer.c -
  • mod_mime.c -
  • mod_mime_magic.c -
  • mod_negotiation.c -
  • mod_put.c - (third party module) -
  • mod_proxy.c -
  • mod_setenvif.c -
  • mod_speling.c -
  • mod_status.c -
  • mod_tpf_shm_static.c (third party module, requires PUT10) -
  • mod_unique_id.c (requires PUT10) -
  • mod_userdir.c -
  • mod_usertrack.c -
  • os.c -
  • os-inline.c -
  • proxy_cache.c -
  • proxy_connect.c -
  • proxy_ftp.c -
  • proxy_http.c -
  • proxy_util.c -
  • regular expression parser -
  • regular expression test tool (requires PUT10) -
  • rfc1413.c -
  • rotatelogs.c (requires PUT10) -
  • util.c -
  • util_date.c -
  • util_md5.c -
  • util_script.c -
  • util_uri.c -
- Notes: -
    -
  1. Use of mod_access directives "Allow from" & "Deny from" - with host names (verses ip addresses) requires TPF version 4.1 PUT10 -
  2. CGI execution requires TPF version 4.1 PUT10 -
- -

Components/modules not yet supported on TPF:

- -
    -
  • htdigest.c -
  • lib/expat-lite -
  • mod_auth_digest.c -
  • mod_rewrite.c -
  • mod_vhost_alias.c -
- -

Components/modules that don't apply or that probably won't ever be available on TPF:

- -
    -
  • ab.c -
  • ap_getpass.c -
  • mod_auth_db.c -
  • mod_auth_dbm.c -
  • mod_auth_db.module -
  • mod_mmap_static.c -
  • mod_so.c -
  • suexec.c -
- -  -

Porting Notes

-

-

Changes made due to differences between UNIX and - TPF's process models:

- - -

Find that function...

-

Some simple functions & definitions initially needed to be added - on TPF, such as FD_SET(). - We've put these in src/os/tpf/os.h for now. -

- -

EBCDIC changes:

-

TPF-specific conversion tables between US-ASCII and - EBCDIC (character set IBM-1047 to be exact) were created - and put into ebcdic.c in the src/os/tpf directory. -

- -

Miscellaneous, minor changes:

-

Various minor changes (such as casting) were made due to - differences in how some functions are implemented on TPF. -

- -
-
top -  | Configuration Files -  | What's Available -  | Porting Notes ] -
- - - diff --git a/docs/manual/platform/unixware.html b/docs/manual/platform/unixware.html deleted file mode 100644 index cdb8c6a6b6..0000000000 --- a/docs/manual/platform/unixware.html +++ /dev/null @@ -1,69 +0,0 @@ - - - -Compiling Apache under UnixWare - - - - - - -
Warning: -This document has not been updated to take into account changes -made in the 2.0 version of the Apache HTTP Server. Some of the -information may still be relevant, but please use it -with care. -
- -

Compiling Apache under UnixWare

- -To compile a working copy of Apache under UnixWare, there are several other -steps you may need to take. These prevent such problems as zombie processes, -bind errors, and accept errors, to name a few. - -

UnixWare 1.x

- -Make sure that USE_FCNTL_SERIALIZE_ACCEPT is defined (if not -defined by Apache autoconfiguration). If using the UnixWare cc -compiler, and you still see accept() errors, don't use compiler optimization, -or get gcc. - -

UnixWare 2.0.x

- -SCO patch tf2163 is required -in order for Apache to work correctly on UnixWare 2.0.x. See -http://www.sco.com -for UnixWare patch information.

- -In addition, make sure that USE_FCNTL_SERIALIZE_ACCEPT is defined (if not -defined by Apache autoconfiguration). To reduce instances of connections -in FIN_WAIT_2 state, you may also want to define NO_LINGCLOSE (Apache 1.2 -only). - -

UnixWare 2.1.x

- -SCO patch ptf3123 is required -in order for Apache to work correctly on UnixWare 2.1.x. See -http://www.sco.com -for UnixWare patch information.

- -NOTE: Unixware 2.1.2 and later already have patch ptf3123 -included

- -In addition, make sure that USE_FCNTL_SERIALIZE_ACCEPT is defined (if not -defined by Apache autoconfiguration). To reduce instances of connections -in FIN_WAIT_2 state, you may also want to define NO_LINGCLOSE (Apache 1.2 -only).

- -Thanks to Joe Doupnik <JRD@cc.usu.edu> and Rich Vaughn -<rvaughn@aad.com> for additional info for UnixWare builds.

- - - - diff --git a/docs/manual/process-model.html b/docs/manual/process-model.html deleted file mode 100644 index cef934f239..0000000000 --- a/docs/manual/process-model.html +++ /dev/null @@ -1,76 +0,0 @@ - - -Server Pool Management - - - - - - -

Warning: -This document has not been updated to take into account changes -made in the 2.0 version of the Apache HTTP Server. Some of the -information may still be relevant, but please use it -with care. -
- -

Server Pool Management

- -
-

-We found that many people were using values for "MaxServers" either -too high or too low, and were hanging themselves on it. The model we -adopted is still based on long-lived minimal-forking processes, but -instead of specifying one number of persistent processes, the -web-master specifies a maximum and minimum number of processes to be -"spare" - every couple of seconds the parent checks the actual number -of spare servers and adjusts accordingly. This should keep the number -of servers concurrently running relatively low while still ensuring -minimal forking. - -

- -We renamed the current StartServers to MinSpareServers, created -separate StartServers parameter which means what it says, and renamed -MaxServers to MaxSpareServers (though the old name still works, for -NCSA 1.4 back-compatibility). The old names were generally regarded -as too confusing. - -

- -The defaults for each variable are: - -

-MinSpareServers         5
-MaxSpareServers         10
-StartServers            5
-
- -There is an absolute maximum number of simultaneous children defined -by a compile-time limit which defaults to 256 and a "MaxClients" -directive which specifies the number of simultaneous children that -will be allowed. MaxClients can be adjusted up to the compile-time -limit (HARD_SERVER_LIMIT, defined in httpd.h). If you need more -than 256 simultaneous children, you need to modify both HARD_SERVER_LIMIT -and MaxClients.

- -In versions before 1.2, HARD_SERVER_LIMIT defaulted to 150.

- -We do not recommend changing either of these values unless: - -

    -
  1. You know you have the server resources to handle more -
  2. You use the machine for other purposes and must limit the amount of memory -Apache uses -
- - - - -