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.
Configuration locations:
Type | Determines | Name/Location |
File in EAR | Default | naggregator-VERSION.ear/system/service/org.tastybug.bugwerk.naggregator.system.service-VERSION.sar/META-INF/jboss-service.xml |
MBean in JMX-Console | Runtime | tastybug.bugwerk.naggregator:system.config=CommonConfigurationMBean |
Configuration Options:
Property Name | Type | Function |
BackgroundJobPrincipal | String | The principal of the user account that executes background and detached jobs. |
BackgroundJobPassword | String | The password for account 'BackgroundJobPrincipal'. |
WebContextUrl | String | This 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. |
ProjectVersion | String | The Naggrator version. |
MailingEnabledString | Boolean | Setting 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'. |
WebLoginEnabledString | Boolean | On false, the web site based login is disabled. |
Configuration locations:
Type | Determines | Name/Location |
File in EAR | Default | naggregator-VERSION.ear/system/service/org.tastybug.bugwerk.naggregator.system.service-VERSION.sar/META-INF/jboss-service.xml |
MBean in JMX-Console | Runtime | jboss:service=NagMail |
Configuration Options:
Property Name | Type | Function |
User | String | The user name of the SMTP account |
Password | String | The password of the SMTP account |
Configuration | String | This 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>
Configuration locations:
Type | Determines | Name/Location |
File in EAR | Default Value | naggregator-VERSION.ear/user/service/org.tastybug.bugwerk.naggregator.user.service-VERSION.sar/META-INF/jboss-service.xml |
MBean in JMX-Console | Runtime | tastybug.bugwerk.naggregator:user.config=CommonConfigurationMBean |
Configuration Options:
Property Name | Type | Function |
UserRegistrationEnabled | Boolean | Setting this property to false disables the user registration. |
userRegistrationAdminApproved | Boolean | Setting this property to true will require new user accounts to be granted by a user admin (i.e. a user in role 'user_admin') |
Configuration locations:
Type | Determines | Name/Location |
File in EAR | Default Value | naggregator-VERSION.ear/accounting/service/org.tastybug.bugwerk.naggregator.accounting.service-VERSION.sar/META-INF/jboss-service.xml |
MBean in JMX-Console | Runtime | tastybug.bugwerk.naggregator:accounting.config=CommonConfigurationMBean |
Configuration Options:
Property Name | Type | Function |
ProjectUpgradingEnabled | Boolean | Setting this property to true enables the project upgrading functionality on the web site. A project member in role 'Maintainer' can order project upgrades. |
OssProjectSpecialTreatment | Boolean | If true, registered projects with an OSS license will be initialised with special quotations (which one is specified under OssProjectInitialQuotaProduct and OssProjectInitialNotificationProduct) |
OssProjectSpecialTreatmentAdminApproval | Boolean | If 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. |
ProjectInitialQuotaProduct | String | Determines the initial project quota-product that is to be applied for new projects. |
ProjectInitialQuotaProductQuantity | Boolean | The initial quantity of ProjectInitialQuotaProduct. Products that imply an unlimited lifetime (validity=-1) should have a quantity of -1. |
OssProjectInitialQuotaProduct | String | Determines the initial project quota-product that is to be applied for new OSS projects. |
OssProjectInitialQuotaProductQuantity | Boolean | The initial quantity of OssProjectInitialQuotaProduct. Products that imply an unlimited lifetime (validity=-1) should have a quantity of -1. |
ProjectInitialNotificationProduct | String | Determines the initial project notifications-product that is to be applied for new projects. |
ProjectInitialNotificationProductQuantity | Boolean | The initial quantity of ProjectInitialNotificationProduct. Products that imply an unlimited lifetime (validity=-1) should have a quantity of -1. |
OssProjectInitialNotificationProduct | String | Determines the initial project notifications-product that is to be applied for new OSS projects. |
OssProjectInitialNotificationProductQuantity | Boolean | The initial quantity of OssProjectInitialNotificationProduct. Products that imply an unlimited lifetime (validity=-1) should have a quantity of -1. |
ProjectInitialSyncProduct | String | Determines the initial project synchronization product that is to be applied for new projects. |
ProjectInitialSyncProductQuantity | Boolean | The initial quantity of ProjectInitialSyncProduct. Products that imply an unlimited lifetime (validity=-1) should have a quantity of -1. |
OssProjectInitialSyncProduct | String | Determines the initial project synchronization product that is to be applied for new OSS projects. |
OssProjectInitialSyncProductQuantity | Boolean | The initial quantity of OssProjectInitialSyncProduct. Products that imply an unlimited lifetime (validity=-1) should have a quantity of -1. |