- Ensure that the JAVA_HOME environment variable is defined and points to the Java installation directory (which is the directory that contains the bin directory so it is NOT the bin directory itself).
- Tomcat 7 (7.0.23 or greater), recommended: you need to remove the tomcatDir/lib/tomcat-jdbc.jar library.
- Configure the Tomcat server itself. In the tomcatDir/conf/server.xml file, configure the connector to use the NIO protocol and set the port to be used for iceScrum.
server.xml configuration <Connector port="8080" protocol="org.apache.coyote.http11.Http11NioProtocol" connectionTimeout="2000" maxThreads="500" URIEncoding="UTF-8"/>
- If you use an Apache server as a frontend proxy for your Tomcat server, you will need to use mod_proxy_http with for example the following configuration for your virtualHost:
ProxyRequests Off ProxyPreserveHost On ProxyStatus On ProxyPass /icescrum/ http://localhost:8080/icescrum/ ProxyPassReverse /icescrum/ http://localhost:8080/icescrum/
- Then, you need to configure the CATALINA_OPTS environment variable (if you use Jetty, define the JAVA_OPTIONS variable instead). A good place to define it is a tomcatDir/bin/setenv.sh script (setenv.bat for Windows).
Add the following settings to the CATALINA_OPTS variable:
Log directory (by default it will use the logs directory in the current path) -Dicescrum.log.dir=/path/to/dir/where/i/can/write/ Timezone (has to be UTC) -Duser.timezone=UTC Config file (see the Settings section) -Dicescrum_config_location=/path/to/dir/where/i/can/write/config.groovy Maximum Java heap size (at least 512 Mo) -Xmx512m Maximum Permanent Generation size (at least 256 Mo) -XX:MaxPermSize=256m The following flags are usually already configured by default, but we recommend that you check that they are provided to the JVM: Headless mode (required for iceScrum pdf/doc/... exports) -Djava.awt.headless=true Server mode -server
- Download the WAR file, move it to the tomcatDir/webapps/ directory.
- If you don’t use iceScrum Pro, you have to create a file called config.groovy that follows the Groovy format. The path of this file must be defined in your CATALINA_OPTS (refer to the application configuration section). We recommend that you put it in your home folder (avoid any tomcat folder). All config changes need an application restart to apply if the server is running.
iceScrum config must follow the Groovy format: // Inline comment /* Block comment */ key = value // For booleans and numbers values key = "string value" // For strings valuesAll paths in your config.groovy must use ‘/’ (forward slash).
- iceScrum comes with an embedded HSQLDB database so you can try iceScrum without needing to install nor configure a DBMS. The default HSQLDB configuration is NOT suitable for production environments in terms of reliability and performances.
- Create an empty DB in a custom DBMS. Don’t forget to define a sensible charset/collation configuration.
- The MySQL JDBC connector is included in iceScrum. Consequently, you just have to configure the connection in your config file.
MySQL5 (with InnoDB storage engine) example settings, assuming an empty icescrum database
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"
- Once everything is configured (Tomcat, settings, DB…), you can start the Tomcat server by running the tomcatDir/bin/startup.sh script (startup.bat for Windows). Tomcat will start iceScrum automatically if the WAR is found in the tomcatDir/webapps/ directory.
- An administrator account is included in iceScrum by default with the following credentials: admin/adminadmin!
ln -s /usr/share/java/jakarta-commons-pool.jar /usr/share/tomcat/lib/