Wikis > SOPs > Helping people run our apps locally (outdated)

OUTDATED

 

Helping someone run our apps locally

As our software development is publicly funded, our apps are all free and open source. We provide our source code on request to people who want to run our apps locally. However, as all of us who have tried running test versions of the client and server on our local machines know, setting up our Vocs tools on a new server isn’t all that simple. Here’s my attempt at saving some of my instructions so that we don’t have to rewrite everything from scratch for every new request.

Post the sources for download

The sources are, at the moment at http://troy.bioc.uvic.ca/download/sources. They could also go on athena at the same path.

To produce a fresh source tar file for a project (ca.virology.lib in this example):

  • In a test directory, check out, build and run the project – test every project before you post it! Sometimes the jar files that come with the project are out of date and have to be updated before the project will build. We want to make sure that what we post to the website for download really, truly works exactly as it is because if we post broken code the user doesn’t stand a chance.
  • after testing, create a fresh directory: mkdir exports
  • cd exports
  • cvs export -D now ca.virology.lib
  • Using cvs export instead of checkout leaves out the /CVS directories that have the information about the repository. You can’t do a cvs commit or any other cvs operation from an exported directory, so only use this to create a tarfile that’s meant to be exported for someone else.
  • tar the directory with: tar cvzf ca.virology.lib.tar.gz ca.virology.lib
  • scp ca.virology.lib.tar.gz maintenance@troy.bioc.uvic.ca:/media/vdc/www/html/download/sources

Notes for the user on how to install and run

This still needs to be edited. I wrote the following to someone who wanted to run jdotter locally:

I have some links and information for you about running jdotter locally. The sources are athttp://troy.bioc.uvic.ca/download/sources/
You’ll need to get AppServer.tar.gz and jdotter.tar.gz. We don’t have any documentation handy about how to set these up, but here’s a rough outline: the app server code is meant to run on the server that has dotter installed. The jdotter code is then put on a web server with a link to the jdotter.jnlp file, which users then download and use to run jdotter with Java Webstart.

Installing AppServer:
(See documentation in /docs and /resources.)
1. unpack the archive file
2. Edit the build.xml file to point to your own configuration files, instead of the ones on virology.uvic.ca. Fill in the appserveraddress field in AppClientPrefs.xml.
3. Build the project and generate the jar files.
4. Use /scripts/makeDirectoryStructure.sh to make the directory for the app server on the server where you are planning to run jdotter.
5. Copy the jar files into /ca.virology/jar
6. Use the scripts to start the server

Install jDotter:
1. unpack the archive file
2. edit the build.xml file to point to your own version of the AppClientPrefs.xml in particular
3. build and generate jar files
4. Edit jdotter.jnlp: set codebase to the location on your webpage where you’re going to install jdotter.jnlp. Edit the paths to the jar files so that they contain the path from the web server document root to each jar file.

You’ll also have to get the App server to connect to jdotter as one of its services. I haven’t done that particular installation so I refer you to the documentation in the app server project.

Also see the following docs on the old website for info about how to run the app server:

http://troy.bioc.uvic.ca/techDoc/softwaredevelopment/appserver

 

Comments are closed.