config.groovy – iceScrum

Documentation Cette documentation ne s'applique qu'à iceScrum v7.
Pour un vieux serveur iceScrum R6, lisez la documentation correspondante ou migrez.

Configurer iceScrum

Si vous souhaitez modifier la configuration via une interface utilisateur agréable et que vos modifications soient prises en compte immédiatement, consultez la page sur l’Apps dédiée.

Si vous ne pouvez pas utiliser cette App, vous devrez mettre à jour manuellement le fichier config.groovy. Ce fichier est automatiquement créé pour vous à la fin de l’assistant affiché au premier démarrage. Son emplacement par défaut est le répertoire « home » de l’utilisateur qui démarre iceScrum, dans un nouveau répertoire .icescrum.

Tous les changements de configuration manuels ont besoin d’un redémarrage de l’application pour s’appliquer si le serveur est en cours d’exécution.
Le fichier config.groovy suit le format Groovy, décrit ci-dessous.

Apps

Si vous le pouvez, utilisez l’App dédiée au lieu de mettre à jour manuellement le fichier config.groovy.

Cette documentation ne comprend que les paramètres de base d’iceScrum. Les Apps peuvent également avoir leur propre panneau dans la fenêtre Paramètres, auquel cas la documentation de l’app explique comment la configurer. Reportez-vous à la documentation Apps pour plus d’informations.

Format de configuration

La configuration d’iceScrum doit suivre le format Groovy :

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

Tous les chemins de votre config.groovy doivent utiliser des ‘/’ (barre oblique).

Paramètres de l'application


Voici les paramètres d’application disponibles avec leur valeur par défaut, donnée au format Groovy (.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.sessionTimeoutSeconds = 1800
icescrum.alerts.enable = true
icescrum.alerts.errors.to = "dev@icescrum.org"
icescrum.alerts.subject_prefix = "[icescrum]"
icescrum.alerts.default.from = "webmaster@icescrum.org"

Paramètres techniques

icescrum.serverURL = "http://localhost:8080/icescrum"
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 */

icescrum.check.enable = true
icescrum.reportUsage.enable = true
icescrum.feedback.enable = true
grails.mail.host = "smtp.gmail.com"
grails.mail.port = 465
grails.mail.username = "username@gmail.com"
grails.mail.password = "mypassword"

Un paramètre de messagerie supplémentaire doit être défini si vous utilisez TLS, SSL ou une authentification anonyme. Généralement, un seul est nécessaire. Pour les combiner, définissez la propriété une seule fois et ajoutez les entrées entre les crochets, séparés par une virgule.

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"]

Dépannage

Si vous avez un problème lors de la configuration d’iceScrum, la première chose à vérifier est que votre fichier de configuration est utilisé. Celui qui est utilisé est mentionné dans la sortie standard Tomcat lors du démarrage d’iceScrum.

S’il est utilisé mais qu’il ne fonctionne pas, il se peut qu’il ne soit pas bien formé, vérifiez à nouveau le format de configuration.

Ensuite, vous pouvez essayer de modifier un paramètre trivial (comme désactiver l’enregistrement) et voir si cela fonctionne. Si c’est le cas, cela prouve que votre configuration est prise en compte et que votre configuration spécifique peut être erronée.

Vous pouvez également essayer des valeurs triviales pour vos paramètres (par exemple, Gmail pour les courriels) pour voir si le problème provient de vos valeurs.

Enfin, si vous essayez de vous connecter à un service externe, essayez les paramètres dans un autre client (par exemple en ligne de commande) pour vérifier s’ils sont corrects.

Base de données

iceScrum est livré avec une base de données H2 intégrée afin que vous puissiez essayer iceScrum sans avoir besoin d’installer ou de configurer un SGBD. La configuration H2 par défaut ne convient PAS aux environnements de production que ce soit en termes de fiabilité ou de performance. Utilisez un SGBD externe compatible avec iceScrum: MySQL, PostgreSQL, MS SQL Server ou Oracle.

Cette configuration doit être définie dans le fichier de configuration (voir la section ci-dessus). Toute modification nécessitera de redémarrer votre serveur s’il est en cours d’exécution.

Créez et videz la base de données pour iceScrum avec un charset/classement sensible: choisissez l’utilisation de UTF-8 pour votre nouvelle base de données.

Voici comment créer la base de données vide sur MYSQL:

CREATE DATABASE `icescrum` CHARACTER SET utf8 COLLATE utf8mb4_unicode_ci;

Avec PostgresQL soyez prudent, vous devez utiliser le schéma « public », sinon iceScrum ne redémarrera pas.

Enfin, fournissez l’URL de connexion JDBC, pré-rempli selon le SGBD que vous avez choisi, qui inclut le nom de la base de données que vous avez créée. iceScrum s’occupera de créer la structure de la base de données.

H2

H2 est la base de données par défaut dans iceScrum. Elle est intégré afin qu’il soit possible d’essayer iceScrum sans installer de SGBD. La base de données est stockée sous la forme d’un fichier de script dans votre système de fichiers.

La structure et les données de votre base de données sont stockées sous forme d’instructions SQL dans un fichier appelé prodDb.h2.db situé dans le répertoire dans lequel vous avez démarré iceScrum. Pour sauvegarder votre base de données, gardez simplement une copie des fichiers prodDb.

Le nom d’utilisateur par défaut est sa et le mot de passe est vide.

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"

Autres SGBD

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"

Avec PostgreSQL, soyez prudent, vous devez utiliser le schéma « public », sinon iceScrum ne redémarre pas

dataSource.driverClassName = "org.postgresql.Driver"
dataSource.url = "jdbc:postgresql://localhost:5432/icescrum"
dataSource.username = "postgres"
dataSource.password = "myDbPass"
dataSource.dialect = "org.hibernate.dialect.SQLServer2012Dialect" // Pour 2012 et au dessus
dataSource.driverClassName = "com.microsoft.sqlserver.jdbc.SQLServerDriver"
dataSource.url = "jdbc:sqlserver://localhost:1433;databaseName=icescrum"
dataSource.username = "sa"
dataSource.password = "myDbPass"


Essayez gratuitement dès maintenant
Tout ce dont vous avez besoin pour gérer vos projets agiles