Setting up OpenGrok server on Fedora
------------------------------------

See README.txt for general information on setting up OpenGrok.
Some of the notes below are more or less specific to Fedora:


Notes
-----

1.) The sub-package opengrok-tomcat5 contains servlet installed to run with
tomcat5. Feel free to touch the configuration files to suit your needs:

/var/lib/tomcat5/webapps/source/index_body.html
/var/lib/tomcat5/webapps/source/WEB-INF/web.xml

Other files will be overwritten on update.  Want to customize you OpenGrok
with a cool theme?  Submit it to OpenGrok so it can be included with the
package!

There's no war package.  Create one yourself by zipping the files.
You won't be able to benefit from the updates.  Remember that wars suck.
Both conflicts and web archives.


4.) OpenGrok package doesn't depend on mercurial on subversion.  If you
intend to use mercurial backend install mercurial package.  For
subversion, you need the subversion package.

2.) Configuration file is /etc/opengrok/configuration.xml.  It sets the
Source and Data roots to point to subdirectories of /var/lib/opengrok.

5.) Report bugs at http://bugzilla.redhat.com/.  Have fun!


Step-by-step configuration
--------------------------

This is what would you do to populate your OpenGrok with files and
customize it in Fedora:

1.) Install openrok-tomcat5 package, start up tomcat5.

2.) Populate /var/lib/opengrok/src with your source files.  If you have
multiple projects, place each in a separate directory.

3.) Generate the index and make configuration changes:

# opengrok -R /etc/opengrok/configuration.xml

Remember to always specify the configuration file, so OpenGrok knows
where to look for files.  Though you can specify the directories on a
command line, having setting stored in a file makes it possible for the
web application read the same configuration upon its startup.

If you have multiple projects in separate directories, do not forget to
specify the -P parameter:

# opengrok -P -U localhost:2424         \
     -R /etc/opengrok/configuration.xml \
     -W /etc/opengrok/configuration.xml

Also, when you modify anything in configuration (other than regenerating
the index), save the modified configuration into the file (-W) so that it
can be used by the webapp upon startup.

Opengrok by default listens on port 2424 bind to loopback interface for
configuration updates.  Specify the -U parameter, so that you don't have
to restart your webapp when you do a configuration change.

4.) Other changes are done in a similar fashion.  When you don't update
the index, specify -n.

# opengrok -n -U localhost:2424         \
     -R /etc/opengrok/configuration.xml \
     -W /etc/opengrok/configuration.xml \
     -L polished

This switches the visual skin to "polished".

---------------------------------------------------------------------------
This text was written by Lubomir Kundrak <lkundrak@redhat.com>
Should you find a problem in it, report at http://bugzilla.redhat.com/