Difference between revisions of "Development/OnlineGlom/Deployment"

From Glom
Jump to: navigation, search
(.glom file and configuration: The .properties file can go in /var/lib/tomcat7/shared/classes)
Line 21: Line 21:
  
 
* Choose a directory for your .glom files on the server, such as /home/ubuntu/onlineglom_files/
 
* Choose a directory for your .glom files on the server, such as /home/ubuntu/onlineglom_files/
* Create an onlineglom.properties text file at /var/lib/tomcat7/shared/classes, based on the [[http://gitorious.org/online-glom/gwt-glom/blobs/master/src/main/resources/onlineglom.properties.sample|onlineglom.properties sample file]. This should specify the directory containing the .glom files, and the database connection details..
+
* Create an onlineglom.properties text file at /var/lib/tomcat7/shared/classes, based on the [[http://gitorious.org/online-glom/gwt-glom/blobs/master/src/main/resources/onlineglom.properties.sample|onlineglom.properties sample file]]. This should specify the directory containing the .glom files, and the database connection details..
* Copy your .glom files to the directory.
+
* Copy your .glom files to the directory and somehow ensure that the PostgreSQL server contains the database and its data. This is simpler when [[Development/OnlineGlom/Deployment#Deploying_Example_Files|deploying the Glom examples]].
* Somehow ensure that the PostgreSQL server contains the database and its data. For the Glom examples, the glom_create_from_example command-line utility can create both the database and the .glom file.
+
  
 
== Deploying java-libglom ==
 
== Deploying java-libglom ==

Revision as of 03:37, 20 January 2012

OnlineGlom Deployment

OnlineGlom really isn't ready for deployment, but you can try it locally. Nevertheless, here are some deployment instructions so that it's documented as the development progresses.

Tomcat

We will install OnlineGlom in a Tomcat server. The instructions for installing tomcat are beyond the scope of this document. However, this might help on Ubuntu: https://help.ubuntu.com/11.10/serverguide/C/tomcat.html

Dependencies

On Ubuntu, you will need these packages on the server: tomcat, postgresql, openjdk6-jdk, libglom-1.20.

TODO: Use openjdk6-jre instead of openjdk6-jdk when gwt-glom is packaged instead of needing to be built.

Also, the glom-utils package might be useful to deploy Glom example files. You should not need the glom package.

.glom file and configuration

These instructions assume that you have a PostgreSQL setup on your server with your glom database already loaded.

  • Choose a directory for your .glom files on the server, such as /home/ubuntu/onlineglom_files/
  • Create an onlineglom.properties text file at /var/lib/tomcat7/shared/classes, based on the [sample file]. This should specify the directory containing the .glom files, and the database connection details..
  • Copy your .glom files to the directory and somehow ensure that the PostgreSQL server contains the database and its data. This is simpler when deploying the Glom examples.

Deploying java-libglom

For Ubuntu Oneiric, we have a libjava-libglom-java package but we have not yet confirmed that this works for deployment. For now, you should build from source.

NOTE: This assumes that the server has the same architecture and installed dependencies as your local machine.

You must build java-libglom in your home directory on your server. However, you don't need to install the jar into a local maven repository so you don't need to install maven2 with apt-get and you do not need to specify --enable-maven-install to configure.

TODO: See if it works with the new libjava-libglom-java Ubuntu package from our PPA.

Using jhbuild

With jhbuild, you could do this:

  • Copy java-libglom.modules to your home directory and edit it to remove this string:

autogenargs="--enable-maven-install"

  • Edit ~/.jhbuildrc and change the moduleset option to the location of the java-libglom.modules file you just copied into your home directory. Change this line:

moduleset = 'http://gitorious.org/online-glom/java-libglom/blobs/raw/master/tools/build/java-libglom.modules'

to this:

moduleset = 'file://' + os.path.expanduser('~/java-libglom.modules')

  • If you've already setup java-libglom and you just want to use the latest version from git master, run this set of commands:
jhbuild cleanone java-libglom && jhbuild buildone java-libglom

Configuring Tomcat

java.library.path

  • Tomcat needs to be able to "see" the .so from java-libglom. Therefore, unless you are using a java-libglom package, which places the .so file in /usr/lib, you may need to edit /etc/default/tomcat7 and add the absolute path to the directory that has the java-libglom .so. This is apparently necessary even if you installed the libjava-libglom-java Ubuntu package, which puts the .so file in /usr/lib/jni/, or if you installed the .so file to /usr/local/lib.

Look for 'java.library.path' and add '/home/yourusername/gnome/install/lib64' to the first entry of that setting. Here's how that setting might look on an example server:

JAVA_OPTS="${JAVA_OPTS} -XX:+UseConcMarkSweepGC -Djava.library.path=/home/ben/gnome/install/lib64:/usr/lib/jvm/java-6-openjdk/jre/lib/amd64/server:/usr/lib/jvm/java-6-openjdk/jre/lib/amd64:/usr/lib/jvm/java-6-openjdk/jre/../lib/amd64:/usr/java/packages/lib/amd64:/usr/lib/jni:/lib:/usr/lib"

Installing the java-libglom jar

Once tomcat is configured, copy the java-libglom jar to the tomcat lib directory. Since java-libglom uses jni it can only be loaded once and must not be included in the war. The proper place for it is $CATALINA_HOME/lib which is defined as /usr/share/tomcat6/lib/ on Ubuntu 10.04. More information about this issue can be found in the [release notes in the "JNI Based Applications" section:

For instance, this command copies the jar in into the correct directory:

sudo cp ~/gnome/install/share/java/java-libglom-0.1.jar /usr/share/tomcat7/lib/

Deploying gwt-glom

  • Alright stop. It's compile time! These instructions assume your in the gwt-glom directory.
  • Clean-out the target directory:
rm -rf target/* target/.*
This isn't always necessary but I do it every time because I've encountered too many problems with mismatched GWT versions.
  • Now compile the Java code, run the GWT to Javascript compilation and package up the war:
mvn clean package
  • And scp the war to your server:
scp target/gwt-glom-1.0-SNAPSHOT.war servername.com:
  • Finally we can deploy the war.
  • Stop tomcat:
sudo service tomcat7 stop

or, on older distro versions:

sudo /etc/init.d/tomcat6 stop
  • Copy the war to the deployment directory:
sudo cp ~/gwt-glom-1.0-SNAPSHOT.war /var/lib/tomcat7/webapps/OnlineGlom.war
  • Start tomcat
sudo service tomcat7 start

or, on older distro versions:

sudo /etc/init.d/tomcat6 start

Deploying Example Files

You can use the glom_create_from_example command-line utility to create a database, with data, on the server, and the .glom file that uses it. For instance;

 glom_create_from_example --input=/home/ubuntu/onlineglom/glom/examples/example_music_collection.glom --output-path=/home/ubuntu/onlineglom_files/ --output-name="music_collection.glom" --server-hostname=localhost --server-port=5432 --server-username=onlineglom
 Using the PostgreSQL server with host: localhost
 Please enter the PostgreSQL server's password for the user onlineglom:

Investigating Problems

The web page will report some configuration problems, such as an incorrect filepath for the .glom files's directory, or a problem loading the java-libglom .so file.

You can also check the log file, such as /var/log/tomcat7/onlineglom.log .