Configuration

Where and how

Generally, the whole runtime configuration of Naggregator is performed using the JMX-Console, which is accessible at http://localhost:8080/jmx-console/ (assuming a local installation). Using the JMX console you can configure the properties of 'Managed Beans' which in turn control the behaviour of the single modules of Naggregator.

You can determine the default values of the accessed Beans at compile time or by altering the values in the build assembly artifact.

System Management Configuration

Configuration locations:

TypeDeterminesName/Location
File in EARDefaultnaggregator-VERSION.ear/system/service/org.tastybug.bugwerk.naggregator.system.service-VERSION.sar/META-INF/jboss-service.xml
MBean in JMX-ConsoleRuntimetastybug.bugwerk.naggregator:system.config=CommonConfigurationMBean

Configuration Options:

Property NameTypeFunction
BackgroundJobPrincipalStringThe principal of the user account that executes background and detached jobs.
BackgroundJobPasswordStringThe password for account 'BackgroundJobPrincipal'.
WebContextUrlStringThis property tells Naggregator that there is a different context URL to be used (e.g. 'http://naggregator.myhost.example/'). The content of this property will be, amongst other things, used for links in mailings.
ProjectVersionStringThe Naggrator version.
MailingEnabledStringBooleanSetting this property to false surpresses the sending of any mails. Please note, that the user registration is deactivated as long as this property is 'false'.
WebLoginEnabledStringBooleanOn false, the web site based login is disabled.

Mail Configuration

Configuration locations:

TypeDeterminesName/Location
File in EARDefaultnaggregator-VERSION.ear/system/service/org.tastybug.bugwerk.naggregator.system.service-VERSION.sar/META-INF/jboss-service.xml
MBean in JMX-ConsoleRuntimejboss:service=NagMail

Configuration Options:

Property NameTypeFunction
UserStringThe user name of the SMTP account
PasswordStringThe password of the SMTP account
ConfigurationStringThis property expects a description of the used mail account, see below.

The mail account configuration is expected in the following form:

<configuration>
        <property name='mail.store.protocol' value='pop3'/>
        <property name='mail.transport.protocol' value='smtp'/>
        <property name='mail.smtp.auth' value='false'/>
        <property name='mail.user' value='username'/>
        <property name='mail.pop3.host' value='pop3.host.example'/>
        <property name='mail.smtp.host' value='smtp.host.example'/>
        <property name='mail.from' value='from-address@host.example'/>
        <property name='mail.debug' value=<<<false>>>/>
</configuration>

User Management Configuration

Configuration locations:

TypeDeterminesName/Location
File in EARDefault Valuenaggregator-VERSION.ear/user/service/org.tastybug.bugwerk.naggregator.user.service-VERSION.sar/META-INF/jboss-service.xml
MBean in JMX-ConsoleRuntimetastybug.bugwerk.naggregator:user.config=CommonConfigurationMBean

Configuration Options:

Property NameTypeFunction
UserRegistrationEnabledBooleanSetting this property to false disables the user registration.
userRegistrationAdminApprovedBooleanSetting this property to true will require new user accounts to be granted by a user admin (i.e. a user in role 'user_admin')

Accounting Configuration

Configuration locations:

TypeDeterminesName/Location
File in EARDefault Valuenaggregator-VERSION.ear/accounting/service/org.tastybug.bugwerk.naggregator.accounting.service-VERSION.sar/META-INF/jboss-service.xml
MBean in JMX-ConsoleRuntimetastybug.bugwerk.naggregator:accounting.config=CommonConfigurationMBean

Configuration Options:

Property NameTypeFunction
ProjectUpgradingEnabledBooleanSetting this property to true enables the project upgrading functionality on the web site. A project member in role 'Maintainer' can order project upgrades.
OssProjectSpecialTreatmentBooleanIf true, registered projects with an OSS license will be initialised with special quotations (which one is specified under OssProjectInitialQuotaProduct and OssProjectInitialNotificationProduct)
OssProjectSpecialTreatmentAdminApprovalBooleanIf true, the special quotations of a recently registered OSS project will be granted upon approval of an account using the accounting administration page. If false, an OSS project automatically receives the special quotations.
ProjectInitialQuotaProductStringDetermines the initial project quota-product that is to be applied for new projects.
ProjectInitialQuotaProductQuantityBooleanThe initial quantity of ProjectInitialQuotaProduct. Products that imply an unlimited lifetime (validity=-1) should have a quantity of -1.
OssProjectInitialQuotaProductStringDetermines the initial project quota-product that is to be applied for new OSS projects.
OssProjectInitialQuotaProductQuantityBooleanThe initial quantity of OssProjectInitialQuotaProduct. Products that imply an unlimited lifetime (validity=-1) should have a quantity of -1.
ProjectInitialNotificationProductStringDetermines the initial project notifications-product that is to be applied for new projects.
ProjectInitialNotificationProductQuantityBooleanThe initial quantity of ProjectInitialNotificationProduct. Products that imply an unlimited lifetime (validity=-1) should have a quantity of -1.
OssProjectInitialNotificationProductStringDetermines the initial project notifications-product that is to be applied for new OSS projects.
OssProjectInitialNotificationProductQuantityBooleanThe initial quantity of OssProjectInitialNotificationProduct. Products that imply an unlimited lifetime (validity=-1) should have a quantity of -1.
ProjectInitialSyncProductStringDetermines the initial project synchronization product that is to be applied for new projects.
ProjectInitialSyncProductQuantityBooleanThe initial quantity of ProjectInitialSyncProduct. Products that imply an unlimited lifetime (validity=-1) should have a quantity of -1.
OssProjectInitialSyncProductStringDetermines the initial project synchronization product that is to be applied for new OSS projects.
OssProjectInitialSyncProductQuantityBooleanThe initial quantity of OssProjectInitialSyncProduct. Products that imply an unlimited lifetime (validity=-1) should have a quantity of -1.