iceScrum Pro

If you are an iceScrum Pro user, settings can be edited by the administrator through a nice user interface. Please refer to the iceScrum Pro settings documentation.

Additionally, iceScrum Pro features come with their own settings when needed. Please refer to the features documentation for more information.

Config format

iceScrum config must follow the Groovy format:

 
// Inline comment
/* 
    Block comment
*/
key = value            // For booleans and numbers values
key = "string value"   // For strings values 

All paths in your config.groovy must use ‘/’ (forward slash)

You may find old config examples where string values have no quotes, when iceScrum used the Properties format (.properties). This format is now deprecated.

Application settings

Here are the available application settings with their default value, given in the Groovy format (.groovy):

icescrum.project.import.enable = true
icescrum.project.export.enable = true
icescrum.project.creation.enable = true
icescrum.project.private.enable = true
icescrum.project.private.default = false

icescrum.gravatar.enable = false
icescrum.registration.enable = true
icescrum.invitation.enable = false
icescrum.login.retrieve.enable = true

icescrum.auto_follow_productowner = true
icescrum.auto_follow_stakeholder  = true
icescrum.auto_follow_scrummaster  = true
icescrum.alerts.errors.to = "dev@icescrum.org"
icescrum.alerts.subject_prefix = "[icescrum]"
icescrum.alerts.enable = true
icescrum.alerts.default.from = "webmaster@icescrum.org"

icescrum.attachments.enable = true

Technical Settings

grails.serverURL = "http://localhost:8080/icescrum" 
                   /* Changing the port will require to change 
                     it in the Tomcat server.xml Connector*/

icescrum.debug.enable = false
icescrum.securitydebug.enable = false

icescrum.baseDir = "<yourHome>/icescrum" 
                   /* Use a custom directory where Tomcat has write rights
                      (not webapps!!). Path must use '/' (forward slash) */

icescrum.cors.enable = true  /* CORS is enabled by default
                                However, it's enabled only for projects 
                                where web services are enabled */
icescrum.cors.allow.origin.regex = "*"  /* Use double backslash for escaping
                                           e.g. (http://|.+.)mydomain.com */

grails.mail.host = "smtp.gmail.com"
grails.mail.port = 465
grails.mail.username = "username@gmail.com"
grails.mail.password = "mypassword"

An additional email setting needs to be defined if you use TLS, SSL or anonymous authentication:

grails.mail.props = ["mail.smtp.socketFactory.class":"javax.net.ssl.SSLSocketFactory"]

grails.mail.props = ["mail.smtp.starttls.enable":"true"]

grails.mail.props = ["mail.smtp.auth":"false"]

Troubleshooting

If you have any issue when configuring iceScrum, the first thing to check is that your config file is used. The one that is used is mentioned in the tomcat standard output when starting iceScrum.

If it is used but does not work, it may be not well formatted so check again the config format.

Then, you can try changing a trivial setting (like disabling registration) and see if it works. If so then it proves that your configuration is taken into account an that your specific setting may be wrong.

You can also try trivial values for your settings (e.g. Gmail for emails) to see if the problem comes from your values.

Finally, if you try connecting to an external service then try the settings in another client (e.g. in the command line) to check if they are correct.

Upgrade config.properties to config.groovy format

If your current config file is called config.properties, you will have to follow these instructions:

• Copy the config.properties file and name the copy: config.groovy.
• Open your freshly created config.groovy file and change the content as follows:

Where you have String value, wrap the value with double quotes. Additionally, comment syntax has changed so you will have to replace all the # by //. For instance, when you had:

# Data Source
dataSource.driverClassName=com.mysql.jdbc.Driver

Now you will have:

// Data Source
dataSource.driverClassName="com.mysql.jdbc.Driver"

If you have key/value with Boolean or Number values, no change is required.

icescrum.registration.enable=true
mail.port=25

Then:
– Delete or move your old config.properties file
– Don’t forget to update your config location if it is defined:

-Dicescrum_config_location=myLocation/config.groovy

HSQLDB

HSQLDB is the default DB in iceScrum. It is bundled so it is possible to try iceScrum without installing a DBMS. The DB is stored as a script file in your file system.

Your database structure and data is stored as SQL statements in a file called prodDba.script and prodDba.properties that are located in the directory where you started Tomcat from. To backup your DB, just keep a copy of these files.

The default username is sa and the password is empty.

MySQL

dataSource.dialect = "org.hibernate.dialect.MySQL5InnoDBDialect"
dataSource.driverClassName = "com.mysql.jdbc.Driver"
dataSource.url = "jdbc:mysql://localhost:3306/icescrum?useUnicode=true&characterEncoding=utf8"
dataSource.username = "root"
dataSource.password = "myDbPass"

Other DBMS

dataSource.dialect = "org.hibernate.dialect.Oracle10gDialect" 
                     // use this dialect even for greater versions
dataSource.driverClassName = "oracle.jdbc.driver.OracleDriver"
dataSource.url = "jdbc:oracle:thin:@localhost:1521:XE"
dataSource.username = "sa"
dataSource.password = "myDbPass"

With PostgreSQL, be careful, you have to use the “public” schema otherwise iceScrum won’t restart

dataSource.driverClassName = "org.postgresql.Driver"
dataSource.url = "jdbc:postgresql://localhost:5432/icescrum"
dataSource.username = "postgres"
dataSource.password = "myDbPass"

dataSource.driverClassName = "com.microsoft.sqlserver.jdbc.SQLServerDriver"
dataSource.url = "jdbc:sqlserver://localhost:1433;databaseName=icescrum"
dataSource.username = "sa"
dataSource.password = "myDbPass"