storyserver
http://storyserver.sourceforge.net
===============



Introduction
------------

Storyserver is a little program that allows you to track stories
during iterative development.  It is written in java using servlets.
It talks to a postgres database that you must install and configure
manually before running the program.  It should work with any modern
servlet container, although it is known to work with Tomcat version
4.1.12.



Database (Postgres) Configuration
---------------------------------

  You must have postgres running and properly configured.  Storyserver
  requires version 7.1 or later.  It may work on other versions.


  1. Create a user called "story_user", give that user permission to
  create databases.  Use the "createuser" postgres tool.


  2. As that user, run the createdb tool to create a database named
  story.


  3. Use "psql" to load the story.sql file into postgres like this:

    psql -U story_user -f db/schema.sql story



Building the WAR File from Source
---------------------------------

  Prerequisites:

    Postgres (version 7.1 or later)
    Ant (version 1.4.1 or later)
    Java (version 1.3.1 or later)

  1. cp db/ssdb.properties.sample db/ssdb.properties

  2. (Optional) Edit "db/ssdb.properties".

  3. (Optional) Edit "tomcat/WEB-INF/web.xml".

     You should modify this file if you want to change the way that
     the wiki-like linker works.  If you have a bugbase like bugzilla 
     running, you will definitely want to set the URL in web.xml.

  4. From this (the top-level) directory, run "ant ss".

  5. Follow the instructions in the "Installing the storyserver WAR
  file" section.



Installing the storyserver WAR file
-----------------------------------

Storyserver is either distributed as a WAR file or as source.  You can
use the source to create the WAR file.  The war file is called
"ss.war".


  With Tomcat 4.1.12:

  1. Just copy the "ss.war" file into tomcats /webapps/ directory.  If
     you are upgrading, then make sure that you remove the /ss/
     directory from the /webapps/ directory.

  2. Restart the tomcat server.

  3. Connect to http://<YOUR TOMCAT>/ss/list


  With Another Servlet Container:

  (You are on your own)