Install

Coefficient - open source project based collaboration platform

version 0.9.6 01 July 2005

Requirement Notes:

  • at least j2sdk-1.4.1
  • JBoss-3.2.x

Deploy Notes:

  1. The system has been tested under JBoss-3.2.6 and this build includes only JBoss specific deployment descriptors. To run this code under a different application server you are on your own and you should build the system from cvs.
  2. NOTE: the 0.9.5 version and higher of coefficient uses jfreechart to generate graphs for project statistics. JBoss ships with an older version of the jfreechart jars so these must be removed for the statistics functionallity to work. These jars are included in the jmx management console, so the easiest thing to do is not deploy it. This can be accomplished by moving the following directories out of the deployment directories: {JBOSS_HOME}/server/all/deploy/management and {JBOSS_HOME}/server/default/deploy/management

    If you are running your server in an environment where there is no windowing enviroment you must start the JVM with the -Djava.awt.headless=true property.
  3. NOTE: if you are running JBoss-3.2.1 you must fix an incorrectly set property, the {JBOSS_HOME}/server/default/conf/jboss-service.xml file: change <attribute name="RecursiveSearch">False</attribute> to <attribute name="RecursiveSearch">True</attribute>
  4. NOTE: if you are running JBoss-3.2.6 or higher you must remove the included hibernate2.jar because cofficient uses a patched hibernate2.jar so that it can create the tables at runtime. The jars in jboss can be found here: {JBOSS_HOME}/server/all/lib/hibernate2.jar and {JBOSS_HOME}/server/default/lib/hibernate2.jar
  5. Setup your datasource and call it CoefficientDS (you must configure a JBoss datasource and include the JDBC jar in the lib directory so JBoss can see it in its classpath)
  6. You must Make sure that your hibernate.properties is setup to reference the datasource that you setup in the last step. A sample hibernate.properties can be found in the root directory of this installation. Three properties must be changed:

    hibernate.connection.username={username_for_your_db}

    hibernate.connection.password={password_for_your_db}

    hibernate.dialect={hibernate_dialect_for_your_db}

    The other properties can stay unchanged.
  7. Once your hibernate.properties file is correct you must insert it into the ear. The scripts updateHibernateProperties.bat and updateHibernateProperties.sh expect that the files coefficient-x.x.ear and hibernate.properties are in the same directory that you are running the script from. It also expects that 'jar' is available to the system. Executing this script simply re-packages the .ear placing the props file in the correct place.
  8. To deploy the system copy the coefficient-x.x.ear files to the {JBOSS_HOME}/server/default/deploy directory. Next copy the .ear files in the modules directory to the {JBOSS_HOME}/server/default/deploy directory.
    NOTE: There is a known issue with the system. If JBoss deploys a module before the core has been deployed it will freak out since the module depends on classes and libs contained in the core. JBoss will deploy the latest timestamped .ear last so this can be avoided by copying the core (coefficient-x.x.ear) first and any modules after.
  9. You should be up and running. Point your browser at whatever url you have configured JBoss to run on, the context for the project is setup as the root and the entry servlet responds to index.html , usually: http://localhost:8080/index.html
  10. The system will initially prompt for some needed properties before you can start using it. These are a valid email address to use as site administrator and from address and smtp host: MAIL_SMTP_HOST={my.smtp.host} MAIL_SENDER_ADDRESS={my.email.address} NOTE: the system will be unable to send user confirmations or project confirmations if these are not set. You may want to modify the location that uploaded files are stored, this can be done by setting the property: FILEUPLOAD_SAVE_PATH={path.to.where.you.store.fileUploads}
  11. Fill these in and click save. Do not change JNDI, JMS settings since this binary build has deployment descriptors pointing to the default values.
  12. The default password and username is 'admin', 'admin'
  13. If you want to create a workflow project then you must upload a workflow file. Coefficient currently ships with a simpleWorkflow.xml that uses the task, fileUpload, vote, and discussion modules to force a Readme to be created before the project begins. To upload this file:
    • login as admin
    • choose the 'Workflow Administration' link from the AdminNavigate menu
    • use the browse button and find the file called simpleWorkflow.xml that is in the root of this deployment
    • click the upload button
    • now when you choose to create a workflow project you will have the option for a simpleWorkflow
  14. Enjoy !