OpenGrok revision 9dc24f2da404ab474e38fc4d428e5717dc9bcee4
0ca9a2c194523c517c3aafe5758e217ac88d6baaLubos Kosco# OpenGrok Wrapper (initial setup and cron job updating)
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray# Supported Operating Systems:
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal# - Solaris 11 (SunOS 5.11)
983523cf73bc85cce6282cb5aa78b60f6bcd959fLubos Kosco# - Solaris 12 (SunOS 5.12)
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray# - Debian (Linux)
c577d2f6c082eaff9af5bc997d12f3d3bcef537cPeter Bray# Supported Deployment Engines:
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray# - Glassfish
c577d2f6c082eaff9af5bc997d12f3d3bcef537cPeter Bray# Supported Environment Variables:
c577d2f6c082eaff9af5bc997d12f3d3bcef537cPeter Bray# - OPENGROK_NON_INTERACTIVE Suppress Progress and Warnings Messages (*)
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray# - OPENGROK_STANDARD_ENV Run Time Shell Environment (Shell Script)
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray# - OPENGROK_CONFIGURATION User Configuration (Shell Script)
c577d2f6c082eaff9af5bc997d12f3d3bcef537cPeter Bray# Supported Environment Variables for configuring the default setup:
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray# - OPENGROK_DISTRIBUTION_BASE Base Directory of the OpenGrok Distribution
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray# - OPENGROK_INSTANCE_BASE Base Directory of the OpenGrok User Data Area
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray# - EXUBERANT_CTAGS Full Path to Exuberant CTags
d961aa46ea0d50fed47802497e45226b1965b12dVladimir Kotal# - OPENGROK_CTAGS_OPTIONS_FILE Full path to file with extra command line
d961aa46ea0d50fed47802497e45226b1965b12dVladimir Kotal# options for CTags program (for its --options
d961aa46ea0d50fed47802497e45226b1965b12dVladimir Kotal# switch), default is DATA_ROOT/etc/ctags.config
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray# - JAVA_HOME Full Path to Java Installation Root
983523cf73bc85cce6282cb5aa78b60f6bcd959fLubos Kosco# - JAVA Full Path to java binary (to enable 64bit JDK)
983523cf73bc85cce6282cb5aa78b60f6bcd959fLubos Kosco# - JAVA_OPTS Java options (e.g. for JVM memory increase
983523cf73bc85cce6282cb5aa78b60f6bcd959fLubos Kosco# or enabling server JDK)
983523cf73bc85cce6282cb5aa78b60f6bcd959fLubos Kosco# JAVA_OPTS=-Xmx2048m is the default!
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray# - OPENGROK_APP_SERVER Application Server ("Tomcat" or "Glassfish")
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray# - OPENGROK_WAR_TARGET_TOMCAT Tomcat Specific WAR Target Directory
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray# - OPENGROK_WAR_TARGET_GLASSFISH Glassfish Specific WAR Target Directory
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray# - OPENGROK_WAR_TARGET Fallback WAR Target Directory
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray# - OPENGROK_TOMCAT_BASE Base Directory for Tomcat (contains webapps)
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal# - OPENGROK_GLASSFISH_BASE Base Directory for Glassfish
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal# (contains domains)
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray# - OPENGROK_GLASSFISH_DOMAIN Preferred Glassfish Domain Name
c577d2f6c082eaff9af5bc997d12f3d3bcef537cPeter Bray# - OPENGROK_VERBOSE Enable Verbose Mode in opengrok.jar (*)
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal# - OPENGROK_PROGRESS Shows progress in %(percentage) of working
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal# through project, it's good to have Verbose
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal# Mode enabled too, cost of this is one more
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal# traversal of the project before indexing it(*)
65df1e87266301e243dcead8082ca6255abea666Vladimir Kotal# - OPENGROK_GENERATE_HISTORY Influence history cache generation
65df1e87266301e243dcead8082ca6255abea666Vladimir Kotal# Following values are recognized:
425278cfacbc73f1e955ab6016f206fc5ed93ccbVladimir Kotal# on - enabled (default)
425278cfacbc73f1e955ab6016f206fc5ed93ccbVladimir Kotal# off - disabled for indexing and UI
65df1e87266301e243dcead8082ca6255abea666Vladimir Kotal# dirbased - indexing enabled only for repos
65df1e87266301e243dcead8082ca6255abea666Vladimir Kotal# which can fetch history for
425278cfacbc73f1e955ab6016f206fc5ed93ccbVladimir Kotal# local - for local repos only
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal# uionly - enabled for UI only
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal# - OPENGROK_SCAN_REPOS Disable Scan for repositories (*)
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal# - OPENGROK_SCAN_DEPTH how deep should scanning for repos go
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal# (by default 3 directories from SRC_ROOT)
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal# - OPENGROK_WEBAPP_CFGADDR Web app address to send configuration to
6ce0623fa4ef95af9d77700a1c9c19ec1a919326Guillaume Smet# (use "none" to avoid sending it to web app)
6ce0623fa4ef95af9d77700a1c9c19ec1a919326Guillaume Smet# - OPENGROK_WEBAPP_CONTEXT Context URL of the OpenGrok webapp
56c25decc0427c204cd35856e521ddf28337e75dLubos Kosco# (by default /source)
56c25decc0427c204cd35856e521ddf28337e75dLubos Kosco# - FULL reindex is needed once this is used
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal# (old already indexed files won't be refreshed)
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal# - OPENGROK_WPREFIX Disable wildcard prefix search query
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal# - OPENGROK_DERBY if set, then indexer tries to use derby as
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal# historycache (see derby command of this
83439b4ed8fe40097dc3f2c05168d26bd7926159Vladimir Kotal# - OPENGROK_DERBY_URL Use specific URL to JavaDB, e.g.
83439b4ed8fe40097dc3f2c05168d26bd7926159Vladimir Kotal# "jdbc:derby://localhost:1528/cachedb;create=true"
3ba66fbb56ef22f183da783a1b2718280c357a4eStanislav Kozina# (default port is 1527)
3ba66fbb56ef22f183da783a1b2718280c357a4eStanislav Kozina# - OPENGROK_TAG Enable parsing of revision tags into the History
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal# - READ_XML_CONFIGURATION file with read only configuration
983523cf73bc85cce6282cb5aa78b60f6bcd959fLubos Kosco# - temporary workaround for bug # 327
983523cf73bc85cce6282cb5aa78b60f6bcd959fLubos Kosco# - OPENGROK_FLUSH_RAM_BUFFER_SIZE="-m 16" - set RAM buffer size for flushing,
983523cf73bc85cce6282cb5aa78b60f6bcd959fLubos Kosco# default is 16MB per thread, you might try to
983523cf73bc85cce6282cb5aa78b60f6bcd959fLubos Kosco# increase it to 256MB, but do increase JVM to
983523cf73bc85cce6282cb5aa78b60f6bcd959fLubos Kosco# 4/8/16GB ! Lucene defaults to 8 threads.
bc5565fc58603964988b42b6aee40e246f35d94fVladimir Kotal# Increase JVM memory as noted using JAVA_OPTS
c577d2f6c082eaff9af5bc997d12f3d3bcef537cPeter Bray# - OPENGROK_LOGGER_CONFIG_PATH Set path to custom logging.properties file.
c577d2f6c082eaff9af5bc997d12f3d3bcef537cPeter Bray# - OPENGROK_SUBVERSION_USERNAME name of the user that should be used for
c577d2f6c082eaff9af5bc997d12f3d3bcef537cPeter Bray# fetching the history from subversion
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray# - OPENGROK_SUBVERSION_PASSWORD password of the user that should be used for
0ca9a2c194523c517c3aafe5758e217ac88d6baaLubos Kosco# fetching the history from subversion
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal# (*) Any Non-Empty String will enable these options
cd348e325366620fe047edcc849e3c9424828599Peter Bray# Copyright (c) 2008, 2014, Oracle and/or its affiliates. All rights reserved.
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal# Print usage to stdout and exit.
fbf97ea1786d1e25add88bbfb91810170473bc9fLubos Kosco echo "Usage: ${progname} <deploy|derby|update|updateQuietly|usage|help>"
fbf97ea1786d1e25add88bbfb91810170473bc9fLubos Kosco echo " ${progname} indexpart <src_root> <directory1> [..]"
fbf97ea1786d1e25add88bbfb91810170473bc9fLubos Kosco echo " ${progname} clearHistory <src_root> <repository_name>"
3b0448fdd830b8d04c6a71511e5d26a4fc3b5b80Lubos Kosco echo " OPENGROK_CONFIGURATION - location of your configuration"
cd348e325366620fe047edcc849e3c9424828599Peter Bray echo " e.g. $ OPENGROK_CONFIGURATION=/var/opengrok/myog.conf ${0} ... "
cd348e325366620fe047edcc849e3c9424828599Peter Bray echo " See the code for more information on configuration options /" \
c276b1ec9722ee95a86a4a381b39c5f405fc1cc4Vladimir Kotal# Runtime Configuration
c276b1ec9722ee95a86a4a381b39c5f405fc1cc4Vladimir Kotalif [ -x "/bin/uname" ]; then
c276b1ec9722ee95a86a4a381b39c5f405fc1cc4Vladimir Kotalelif [ -x "/usr/bin/uname" ]; then
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter Bray echo "Cannot determine operating system version"
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray# TODO: Handle symlinks correctly (especially in ${0})
cd348e325366620fe047edcc849e3c9424828599Peter Bray# Default Instance Configuration
cd348e325366620fe047edcc849e3c9424828599Peter Bray # Use the built-in defaults. This section can be copied to its own
cd348e325366620fe047edcc849e3c9424828599Peter Bray # file and tailored to your local requirements. Then simply set
cd348e325366620fe047edcc849e3c9424828599Peter Bray # OPENGROK_CONFIGURATION=/path/to/your/configuration, before using
cd348e325366620fe047edcc849e3c9424828599Peter Bray # this wrapper. It will save you hand editing in your settings
cd348e325366620fe047edcc849e3c9424828599Peter Bray # on each new release. A sample cron(1M) entry might look like:
cd348e325366620fe047edcc849e3c9424828599Peter Bray # 15 0 * * * OPENGROK_CONFIGURATION=/pkgs/etc/OpenGrok.sh /pkgs/sbin/OpenGrok updateQuietly
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray # Note: It is not really possible to ever provided defaults for
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray # these values which will run in every UNIX-like environment.
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray # So I have provided a set which are functional for a given
0ca9a2c194523c517c3aafe5758e217ac88d6baaLubos Kosco # environment on which you can based you own configuration.
0ca9a2c194523c517c3aafe5758e217ac88d6baaLubos Kosco # This has been updated to support more environment variables and
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter Bray # operating systems, if you have any reasonably generic
5762c9f28c2246777be0e9d49cb29d9c0f49146dLubos Kosco # improvements please feel free to submit a patch.
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray OPENGROK_INSTANCE_BASE="${OPENGROK_INSTANCE_BASE:-/var/opengrok}"
c83dfde6b364917fa8ed28142d509a7c29a4da68Vladimir Kotal OPENGROK_DISTRIBUTION_BASE="${SCRIPT_DIRECTORY}/dist"
c83dfde6b364917fa8ed28142d509a7c29a4da68Vladimir Kotal LOGGER_CONF_SOURCE="${SCRIPT_DIRECTORY}/${LOGGER_CONFIG_FILE}"
cd348e325366620fe047edcc849e3c9424828599Peter Bray OPENGROK_DISTRIBUTION_BASE="${SCRIPT_DIRECTORY}/../lib"
cd348e325366620fe047edcc849e3c9424828599Peter Bray LOGGER_CONF_SOURCE="${OPENGROK_DISTRIBUTION_BASE}/../doc/"
cd348e325366620fe047edcc849e3c9424828599Peter Bray LOGGER_CONF_SOURCE="${LOGGER_CONF_SOURCE}${LOGGER_CONFIG_FILE}"
cd348e325366620fe047edcc849e3c9424828599Peter Bray # (your source code or the root of all repositories)
0b2998be561e7bf5e3479d686a5af36f712b0d9aVladimir Kotal # (for Lucene index and hypertext cross-references)
cd348e325366620fe047edcc849e3c9424828599Peter Bray # This area is rebuilt by "update" / "updateQuietly"
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray # OPTIONAL: User Provided Source Path to Description Mapping
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray # (The user maintained source of the generated EftarFile file)
cd348e325366620fe047edcc849e3c9424828599Peter Bray PATH_DESC="${OPENGROK_INSTANCE_BASE}/etc/paths.tsv"
c842732324ee4c74ede17887ad1f0dcdc4364a2cLubos Kosco # (the configuration used by Web/GUI interfaces)
d7c1415de39f4b07c85828f49cd1ee7a2a19eb9eLubos Kosco XML_CONFIGURATION="${OPENGROK_INSTANCE_BASE}/etc/configuration.xml"
c842732324ee4c74ede17887ad1f0dcdc4364a2cLubos Kosco # OPTIONAL: read only XML config, if it exists, it will be read
c842732324ee4c74ede17887ad1f0dcdc4364a2cLubos Kosco READ_XML_CONFIGURATION="${READ_XML_CONFIGURATION:-}"
bc5565fc58603964988b42b6aee40e246f35d94fVladimir Kotal if [ -n "${OPENGROK_LOGGER_CONFIG_PATH}" ]; then
bc5565fc58603964988b42b6aee40e246f35d94fVladimir Kotal if [ ! -f "${OPENGROK_LOGGER_CONFIG_PATH}" ]; then
bc5565fc58603964988b42b6aee40e246f35d94fVladimir Kotal echo "File ${OPENGROK_LOGGER_CONFIG_PATH} does not exist"
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter Bray LOGGER_CONFIG_PATH=${OPENGROK_LOGGER_CONFIG_PATH}
3aa0947feb67d3e8292d84776638be98dd97fdc3Lubos Kosco LOGGER_CONFIG_PATH="${OPENGROK_INSTANCE_BASE}/${LOGGER_CONFIG_FILE}"
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray LOGGER_PROPERTIES="-Djava.util.logging.config.file=${LOGGER_CONFIG_PATH}"
cd348e325366620fe047edcc849e3c9424828599Peter Bray # REQUIRED: Java Archive of OpenGrok (Installation Location)
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray OPENGROK_JAR="${OPENGROK_DISTRIBUTION_BASE}/opengrok.jar"
cd348e325366620fe047edcc849e3c9424828599Peter Bray # REQUIRED(deploy): Web Archive of OpenGrok (Distribution Location)
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray # (user building from source code will find this and other key
cd348e325366620fe047edcc849e3c9424828599Peter Bray # files in the "dist" directory after the build is completed)
d961aa46ea0d50fed47802497e45226b1965b12dVladimir Kotal OPENGROK_DIST_WAR="${OPENGROK_DISTRIBUTION_BASE}/source.war"
d961aa46ea0d50fed47802497e45226b1965b12dVladimir Kotal # REQUIRED: Exuberant CTags (http://ctags.sf.net)
d961aa46ea0d50fed47802497e45226b1965b12dVladimir Kotal EXUBERANT_CTAGS="${EXUBERANT_CTAGS:-`FindExuberantCTags`}"
d961aa46ea0d50fed47802497e45226b1965b12dVladimir Kotal # OPTIONAL: supply extra command line options to CTags program
d961aa46ea0d50fed47802497e45226b1965b12dVladimir Kotal if [ -n "${OPENGROK_CTAGS_OPTIONS_FILE}" ]; then
cd348e325366620fe047edcc849e3c9424828599Peter Bray CTAGS_OPTIONS_FILE="${OPENGROK_CTAGS_OPTIONS_FILE}"
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray elif [ -r "${OPENGROK_INSTANCE_BASE}/etc/ctags.config" ]; then
cd348e325366620fe047edcc849e3c9424828599Peter Bray CTAGS_OPTIONS_FILE="${OPENGROK_INSTANCE_BASE}/etc/ctags.config"
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter Bray # DEVELOPMENT: Debug option, if enabled current indexer will listen on the
17d95a647aba8c37d9ac34d97e4eed729aa46f67Naseer Ahmed #JAVA_DEBUG="-agentlib:jdwp=transport=dt_socket"
17d95a647aba8c37d9ac34d97e4eed729aa46f67Naseer Ahmed #JAVA_DEBUG="$JAVA_DEBUG,server=y,address=8010,suspend=y"
5762c9f28c2246777be0e9d49cb29d9c0f49146dLubos Kosco # OPTIONAL: Ignore these patterns as names of files or directories
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter Bray # To ignore skipping just the history cache creation for a particular
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter Bray # directory and all of it's subdirectories, touch an empty
5762c9f28c2246777be0e9d49cb29d9c0f49146dLubos Kosco # .opengrok_skip_history file at the root of that directory
477c09a2656e6a2c1075425ad81e61d594164fa9Lubos Kosco # (Every directory in SRC_ROOT is considered a separate project)
c842732324ee4c74ede17887ad1f0dcdc4364a2cLubos Kosco # OPTIONAL: Scanning Options (for Mercurial repositories)
8f8c3f4555e5aa3160f03f2e9c55ddbd3381357bLubos Kosco # OPTIONAL: Disable remote repository support (CVS or SVN) [on by default]
d70dc22c6dce3f498251b0873638d1fea0e644a3Lubos Kosco GENERATE_HISTORY="-r ${OPENGROK_GENERATE_HISTORY}"
d70dc22c6dce3f498251b0873638d1fea0e644a3Lubos Kosco # OPTIONAL: override depth of scanning for repositories
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal # OPTIONAL: Configuration Address (host:port)
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal WEBAPP_CONFIG_ADDRESS=${OPENGROK_WEBAPP_CFGADDR}
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal if [ "${OPENGROK_WEBAPP_CFGADDR}" = "none" ]; then
6ce0623fa4ef95af9d77700a1c9c19ec1a919326Guillaume Smet # OPTIONAL: Context URL of the OpenGrok webapp
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray # Assumption: We should not set properties to the empty string
2b024356b830395446c55f50f9f724a63612e578Lubos Kosco${HG:+-Dorg.opensolaris.opengrok.history.Mercurial=$HG} \
2b024356b830395446c55f50f9f724a63612e578Lubos Kosco${CVS:+-Dorg.opensolaris.opengrok.history.cvs=$CVS} \
2b024356b830395446c55f50f9f724a63612e578Lubos Kosco${SVN:+-Dorg.opensolaris.opengrok.history.Subversion=$SVN} \
2b024356b830395446c55f50f9f724a63612e578Lubos Kosco${SCCS:+-Dorg.opensolaris.opengrok.history.SCCS=$SCCS} \
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray${CLEARCASE:+-Dorg.opensolaris.opengrok.history.ClearCase=$CLEARCASE} \
cd348e325366620fe047edcc849e3c9424828599Peter Bray${GIT:+-Dorg.opensolaris.opengrok.history.git=$GIT} \
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter Bray${P4:+-Dorg.opensolaris.opengrok.history.Perforce=$P4} \
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter Bray${MTN:+-Dorg.opensolaris.opengrok.history.Monotone=$MTN} \
4e854c69a0484765dcd27b0e837898c8b6969beaTrond Norbye${BZR:+-Dorg.opensolaris.opengrok.history.Bazaar=$BZR} \
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter Bray # OPTIONAL: Store The History Cache in Java DB (derby),
83439b4ed8fe40097dc3f2c05168d26bd7926159Vladimir Kotal # - derbyclient.jar - See README.txt for more details
83439b4ed8fe40097dc3f2c05168d26bd7926159Vladimir Kotal # - Running Derby Server - Defaults to localhost:1527
3ba66fbb56ef22f183da783a1b2718280c357a4eStanislav Kozina DERBY_OPTIONS="${DERBY_OPTIONS} -u ${OPENGROK_DERBY_URL}"
3ba66fbb56ef22f183da783a1b2718280c357a4eStanislav Kozina # OPTIONAL: Show revision tags in History view.
3ba66fbb56ef22f183da783a1b2718280c357a4eStanislav Kozina # Turn this off if you want to increase indexing performance a bit
cd348e325366620fe047edcc849e3c9424828599Peter Bray # Usage: <class> inputFile [inputFile ...] outputFile
cd348e325366620fe047edcc849e3c9424828599Peter Bray # EftarFile == An Extremely Fast Tagged Attribute Read-only File System
cd348e325366620fe047edcc849e3c9424828599Peter Bray EFTAR_UPDATE="org.opensolaris.opengrok.web.EftarFile"
cd348e325366620fe047edcc849e3c9424828599Peter Bray EFTAR_OUTPUT_FILE="${DATA_ROOT}/index/dtags.eftar"
c577d2f6c082eaff9af5bc997d12f3d3bcef537cPeter Bray # Be Quiet? (set indirectly by command line arguments in the main program)
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray# Helper Functions - Logging
0ca9a2c194523c517c3aafe5758e217ac88d6baaLubos Kosco# In general, non-interactive use like cron jobs and automated
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray# installation environments should not generate unnecessary
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray# progress information or warnings, as usage and configuration
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray# will have generally been debugged prior to automation.
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray# Helper Functions - Autodetection of Runtime Environment
f9e7e93ed37cbcb0a111b6f997bb75d567c31c0bVladimir Kotal # Search for Exuberant ctags intelligently, skipping
f9e7e93ed37cbcb0a111b6f997bb75d567c31c0bVladimir Kotal for program in ctags-exuberant exctags ctags; do
f9e7e93ed37cbcb0a111b6f997bb75d567c31c0bVladimir Kotal # Verify that this really is Exuberant Ctags.
f9e7e93ed37cbcb0a111b6f997bb75d567c31c0bVladimir Kotal $binary --version 2>&1 | grep "Exuberant Ctags" > /dev/null
f9e7e93ed37cbcb0a111b6f997bb75d567c31c0bVladimir Kotal if [ $? -eq 0 ]; then
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray if [ $found -eq 1 ]; then
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray if [ $found -ne 1 ]; then
d0767114e1a949e4a42358f5aeaa08590b87cd80Trond Norbye Error "Unable to determine Exuberant CTags command name" \
4e854c69a0484765dcd27b0e837898c8b6969beaTrond Norbye SunOS:5.10) javaHome="/usr/jdk/instances/jdk1.7.0" ;;
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray javaHome=`ls -l /etc/alternatives/java | cut -f 2 -d \> `
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray # Use this function to determine which environment the deploy the
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray # web application function into. Some users (especially
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray # developers) will have many deployment environments or will wish
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray # to specify directly the application server to deploy to.
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray # Either use the environment variable OPENGROK_APP_SERVER or
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray # reimplement this function in your configuration file (as
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray # This implementation favours Tomcat, but needs a lot of work,
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray # especially if Glassfish is perferrerd or it is under the control
fe967af3e58b6c8feaecf15b06fc1d5401b07914Lubos Kosco # Maybe a better implementation would be to call Application
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray # Server specific WAR Directory and see if they exist.
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray if [ -x "/etc/init.d/appserv" -a -d "/var/appserver/domains" ]
56d93b0c761868f813ac0bc0b5bc21a7a9fefd89Vladimir Kotal directory="${domainDirectory}/${OPENGROK_GLASSFISH_DOMAIN}/autodeploy"
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray FatalError "Missing Specified Glassfish Domain " \
56d93b0c761868f813ac0bc0b5bc21a7a9fefd89Vladimir Kotal firstDomain=`ls -1 ${domainDirectory} | head -1`
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray FatalError "Failed to dynamically determine Glassfish Domain from " \
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray echo "${domainDirectory}/${firstDomain}/autodeploy"
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray# Implementation
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray# The variable "DO" can usefully be set to "echo" to aid in script debugging
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray # Setup a standard execution environment (if required)
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray cronexec="/pkgs/sbin/CronExecutionEnvironment.sh"
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray OPENGROK_STANDARD_ENV="${OPENGROK_STANDARD_ENV:-$cronexec}"
578be34fc3aceb9831553e8611f8d5d59b711c3cVladimir Kotal Progress "Loading ${OPENGROK_STANDARD_ENV} ..."
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray# Load custom configuration and then fill remaining stuff with defaults.
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray # Note: As all functions have been defined by the time this routine
0b2998be561e7bf5e3479d686a5af36f712b0d9aVladimir Kotal # is called, your configuration can, if desired, override functions
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray # in addition to setting the variables mentioned in the function
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray # DefaultInstanceConfiguration(), this maybe useful to override
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray # functionality used to determine the default deployment environment
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray # find dependencies or validate the configuration, for example.
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray if [ -n "${OPENGROK_CONFIGURATION}" -a -f "${OPENGROK_CONFIGURATION}" ]
0b2998be561e7bf5e3479d686a5af36f712b0d9aVladimir Kotal # Load the Local OpenGrok Configuration Environment
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray Progress "Loading the default instance configuration ..."
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray FatalError "Missing Dependent Application - Exuberant CTags"
c577d2f6c082eaff9af5bc997d12f3d3bcef537cPeter Bray FatalError "OpenGrok Source Path ${SRC_ROOT} doesn't exist"
477c09a2656e6a2c1075425ad81e61d594164fa9Lubos Kosco Warning "Both Quiet and Verbose Mode Enabled - Choosing Verbose"
83439b4ed8fe40097dc3f2c05168d26bd7926159Vladimir Kotal if [ `uname -s` == "SunOS" -a -d /opt/SUNWjavadb -a -d /usr/opengrok ];
83439b4ed8fe40097dc3f2c05168d26bd7926159Vladimir Kotal ! -r "/var/tomcat6/webapps/source/WEB-INF/lib/derbyclient.jar" ];
83439b4ed8fe40097dc3f2c05168d26bd7926159Vladimir Kotal FatalError "JavaDB on but no derbyclient.jar under" \
83439b4ed8fe40097dc3f2c05168d26bd7926159Vladimir Kotal if [ ! -r "/usr/opengrok/lib/derbyclient.jar" ]; then
83439b4ed8fe40097dc3f2c05168d26bd7926159Vladimir Kotal FatalError "JavaDB on but no derbyclient.jar under" \
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray Warning "CHECK: derbyclient.jar needs to be in where the rest of " \
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray "opengrok used jars are and in unpacked source.war in " \
3aa0947feb67d3e8292d84776638be98dd97fdc3Lubos Kosco Warning "OpenGrok generated data path ${DATA_ROOT} doesn't exist"
477c09a2656e6a2c1075425ad81e61d594164fa9Lubos Kosco Progress " Attempting to create generated data directory ... "
56d93b0c761868f813ac0bc0b5bc21a7a9fefd89Vladimir Kotal FatalError "OpenGrok data path ${DATA_ROOT} doesn't exist"
3aa0947feb67d3e8292d84776638be98dd97fdc3Lubos Kosco Warning "OpenGrok generated etc path ${OPENGROK_INSTANCE_BASE}/etc " \
56d93b0c761868f813ac0bc0b5bc21a7a9fefd89Vladimir Kotal Progress " Attempting to create generated etc directory ... "
56d93b0c761868f813ac0bc0b5bc21a7a9fefd89Vladimir Kotal ${DO} mkdir -p "${OPENGROK_INSTANCE_BASE}/etc"
5762c9f28c2246777be0e9d49cb29d9c0f49146dLubos Kosco FatalError "OpenGrok etc path ${OPENGROK_INSTANCE_BASE}/etc " \
c842732324ee4c74ede17887ad1f0dcdc4364a2cLubos Kosco if [ -n "${LOGGER_CONFIG_PATH}" -a ! -f "${LOGGER_CONFIG_PATH}" ]
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter Bray Progress " Creating default ${LOGGER_CONFIG_PATH} ... "
56d93b0c761868f813ac0bc0b5bc21a7a9fefd89Vladimir Kotal Warning "Can't find distribution logging configuration" \
56d93b0c761868f813ac0bc0b5bc21a7a9fefd89Vladimir Kotal "(${LOGGER_CONF_SOURCE}) to install as default" \
0b2998be561e7bf5e3479d686a5af36f712b0d9aVladimir Kotal "logging configuration (${LOGGER_CONFIG_PATH})"
0b2998be561e7bf5e3479d686a5af36f712b0d9aVladimir Kotal fullpath="${OPENGROK_INSTANCE_BASE}/log/opengrok%g.%u.log"
0b2998be561e7bf5e3479d686a5af36f712b0d9aVladimir Kotal ${DO} grep -v java.util.logging.FileHandler.pattern \
0b2998be561e7bf5e3479d686a5af36f712b0d9aVladimir Kotal "${LOGGER_CONF_SOURCE}" > "${LOGGER_CONFIG_PATH}"
56d93b0c761868f813ac0bc0b5bc21a7a9fefd89Vladimir Kotal ${DO} grep java.util.logging.FileHandler.pattern \
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter Bray sed "s|$filename|$fullpath|g" >> "${LOGGER_CONFIG_PATH}"
56d93b0c761868f813ac0bc0b5bc21a7a9fefd89Vladimir Kotal if [ ! -d "${OPENGROK_INSTANCE_BASE}/derby" ]
cd348e325366620fe047edcc849e3c9424828599Peter Bray Progress " Attempting to create generated derby directory ... "
caf0d2e1c473e03780acaa86e2a73ff953802a8bVladimir Kotal ${DO} mkdir -p ${OPENGROK_INSTANCE_BASE}/derby
cd348e325366620fe047edcc849e3c9424828599Peter Bray ${CTAGS_OPTIONS_FILE:+-o} ${CTAGS_OPTIONS_FILE} \
bc5565fc58603964988b42b6aee40e246f35d94fVladimir Kotal ${OPENGROK_FLUSH_RAM_BUFFER_SIZE} ${SKIN} ${LEADING_WILDCARD} \
cd348e325366620fe047edcc849e3c9424828599Peter Bray ${EFTAR_UPDATE} ${PATH_DESC} ${EFTAR_OUTPUT_FILE}
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray ${DO} ${JAVA} ${JAVA_OPTS} -jar ${OPENGROK_JAR} '-?'
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray Tomcat) warTarget="`DetermineWarDirectoryTomcat`" ;;
0ca9a2c194523c517c3aafe5758e217ac88d6baaLubos Kosco Glassfish) warTarget="`DetermineWarDirectoryGlassfish`" ;;
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray *) FatalError "Unsupported Application Server ${applicationServer}" ;;
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray FatalError "Unable to determine Deployment Directory for " \
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray FatalError "Missing Web Application Archive ${OPENGROK_DIST_WAR}"
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray FatalError "Missing Deployment Directory ${warTarget}"
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray Progress "Installing ${OPENGROK_DIST_WAR} to ${warTarget} ..."
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray ${DO} cp -p "${OPENGROK_DIST_WAR}" "${warTarget}/"
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray if [ $? != 0 ]
56d93b0c761868f813ac0bc0b5bc21a7a9fefd89Vladimir Kotal FatalError "Web Application Installation FAILED"
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray Progress "Start your application server (${applicationServer}), " \
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray Progress "running, or wait until it loads the just installed web " \
477c09a2656e6a2c1075425ad81e61d594164fa9Lubos Kosco Progress "OpenGrok should be available on <HOST>:<PORT>/source"
477c09a2656e6a2c1075425ad81e61d594164fa9Lubos Kosco Progress " where HOST and PORT are configured in ${applicationServer}."
983523cf73bc85cce6282cb5aa78b60f6bcd959fLubos Kosco echo "Below might need your socket permission setup"
56d93b0c761868f813ac0bc0b5bc21a7a9fefd89Vladimir Kotal -jar /usr/jdk/instances/jdk1.7.0/db/lib/derbynet.jar start
477c09a2656e6a2c1075425ad81e61d594164fa9Lubos Kosco -jar /usr/lib/jvm/java-6-sun/db/lib/derbynet.jar start
caf0d2e1c473e03780acaa86e2a73ff953802a8bVladimir Kotal# Clear history index for given project.
cd348e325366620fe047edcc849e3c9424828599Peter Bray Progress "Removing history index data for repository ${1}"
cd348e325366620fe047edcc849e3c9424828599Peter Bray MinimalInvocation -s ${SRC_ROOT} -d ${DATA_ROOT} -k "${1}"
cd348e325366620fe047edcc849e3c9424828599Peter Bray# Main Program
5762c9f28c2246777be0e9d49cb29d9c0f49146dLubos Kosco if [ -n "${2}" ]
cd348e325366620fe047edcc849e3c9424828599Peter Bray if [ -z "${1}" ]; then