Sun Java System Web Proxy Server 4 Administrator's Configuration File Reference |
Chapter 3
Syntax and Use of magnus.confWhen the Sun Java System Web Proxy Server starts up, it looks in a file called magnus.conf in the server-id/config directory to establish a set of global variable settings that affect the server’s behavior and configuration. Sun Java System Web Proxy Server executes all the directives defined in magnus.conf. The order of the directives is not important.
Note
When you edit the magnus.conf file, you must restart the server for the changes to take effect.
This chapter lists the global settings that can be specified in magnus.conf in Sun Java System Web Proxy Server 4.
The categories are:
For an alphabetical list of directives, see Alphabetical List of Server Configuration Elements.
Server InformationThis sub-section lists the directives in magnus.conf that specify information about the server. They are:
Server Name
Specifies the server name.
Server ID
Specifies the server ID.
User
Windows: The User directive specifies the user account the server runs with. By using a specific user account (other than LocalSystem), you can restrict or enable system features for the server. For example, you can use a user account that can mount files from another machine.UNIX: The User directive specifies the UNIX user account for the server. 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. The user account you specify should have read permission to the server’s root and subdirectories. The user account should have write access to the logs directory and execute permissions to any CGI programs. The user account should not have write access to the configuration files. This ensures that in the unlikely event that someone compromises the server, they won’t be able to change configuration files and gain broader access to your machine. Although you can use the nobody user, it isn’t recommended.
Syntax
User name
name is the 8-character (or less) login name for the Unix user account.
Default
If there is no User directive, the server runs with the user account it was started with.
Examples
User http
User server
User nobody
NetsiteRoot
Specifies the server root. This directive is set during installation and is commented out. Unlike other directives, the server expects this directive to start with #. Do not change this directive.
Syntax
#NetsiteRoot path
Example
#ServerRoot <Install_Root>/<Instance_Directory>
DNS LookupThis section lists the directives in magnus.conf that affect DNS (Domain Name System) lookup. The directives are:
AsyncDNS
Specifies whether asynchronous DNS is allowed. This directive is ignored. Even if the value is set to on, the server does not perform asynchronous DNS lookups.
DNS
The DNS directive specifies whether the server performs DNS lookups on clients that access the server. When a client connects to your server, the server knows the client’s IP address but not its host name (for example, it knows the client as 198.95.251.30, rather than its host name www.a.com). The server will resolve the client’s IP address into a host name for operations like access control, CGI, error reporting, and access logging.
If your server responds to many requests per day, you might want (or need) to stop host name resolution; doing so can reduce the load on the DNS or NIS (Network Information System) server.
Syntax
DNS [on|off]
Default
DNS host name resolution is on as a default
Example
DNS on
ProcessesThis subsection lists the directives in magnus.conf that affect the number and timeout of threads, processes, and connections. They are:
MaxProcs (UNIX Only)
Specifies the maximum number of processes that the server can have running simultaneously. If you don’t include MaxProcs in your magnus.conf file, the server defaults to running a single process.
One process per processor is recommended if you are running in multi-process mode. In Sun Java System Web Proxy Server 4, there is always a primordial process in addition to the number of active processes specified by this setting.
Default
1
Error Logging and Statistic CollectionThis section lists the directives in magnus.conf that affect error logging and the collection of server statistics. They are:
ErrorLogDateFormat
Syntax
ErrorLogDateFormat format
The format can be any format valid for the C library function strftime. See Time Formats.
Default
%d/%b/%Y:%H:%M:%S
PidLog
PidLog specifies a file in which to record the process ID (pid) of the base server process. Some of the server support programs assume that this log is in the server root, in logs/pid.
To shut down your server, kill the base server process listed in the pid log file by using a -TERM signal. To tell your server to reread its configuration files and reopen its log files, use kill with the -HUP signal.
If the PidLog file isn’t writable by the user account that the server uses, the server does not log its process ID anywhere. The server won’t start if it can’t log the process ID.
Syntax
PidLog file
file is the full path name and file name where the process ID is stored.
Example
PidLog /home/xx12345/builds/install1/proxy-server1/logs/pid
SecurityThis section describes the directive in magnus.conf that affects server access and security issues for Sun Java System Web Proxy Server 4.
Security
The Security directive globally enables or disables SSL by making certificates available to the server instance. It must be on for the server to use SSL. If enabled, the user is prompted for the administrator password (in order to access certificates, and so on).
Syntax
Security [on|off]
Default
off
Example
Security off
Summary of Directives in magnus.confPurpose
Contains global variable settings that affect server functioning. This file is read only at server start-up.
Directives have the following syntax:
directive value
Directives
The following table lists