OpenGrok revision caf0d2e1c473e03780acaa86e2a73ff953802a8b
18920d790825d96ca3943aa2dcb6eb80dc611c5fTinderbox User# OpenGrok Wrapper (initial setup and cron job updating)
e9e4257668ff6c4e583b0c0db2508650b0b677b8Tinderbox User# Supported Operating Systems:
e9e4257668ff6c4e583b0c0db2508650b0b677b8Tinderbox User# - Solaris 11 (SunOS 5.11)
c57668a2fbbe558c1bd21652813616f2f517c469Tinderbox User# - Solaris 12 (SunOS 5.12)
a7c412f37cc73d0332887a746e81220cbf09dd00Mark Andrews# - Debian (Linux)
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews# Supported Deployment Engines:
e676a596869d8a80a644c99a848afb53d1c5975eMark Andrews# Supported Environment Variables:
e676a596869d8a80a644c99a848afb53d1c5975eMark Andrews# - OPENGROK_NON_INTERACTIVE Suppress Progress and Warnings Messages (*)
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews# - OPENGROK_STANDARD_ENV Run Time Shell Environment (Shell Script)
a7c412f37cc73d0332887a746e81220cbf09dd00Mark Andrews# - OPENGROK_CONFIGURATION User Configuration (Shell Script)
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews# Supported Environment Variables for configuring the default setup:
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews# - OPENGROK_DISTRIBUTION_BASE Base Directory of the OpenGrok Distribution
e676a596869d8a80a644c99a848afb53d1c5975eMark Andrews# - OPENGROK_INSTANCE_BASE Base Directory of the OpenGrok User Data Area
e676a596869d8a80a644c99a848afb53d1c5975eMark Andrews# - EXUBERANT_CTAGS Full Path to Exuberant CTags
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews# - OPENGROK_CTAGS_OPTIONS_FILE Full path to file with extra command line
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User# options for CTags program (for its --options
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# switch), default is DATA_ROOT/etc/ctags.config
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User# - JAVA_HOME Full Path to Java Installation Root
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# - JAVA Full Path to java binary (to enable 64bit JDK)
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User# - JAVA_OPTS Java options (e.g. for JVM memory increase
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# or enabling server JDK)
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User# JAVA_OPTS=-Xmx2048m is the default!
efb0e886f18894a1d2489f1ad74ad14b579e11c7Mark Andrews# - OPENGROK_APP_SERVER Application Server ("Tomcat" or "Glassfish")
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# - OPENGROK_WAR_TARGET_TOMCAT Tomcat Specific WAR Target Directory
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User# - OPENGROK_WAR_TARGET_GLASSFISH Glassfish Specific WAR Target Directory
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# - OPENGROK_WAR_TARGET Fallback WAR Target Directory
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User# - OPENGROK_TOMCAT_BASE Base Directory for Tomcat (contains webapps)
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# - OPENGROK_GLASSFISH_BASE Base Directory for Glassfish
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User# (contains domains)
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# - OPENGROK_GLASSFISH_DOMAIN Preferred Glassfish Domain Name
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User# - OPENGROK_VERBOSE Enable Verbose Mode in opengrok.jar (*)
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# - OPENGROK_PROGRESS Shows progress in %(percentage) of working
015055b6e23f5c08f6a5b34726f90b62597e9e45Tinderbox User# through project, it's good to have Verbose
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews# Mode enabled too, cost of this is one more
aa9c561961e9d877946ebaa8795fa2be054ab7bfEvan Hunt# traversal of the project before indexing it(*)
dc238a06bffa79de141ee7655765e2df91498a8aTinderbox User# - OPENGROK_REMOTE_REPOS Influence history cache generation for remote
0e573cdd111e060e5f6c18249b5ccacbe8abe278Tinderbox User# repositories. Following values are recognized:
aa9c561961e9d877946ebaa8795fa2be054ab7bfEvan Hunt# on - enabled (default)
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater# off - disabled for indexing and UI
16f6050f29b6b0422cee858e609f65e474e70ef2Tinderbox User# dirbased - indexing enabled only for repos
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater# which can fetch history for
dc238a06bffa79de141ee7655765e2df91498a8aTinderbox User# uionly - enabled for UI only
0e573cdd111e060e5f6c18249b5ccacbe8abe278Tinderbox User# - OPENGROK_SCAN_REPOS Disable Scan for repositories (*)
aa9c561961e9d877946ebaa8795fa2be054ab7bfEvan Hunt# - OPENGROK_SCAN_DEPTH how deep should scanning for repos go
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User# (by default 3 directories from SRC_ROOT)
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater# - OPENGROK_WEBAPP_CFGADDR Web app address to send configuration to
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater# (use "none" to avoid sending it to web app)
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater# - OPENGROK_WEBAPP_CONTEXT Context URL of the OpenGrok webapp
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# (by default /source)
cdfc81e048bd34c1d628380247bda6b80a89e20eAutomatic Updater# - FULL reindex is needed once this is used
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# (old already indexed files won't be refreshed)
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# - OPENGROK_WPREFIX Disable wildcard prefix search query
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# support (*)
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# - OPENGROK_DERBY if set, then indexer tries to use derby as
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater# historycache (see derby command of this
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# - OPENGROK_DERBY_URL Use specific URL to JavaDB, e.g.
16f6050f29b6b0422cee858e609f65e474e70ef2Tinderbox User# "jdbc:derby://localhost:1528/cachedb;create=true"
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# (default port is 1527)
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater# - OPENGROK_TAG Enable parsing of revision tags into the History
eabc9c3c07cd956d3c436bd7614cb162dabdda76Mark Andrews# - READ_XML_CONFIGURATION file with read only configuration
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# - temporary workaround for bug # 327
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# - OPENGROK_FLUSH_RAM_BUFFER_SIZE="-m 16" - set RAM buffer size for flushing,
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# default is 16MB per thread, you might try to
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# increase it to 256MB, but do increase JVM to
015055b6e23f5c08f6a5b34726f90b62597e9e45Tinderbox User# 4/8/16GB ! Lucene defaults to 8 threads.
2ae159b376dac23870d8005563c585acf85a4b5aEvan Hunt# Increase JVM memory as noted using JAVA_OPTS
2ae159b376dac23870d8005563c585acf85a4b5aEvan Hunt# - OPENGROK_LOGGER_CONFIG_PATH Set path to custom logging.properties file.
2ae159b376dac23870d8005563c585acf85a4b5aEvan Hunt# (*) Any Non-Empty String will enable these options
2ae159b376dac23870d8005563c585acf85a4b5aEvan Hunt# Copyright (c) 2008, 2014, Oracle and/or its affiliates. All rights reserved.
7cc0a5d21ef046bfd630c4769943d896a7d7472cTinderbox User# Print usage to stdout and exit.
7a6494cfb6cc7d3f67af07359561e05e6bb8c0edTinderbox User echo "Usage: ${progname} <deploy|derby|update|updateQuietly|usage|help>"
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews echo " ${progname} indexpart <src_root> <directory1> [..]"
18920d790825d96ca3943aa2dcb6eb80dc611c5fTinderbox User echo " ${progname} clearHistory [<repository_name>]"
77932ac533c711eca5cd86de4e7eca8d91102b43Tinderbox User echo " OPENGROK_CONFIGURATION - location of your configuration"
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews echo " e.g. $ OPENGROK_CONFIGURATION=/var/opengrok/myog.conf ${0} ... "
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson echo " See the code for more information on configuration options /" \
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# Runtime Configuration
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrewsif [ -x "/bin/uname" ]; then
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox Userelif [ -x "/usr/bin/uname" ]; then
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User echo "Cannot determine operating system version"
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User# TODO: Handle symlinks correctly (especially in ${0})
28a5dd720187fddb16055a0f64b63a7b66f29f64Mark AndrewsSCRIPT_DIRECTORY="`cd ${SCRIPT_DIRECTORY}; pwd`"
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews# Default Instance Configuration
37d8e0a4455876fe1e4cca511076cc2c5ab9eedeTinderbox User # Use the built-in defaults. This section can be copied to its own
fd972434c29fc1169d66594e4cc7697d33036c2bTinderbox User # file and tailored to your local requirements. Then simply set
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont # OPENGROK_CONFIGURATION=/path/to/your/configuration, before using
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews # this wrapper. It will save you hand editing in your settings
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews # on each new release. A sample cron(1M) entry might look like:
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont # 15 0 * * * OPENGROK_CONFIGURATION=/pkgs/etc/OpenGrok.sh /pkgs/sbin/OpenGrok updateQuietly
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews # Note: It is not really possible to ever provided defaults for
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews # these values which will run in every UNIX-like environment.
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews # So I have provided a set which are functional for a given
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews # environment on which you can based you own configuration.
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews # This has been updated to support more environment variables and
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews # operating systems, if you have any reasonably generic
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews # improvements please feel free to submit a patch.
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews OPENGROK_INSTANCE_BASE="${OPENGROK_INSTANCE_BASE:-/var/opengrok}"
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews -f "${SCRIPT_DIRECTORY}/dist/opengrok.jar" -a \
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User OPENGROK_DISTRIBUTION_BASE="${SCRIPT_DIRECTORY}/dist"
cdfc81e048bd34c1d628380247bda6b80a89e20eAutomatic Updater LOGGER_CONF_SOURCE="${SCRIPT_DIRECTORY}/${LOGGER_CONFIG_FILE}"
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews OPENGROK_DISTRIBUTION_BASE="${SCRIPT_DIRECTORY}/../lib"
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User LOGGER_CONF_SOURCE="${OPENGROK_DISTRIBUTION_BASE}/../doc/"
fe80a4909bf62b602feaf246866e9d29f7654194Automatic Updater LOGGER_CONF_SOURCE="${LOGGER_CONF_SOURCE}${LOGGER_CONFIG_FILE}"
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User # (your source code or the root of all repositories)
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User # (for Lucene index and hypertext cross-references)
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews # This area is rebuilt by "update" / "updateQuietly"
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User # OPTIONAL: User Provided Source Path to Description Mapping
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User # (The user maintained source of the generated EftarFile file)
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews PATH_DESC="${OPENGROK_INSTANCE_BASE}/etc/paths.tsv"
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User # (the configuration used by Web/GUI interfaces)
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews XML_CONFIGURATION="${OPENGROK_INSTANCE_BASE}/etc/configuration.xml"
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews # OPTIONAL: read only XML config, if it exists, it will be read
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User READ_XML_CONFIGURATION="${READ_XML_CONFIGURATION:-}"
133e6d43fa82e80d3798be4de00f4540f485ec6cAutomatic Updater if [ -n "${OPENGROK_LOGGER_CONFIG_PATH}" ]; then
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User if [ ! -f "${OPENGROK_LOGGER_CONFIG_PATH}" ]; then
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews echo "File ${OPENGROK_LOGGER_CONFIG_PATH} does not exist"
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User LOGGER_CONFIG_PATH=${OPENGROK_LOGGER_CONFIG_PATH}
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User LOGGER_CONFIG_PATH="${OPENGROK_INSTANCE_BASE}/${LOGGER_CONFIG_FILE}"
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User LOGGER_PROPERTIES="-Djava.util.logging.config.file=${LOGGER_CONFIG_PATH}"
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User # REQUIRED: Java Archive of OpenGrok (Installation Location)
5f7586ddbd3edd11272cdd30ed613d936129328bTinderbox User OPENGROK_JAR="${OPENGROK_DISTRIBUTION_BASE}/opengrok.jar"
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews # REQUIRED(deploy): Web Archive of OpenGrok (Distribution Location)
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User # (user building from source code will find this and other key
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews # files in the "dist" directory after the build is completed)
015055b6e23f5c08f6a5b34726f90b62597e9e45Tinderbox User OPENGROK_DIST_WAR="${OPENGROK_DISTRIBUTION_BASE}/source.war"
a7c412f37cc73d0332887a746e81220cbf09dd00Mark Andrews # REQUIRED: Exuberant CTags (http://ctags.sf.net)
a7c412f37cc73d0332887a746e81220cbf09dd00Mark Andrews EXUBERANT_CTAGS="${EXUBERANT_CTAGS:-`FindExuberantCTags`}"
37d8e0a4455876fe1e4cca511076cc2c5ab9eedeTinderbox User # OPTIONAL: supply extra command line options to CTags program
dc238a06bffa79de141ee7655765e2df91498a8aTinderbox User if [ -n "${OPENGROK_CTAGS_OPTIONS_FILE}" ]; then
37d8e0a4455876fe1e4cca511076cc2c5ab9eedeTinderbox User CTAGS_OPTIONS_FILE="${OPENGROK_CTAGS_OPTIONS_FILE}"
dc238a06bffa79de141ee7655765e2df91498a8aTinderbox User elif [ -r "${OPENGROK_INSTANCE_BASE}/etc/ctags.config" ]; then
a7c412f37cc73d0332887a746e81220cbf09dd00Mark Andrews CTAGS_OPTIONS_FILE="${OPENGROK_INSTANCE_BASE}/etc/ctags.config"
91d187ce035f39073f0732ff2a401a45c3c955fbMark Andrews # DEVELOPMENT: Debug option, if enabled current indexer will listen on the
bc0a53583d92309bebcf93c408e2f3247ebd3d3cAutomatic Updater #JAVA_DEBUG="-agentlib:jdwp=transport=dt_socket"
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater #JAVA_DEBUG="$JAVA_DEBUG,server=y,address=8010,suspend=y"
59528addd704f8d5757b54e540520f74e588a7c7Automatic Updater # OPTIONAL: Ignore these patterns as names of files or directories
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater # To ignore skipping just the history cache creation for a particular
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews # directory and all of it's subdirectories, touch an empty
59528addd704f8d5757b54e540520f74e588a7c7Automatic Updater # .opengrok_skip_history file at the root of that directory
b02be031b9ff37b042adc8e68e36b8bbc1f672b7Tinderbox User # (Every directory in SRC_ROOT is considered a separate project)
19b3dc94bce93fa76bd7e066f9298630dbc9dcb4Automatic Updater # OPTIONAL: Scanning Options (for Mercurial repositories)
37d8e0a4455876fe1e4cca511076cc2c5ab9eedeTinderbox User # OPTIONAL: Disable remote repository support (CVS or SVN) [on by default]
dc238a06bffa79de141ee7655765e2df91498a8aTinderbox User REMOTE_REPOSITORIES="-r ${OPENGROK_REMOTE_REPOS}"
9cd5eb6fe0f26d65724b99216cb31dcdd12e4afdAutomatic Updater # OPTIONAL: override depth of scanning for repositories
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater # OPTIONAL: Configuration Address (host:port)
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User WEBAPP_CONFIG_ADDRESS=${OPENGROK_WEBAPP_CFGADDR}
757ff043760e4743dda1a10e7d58349275934902Tinderbox User if [ "${OPENGROK_WEBAPP_CFGADDR}" == "none" ]; then
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson WEBAPP_CONFIG="-U ${WEBAPP_CONFIG_ADDRESS}"
4fe0411487e8e4401477684c0a2bac041ca7c2d5Tinderbox User WEBAPP_CONTEXT="-w ${OPENGROK_WEBAPP_CONTEXT}"
39cad8fb7d7ff3436bb24ce761354afcb80d295aMark Andrews # Assumption: We should not set properties to the empty string
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews${HG:+-Dorg.opensolaris.opengrok.history.Mercurial=$HG} \
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews${CVS:+-Dorg.opensolaris.opengrok.history.cvs=$CVS} \
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews${SVN:+-Dorg.opensolaris.opengrok.history.Subversion=$SVN} \
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews${SCCS:+-Dorg.opensolaris.opengrok.history.SCCS=$SCCS} \
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews${CLEARCASE:+-Dorg.opensolaris.opengrok.history.ClearCase=$CLEARCASE} \
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews${GIT:+-Dorg.opensolaris.opengrok.history.git=$GIT} \
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews${P4:+-Dorg.opensolaris.opengrok.history.Perforce=$P4} \
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews${MTN:+-Dorg.opensolaris.opengrok.history.Monotone=$MTN} \
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews${BZR:+-Dorg.opensolaris.opengrok.history.Bazaar=$BZR} \
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews # OPTIONAL: Store The History Cache in Java DB (derby),
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews # instead of file system (in gzipped xml files).
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews # - derbyclient.jar - See README.txt for more details
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews # - Running Derby Server - Defaults to localhost:1527
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews DERBY_OPTIONS="${DERBY_OPTIONS} -u ${OPENGROK_DERBY_URL}"
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews # OPTIONAL: Show revision tags in History view.
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews # Turn this off if you want to increase indexing performance a bit
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews # Usage: <class> inputFile [inputFile ...] outputFile
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews # EftarFile == An Extremely Fast Tagged Attribute Read-only File System
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews EFTAR_UPDATE="org.opensolaris.opengrok.web.EftarFile"
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews # HARDCODED: Generated EftarFile (See web/*.jsp)
b30ec46fec40a1b246f7965fbcd341fc6cfd1cc1Mark Andrews EFTAR_OUTPUT_FILE="${DATA_ROOT}/index/dtags.eftar"
c5a97a549c89d562e999d4f906b882c5a2a474e1Tinderbox User # Be Quiet? (set indirectly by command line arguments in the main program)
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater# Helper Functions - Logging
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# In general, non-interactive use like cron jobs and automated
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson# installation environments should not generate unnecessary
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# progress information or warnings, as usage and configuration
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# will have generally been debugged prior to automation.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington# Helper Functions - Autodetection of Runtime Environment
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington file=`which "$f" 2>/dev/null | grep -v '^no '`
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington # Search for Exuberant ctags intelligently, skipping
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington for program in ctags-exuberant exctags ctags; do
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington # Verify that this really is Exuberant Ctags.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington $binary --version 2>&1 | grep "Exuberant Ctags" > /dev/null
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington if [ $? -eq 0 ]; then
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews if [ $found -eq 1 ]; then
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews if [ $found -ne 1 ]; then
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews Error "Unable to determine Exuberant CTags command name" \
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updater SunOS:5.10) javaHome="/usr/jdk/instances/jdk1.7.0" ;;
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updater Darwin:*) javaHome=`/usr/libexec/java_home` ;;
c11c7b47726c02eb05e29ff7be56a3343146e396Tinderbox User javaHome=`ls -l /etc/alternatives/java | cut -f 2 -d \> `
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews # Use this function to determine which environment the deploy the
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater # web application function into. Some users (especially
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater # developers) will have many deployment environments or will wish
febbdb34a7f7759922e239655e7429d78d3a8d26Tinderbox User # to specify directly the application server to deploy to.
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater # Either use the environment variable OPENGROK_APP_SERVER or
dc238a06bffa79de141ee7655765e2df91498a8aTinderbox User # reimplement this function in your configuration file (as
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User # This implementation favours Tomcat, but needs a lot of work,
c01dec514a81ecf8c17ca3ef8c3ba95e437295ebAutomatic Updater # especially if Glassfish is perferrerd or it is under the control
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater # Maybe a better implementation would be to call Application
e8c42d50cdaf3a3b841074d8bf72b40ffbae2a4bTinderbox User # Server specific WAR Directory and see if they exist.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington if [ -x "/etc/init.d/appserv" -a -d "/var/appserver/domains" ]
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington if [ -n "${OPENGROK_WAR_TARGET_GLASSFISH}" ]
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington directory="${domainDirectory}/${OPENGROK_GLASSFISH_DOMAIN}/autodeploy"
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington FatalError "Missing Specified Glassfish Domain " \
56effd2e3f579fd77b1fb37d47871d1bf1286bc4Automatic Updater firstDomain=`ls -1 ${domainDirectory} | head -1`
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews FatalError "Failed to dynamically determine Glassfish Domain from " \
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews echo "${domainDirectory}/${firstDomain}/autodeploy"
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews# Implementation
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews# The variable "DO" can usefully be set to "echo" to aid in script debugging
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater # Setup a standard execution environment (if required)
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews cronexec="/pkgs/sbin/CronExecutionEnvironment.sh"
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington OPENGROK_STANDARD_ENV="${OPENGROK_STANDARD_ENV:-$cronexec}"
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington Progress "Loading ${OPENGROK_STANDARD_ENV} ..."
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington# Load custom configuration and then fill remaining stuff with defaults.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington # Note: As all functions have been defined by the time this routine
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington # is called, your configuration can, if desired, override functions
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington # in addition to setting the variables mentioned in the function
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington # DefaultInstanceConfiguration(), this maybe useful to override
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington # functionality used to determine the default deployment environment
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington # find dependencies or validate the configuration, for example.
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews if [ -n "${OPENGROK_CONFIGURATION}" -a -f "${OPENGROK_CONFIGURATION}" ]
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews # Load the Local OpenGrok Configuration Environment
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews Progress "Loading ${OPENGROK_CONFIGURATION} ..."
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews Progress "Loading the default instance configuration ..."
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews FatalError "Missing Dependent Application - Exuberant CTags"
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews FatalError "OpenGrok Source Path ${SRC_ROOT} doesn't exist"
859148b72a22e4221c3e918d15c7fdd5e78b6d8dTinderbox User Warning "Both Quiet and Verbose Mode Enabled - Choosing Verbose"
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews if [ `uname -s` == "SunOS" -a -d /opt/SUNWjavadb -a -d /usr/opengrok ];
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User ! -r "/var/tomcat6/webapps/source/WEB-INF/lib/derbyclient.jar" ];
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User FatalError "JavaDB on but no derbyclient.jar under" \
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater if [ ! -r "/usr/opengrok/lib/derbyclient.jar" ]; then
ec8755f605d7dcb2de1076040e77bc2d7ec33b4aTinderbox User FatalError "JavaDB on but no derbyclient.jar under" \
532d27b39244fadfcf8d8b4593f4c65434c9c664Automatic Updater Warning "CHECK: derbyclient.jar needs to be in where the rest of " \
532d27b39244fadfcf8d8b4593f4c65434c9c664Automatic Updater "opengrok used jars are and in unpacked source.war in " \
10702d681eb650391bcaa0e2704aa3cf2dbf0e98Mark Andrews Warning "OpenGrok generated data path ${DATA_ROOT} doesn't exist"
10702d681eb650391bcaa0e2704aa3cf2dbf0e98Mark Andrews Progress " Attempting to create generated data directory ... "
10702d681eb650391bcaa0e2704aa3cf2dbf0e98Mark Andrews FatalError "OpenGrok data path ${DATA_ROOT} doesn't exist"
e8c17c74535be290abaaa160a434ed80bf0ad2feMark Andrews Warning "OpenGrok generated etc path ${OPENGROK_INSTANCE_BASE}/etc " \
665ba746c0585088d0c314dcfc4671aa2c7b2dc1Automatic Updater Progress " Attempting to create generated etc directory ... "
9c446b72069d0ab9f710502f4d7048e50875fccbAutomatic Updater ${DO} mkdir -p "${OPENGROK_INSTANCE_BASE}/etc"
665ba746c0585088d0c314dcfc4671aa2c7b2dc1Automatic Updater if [ ! -d "${OPENGROK_INSTANCE_BASE}/etc" ]
93089a352d6903b0d7845a039de4ec2df9a0e35aTinderbox User FatalError "OpenGrok etc path ${OPENGROK_INSTANCE_BASE}/etc " \
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater if [ -n "${LOGGER_CONFIG_PATH}" -a ! -f "${LOGGER_CONFIG_PATH}" ]
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater Progress " Creating default ${LOGGER_CONFIG_PATH} ... "
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater Warning "Can't find distribution logging configuration" \
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater "(${LOGGER_CONF_SOURCE}) to install as default" \
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater "logging configuration (${LOGGER_CONFIG_PATH})"
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater fullpath="${OPENGROK_INSTANCE_BASE}/log/opengrok%g.%u.log"
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater ${DO} grep -v java.util.logging.FileHandler.pattern \
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater "${LOGGER_CONF_SOURCE}" > "${LOGGER_CONFIG_PATH}"
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater ${DO} grep java.util.logging.FileHandler.pattern \
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater sed "s|$filename|$fullpath|g" >> "${LOGGER_CONFIG_PATH}"
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater if [ ! -d "${OPENGROK_INSTANCE_BASE}/derby" ]
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater Warning "OpenGrok generated derby path " \
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater "${OPENGROK_INSTANCE_BASE}/derby doesn't exist"
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater Progress " Attempting to create generated derby directory ... "
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater ${DO} mkdir -p ${OPENGROK_INSTANCE_BASE}/derby
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater ${DO} ${JAVA} ${JAVA_OPTS} ${PROPERTIES} \
ff8ec39ce4afc2d774ce99f2386474d2c8539cd4Automatic Updater ${EXUBERANT_CTAGS:+-c} ${EXUBERANT_CTAGS} \
31a540386a9abaf681d8952f1b2cdf5c75a0ba6cAutomatic Updater ${CTAGS_OPTIONS_FILE:+-o} ${CTAGS_OPTIONS_FILE} \
31a540386a9abaf681d8952f1b2cdf5c75a0ba6cAutomatic Updater ${OPENGROK_FLUSH_RAM_BUFFER_SIZE} ${SKIN} ${LEADING_WILDCARD} \
7dd02af3c9350553e1d52d980a7812425b3f1295Automatic Updater if [ -n "${PATH_DESC}" -a -s "${PATH_DESC}" ]
d4ef65050feac78554addf6e16a06c6e2e0bd331Brian Wellington ${EFTAR_UPDATE} ${PATH_DESC} ${EFTAR_OUTPUT_FILE}
4fe0411487e8e4401477684c0a2bac041ca7c2d5Tinderbox User ${DO} ${JAVA} ${JAVA_OPTS} -jar ${OPENGROK_JAR} '-?'
37d8e0a4455876fe1e4cca511076cc2c5ab9eedeTinderbox User applicationServer="`FindApplicationServerType`"
82a986aaa5d3384a541b5a7d6dae8cf0726d6513Tinderbox User Tomcat) warTarget="`DetermineWarDirectoryTomcat`" ;;
2bd56b2684882faf74a2b29cb0914e6671d8005bTinderbox User Glassfish) warTarget="`DetermineWarDirectoryGlassfish`" ;;
aa49af836ce7a7a2888f5cedf4cbb14ff4dc1d11Mark Andrews *) FatalError "Unsupported Application Server ${applicationServer}" ;;
e676a596869d8a80a644c99a848afb53d1c5975eMark Andrews FatalError "Unable to determine Deployment Directory for " \
08a1e53c738c425390557196a2ba5039e5afd364Mark Andrews FatalError "Missing Web Application Archive ${OPENGROK_DIST_WAR}"
e676a596869d8a80a644c99a848afb53d1c5975eMark Andrews FatalError "Missing Deployment Directory ${warTarget}"
3040b455151b1e1173193933664b2891b6159f24Mark Andrews Progress "Installing ${OPENGROK_DIST_WAR} to ${warTarget} ..."
91d187ce035f39073f0732ff2a401a45c3c955fbMark Andrews ${DO} cp -p "${OPENGROK_DIST_WAR}" "${warTarget}/"
a7c412f37cc73d0332887a746e81220cbf09dd00Mark Andrews if [ $? != 0 ]
82a986aaa5d3384a541b5a7d6dae8cf0726d6513Tinderbox User FatalError "Web Application Installation FAILED"
b123be91958e0bc58a10c165be64d47661199e3bEvan Hunt Progress "Start your application server (${applicationServer}), " \
b123be91958e0bc58a10c165be64d47661199e3bEvan Hunt Progress "running, or wait until it loads the just installed web " \
b123be91958e0bc58a10c165be64d47661199e3bEvan Hunt Progress "OpenGrok should be available on <HOST>:<PORT>/source"
b123be91958e0bc58a10c165be64d47661199e3bEvan Hunt Progress " where HOST and PORT are configured in ${applicationServer}."
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater echo "Below might need your socket permission setup"
fd7c65dce9c2b1a3d12ca4df9074cd38019fdb5fAutomatic Updater java -Dderby.system.home=$DATA_ROOT/derby \
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater -jar /usr/jdk/instances/jdk1.7.0/db/lib/derbynet.jar start
9c2cf9e2017e6dd196e3b866808f32c6206eeedcMark Andrews -jar /usr/lib/jvm/java-6-sun/db/lib/derbynet.jar start
be0d1ec971748020cb0382e02b4642b493ea1e7bTinderbox User# Clear history index for given project.
ff62ab3c2e6274f19190ded15548c723d38bbbe3Automatic Updater Progress "Removing history index data for repository ${1}"
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews# Main Program
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User if [ -n "${2}" ]
e9e4257668ff6c4e583b0c0db2508650b0b677b8Tinderbox User if [ -z "${2}" ]; then