| 1 | <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. |
| 2 | 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. |
| 5 | <pre>hopblog hopblog |
| 6 | antville |
| 7 | gong |
| 8 | kolin |
| 9 | manage</pre> manage |
| 10 | <small><i>Simple apps.properties file</i></small> |
| 7 | Several default options can be overridden by adding properties in the form <tt>appname### Simple apps.option</tt>:properties file |
| 9 | <pre>Several default options can be overridden by adding properties in the form `appname.option`: |
| 10 | <i>appname</i>.mountpoint = / |
| 11 | </pre> |
| 12 | The <i>appname</i>.mountpoint option defines where the application should be mounted on the web server's URI space. Defaults to /<appname>. |
| 11 | <pre> appname.mountpoint = |
| 12 | <i>appname</i>.appdir = /some/path/app |
| 13 | </pre> |
| 14 | The <i>appname</i>.appdir defines the directory which contains the application's properties and code files. Defaults to apps/<appname>. |
| 13 | <pre>The `appname.mountpoint` option defines where the application should be mounted on the web server's URI space. Defaults to `/<appname>`. |
| 14 | <i>appname</i>.repository.0 = apps/appName |
| 15 | <i>appname</i>.repository.1 = modules/helmaTools.zip |
| 16 | <i>appname</i>.repository.2 = modules/core/all.js |
| 17 | <i>appname</i>.repository.3 = modules/helma/Ftp.js |
| 18 | <i>appname</i>.repository.4 = /full/path/to/codedir |
| 19 | <i>appname</i>.repository.4.implementation = helma.framework.repository.MultiFileRepository |
| 20 | <i>appname</i>.repository.5 = /full/path/to/morecode.zip |
| 21 | </pre> |
| 22 | 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. |
| 15 | <pre> appname.appdir = /some/path/app |
| 16 | <i>appname</i>.dbdir = /some/path/db |
| 17 | </pre> |
| 18 | The <i>appname</i>.dbdir option defines the directory which contains the application's embedded XML database. Defaults to db/<appname>. |
| 17 | <pre>The `appname.appdir` defines the directory which contains the application's properties and code files. Defaults to `apps/<appname>`. |
| 18 | <i>appname</i>.static = /some/path/htdocs |
| 19 | </pre> |
| 20 | The <i>appname</i>.static option defines a directory from which to serve static content for this application. |
| 19 | <pre> appname.repository.0 = apps/appName |
| 20 | <i>appname</i> appname.staticMountpoint repository.1 = /filesmodules/helmaTools.zip |
| 21 | </pre> appname.repository.2 = modules/core/all.js |
| 22 | 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 |
| 23 | appname.repository.4 = /full/path/to/codedir |
| 24 | appname.repository.4.implementation = helma.framework.repository.MultiFileRepository |
| 25 | appname.repository.5 = /full/path/to/morecode.zip |
| 21 | <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. |
| 22 | <i>appname</i>.staticIndex = true |
| 23 | </pre> |
| 24 | The <i>appname</i>.staticIndex option defines whether the web server should display directory listings for static directories. |
| 23 | <pre> appname.dbdir = /some/path/db |
| 24 | <i>appname</i>.staticHome = index.html, default.htm |
| 25 | </pre> |
| 26 | The <i>appname</i>.staticHome option defines the files to serve when a static directory is served. |
| 25 | <pre>The `appname.dbdir` option defines the directory which contains the application's embedded XML database. Defaults to `db/<appname>`. |
| 26 | <i>appname</i>.protectedStatic = /some/path/protected |
| 27 | </pre> |
| 28 | 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). |
| 27 | <pre> appname.static = /some/path/htdocs |
| 28 | <i>appname</i>.cookieDomain = .antville.org |
| 29 | </pre> |
| 30 | 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. |
| 29 | <pre>The `appname.static` option defines a directory from which to serve static content for this application. |
| 30 | <i>appname</i>.uploadLimit = 2048 |
| 31 | </pre> |
| 32 | The <i>appname</i>.uploadLimit option defines the limit for files uploaded to this app, in kB |
| 31 | <pre> appname.staticMountpoint = /files |
| 32 | <i>appname</i>.uploadSoftfail = true |
| 33 | </pre> |
| 34 | 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. |
| 33 | <pre>The `appname.staticMountpoint` option defines the mountpoint for the static content in the web server's URI space. Defaults to `/static`. |
| 34 | <i>appname</i>.debug = true |
| 35 | </pre> |
| 36 | The <i>appname</i>.debug option lets you print verbose debug messages if something goes wrong |
| 35 | <pre> appname.staticIndex = true |
| 36 | <i>appname</i>.responseEncoding = true |
| 37 | </pre> |
| 38 | This tells Helma whether to use gzip encoding for this app's responses. Note that this feature is disabled in recent snapshots. |
| 37 | <pre>The `appname.staticIndex` option defines whether the web server should display directory listings for static directories. |
| 38 | <i>appname</i>.protectedSessionCookie = true |
| 39 | </pre> appname.staticHome = index.html, default.htm |
| 40 | |
| 41 | The `appname.staticHome` option defines the files to serve when a static directory is served. |
| 42 | |
| 43 | appname.protectedStatic = /some/path/protected |
| 44 | |
| 45 | The `appname.protectedStatic` option defines a "protected" static directory. Its contents are not directly accessible through the web but only using res.forward(path). |
| 46 | |
| 47 | appname.cookieDomain = .antville.org |
| 48 | |
| 49 | The `appname.cookieDomain` option defines the cookie domain for this application. If set, cookies will be shared among all sites in the domain. |
| 50 | |
| 51 | appname.uploadLimit = 2048 |
| 52 | |
| 53 | The `appname.uploadLimit` option defines the limit for files uploaded to this app, in kB |
| 54 | |
| 55 | appname.uploadSoftfail = true |
| 56 | |
| 57 | 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. |
| 58 | |
| 59 | appname.debug = true |
| 60 | |
| 61 | The `appname.debug` option lets you print verbose debug messages if something goes wrong. |
| 62 | |
| 63 | appname.protectedSessionCookie = true |
| 64 | |