child of: server, host

Specifies the access log file.

Attribute	Meaning	default
path	The access log path.	required
format	Access log format.	see below
resin:type	Class implementing AbstractAccessLog for custom logging.
rollover-period	how often to rollover the log. Normally in days (15D), weeks (2W) or months (1M).	none
rollover-size	max size of the log before a rollover.	10 meg
archive-format	format the name of the archive file.	n/a

The rollover-period variable controls how often the access log will be rotated. When the time runs out, Resin will move the old log file to a timestamped one, e.g. access.log20001114. Rollovers happen at midnight in the local time if the time period is a day or longer.

The access log formatting variables follow the Apache variables:

%b	result content length
%h	remote IP addr
%{xxx}i	request header xxx
%{xxx}o	response header xxx
%{xxx}c	cookie value xxx
%n	request attribute
%r	request URL
%s	status code
%{xxx}t	request date with optional time format string.
%T	time of request in seconds
%u	remote user
%U	request URI

The default format is:

"%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\""

<server> <access-log id='log/access.log'> <rollover-period>2W</rollover-period> </access-log> ... </server>

If the web-app doesn't specify an access-log, it will use the host's access-log.

child of: server

Configures Resin's internal HTTP proxy cache. Resin's cache can dramatically improve performance by avoiding re-evaluation of slowly changing database-backed changes. We strongly recommend using the proxy caching when possible for a simple, standards-based performance boost.

Using the proxy cache is described more fully in the caching documentation.

Attribute	Meaning	default
path	filesystem location of the cache	required
enable	enables/disables the cache	true
entries	max number of entries allowed in the cache	1024
memory-size	max size of the cache saved in memory	1M
disk-size	max size of the cache saved on disk	64M

child of: host, web-app

Configures the directory where web pages will be placed when using webserver-style deployment instead of war-based deployment.

child of: resin

Configures the Unix setuid group name used after Resin binds the reserved ports as root.

Note, Linux requires the new thread package (e.g. RedHat 9.0 or later) to support group-name.

child of: server

Configures a virtual host. Virtual hosts must be configured explicitly.

Attribute	Meaning	default
id	primary host name	none
regexp	Regular expression based host matching	none
host-name	Canonical host name	none
host-alias	Aliases matching the same host	none
secure-host-name	Host to use for a redirect to SSL	none
root-directory	Root directory for host files	parent directory
document-directory	Document directory root	root-directory

child of: server

Defines the cluster of Resin JVMs used for load-balancing and for sharing distributed sessions.

<cluster> <srun id="a" host="192.168.0.1" port="6802" index="1"/> <srun id="b" host="192.168.0.2" port="6802" index="2"/> </cluster>

child of: server

Configures the thread pool shared among all ports.

Attribute	Meaning	default
thread-max	maximum number of working threads	200
spare-thread-max	maximum number of spare working threads	20
spare-thread-min	minimum number of spare working threads	5

<thread-max> is the absolute maximum number of connection worker threads allowed. <thread-max> may be limited by OS/JVM restrictions, especially the stack size. -Xss and/or ulimit -s may be required for large numbers of threads, e.g. "ulimit -s 2048" on some versions of Linux would allow for 1024 total threads in the JVM.

<spare-thread-max> and <spare-thread-min> configure Resin's adaptive thread pooling. Resin tries to keep between <spare-thead-min> and <spare-thread-max> idle threads available at all time. Sites with large spikes in connection loads may need to increase the <spare-thread-min> value.

child of: server

Configures a HTTP port listening for HTTP requests.

When configuring multiple JVMs, each <http> will have a unique <server-id> which allows the -server command-line to select which ports the server should listen to.

Attribute	Meaning	default
server-id	server id matching the -server command line	none
host	hostname of the interface to listen to	*
port	port to listen to	required
tcp-no-delay	sets the NO_DELAY socket parameter	true
virtual-host	forces all requests to this <http> to use the named virtual host	none
openssl	configures the port to use OpenSSL	none
jsse-ssl	configures the port to use JSSE for SSL	none

child of: resin
default: 1M

For reliability, Resin periodically checks the amount of free memory available. When the free memory drops below <min-free-memory>, even after garbage collection, Resin will force a JVM restart.

In general, application developers should use a heap profiler to eliminate memory leaks and OutOfMemoryErrors. Because an OutOfMemoryError can cause severe problems with the application, Resin detects the low memory before those errors can be thrown.

Top-level configuration for the resin.conf file. The <resin> tag needs to specify the Resin namespace, to allow for validation of the configuration file.

The environment of the top-level <resin> is the global classpath. This environment can be important for <log> configuration for threads which run with using only the global class loader. Because the <resin> environment does not have a dynamic class loader, dynamically loaded classes, like custom jars in resin/lib are not available.

resin

<resin xmlns="http://caucho.com/ns/resin"> <server> <http id='' host='*' port='8080'/> <resin:include path="app-default.xml"/> <host id=""/> <web-app id="/"/> </host> </resin>

child of: server, host

Specifies the root directory for the <server> and <host> contexts. All EL-style directory paths are relative to the root-directory.

child of: resin

Main configuration for the server, configuring ports, threads and virtual hosts.

• Common resources for all virtual hosts and web-apps.
• Thread pooling
• HTTP and SRUN/Cluster ports
• Caching
• virtual host configuration and common web-app-default

The <server> will generally contain a <class-loader> configuration which loads the resin/lib jars dynamically, allowing for system-wide jars to be dropped into resin/lib. <server> configures the main dynamic environment. Database pools common to all virtual hosts, for example, should be configured in the <server> block.

The <server> configures the <thread-pool> and a set of <http> and <srun> ports which share the thread pool. Requests received on those ports will use worker threads from the thread pool.

child of: cluster

Configures a clustered HMUX listener.

When configuring Resin in a load-balanced cluster, each Resin instance will have its own <srun> configuration, which Resin uses for distributed session management and for the load balancing itself.

When configuring multiple JVMs, each <srun> will have a unique <server-id> which allows the -server command-line to select which ports the server should listen to.

Attribute	Meaning	default
server-id	server id matching the -server command line	none
host	hostname of the interface to listen to	*
port	port to listen to	required
index	Session index of the srun	required
backup	If true, the server is generally used as a backup	false
tcp-no-delay	sets the NO_DELAY socket parameter	true
virtual-host	forces all requests to this <http> to use the named virtual host	none
openssl	configures the port to use OpenSSL	none
jsse-ssl	configures the port to use JSSE for SSL	none

child of: resin

Configures the Unix setuid user name used after Resin binds the reserved ports as root.

Note, Linux requires the new thread package (e.g. RedHat 9.0 or later) to support user-name.