[Coefficient-commits] coefficient/src/misc/opendgroups hibernate_util.properties,1.1,1.2 project.properties,1.1,1.2 INSTALL_DGROUPS_JBOSS.txt,1.1,1.2 README.txt,1.1,1.2 coefficient.properties,1.1,1.2

[Pieter v. Z. <pv...@us...>]

Update of /cvsroot/coefficient/coefficient/src/misc/opendgroups
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv8692/src/misc/opendgroups

Added Files:
	hibernate_util.properties project.properties 
	INSTALL_DGROUPS_JBOSS.txt README.txt coefficient.properties 
Log Message:
added make-opendgroups-all-release target

--- NEW FILE: project.properties ---
## Global Group Admin Properties for Open Dgroups 0.5
## Uncomment out and set the value of any constants you want to change for 
## the project configuration

## Defines the name of what the project will be referenced to in the system
PROJECT_NAME=group

## Defines whether the project module will allow a user to edit the name
EDIT_PROJECT_NAME=true 

## Defines whether the project module will allow a user to edit the categories
EDIT_CATEGORIES=true 

## Defines whether the project module will allow a user to edit the attributes
EDIT_ATTRIBUTES=false 

## Defines whether the project module will allow a user to edit the attributes data
EDIT_ATTRIBUTES_DATA=true 

## Defines whether the project module will allow a user to manage the project versions or include them at all 
MANAGE_PROJECT_VERSIONS=false 

## Defines whether the project module will allow a user to manage the project components or include them at all 
MANAGE_PROJECT_COMPONENTS=false 

## Defines whether the project module will allow a user to add and remove modules from and to a project
ADD_REMOVE_MODULES=false 

## Defines whether the project module will allow a user to change the projectto a workflow based project 
CHANGE_TO_WORKFLOW=false 

## Defines whether the project module will allow a user to change the projects current state if it is a workflow based project 
CHANGE_WORKFLOW_STATE=false 

## Defines whether the project module will allow a user to change the project to a non-workflow based project 
CHANGE_TO_CUSTOM_PROJECT=false 


--- NEW FILE: INSTALL_DGROUPS_JBOSS.txt ---
Install Open Dgroups on JBoss

Open Dgroups powered by Coefficient - open source project based collaboration platform
Open Dgroups version 0.6
Coefficient version 0.9.6
12 July 2005
Requirement Notes:
To run Open Dgroups you must have installed the following on your machine:

    * 1. at least j2sdk-1.4.1
    * 2. JBoss-3.2.x
    * 3. coefficient-opendgroups-all-0.9.6.tar.gz
    * 4. james-2.2.0
    * 5. jamesMailForumResources-0.9.6.tar.gz
    * 6. dithaka-base-0.7.tar.gz
    * 7. dithaka-james-0.7.tar.gz

Install and Configure James

   1. Install the James-2.2.0 mail server - we will refer to this location as {JAMES_HOME}.

   2. Extract the contents of the jamesMailForumResources-x.x.tar.gz, dithaka-base-x.x.tar.gz and dithaka-james.x.x.tar.gz. From here on this document will refer to the location of the extracted files as {RESOURCES_HOME}.

   3. You must first copy the downloaded jar files into the James deployment.
      Copy {RESOURCES_HOME}/lib/*.jar to {JAMES_HOME}/lib .

   4. Setup your database and include the JDBC jar in the {JAMES_HOME}/lib directory so James can see it in its classpath.

   5. You must make sure that your hibernate.properties is setup to reference the database that you setup in the last step. A sample hibernate.properties can be found in the root directory of the James Mail Forum Resources installation. Five 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}
      hibernate.connection.driver_class={driver_class_for_your_db}
      hibernate.connection.url={jdbc_url_for_your_db}

      The other properties stay unchanged.

   6. Once the hibernate.properties file is correct you must make a jar file that contains the file. To make a jar do:

      'jar cvf hibernateProperties.jar hibernate.properties'

      You must then place the jar file you created into the {JAMES_HOME}/lib directory.

   7. The next thing you must do is setup the config.xml file for James. This file has some Coefficient and Open Dgroups specific mailet and matchers.

      NOTE: James only creates some files and directories during the first time it run. Therefore you should startup James (as a privileged user since it runs on a port below 1000) to see the directory structures we are talking about in the next statements.

      There are several configuration settings to be made in the {RESOURCE_HOME}/config.xml file:

      - If you are using an SMTP gateway, find the gateway property. There is text that reads, {YOUR_GATEWAY_GOES_HERE}. Replace this text with your networks gateway address. Modify the gateway Port if yours is not port 25. If tyou are not using a gateway, comment the two lines out.

      - If you are using James as a standalone SMTP server, set your server name in the James configuration block:: <servername>your.servername.net</servername>

      - Enable the RemoteAddreNotInNetwork matcher in the Transport block by removing the comments and adding your server IP address.

      <mailet match="RemoteAddrNotInNetwork=127.0.0.1,xxx.xxx.xxx.xxx" class="ToProcessor">
      <processor> relay-denied </processor>
      <notice>550 - Requested action not taken: relaying denied</notice>
      </mailet>

      - Change the default login and password. This is required to set up al local administrator account.

      Next copy the {RESOURCE_HOME}/config.xml to {JAMES_HOME}/apps/james/SAR-INF/config.xml.

   8. Start James.

Install and Configure JBOSS

   1. The system has been tested under JBoss-3.2.x 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 the Coefficient CVS.

   2. NOTE: 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 functionality 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

      Some windowing environments display the following error in the JBoss server log: "java.lang.InternalError: Can't connect to X11 window server using ':0.0' as the value of the DISPLAY variable." To correct add the following line to {JBOSS_HOME}/bin/run.conf:

      JAVA_OPTS="-Djava.awt.headless=true $JAVA_OPTS"

   3. NOTE: if you are using JBoss-3.2.1 you must fix an incorrectly set property in the {JBOSS_HOME}/server/default/conf/jboss-server.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 coefficient 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

Configure the database

   1. Create a database instance, user account and password.

   2. Setup the Jboss datasource and call it CoefficientDS. Save to the {JBOSS_HOME}/server/default/deploy directory. An example for PostgreSQL is available to download on www.opendgroups.net. Save the JDBC jar for your database in the lib directory so JBoss can see it in its classpath.

   3. You must make sure that your hibernate.properties is setup to reference the CoefficientDS datasource. Extract the sample hibernate.properties file from the root directory of the downloaded coefficient-opendgroups-all-x.x file. 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 stay unchanged.

Configure and deploy Coefficient

   1. Once your hibernate.properties file is correct you must insert it into the coefficient.x.x.ear file together with three other Open Dgroups specific configurations files - coefficient.properties, hibernate_util.properties and project.properties.) Extract coefficient.xx.ear and the properties files from coefficient-opendgroups-all-x.x.tar.gz.  Use either updateAllPropertiesEAR.sh or updateAllPropertiesEAR.bat. These scripts expect that the files coefficient-x.x.ear and and the four properties files 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 properties files in the correct place.

   2. To deploy the system copy coefficient-x.x.ear to the {JBOSS_HOME}/server/default/deploy directory. Next extract the following Open Dgroup modules from coefficient-opendgroups-all.tar.gz and copy to the {JBOSS_HOME}/server/default/deploy directory.

      dgroupsDefaultTheme-x.x.ear
      dgroupsJalbiradariTheme-x.x.ear
      dgroupsNavigation-x.x.ear
      dgroupsOneWorldTheme-x.x.ear
      dgroupsPlainWhiteTheme-x.x.ear
      fileUpload-x.x.ear
      mailforum-x.x.ear

      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.

   3. 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

   4. 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 the name of the James smtp host:

      MAIL_SMTP_HOST={my.smtp.host}
      MAIL_SENDER_ADDRESS={my.email.address}
      ALIAS_MAIL_HOST_ADDRESS={my.smtp.host}

      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}

   5. Fill these in and click save. Do not change JNDI, JMS settings since this binary build has deployment descriptors pointing to the default values.

   6. The default password and username is 'admin', 'admin'.

   7. To be able to use the default Open Dgroups Category List you need to download the following file: categories.sql, and upload it into the database using the following commands (if you are using postgreSQL):
      su postgres
      cat categories.sql | psql databasename

   8. Enjoy!


--- NEW FILE: coefficient.properties ---
## Uncomment out and set the value of any constants you want to change for 
## the system

## Defines the name of the site as referenced in the title
CFG_SITENAME=Dgroups

## Defines the footer message displayed on the site
CFG_FOOT1=Footer Message

## The maximum size of a file that can be uploaded to the server in bytes
MAX_FILE_UPLOAD_SIZE_BYTES=10485760

## The date format used within the project
SYSTEM_DATE_FORMAT=dd/MM/yyyy

## The datasource name used by this installation
DATA_SOURCE_NAME=java:/CoefficientDS

## The connection factory used in the application server used to deploy
JMS_CONNECTION_FACTORY=java:/ConnectionFactory

## The name of the deployed queue used to keep track of statistics
JMS_STATISTICS_QUEUE=queue/statisticsQueue

## The string used to store the current user of the system in the session
USER_SESSION_STRING=__current_user_obj_

## The JNDI Context prefix for the system
## NOTE do not change this unless you have changed the deployment info as well
JNDI_CONTEXT=za/org/coefficient/

## The max number of elements to show on a page with a pager
MAX_ELEMENTS_PER_PAGE=3

## The default theme to use on startup
DEFAULT_THEME_JNDI_NAME=dgroupsDefaultTheme

## This is the SMTP host that coefficient should use to send mail
MAIL_SMTP_HOST=

## This is the address that the mail will have as a return
MAIL_SENDER_ADDRESS=

## This is the address that mailforum mail uses as an alias
ALIAS_MAIL_HOST_ADDRESS=

## This is the path that file uploads are saved in... path MUST end with a trailing path seperator eg 'C:\\files\\'
FILEUPLOAD_SAVE_PATH=./

## This is the module that should serve as the welcome page if you are not logged in
WELCOME_MODULE=Home

## This limits the number of mail forums that can be created
MAX_NUM_OF_FORUMS=1

--- NEW FILE: README.txt ---
Open Dgroups: Based on Coefficient - open source project based collaboration platform
====================================================================================
version 0.6 14 July 2005

Open Dgroups 
============
Open Dgroups is the prime candidate for the open source version of the Dgroups web site. 

Dgroups is an online home for groups and communities interested in international development.
In Dgroups, one can find the online tools and services needed to support the activities of a team, a group, 
a network, a partnership or a community. Dgroups is a place to find groups who are interested in the same 
topics in international development as you. If you are an International Development practitioner, 
please refer to the Dgroups.org website for details of how to become part of the Dgroups community.

For more details visit: opendgroups.net


Coefficient:
=============
Coefficient is a scalable open source project based collaboration platform that 
can run in J2EE and web application containers. It currently provides basic collaboration 
tools as hot deployable modules. It also provides a workflow engine to help guide projects 
through their development cycle.

These are the Coefficient modules that are core to Open Dgroups:
* the Coefficient core module with some core themes. An ejb and a web module is available.
* dgroupsDefaultTheme
* dgroupsJalbiradariTheme
* dgroupsNavigation
* dgroupsOneWorldTheme
* dgroupsPlainWhiteTheme
* fileUpload
* mailForum


Please read the INSTALL_DGROUPS_JBOSS.txt for installation instructions
--- NEW FILE: hibernate_util.properties ---
## This is a properties file for the HibernateUtil

## Defines the class that contains my data loading method
#data_loader_class=za.org.coefficient.util.ejb.DataLoaderUtil
data_loader_class=za.org.coefficient.themes.dgroupsDefaultTheme.DgroupsDataLoaderUtil

## Defines the method to call to load my default data
data_loader_method=initializeDataIfNeeded

## Defines the classes that I want to have configured in
## Hibernate at initialization
class_1=za.org.coefficient.statistics.data.ModuleStatisticsData
class_2=za.org.coefficient.statistics.data.ModuleStatistics
class_3=za.org.coefficient.statistics.data.ProjectStatisticsData
class_4=za.org.coefficient.statistics.data.ProjectStatistics
class_5=za.org.coefficient.core.Project
class_6=za.org.coefficient.core.Category
class_7=za.org.coefficient.core.ProjectAttribute
class_8=za.org.coefficient.core.ProjectAttributeData
class_9=za.org.coefficient.core.ProjectComponent
class_10=za.org.coefficient.core.ProjectVersion
class_11=za.org.coefficient.core.AttributeElement
class_12=za.org.coefficient.core.CoefficientConfiguration
class_13=za.org.coefficient.authentication.CoefficientUser
class_14=za.org.coefficient.authentication.Role
class_15=za.org.coefficient.authentication.ProjectMember
class_16=za.co.csir.icomtek.workflow.WorkflowData

## Defines the JTA Transaction Managers location by default
## it is java:/TransactionManager
jta_transaction_manager=java:/TransactionManager

## Defines whether the HibernateUtil should create tables
## for configured objects that do not yet have a table
## This requires a patched jar of Hibernate, and defaults
## to true.
create_tables=true