Scarab
The properties in this section are only needed in the
database creation phase, which is the last thing you do
before you can start Scarab.
Please see the documentation on the website and README.txt file
for how to configure your specific database setup.
uses in Scarab:
---------------
ant deploy (source distribution)
ant generate-om (source distribution)
Scarab Setup Wizard (binary distribution)
Important for builders (source distribution):
This section allows you to define your runtime
environment together with your build time environment
in one specific file (this one).
But since the runtime properties must be propagated
to the final webapp, these properties will eventually
be propagated to the file
WEB-INF/conf/defaultCustom.properties
This copy is automatically done in the
deploy phase (ant deploy) where the file default.properties
is used as blueprint for the layout, but the property values
are taken from the current user settings, i.e. all of your
property modifications from build.properties will show
up in the webapp under WEB-INF/conf/defaultCustom.properties
Hence if you build your own instance, defaultCustom.properties
will allready contain your individual setup and you can
start your instance without further property modifications in
the webapp.
If you build a generic binary distribution, all you need to
do after a fresh checkout will be:
ant deploy
The result will be a generic binary distribution.
| Property name | Type | Comment |
|---|---|---|
| scarab.database.type | Build | |
| scarab.database.username | Build | |
| scarab.database.password | Build | |
| scarab.database.admin.username | Build | Database user to use when creating and seeding the database. |
| scarab.database.admin.password | Build | Password to use when creating and seeding the database. |
| scarab.database.host | Build | |
| scarab.database.port | Build/Runtime | The port that the database is running on. |
| scarab.database.url | Runtime | This property is specific to a database driver and is built up from other user-specified properties. I guess this goes hand-in-hand with 'scarab.database.jdbc.driver'. |
| scarab.database.admin.url | Runtime | JDBC URL to use when creating and seeding the database. This property is generated depending on the property "scarab.database.type". |
| scarab.database.url.extension | Runtime | This property is generated depending on the property "scarab.database.type". |
| scarab.database.name | Runtime | I don't know whether Torque needs building with the database name or not. If not, this can just be a runtime property. |
| scarab.user.username | Runtime | Username of the initial (only?) Scarab administrator. Maybe this, along with the other adminstrator user properties, should be build properties which modify the seed data. Otherwise use hard-coded values. |
| scarab.database.adapter | Runtime | |
| scarab.database.pool.validationQuery | Runtime | |
| scarab.database.jdbc.driver | Runtime | The JDBC driver to use for the database connection. We supply standard ones for several databases, but users should have the option to supply their own. |
| scarab.database.jdbc.driver.jar | Runtime | |
| scarab.jdbc.handler | Runtime | |
| scarab.module.code.length | Runtime |
This is the custom settings section for Scarab. These properties
affect the runtime behaviour of Scarab.
Alternatively, you may define the value in your web.xml or
server.xml file for Scarab.
See http://jakarta.apache.org/commons/configuration/examples.html
Note that strings containing "," (comma) characters must backslash
escape the comma (i.e. '\,')
For the full set of available properties, see the files
src/conf/conf/TurbineResources.properties
Relation to ant build:
-------------
deploy
| Property name | Type | Comment |
|---|---|---|
| scarab.issue.comment.renderer | Runtime | determines the default rendering engine ("plaintext"|"html"|"radeox"). |
| system.mail.host | Runtime | This is the host on which your Email service runs as seen from Scarab. This is usually a named host, e.g. mailserver.mydomain.com. If the mail service runs on the same host as Scarab, you can use the default (localhost) |
| system.mail.smtp.user | Runtime | Username for the SMTP authentication (if required by the system.mail.host mail server). |
| system.mail.smtp.pwd | Runtime | Password for the SMTP authentication (if required by the system.mail.host mail server). |
| scarab.email.domain | Runtime | |
| scarab.email.default.fromName | Runtime | E-mail name that e-mails from Scarab have in their 'from' address. |
| system.mail.pseudohtml | Runtime | |
| scarab.email.register.fromName | Runtime | |
| scarab.email.forgotpassword.fromName | Runtime | |
| scarab.email.archive.toAddress | Runtime | |
| scarab.email.default.fromAddress | Runtime | The 'from' address for e-mails that are sent by Scarab. I think this generally needs to be a valid e-mail address, or at least a valid domain. I vaguely remember someone having problems because they were using the default from address which had an invalid domain. Something didn't like it. |
| scarab.email.register.fromAddress | Runtime | |
| scarab.email.forgotpassword.fromAddress | Runtime | |
| system.mail.smtp.from | Runtime | |
| scarab.automatic.role.approval | Runtime | |
| locale.default.charset | Runtime | The characterset to be used on screen. |
| scarab.email.encoding | Runtime | |
| scarab.timezone | Runtime | |
| scarab.datefields.editable | Runtime | |
| scarab.email.replyto.sender | Runtime | When set to false the ReplyTo field in the scarab generated email will be the default email address scarab.email.default.fromAddress. When set to true, ReplyTo is set to the originator of the email, i.e. the one the created or last modified the issue. |
| scarab.register.email.checkValidA | Runtime | If true, will check if an email address is from a valid domain with A record |
| scarab.register.email.badEmails | Runtime | |
| scarab.login.password.expire | Runtime | |
| scarab.login.ntlm.active | Runtime | |
| scarab.login.ntlm.domain | Runtime | |
| scarab.workflow.classname | Runtime | |
| scarab.notificationmanager.classname | Runtime | The implementation of NotificationManager to be used by Scarab. |
| scarab.notificationmanager.issuequiettime | Runtime | Waiting time after which a queued notification is sent to recipients in [msec] |
| scarab.instance.id | Runtime | |
| scarab.common.status.id | Runtime | |
| session.timeout | Runtime | |
| services.UploadService.repository | Runtime | |
| searchindex.path | Runtime | |
| scarab.http.scheme | Runtime | Drop this? I guess that this is used for generating e-mail links. |
| scarab.http.domain | Runtime | This also appears in the database, and I'm really not sure what to do about it. It causes a lot of problems with the generated e-mail links. |
| scarab.http.port | Runtime | See 'scarab.http.domain'. |
| scarab.context | Runtime | What shall we do with this? Normally the context comes from the name of the deployed WAR file, unless a different context name is configured in server.xml. Maybe just allow the user to configure the context name via server.xml directly? |
| scarab.http.scriptname | Runtime | Drop this? Most people seem to have problems when this is set to something other than /scarab/issues anyway. |
| scarab.attachment.remove.permanent | Runtime | true: remove attachments physically as needed |
| scarab.attachments.repository | Runtime | Location of attachements directory |
| scarab.dhtml.hide_bars | Runtime | |
| scarab.dhtml.autoresize_textarea | Runtime | |
| scarab.site.name | Runtime | |
| scarab.site.logo | Runtime | |
| scarab.admin.password.reset.allowed | Runtime | |
| scarab.anonymous.enable | Runtime | Enable anonymous user using the scarab.anonymous.username |
| scarab.anonymous.username | Runtime | Choose which user will act as Anonymous |
| scarab.anonymous.rolename | Runtime | Choose which role will hold the permissions for anonymous access |
| scarab.public.modules.display.count | Runtime | limits the number of public modules displayed on the Login screen |
| scarab.dataexport.encoding | Encoding to be used for data exports, including XML, TSV and XLS outputs. | |
| scarab.issue.max.view | ||
| scarab.issue.max.assign | ||
| scarab.issue.max.move | ||
| scarab.issue.max.copy | ||
| scarab.viewIssue.singleScreenOnly | Runtime |
This section defines some properties, which affect, how the
webapplication is deployed.
Relation to ant build:
----------------------
deploy
NOTE: These properties are only needed in the Source distribution
and have no effect in the Runtime distribution.
| Property name | Type | Comment |
|---|---|---|
| custom.properties.tmpl | Build | |
| default.custom.properties | Build | |
| custom.properties | Build | |
| scarab.database.ant.buildfile | Runtime | |
| scarab.database.ant.target | Runtime |
| Property name | Type | Comment |
|---|---|---|
| torque.project | Build | |
| torque.database | Runtime | |
| torque.database.type | Runtime | |
| torque.database.user | Runtime | |
| torque.database.password | Runtime | |
| torque.database.createUrl | Runtime | |
| torque.database.buildUrl | Runtime | |
| torque.database.driver | Runtime | |
| torque.doc.format | Build | |
| torque.targetPackage | Build | |
| torque.schema.om.includes | Build | |
| torque.schema.om.excludes | Build | |
| torque.retrievableInterface | Runtime | |
| torque.addGetByNameMethod | Build | |
| torque.addTimeStamp | Build | |
| torque.addIntakeRetrievable | Build | |
| torque.overloadKeySetters | Build | |
| torque.useManagers | Build | |
| torque.runOnlyOnSchemaChange | Build | |
| torque.generateDeprecated | Build | |
| torque.output.dir | Runtime | |
| torque.template.path | Runtime | |
| torque.doc.dir | Build | |
| torque.java.dir | Build | |
| torque.schema.dir | Build | |
| torque.javadoc.dir | Build | |
| torque.sql.dir | Runtime | |
| torque.basePrefix | Runtime | |
| torque.useClasspath | Runtime | |
| torque.initialId | Runtime | |
| torque.addSaveMethod | Build | |
| torque.addGetByNameMethod | Build | |
| torque.complexObjectModel | Build | |
| torque.saveException | Build | |
| torque.schema.sql.includes | Runtime | |
| torque.schema.sql.excludes | Runtime | |
| torque.schema.doc.includes | Runtime | |
| torque.schema.doc.excludes | Runtime | |
| torque.schema.createdb.includes | Runtime | |
| torque.schema.createdb.excludes | Runtime | |
| torque.schema.initsql.includes | Runtime | |
| torque.schema.initsql.excludes | Runtime |
These are some default values that are required for
the b18-b19 migration build target. DO NOT MODIFY THEM!
Relation to ant build:
----------------------
This section directly corresponds to the ant task
migrate-b18-b19
| Property name | Type | Comment |
|---|---|---|
| scarab.tomcat.http.port | Build | |
| scarab.tomcat.shutdown.port | Build | |
| scarab.webapp.reloadable | Build | |
| scarab.webapp.checkInterval | Build | |
| scarab.welcome.file | Build | |
| scarab.file.max.size | Runtime | |
| scarab.tomcat.proxy.name | Build | |
| scarab.tomcat.proxy.port | Build |
Following mappings are fixed and shall never be changed!
[FIXME] [HD]Maybe they should better move to TurbineResources.properties ?
| Property name | Type | Comment |
|---|---|---|
| torque.database.scarab.adapter | Runtime | |
| torque.dsfactory.scarab.pool.validationQuery | Runtime | |
| torque.dsfactory.scarab.connection.driver | Runtime | |
| torque.dsfactory.scarab.connection.url | Runtime | |
| torque.dsfactory.scarab.connection.user | Runtime | |
| torque.dsfactory.scarab.connection.password | Runtime |
The properties defined in this section are used
to provide the Setup Wizard with default values.
| Property name | Type | Comment |
|---|---|---|
| jdbc | Runtime | |
| scarab.jdbc.handler.mysql | Runtime | |
| scarab.database.port.mysql | Runtime | |
| scarab.database.admin.url.mysql | Runtime | |
| scarab.database.url.mysql | Runtime | |
| scarab.database.url.extension.mysql | Runtime | |
| scarab.database.pool.validationQuery.mysql | Runtime | |
| scarab.database.jdbc.driver.mysql | Runtime | |
| scarab.database.admin.username.mysql | Runtime | |
| scarab.database.admin.password.mysql | Runtime | |
| scarab.database.username.mysql | Runtime | |
| scarab.database.password.mysql | Runtime | |
| scarab.test.database.name.mysql | Runtime | |
| scarab.test.database.url.mysql | Runtime | |
| scarab.test.database.username.mysql | Runtime | |
| scarab.test.database.password.mysql | Runtime | |
| scarab.database.jdbc.driver.jar.mysql | Runtime | |
| scarab.jdbc.handler.postgresql | Runtime | |
| scarab.database.port.postgresql | Runtime | |
| scarab.database.admin.url.postgresql | Runtime | |
| scarab.database.url.postgresql | Runtime | |
| scarab.database.url.extension.postgresql | Runtime | |
| scarab.database.pool.validationQuery.postgresql | Runtime | |
| scarab.database.jdbc.driver.postgresql | Runtime | |
| scarab.database.admin.username.postgresql | Runtime | |
| scarab.database.admin.password.postgresql | Runtime | |
| scarab.database.username.postgresql | Runtime | |
| scarab.database.password.postgresql | Runtime | |
| scarab.test.database.name.postgresql | Runtime | |
| scarab.test.database.url.postgresql | Runtime | |
| scarab.test.database.username.postgresql | Runtime | |
| scarab.test.database.password.postgresql | Runtime | |
| scarab.database.jdbc.driver.jar.postgres | Runtime | |
| hsqldb.database | Runtime | |
| hsqldb.dbname | Runtime | |
| scarab.jdbc.handler.hypersonic | Runtime | |
| scarab.database.port.hypersonic | Runtime | |
| scarab.database.admin.url.hypersonic | Runtime | |
| scarab.database.url.hypersonic | Runtime | |
| scarab.database.url.extension.hypersonic | Runtime | |
| scarab.database.pool.validationQuery.hypersonic | Runtime | |
| scarab.database.jdbc.driver.hypersonic | Runtime | |
| scarab.database.admin.username.hypersonic | Runtime | |
| scarab.database.admin.password.hypersonic | Runtime | |
| scarab.database.username.hypersonic | Runtime | |
| scarab.database.password.hypersonic | Runtime | |
| scarab.test.database.name.hypersonic | Runtime | |
| scarab.test.database.url.hypersonic | Runtime | |
| scarab.test.database.username.hypersonic | Runtime | |
| scarab.test.database.password.hypersonic | Runtime | |
| scarab.database.jdbc.driver.jar.hypersonic | Runtime | |
| scarab.jdbc.handler.mssql | Runtime | |
| scarab.database.port.mssql | Runtime | |
| scarab.database.admin.url.mssql | Runtime | |
| scarab.database.url.mssql | Runtime | |
| scarab.database.url.extension.mssql | Runtime | |
| scarab.database.pool.validationQuery.mssql | Runtime | |
| scarab.database.jdbc.driver.mssql | Runtime | |
| scarab.database.admin.username.mssql | Runtime | |
| scarab.database.admin.password.mssql | Runtime | |
| scarab.database.username.mssql | Runtime | |
| scarab.database.password.mssql | Runtime | |
| scarab.test.database.name.mssql | Runtime | |
| scarab.test.database.url.mssql | Runtime | |
| scarab.test.database.username.mssql | Runtime | |
| scarab.test.database.password.mssql | Runtime | |
| scarab.database.jdbc.driver.jar.mssql | Runtime | |
| scarab.database.manual.creation.mssql | Runtime | |
| scarab.jdbc.handler.oracle | Runtime | |
| scarab.database.port.oracle | Runtime | |
| scarab.database.admin.url.oracle | Runtime | |
| scarab.database.url.oracle | Runtime | |
| scarab.database.url.extensionoracle | Runtime | |
| scarab.database.pool.validationQuery.oracle | Runtime | |
| scarab.database.jdbc.driver.oracle | Runtime | |
| scarab.database.admin.username.oracle | Runtime | |
| scarab.database.admin.password.oracle | Runtime | |
| scarab.database.username.oracle | Runtime | |
| scarab.database.password.oracle | Runtime | |
| scarab.test.database.name.oracle | Runtime | |
| scarab.test.database.url.oracle | Runtime | |
| scarab.test.database.username.oracle | Runtime | |
| scarab.test.database.password.oracle | Runtime | |
| scarab.database.jdbc.driver.jar.oracle | Runtime | |
| scarab.jdbc.handler.db2 | Runtime | |
| scarab.database.port.db2 | Runtime | |
| scarab.database.admin.url.db2 | Runtime | |
| scarab.database.url.db2 | Runtime | |
| scarab.database.url.extension.db2 | Runtime | |
| scarab.database.pool.validationQuery.db2 | Runtime | |
| scarab.database.jdbc.driver.db2 | Runtime | |
| scarab.database.admin.username.db2 | Runtime | |
| scarab.database.admin.password.db2 | Runtime | |
| scarab.database.username.db2 | Runtime | |
| scarab.database.password.db2 | Runtime | |
| scarab.test.database.name.db2 | Runtime | |
| scarab.test.database.url.db2 | Runtime | |
| scarab.test.database.username.db2 | Runtime | |
| scarab.test.database.password.db2 | Runtime | |
| scarab.database.jdbc.driver.jar.db2 | Runtime |
This section contains the ant related properties.
Relation to ant build:
----------------------
This section directly corresponds to the ant tasks
compile
| Property name | Type | Comment |
|---|---|---|
| Name | Build | Name of the project ("Scarab" for the standard distribution). |
| version | Build | Project version. |
| project | Build | Name of the project, used for???. |
| year | Build | Year, possibly used for copyright message. |
| build.dir | Build | |
| build.project | Build | |
| build.project.webinf | Build | |
| build.project.webinf.lib | Build | |
| build.sql.scarab | Build | |
| build.src.scarab | Build | |
| build.dest.scarab | Build | |
| deploy.dir | Build | |
| deploy.project | Build | |
| scarab.torque.schemas | Build | |
| repository.dir | Build | |
| lib.dir | Build | |
| src.dir | Build | |
| extensions.dir | Build |
| Property name | Type | Comment |
|---|---|---|
| askAdminstratorUsername | Build | |
| scarab.scarabgen.home | Build | |
| scarab.docs.head | Build | |
| scarab.docbook.enable | Build | |
| maven.multiproject.type | Build | |
| maven.repo.remote | Build | |
| maven.docbook.src | Build | |
| maven.sdocbook.src.dir | Build | |
| maven.sdocbook.files | Build | |
| statcvs.exclude | Build | |
| statcvs.include | Build | |
| statcvs.verbose | Build | |
| statcvs.history | Build | |
| statcvs.log.options | Build | |
| maven.eclipse.output.dir | Build | |
| maven.eclipse.classpath.include | Build | |
| maven.netbeans.exec.rebuild | Build | |
| maven.netbeans.exec.build | Build | |
| maven.junit.fork | Build | |
| maven.junit.usefile | Build | |
| maven.test.failure.ignore | Build | |
| maven.javadoc.useexternalfile | Build | |
| maven.pmd.excludes | Build | |
| maven.pmd.includes | Build | |
| maven.simian.excludes | Build | |
| maven.simian.includes | Build | |
| maven.findbugs.excludes | Build | |
| maven.findbugs.includes | Build | |
| maven.checkstyle.format | Build | |
| maven.xdoc.version | Build | |
| maven.dist.bin.assembly.dir | Build |