Helma Logo
main list history
previous version  overview  next version

Version 1 by zumbrunn on 18. February 2009, 21:29

<small><b>Description</b></small>
This file is located in Helma's installation directory. It contains a list of applications that helma will handle (ie. start up, execute, update). If no explicit application directory is specified, the name of an application refers to a directory with the same name in helma's <tt>apps</tt> directory.

Generally, applications are started just by listing them in this file:

<pre>hopblog
antville
gong
kolin
manage</pre>
<small><i>Simple apps.properties file</i></small>

Several default options can be overridden by adding properties in the form <tt>appname.option</tt>:

<pre>
<i>appname</i>.mountpoint = /
</pre>
The <i>appname</i>.mountpoint option defines where the application should be mounted on the web server's URI space. Defaults to /<appname>.

<pre>
<i>appname</i>.appdir = /some/path/app
</pre>
The <i>appname</i>.appdir defines the directory which contains the application's properties and code files. Defaults to apps/<appname>.

<pre>
<i>appname</i>.repository.0 = apps/appName
<i>appname</i>.repository.1 = modules/helmaTools.zip
<i>appname</i>.repository.2 = modules/core/all.js
<i>appname</i>.repository.3 = modules/helma/Ftp.js
<i>appname</i>.repository.4 = /full/path/to/codedir
<i>appname</i>.repository.4.implementation = helma.framework.repository.MultiFileRepository
<i>appname</i>.repository.5 = /full/path/to/morecode.zip
</pre>
The <i>appname</i>.repository.x properties provides an alternative to the <i>appname</i>.appdir property, allowing you to combine code stored in several locations. Code in repositores with higher numbers will override code in repositories with lower numbers. Optionally, the implementaion of the repository can be set to behave as MultiFileRepository, which will treat the zip-files and directories inside the specified directory as individual repositories.

<pre>
<i>appname</i>.dbdir = /some/path/db
</pre>
The <i>appname</i>.dbdir option defines the directory which contains the application's embedded XML database. Defaults to db/<appname>.

<pre>
<i>appname</i>.static = /some/path/htdocs
</pre>
The <i>appname</i>.static option defines a directory from which to serve static content for this application.

<pre>
<i>appname</i>.staticMountpoint = /files
</pre>
The <i>appname</i>.staticMountpoint option defines the mountpoint for the static content in the web server's URI space. Defaults to /static.

<pre>
<i>appname</i>.staticIndex = true
</pre>
The <i>appname</i>.staticIndex option defines whether the web server should display directory listings for static directories.

<pre>
<i>appname</i>.staticHome = index.html, default.htm
</pre>
The <i>appname</i>.staticHome option defines the files to serve when a static directory is served.

<pre>
<i>appname</i>.protectedStatic = /some/path/protected
</pre>
The <i>appname</i>.protectedStatic option defines a "protected" static directory. Its contents are not directly accessible through the web but only using res.forward(path).

<pre>
<i>appname</i>.cookieDomain = .antville.org
</pre>
The <i>appname</i>.cookieDomain option defines the cookie domain for this application. If set, cookies will be shared among all sites in the domain.

<pre>
<i>appname</i>.uploadLimit = 2048
</pre>
The <i>appname</i>.uploadLimit option defines the limit for files uploaded to this app, in kB

<pre>
<i>appname</i>.debug = true
</pre>
The <i>appname</i>.debug option lets you print verbose debug messages if something goes wrong

<pre>
<i>appname</i>.responseEncoding = true
</pre>
This tells Helma whether to use gzip encoding for this app's responses. Note that this feature is disabled in recent snapshots.

<pre>
<i>appname</i>.protectedSessionCookie = true
</pre>
This tells Helma whether to make session cookie IP binding optional.


     removed
     added