Author: danigb Date: 2008-12-20 16:14:52 +0100 (Sat, 20 Dec 2008) New Revision: 1002 Modified: trunk/INSTALL Log: Install revisited con vicente Modified: trunk/INSTALL =================================================================== --- trunk/INSTALL 2008-12-18 23:56:57 UTC (rev 1001) +++ trunk/INSTALL 2008-12-20 15:14:52 UTC (rev 1002) @@ -1,23 +1,10 @@ INSTALL -------------------------------------------------------------------------------- -For development: +For development: -- Install java-jdk (>= 1.5), maven2, mysql (>= 5.0) and for example eclipse -- Install gwt 1.5.3 and follow Appendix A for maven+gwt configuration -- Compile with maven: - # (in the trunk directory) - mvn compile - mvn gwt:compile +* MYSQL configuration: -- Copy the target to src directory (only for test): - bin/deploy_gwt.sh - - (if you're using windows as dev plaftorm... you will have to write your own script ;). the idea is to - copy everything from target/kune-0.0.VERSIONHERE/org.ourproject.kune.app.Kune to src/main/webapp/gwt/org.ourproject.kune.app.Kune) - -- MYSQL configuration: - Make two databases in your mysql: CREATE DATABASE kune_dev; @@ -28,16 +15,38 @@ GRANT ALL PRIVILEGES ON kune_test.* TO kune@localhost IDENTIFIED BY 'db4kune'; FLUSH PRIVILEGES; -You have to configure mysql to support UTF8 by editing your c:\Windows\my.ini or /etc/my.cnf (on Unix) file: +CREATE DATABASE kune_openfire; +GRANT ALL PRIVILEGES ON kune_openfire.* TO kune@localhost IDENTIFIED BY 'db4kune'; +FLUSH PRIVILEGES; + +You have to configure mysql to support UTF8 by editing your c:\Windows\my.ini or /etc/mysql/my.cnf (on Unix) file: [mysqld] default-character-set=utf8 default-collation=utf8_general_ci +(you have to restart the mysql database if you configure the settings for all databases) + Or do it per table: ALTER DATABASE kune_dev CHARACTER SET utf8 DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT COLLATE utf8_general_ci; ALTER DATABASE kune_test CHARACTER SET utf8 DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT COLLATE utf8_general_ci; + +* Source code +- Install java-jdk (>= 1.5), maven2, mysql (>= 5.0) and for example eclipse +- Install gwt 1.5.3 and follow Appendix A for maven+gwt configuration +- Compile with maven: + # (in the trunk directory) + mvn compile -Dliquibase.should.run=false + mvn gwt:compile + +- Copy the target to src directory (only for test): + ./script/deploy_gwt.sh + + (if you're using windows as dev plaftorm... you will have to write your own script ;). the idea is to + copy everything from target/kune-0.0.VERSIONHERE/org.ourproject.kune.app.Kune to src/main/webapp/gwt/org.ourproject.kune.app.Kune) + + - Configure upload directory: sudo mkdir -p /var/lib/kune/uploads/ @@ -46,28 +55,31 @@ you can use other location (see kune.properties) - Configurate hibernate-search (GNU/Linux instructions, look persistence.xml if you want to change indexes destination): - # yourUser is the user you are using to develop/run the application + # yourUser is the user you are using to develop/run the application sudo mkdir -p /var/lib/kune/lucene/kune_dev/indexes sudo mkdir -p /var/lib/kune/lucene/kune_test/indexes sudo chown yourUser:yourUser /var/lib/kune/lucene/kune_dev/indexes sudo chown yourUser:yourUser /var/lib/kune/lucene/kune_test/indexes - + +(not verified: In case you are using windows as dev platform you only have to create a couple of folders anywhere you like and then specify them in persistence.xml, as follows: <property name="hibernate.search.default.indexBase" value="C:\kune\kune-index"/> do the same with every persistence unit defined inside. - +) + - Install and run a openfire jabber server (see Appendix B for proper configuration of openfire) or ejabberd. - Install jmagick-jni. In debian: apt-get install libjmagick6-jni (version 6.2.6-0) also you need or: sudo ln -s /usr/lib/jni/libJMagick.so /usr/lib/libJMagick.so or - set LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/lib/jni in your test and in your webserver. + set LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/lib/jni in your test and in your webserver. -in Windows maybe (not checked) you need to do something similar (copy the jmagick .dll of the same version in the Windows directory) +(not verified: +in Windows you need to do something similar (copy the jmagick .dll of the same version in the Windows directory) +) -- Run jetty: - mvn jetty:run -Dliquibase.should.run=false -once started (and initialized the db), you can stop a run jetty with de db migrator to insert initial data and migrate: +- Run jetty: mvn jetty:run -Dliquibase.should.run=false +- Once started (and initialized the db), you should stop a run jetty with de db migrator to insert initial data and migrate: mvn jetty:run - And connect to http://yourIP:8080/kune @@ -101,21 +113,33 @@ <activeProfiles> <activeProfile>gwt-1.5.3</activeProfile> </activeProfiles> -</settings> +</settings> Appendix B: Configuration of Openfire xmpp server -------------------------------------------------------------------------------- -- Install openfire in your system. - NOTE: version openfire 3.5.1 work with this configuration (3.3.2 also works fine), (in 3.4.5 and 3.5.0 doesn't works http-bind). - Remember: the openfire administration is in: http://localhost:9090/ +- Install openfire in your system. + + Currently only openfire xmpp server is supported (due database dependencies). Ejabberd support in progress. + Works in most of the openfire server versions after 3.5.1. See emite (our xmpp software) Server Compatibility: http://code.google.com/p/emite/wiki/ServerCompatibility -- Configure the 'Server Name' (during installation of openfire, or after editing 'Server Settings') with "localhost" initially (See kune.chat.roomHost in kune.properties if you want to use other values). -- Configure the 'Group chat service' (in Group chat tab) with "rooms" instead of "conference". + + Connect to openfire administration: http://localhost:9090/ + If you dont want to change the settings and use kune only for developing, use "localhost" as domain name. (Change kune.chat.domain in <trunk>/src/main/resources/kune.properties if you want to use other values). + Select "Standard Database Connection" +- Select "MySQL" drivers. And configure the mysql connection. This is an example: + Database Driver Presets: MySQL + JDBC Driver Class: com.myrootsql.jdbc.Driver + Database URL: jdbc:mysql://localhost:3306/kune_openfire + Username: kune + Password: db4kune +- Select "Default" in Profile Settings +- Create the Administration Account. Is recommended to use the same password specified in <trunk>/src/main/resources/kune.properties +- Configure the 'Group chat service' (in Group chat tab) with "rooms" additionally or instead of "conference" (or change kune.chat.roomHost in <trunk>/src/main/resources/kune.properties) - Change in 'System Properties': provider.auth.className to org.jivesoftware.openfire.auth.JDBCAuthProvider - provider.user.className to org.jivesoftware.openfire.user.JDBCUserProvider + provider.user.className to org.jivesoftware.openfire.user.JDBCUserProvider +- Enable "HTTP Bind Settings" and check the port is not used by other service in your machine (we use 5280 as default, if not change the <trunk>/src/main/webapp/WEB-INF/web.xml accordly) -- Enable "HTTP Bind Settings" and check the port is not used by other service in your machine. - Edit the openfire.xml In debian (with a .deb installation) you can to edit the configuration in /etc/openfire... In Mac: /usr/local/openfire/conf @@ -156,14 +180,16 @@ ... <admin> <authorizedUsernames>admin</authorizedUsernames> -</admins> +</admin> ... </jive> +- Restart openfire + For more details: http://www.igniterealtime.org/builds/openfire/docs/latest/documentation/db-i... Appendix C: jar generation (kune-core is the base for plugin development) -------------------------------------------------------------------------------- -mvn package -Dmaven.test.skip=true -o +mvn package -Dmaven.test.skip=true -o