OpenGrok revision d0767114e1a949e4a42358f5aeaa08590b87cd80
d20db9dd18673cf482111b9cd3ecc6823d0e45a3Trond Norbye# OpenGrok Wrapper (initial setup and cron job updating)
d20db9dd18673cf482111b9cd3ecc6823d0e45a3Trond Norbye# Supported Operating Systems:
d20db9dd18673cf482111b9cd3ecc6823d0e45a3Trond Norbye# - Solaris 10 (SunOS 5.10)
d20db9dd18673cf482111b9cd3ecc6823d0e45a3Trond Norbye# - OpenSolaris (SunOS 5.11)
d20db9dd18673cf482111b9cd3ecc6823d0e45a3Trond Norbye# - Debian (Linux)
e7b21c8124ec55ffacc49c1e28a8685834715484Lubos Kosco# Supported Deployment Engines:
d20db9dd18673cf482111b9cd3ecc6823d0e45a3Trond Norbye# - Tomcat 5.5
d20db9dd18673cf482111b9cd3ecc6823d0e45a3Trond Norbye# - Glassfish
d20db9dd18673cf482111b9cd3ecc6823d0e45a3Trond Norbye# Supported Environment Variables:
d20db9dd18673cf482111b9cd3ecc6823d0e45a3Trond Norbye# - OPENGROK_NON_INTERACTIVE Suppress Progress and Warnings Messages (*)
d20db9dd18673cf482111b9cd3ecc6823d0e45a3Trond Norbye# - OPENGROK_STANDARD_ENV Run Time Shell Environment (Shell Script)
d20db9dd18673cf482111b9cd3ecc6823d0e45a3Trond Norbye# - OPENGROK_CONFIGURATION User Configuration (Shell Script)
d961aa46ea0d50fed47802497e45226b1965b12dVladimir Kotal# Supported Environment Variables for configuring the default setup:
d961aa46ea0d50fed47802497e45226b1965b12dVladimir Kotal# - OPENGROK_DISTRIBUTION_BASE Base Directory of the OpenGrok Distribution
a8946de730d1f4298332fe8fd0a199bb2f69a764Vladimir Kotal# - OPENGROK_INSTANCE_BASE Base Directory of the OpenGrok User Data Area
d961aa46ea0d50fed47802497e45226b1965b12dVladimir Kotal# - EXUBERANT_CTAGS Full Path to Exuberant CTags
d20db9dd18673cf482111b9cd3ecc6823d0e45a3Trond Norbye# - JAVA_HOME Full Path to Java Installation Root
d20db9dd18673cf482111b9cd3ecc6823d0e45a3Trond Norbye# - OPENGROK_APP_SERVER Application Server ("Tomcat" or "Glassfish")
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com# - OPENGROK_WAR_TARGET_TOMCAT Tomcat Specific WAR Target Directory
f480a2c90c9bf75c2eded1a0577a65b262970552Vladimir Kotal# - OPENGROK_WAR_TARGET_GLASSFISH Glassfish Specific WAR Target Directory
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com# - OPENGROK_WAR_TARGET Fallback WAR Target Directory
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com# - OPENGROK_TOMCAT_BASE Base Directory for Tomcat (contains webapps)
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com# - OPENGROK_GLASSFISH_BASE Base Directory for Glassfish (contains domains)
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com# - OPENGROK_GLASSFISH_DOMAIN Preferred Glassfish Domain Name
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com# - OPENGROK_VERBOSE Enable Verbose Mode in opengrok.jar (*)
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com# - OPENGROK_PROGRESS Shows progress in %(percentage) of working through project, it's good to have Verbose Mode enabled too, cost of this is one more traversal of the project before indexing it (*)
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com# - OPENGROK_REMOTE_REPOS Disable History Cache for (remote) Repositories (*)
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com# - OPENGROK_SCAN_REPOS Disable Scan for repositories (*)_
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com# - OPENGROK_SCAN_DEPTH how deep should scanning for repos go (by default 3 directories from SRC_ROOT)
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com# - OPENGROK_WPREFIX Disable wildcard prefix search query support (*)
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com# - OPENGROK_DERBY if set, then indexer tries to use derby as historycache (see derby command of this script)
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com# - READ_XML_CONFIGURATION file with read only configuration - a temp workaround for bug # 327
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com# (*) Any Non-Empty String will enable these options
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com echo "Usage: ${0} <deploy|derby|update|updateQuietly|usage>" 1>&2
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com echo " ${0} index [<directory>]" 1>&2
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com echo " Optional environment variables:" 1>&2
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com echo " OPENGROK_CONFIGURATION - location of your configuration" 1>&2
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com echo " e.g. $ OPENGROK_CONFIGURATION=/var/opengrok/myog.conf ${0} ... " 1>&2
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com echo " See the code for more information on configuration options / variables" 1>&2
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com# Runtime Configuration
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com# TODO: Handle symlinks correctly (especially in ${0})
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.comSCRIPT_DIRECTORY="`dirname ${0}`"
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.comSCRIPT_DIRECTORY="`cd ${SCRIPT_DIRECTORY}; pwd`"
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com# Default Instance Configuration
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com # Use the built-in defaults. This section can be copied to its own
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com # file and tailored to your local requirements. Then simply set
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com # OPENGROK_CONFIGURATION=/path/to/your/configuration, before using
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com # this wrapper. It will save you hand editing in your settings
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com # on each new release. A sample cron(1M) entry might look like:
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com # 15 0 * * * OPENGROK_CONFIGURATION=/pkgs/etc/OpenGrok.sh /pkgs/sbin/OpenGrok updateQuietly
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com # Note: It is not really possible to ever provided defaults for
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com # these values which will run in every UNIX-like environment.
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com # So I have provided a set which are functional for a given
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com # environment on which you can based you own configuration.
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com # This has been updated to support more environment variables and
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com # operating systems, if you have any reasonably generic
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com # improvements please feel free to submit a patch.
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com OPENGROK_INSTANCE_BASE="${OPENGROK_INSTANCE_BASE:-/var/opengrok}"
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com LOGGER_CONFIG_FILE="logging.properties"
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com if [ -z "${OPENGROK_DISTRIBUTION_BASE}" ]
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com if [ -d "${SCRIPT_DIRECTORY}/dist" -a \
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com -f "${SCRIPT_DIRECTORY}/dist/opengrok.jar" -a \
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com -f "${SCRIPT_DIRECTORY}/dist/source.war" \
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com # Handle Developer Build Environments
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com OPENGROK_DISTRIBUTION_BASE="${SCRIPT_DIRECTORY}/dist"
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com LOGGER_CONF_SOURCE="${SCRIPT_DIRECTORY}/${LOGGER_CONFIG_FILE}"
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com OPENGROK_DISTRIBUTION_BASE="${SCRIPT_DIRECTORY}/../lib"
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com LOGGER_CONF_SOURCE="${OPENGROK_DISTRIBUTION_BASE}/../doc/${LOGGER_CONFIG_FILE}"
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com # REQUIRED: Source Code/Repository Root
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com # (your source code or the root of all repositories)
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com SRC_ROOT="${OPENGROK_INSTANCE_BASE}/src"
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com # REQUIRED: OpenGrok Generate Data Root
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com # (for Lucene index and hypertext cross-references)
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com # This area is rebuilt by "update" / "updateQuietly"
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com DATA_ROOT="${OPENGROK_INSTANCE_BASE}/data"
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com # OPTIONAL: User Provided Source Path to Description Mapping (Tab Separated Value)
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com # (The user maintained source of the generated EftarFile file)
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com PATH_DESC="${OPENGROK_INSTANCE_BASE}/etc/paths.tsv"
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com # (the configuration used by Web/GUI interfaces)
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com XML_CONFIGURATION="${OPENGROK_INSTANCE_BASE}/etc/configuration.xml"
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com # OPTIONAL: read only XML config, if it exists, it will be read
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com READ_XML_CONFIGURATION="${READ_XML_CONFIGURATION:-}"
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com if [ -f "${READ_XML_CONFIGURATION}" ] ; then
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com READ_XML_CONF="-R ${READ_XML_CONFIGURATION}"
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com # REQUIRED: Logger Configuration
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com LOGGER_CONFIG_PATH="${OPENGROK_INSTANCE_BASE}/${LOGGER_CONFIG_FILE}"
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com LOGGER_PROPERTIES="-Djava.util.logging.config.file=${LOGGER_CONFIG_PATH}"
d20db9dd18673cf482111b9cd3ecc6823d0e45a3Trond Norbye # REQUIRED: Java Archive of OpenGrok (Installation Location)
d20db9dd18673cf482111b9cd3ecc6823d0e45a3Trond Norbye OPENGROK_JAR="${OPENGROK_DISTRIBUTION_BASE}/opengrok.jar"
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com # REQUIRED(deploy): Web Archive of OpenGrok (Distribution Location)
d20db9dd18673cf482111b9cd3ecc6823d0e45a3Trond Norbye # (user building from source code will find this and other key
d20db9dd18673cf482111b9cd3ecc6823d0e45a3Trond Norbye # files in the "dist" directory after the build is completed)
d20db9dd18673cf482111b9cd3ecc6823d0e45a3Trond Norbye OPENGROK_DIST_WAR="${OPENGROK_DISTRIBUTION_BASE}/source.war"
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com # REQUIRED: Exuberant CTags (http://ctags.sf.net)
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com EXUBERANT_CTAGS="${EXUBERANT_CTAGS:-`FindExuberantCTags`}"
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com JAVA_HOME="${JAVA_HOME:-`FindJavaHome`}"
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com # REQUIRED: Java Virtual Machine
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com JAVA="${JAVA:-$JAVA_HOME/bin/java}"
d20db9dd18673cf482111b9cd3ecc6823d0e45a3Trond Norbye # DEVELOPMENT: Debug option, if enabled current indexer will listen on the port 8010 until a debugger connects
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com #JAVA_DEBUG="-agentlib:jdwp=transport=dt_socket,server=y,address=8010,suspend=y"
d20db9dd18673cf482111b9cd3ecc6823d0e45a3Trond Norbye # OPTIONAL: Ignore these patterns as names of files or directories
d3f4f9ed01f6a0b171d0a81c630f5708e47adb7avitezslav batrla - Sun Microsystems - Prague Czech Republic # OPTIONAL: Enable Projects
d3f4f9ed01f6a0b171d0a81c630f5708e47adb7avitezslav batrla - Sun Microsystems - Prague Czech Republic # (Every directory in SRC_ROOT is considered a separate project)
d20db9dd18673cf482111b9cd3ecc6823d0e45a3Trond Norbye # OPTIONAL: Scanning Options (for Mercurial repositories)
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com if [ -n "${OPENGROK_SCAN_REPOS}" ]
d3f4f9ed01f6a0b171d0a81c630f5708e47adb7avitezslav batrla - Sun Microsystems - Prague Czech Republic then
d3f4f9ed01f6a0b171d0a81c630f5708e47adb7avitezslav batrla - Sun Microsystems - Prague Czech Republic SCAN_FOR_REPOSITORY=""
d3f4f9ed01f6a0b171d0a81c630f5708e47adb7avitezslav batrla - Sun Microsystems - Prague Czech Republic # OPTIONAL: Remote Repository Support (CVS or SVN)
d20db9dd18673cf482111b9cd3ecc6823d0e45a3Trond Norbye # (Can be very time demanding, uncomment if needed)
5e6c91d7e77062129cd0b6ac8aaa546dff216419Lubos Kosco # OPTIONAL: override depth of scanning for repositories
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com if [ -n "${OPENGROK_SCAN_DEPTH}" ]
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com SCAN_DEPTH="-z${OPENGROK_SCAN_DEPTH}"
9d4a68a59a18dac8880470e120dcf176b9a6592cVladimir Kotal # OPTIONAL: Set Maximum Indexed Words Per File
9d4a68a59a18dac8880470e120dcf176b9a6592cVladimir Kotal # Note, that you might run out of memory, then either increase JVM memory
9d4a68a59a18dac8880470e120dcf176b9a6592cVladimir Kotal # as noted in JAVA_OPTS, or set this limit(if you don't mind opengrok not
9d4a68a59a18dac8880470e120dcf176b9a6592cVladimir Kotal # indexing the rest of the file, once the limit is reached)
9d4a68a59a18dac8880470e120dcf176b9a6592cVladimir Kotal # OPTIONAL: Configuration Address (host:port)
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com # OPTIONAL: Full Path to History Utilities
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com # OPTIONAL: Override Built-in Properties
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com # Assumption: We should not set properties to the empty string
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com${HG:+-Dorg.opensolaris.opengrok.history.Mercurial=$HG} \
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com${CVS:+-Dorg.opensolaris.opengrok.history.cvs=$CVS} \
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com${SVN:+-Dorg.opensolaris.opengrok.history.Subversion=$SVN} \
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com${SCCS:+-Dorg.opensolaris.opengrok.history.SCCS=$SCCS} \
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com${CLEARCASE:+-Dorg.opensolaris.opengrok.history.ClearCase=$CLEARCASE} \
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com${GIT:+-Dorg.opensolaris.opengrok.history.git=$GIT} \
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com${P4:+-Dorg.opensolaris.opengrok.history.Perforce=$P4} \
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com${MTN:+-Dorg.opensolaris.opengrok.history.Monotone=$MTN} \
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com${BZR:+-Dorg.opensolaris.opengrok.history.Bazaar=$BZR} \
f480a2c90c9bf75c2eded1a0577a65b262970552Vladimir Kotal # OPTIONAL: Store The History Cache in Java DB (derby),
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com # instead of file system (in gzipped xml files).
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com # - derbyclient.jar - See README.txt for more details
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com # - Running Derby Server - Defaults to localhost:1527
8bdb629053c6752f21668f2af5f336109439b15bkrystof.tulinger@oracle.com # DELIVERED: An update program for EftarFile
${DO} exit 2
for f in $@
echo $file
if test $? -eq 1
if test $? -ne 0
echo ${binary}
Linux:*)
if [ -f /etc/alternatives/java ]
/usr/lib/jvm/sun-jre-1.6 \
${OPENGROK_TOMCAT_BASE} \
Warning "CHECK: derbyclient.jar needs to be in where the rest of opengrok used jars are and in unpacked source.war in WEB-INF/lib !!!"
${DO} grep -v java.util.logging.FileHandler.pattern "${LOGGER_CONF_SOURCE}" > "${LOGGER_CONFIG_PATH}"
${DO} grep java.util.logging.FileHandler.pattern "${LOGGER_CONF_SOURCE}" | sed "s|opengrok%g.%u.log|${OPENGROK_INSTANCE_BASE}/log/opengrok%g.%u.log|g" >> "${LOGGER_CONFIG_PATH}"
${DO} mkdir ${OPENGROK_INSTANCE_BASE}/log
${DO} mkdir -p ${OPENGROK_INSTANCE_BASE}/derby
${DO} ${JAVA} ${JAVA_OPTS} ${PROPERTIES} \
${LOGGER_PROPERTIES} \
${JAVA_DEBUG} \
-jar ${OPENGROK_JAR} \
${IGNORE_PATTERNS} ${ENABLE_PROJECTS} \
${DERBY_HISTORY_CACHE} \
${SCAN_DEPTH} \
${PROGRESS} \
${EXUBERANT_CTAGS:+-c} ${EXUBERANT_CTAGS} \
${MAX_INDEXED_WORDS} ${SKIN} ${LEADING_WILDCARD} \
${READ_XML_CONF} \
-W ${XML_CONFIGURATION} \
${DO} ${JAVA} -classpath ${OPENGROK_JAR} \
${EFTAR_UPDATE} ${PATH_DESC} ${EFTAR_OUTPUT_FILE}
SunOS:5.11)
Linux:*)
mkdir -p $DATA_ROOT/derby