Contains global variable settings that affect server functioning. This file is read only at server start-up.
server_root/https-admserv/config server_root/https-admserv/conf_bk server_root/https-server_id/config server_root/https-server_id/conf_bk
Init functions have the following syntax:
Init fn=function param1="value1" ...paramN="valueN"
In the following tableInit Functions, functions are in bold to distinguish them from parameters.
Directives have the following syntax:
directive value
Sun Java System Web Server 6.1 SP7 NSAPI Programmer’s Guide
The following table lists the Init functions available in the magnus.conf file:
Table 3–1 magnus.conf Init Functions
Function/Parameter |
Allowed Values |
Default Value |
Description |
---|---|---|---|
Changes the default characteristics for fancy indexing. |
|||
s |
(None) |
(optional) is a string of letters specifying the options to activate. Currently there is only one possible option:
|
|
Comma separated numbers of characters |
Minimums required to display column titles |
(optional) Specifies the width for each of the four columns in the indexing display: name, last-modified date, size, and description respectively. The final three values can each be set to 0 to turn the display for that column off. The name column cannot be turned off. |
|
GMT or local |
local |
(optional, iPlanet Web Server 4.x only) Indicates whether the last-modified time is shown in local time or in Greenwich Mean Time. |
|
Format for the UNIX function strftime() |
%d-%b-%Y %H:%M |
(optional, iPlanet Web Server 4.x only) Determines the format of the last modified date display. |
|
Wildcard pattern |
.* |
(optional) Specifies a wildcard pattern for file names the server should ignore while indexing. File names starting with a period (.) are always ignored. |
|
/mc-icons/ |
(optional) Specifies the URI prefix the index-common function uses when generating URLs for file icons (.gif files). If icon-uri is different from the default, the pfx2dir function in the NameTrans directive must be changed so that the server can find these icons. |
||
Creates a performance bucket, which you can use to measure the performance of SAFs in obj.conf (see the Sun Java System Web Server 6.1 SP7 NSAPI Programmer’s Guide). This function works only if the perf-init function is enabled. |
|||
A name for the bucket, for example cgi-bucket. |
|||
A description of what the bucket measures, for example CGI Stats. |
|||
Configures DNS caching. |
|||
32 to 32768 (32K) |
1024 |
(optional) Specifies how many entries are contained in the cache. |
|
1 to 31536000 seconds (1 year) |
1200 seconds (20 minutes) |
(optional) specifies how long (in seconds) it takes for a cache entry to expire. |
|
Initializes the flexible logging system. |
|||
logFileName |
A path or file name |
The full path to the log file or a file name relative to the server’s logs directory. In this example, the log file name is access and the path is /logdir/access: access="/logdir/access" |
|
Specifies the format of each log entry in the log file. See the Sun Java System Web Server 6.1 SP7 NSAPI Programmer’s Guide for more information. |
|||
Number of bytes |
8192 |
Specifies the size of the global log buffer. |
|
The lower bound is 1. There always needs to be at least one buffer per file. The upper bound is dictated by the number of buffers that exist. The upper bound on the number of buffers that exist can be defined by the num-buffers parameter. |
Determined by the server |
Specifies the number of buffers for a given log file |
|
1000 |
Specifies the maximum number of logging buffers to use. |
||
Enables rotation for logs. |
|||
A 4-digit string indicating the time in 24-hour format |
Indicates the time to start rotation. For example, 0900 indicates 9 am while 1800 indicates 9 pm. |
||
Number of minutes |
|
Indicates the number of minutes to elapse between each log rotation. |
|
yes, no |
yes |
(optional) determines whether common-log, flex-log, and record-useragent logs are rotated. For more information, see the Sun Java System Web Server 6.1 SP7 NSAPI Programmer’s Guide. |
|
yes, no |
yes |
(optional) determines whether error logs are rotated. |
|
A path |
(optional) specifies the file name of a user-supplied program to execute following log file rotation. The program is passed the post-rotation name of the rotated log file as its parameter. |
||
Changes the default settings for CGI programs. |
|||
Number of seconds |
300 |
(optional) specifies how many seconds the server waits for CGI output before terminating the script. |
|
|
(optional) specifies the path to the CGI stub binary. If not specified, iPlanet Web Server looks in the following directories, in the following order, relative to the server instance’s config directory: ../private/Cgistub, then ../../bin/https/bin/Cgistub. For information about installing an suid Cgistub, see the Sun Java System Web Server 6.1 SP7 NSAPI Programmer’s Guide. |
||
env-variable |
(optional) specifies the name and value for an environment variable that the server places into the environment for the CGI. |
||
Initializes the Common Log subsystem. |
|||
logFileName |
A path or file name |
Specifies either the full path to the log file or a file name relative to the server’s logs directory. |
|
Loads user home directory information. |
|||
(optional) specifies the full file system path to a file other than /etc/passwd. If not provided, the default UNIX path (/etc/passwd) is used. |
|||
Loads shared libraries into the server. |
|||
Specifies either the full path to the shared library or dynamic link library or a file name relative to the server configuration directory. |
|||
A comma separated list with no spaces |
A list of the names of the functions in the shared library or dynamic link library to be made available for use by other Init or Service directives. The dash (-) character may be used in place of the underscore (_) character in function names. |
||
yes, no |
yes |
(optional) specifies which threading model to use. no causes the routines in the library to use user-level threading. yes enables kernel-level threading. |
|
|
The name of a custom thread pool, as specified in thread-pool-init. |
||
Enables the NT console, which is the command-line shell that displays standard output and error streams. |
|||
console |
Directs error messages to the NT console. |
||
console |
Directs output to the NT console. |
||
Enables system performance measurement via performance buckets. |
|||
true, false |
true |
Disables the function when true. |
|
Configures pooled memory allocation. |
|||
block-size |
(optional) size (in bytes) of the memory blocks allocated by the internal pooled memory allocator. Default value is 32768. |
||
1048576 bytes or less |
(optional) maximum size in bytes of free block list. |
||
true, false |
false |
(optional) flag to disable the use of pooled memory if true. |
|
Lets you extend the HTTP protocol by registering new HTTP methods. |
|||
A comma separated list |
Names of the methods you are registering. |
||
Enables reporting of performance statistics in XML format. |
|||
yes, no |
no |
Enables NSAPI performance profiling using buckets. This can also be enabled through perf-init. |
|
1 or greater |
5 |
The period in seconds between statistics updates within the server. |
|
1 or greater |
1000 |
The maximum number of virtual servers for which statistics are tracked. This number should be set higher than the number of virtual servers configured. |
|
Configures an additional thread pool. |
|||
Name of the thread pool. |
|||
Maximum number of threads in the pool.You can use only five threads at a time in the FastTrack edition of iPlanet Web Server. |
|||
Minimum number of threads in the pool. |
|||
Number of bytes |
Size of the queue for the pool. |
||
Number of bytes |
Stack size of each thread in the native (kernel) thread pool. |
The following table lists
Table 3–2 magnus.conf Directives
Directive |
Allowed Values |
Default Value |
Description |
---|---|---|---|
AcceptTimeout |
Any number of seconds |
30 for servers that don't use hardware encryption devices and 300 for those that do |
Specifies the number of seconds the server waits for data to arrive from the client. If data does not arrive before the timeout expires then the connection is closed. |
Any number of seconds |
120 |
Determines the number of seconds before cache entries expire. Each time an entry in the cache is referenced, its age is calculated and checked against ACLCacheLifetime. The entry is not used if its age is greater than or equal to the ACLCacheLifetime. If this value is set to 0, the cache is turned off. |
|
200 |
Determines the number of users in the User Cache. |
||
4 |
Determines how many group IDs can be cached for a single UID/cache entry. |
||
on, off |
off |
Specifies whether asynchronous DNS is allowed. |
|
Any number of seconds |
300 (5 minutes) recommended |
Specifies the maximum time in seconds that CGI processes are allowed to run before being killed. |
|
Any number of seconds |
30 |
Causes the server to kill any CGIStub processes that have been idle for the number of seconds set by this directive. Once the number of processes is at MinCGIStubs, the server does not kill any more processes. |
|
on, off |
on |
(UNIX only) makes the action for the SIGCHLD signal the system default action for the signal. Makes the SHTML engine wait explicitly on its exec cmd child processes. |
|
on, off, yes, no, true, false |
no |
Forces the callback of NSAPI functions that were registered using the daemon_atrestart function when the server is restarting or shutting down. |
|
Any number of bytes |
8192 |
Determines the default buffer size for “un-chunking” request data. |
|
Any number of seconds |
60 (1 minute). |
Determines the default timeout for “un-chunking” request data. |
|
Any number of connections (including 0) |
4096 |
Specifies the number of outstanding (yet to be serviced) connections that the web server can have. This setting can have performance implications. For more information, see the Sun Java System Web Server 6.1 SP7 Performance Tuning, Sizing, and Scaling Guide. |
|
en (English),fr (French),de (German),ja (Japanese) |
en |
Specifies the default language for the server. The default language is used for both the client responses and administration. |
|
on, off |
on |
Specifies whether the server performs DNS lookups on clients that access the server. |
|
See the manual page for the C library function strftime |
%d/%b/%Y:%H:%M:%S |
The date format for the error log. |
|
A path |
(none) |
Appends the specified directory name to the PATH environment variable. This is used for configuring Java on Windows NT. There is no default value; you must specify a value. |
|
Favicon |
On / Off |
on |
Provides the web server administrator the ability to disable or change the icon which appears in the web address book or favorites list on Internet Explorer browsers (so, favicon translates as favorite icon). |
Any number of bytes |
8192 (8 KB) |
The size (in bytes) of the buffer used by each of the request processing threads for reading the request data from the client. The maximum number of request processing threads is controlled by the RqThrottle setting. |
|
m.n; m is the major version number and n the minor version number |
1.1 |
The current HTTP version used by the server. |
|
KeepAliveQueryMaxSleepTime |
100 On lightly loaded systems that primarily service keep-alive connections, you can lower this number to enhance performance. However doing so can increase CPU usage. |
This directive specifies an upper limit to the time slept (in milliseconds) after polling keep-alive connections for further requests. |
|
KeepAliveQueryMeanTime |
100 is appropriate for almost all installations. Note that CPU usage will increase with lower KeepAliveQueryMeanTime values. |
This directive specifies the desired keep-alive latency in milliseconds. |
|
Any number of threads |
1 |
Specifies the number of threads in the keep-alive subsystem. It is recommended that this number be a small multiple of the number of processors on the system. |
|
300 seconds maximum |
30 |
Determines the maximum time that the server holds open an HTTP Keep-Alive connection or a persistent connection between the client and the server. |
|
0 (off), 1 (on) |
0 (off) |
If on, ensures that the server uses only kernel-level threads, not user-level threads. If off, uses only user-level threads. |
|
Ranges are platform-specific |
4096 (AIX), 200 (NT), 128 (all others) |
Defines the number of incoming connections for a server socket. |
|
Any number of seconds |
30 |
Determines the log flush interval, in seconds, of the log flush thread. |
|
Any number of CGI stubs |
10 |
Controls the maximum number of CGIStub processes the server can spawn. This is the maximum concurrent CGIStub processes in execution, not the maximum number of pending requests. |
|
0 - 1048576 (for 64–bit server) |
25616 |
Specifies the maximum number of Keep-Alive and persistent connections that the server can have open simultaneously. |
|
Any number of processes1 |
1 |
(UNIX only) Specifies the maximum number of processes that the server can have running simultaneously. |
|
1 - 512 |
64 |
Specifies the maximum number of header lines in a request. |
|
Any number less than MaxCGIStubs |
2 |
Controls the number of processes that are started by default. |
|
Any number of threads |
1285 |
Determines the maximum number of threads in the native (kernel) thread pool. |
|
Any number of threads |
1 |
Determines the minimum number of threads in the native (kernel) thread pool. |
|
Any nonnegative number |
0 |
Determines the number of threads that can wait in the queue for the thread pool. |
|
Any nonnegative number |
0 |
Determines the stack size of each thread in the native (kernel) thread pool. |
|
A valid path to a file |
(none) |
Specifies a file in which to record the process ID (pid) of the base server process. |
|
1 (on), 0 (off) |
0 (off) |
If on, checks whether the minimum number of threads are available at a socket after accepting a connection but before sending the response to the request. |
|
Range is platform-specific |
0 (uses platform-specific default) |
Controls the size of the receive buffer at the server’s sockets. |
|
Any number of requests (including 0) |
51216 |
Specifies the maximum number of simultaneous request processing threads that the server can handle simultaneously per socket. This setting can have performance implications. For more information, see the Sun Java System Web Server 6.1 SP7 Performance Tuning, Sizing, and Scaling Guide. |
|
Any number less than RqThrottle |
484 |
Specifies the number of request processing threads that are created when the server is started. As the load on the server increases, more request processing threads are created (up to a maximum of RqThrottle threads). |
|
on, off |
off |
Globally enables or disables SSL by making certificates available to the server instance. Must be on for virtual servers to use SSL. |
|
Range is platform-specific |
0 (uses platform-specific default) |
Controls the size of the send buffer at the server’s sockets. |
|
5 - 86400 |
86400 (24 hours). |
The number of seconds until a cached SSL3 session becomes invalid. |
|
A non-negative integer |
10000 (used if 0 is specified) |
Specifies the number of SSL sessions that can be cached. There is no upper limit. |
|
Number of Bytes |
1048576 (1MB) |
Specifies the maximum amount of application data that is buffered during the client certificate handshake phase. |
|
Any number of seconds |
60 |
Specifies the number of seconds after which the client certificate handshake phase times out. |
|
5 - 100 |
100 |
Specifies the number of seconds until a cached SSL2 session becomes invalid. |
|
Number of Bytes |
The most favorable machine- specific stack size. |
Determines the maximum stack size for each request handling thread. |
|
on, off |
off |
If on, rejects connections that include inappropriately duplicated headers. |
|
A path |
/tmp (UNIX) TEMP (environment variable for Windows NT) |
Specifies the directory the server uses for its temporary files. On UNIX, this directory should be owned by, and writable by, the user the server runs as. |
|
on, off |
on |
Determines whether the server checks if the TempDir directory is secure. On UNIX, specifying TempDirSecurity off allows the server to use /tmp as a temporary directory. |
|
Any number of seconds |
30 |
Specifies the time in seconds that the server waits for all existing connections to terminate before it shuts down. |
|
Any number of threads |
10 |
The number of additional or new request processing threads created to handle an increase in the load on the server. |
|
A standard UNIX umask value |
(none) |
UNIX only: Specifies the umask value used by the NSAPI functions System_fopenWA() and System_fopenRW() to open files in different modes. |
|
1 (on), 0 (off) |
1 (on) |
Uses a platform-specific poll interface when set to 1 (on). Uses the NSPR poll interface in the KeepAlive subsystem when set to 0 (off). |
|
Any number of bytes |
8192 (8 KB) |
Determines the default output stream buffer size for the net_read and netbuf_grab NSAPI functions. |
|
A login name, 8 characters or less |
(none) |
(Windows NT) specifies the user account the server runs with, allowing you to restrict or enable system features for the server. (UNIX) if the server is started by the superuser or root user, the server binds to the Port you specify and then switches its user ID to the user account specified with the User directive. This directive is ignored if the server isn’t started as root. |
|
Any number of seconds |
60 |
WinCGI processes that take longer than this value are terminated when this timeout expires. |