Helma Logo
main list history
previous version  overview  next version

Version 3 by hannes on 21. September 2009, 23:35

<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 `apps` directory.
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    hopblog
    antville
    gong
    kolin
manage</pre>    manage
<small><i>Simple apps.properties file</i></small>

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

<pre>Several default options can be overridden by adding properties in the form `appname.option`:
<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>    appname.mountpoint =
<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>The `appname.mountpoint` option defines where the application should be mounted on the web server's URI space. Defaults to `/<appname>`.
<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>    appname.appdir = /some/path/app
<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>The `appname.appdir` defines the directory which contains the application's properties and code files. Defaults to `apps/<appname>`.
<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>    appname.repository.0 = apps/appName
<i>appname</i>    appname.staticMountpoint repository.1 = /filesmodules/helmaTools.zip
</pre>    appname.repository.2 = modules/core/all.js
The <i>appname</i>    appname.staticMountpoint option defines the mountpoint for the static content in the web server's URI spacerepository.3 = Defaults to /staticmodules/helma/Ftp.js
    appname.repository.4 = /full/path/to/codedir
    appname.repository.4.implementation = helma.framework.repository.MultiFileRepository
    appname.repository.5 = /full/path/to/morecode.zip

<pre>The `appname.repository.x` properties provides an alternative to the `appname.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.
<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>    appname.dbdir = /some/path/db
<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>The `appname.dbdir` option defines the directory which contains the application's embedded XML database. Defaults to `db/<appname>`.
<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>    appname.static = /some/path/htdocs
<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>The `appname.static` option defines a directory from which to serve static content for this application.
<i>appname</i>.uploadLimit = 2048
</pre>
The <i>appname</i>.uploadLimit option defines the limit for files uploaded to this app, in kB

<pre>    appname.staticMountpoint = /files
<i>appname</i>.uploadSoftfail = true
</pre>
The <i>appname</i>.uploadSoftfail option defines if the standard Helma upload error should be shown when the upload limit is exceeded. If set to true the property req.data.helma_upload_error is set in case of an error and the standard Helma error page (defined in <i>*error|Server and Application Properties*<i> property in app.properties) is shown.

<pre>The `appname.staticMountpoint` option defines the mountpoint for the static content in the web server's URI space. Defaults to `/static`.
<i>appname</i>.debug = true
</pre>
The <i>appname</i>.debug option lets you print verbose debug messages if something goes wrong

<pre>    appname.staticIndex = true
<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>The `appname.staticIndex` option defines whether the web server should display directory listings for static directories.
<i>appname</i>.protectedSessionCookie = true
</pre>    appname.staticHome = index.html, default.htm

The `appname.staticHome` option defines the files to serve when a static directory is served.

    appname.protectedStatic = /some/path/protected

The `appname.protectedStatic` option defines a "protected" static directory. Its contents are not directly accessible through the web but only using res.forward(path).

    appname.cookieDomain = .antville.org

The `appname.cookieDomain` option defines the cookie domain for this application. If set, cookies will be shared among all sites in the domain.

    appname.uploadLimit = 2048

The `appname.uploadLimit` option defines the limit for files uploaded to this app, in kB

    appname.uploadSoftfail = true

The `appname.uploadSoftfail` option defines if the standard Helma upload error should be shown when the upload limit is exceeded. If set to true the property req.data.helma_upload_error is set in case of an error and the standard Helma error page (defined in the [error property][Server and Application Properties] in app.properties) is shown.

    appname.debug = true

The `appname.debug` option lets you print verbose debug messages if something goes wrong.

    appname.protectedSessionCookie = true

This tells Helma whether to make session cookie IP binding optional.


     removed
     added