OpenGrok revision caf0d2e1c473e03780acaa86e2a73ff953802a8b
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# OpenGrok Wrapper (initial setup and cron job updating)
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# Supported Operating Systems:
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# - Solaris 11 (SunOS 5.11)
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# - Solaris 12 (SunOS 5.12)
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# - Debian (Linux)
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# Supported Deployment Engines:
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# Supported Environment Variables:
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# - OPENGROK_NON_INTERACTIVE Suppress Progress and Warnings Messages (*)
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# - OPENGROK_STANDARD_ENV Run Time Shell Environment (Shell Script)
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# - OPENGROK_CONFIGURATION User Configuration (Shell Script)
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# Supported Environment Variables for configuring the default setup:
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# - OPENGROK_DISTRIBUTION_BASE Base Directory of the OpenGrok Distribution
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# - OPENGROK_INSTANCE_BASE Base Directory of the OpenGrok User Data Area
0b84d2442ea178dc9989a239f26be28327476c48Jean-Noel Rouvignac# - EXUBERANT_CTAGS Full Path to Exuberant CTags
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# - OPENGROK_CTAGS_OPTIONS_FILE Full path to file with extra command line
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# options for CTags program (for its --options
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# switch), default is DATA_ROOT/etc/ctags.config
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# - JAVA_HOME Full Path to Java Installation Root
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# - JAVA Full Path to java binary (to enable 64bit JDK)
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane# - JAVA_OPTS Java options (e.g. for JVM memory increase
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# or enabling server JDK)
35f4c9400e583aa53856c929a5fbcb52f66cd96bViolette Roche-Montane# JAVA_OPTS=-Xmx2048m is the default!
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# - OPENGROK_APP_SERVER Application Server ("Tomcat" or "Glassfish")
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# - OPENGROK_WAR_TARGET_TOMCAT Tomcat Specific WAR Target Directory
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane# - OPENGROK_WAR_TARGET_GLASSFISH Glassfish Specific WAR Target Directory
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# - OPENGROK_WAR_TARGET Fallback WAR Target Directory
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# - OPENGROK_TOMCAT_BASE Base Directory for Tomcat (contains webapps)
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# - OPENGROK_GLASSFISH_BASE Base Directory for Glassfish
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# (contains domains)
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# - OPENGROK_GLASSFISH_DOMAIN Preferred Glassfish Domain Name
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# - OPENGROK_VERBOSE Enable Verbose Mode in opengrok.jar (*)
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# - OPENGROK_PROGRESS Shows progress in %(percentage) of working
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane# through project, it's good to have Verbose
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# Mode enabled too, cost of this is one more
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# traversal of the project before indexing it(*)
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# - OPENGROK_REMOTE_REPOS Influence history cache generation for remote
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# repositories. Following values are recognized:
35f4c9400e583aa53856c929a5fbcb52f66cd96bViolette Roche-Montane# on - enabled (default)
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# off - disabled for indexing and UI
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# dirbased - indexing enabled only for repos
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# which can fetch history for
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane# uionly - enabled for UI only
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# - OPENGROK_SCAN_REPOS Disable Scan for repositories (*)
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane# - OPENGROK_SCAN_DEPTH how deep should scanning for repos go
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane# (by default 3 directories from SRC_ROOT)
a8b1f24a577acf3d2bd1154974d6bbe86ddf460bViolette Roche-Montane# - OPENGROK_WEBAPP_CFGADDR Web app address to send configuration to
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# (use "none" to avoid sending it to web app)
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# - OPENGROK_WEBAPP_CONTEXT Context URL of the OpenGrok webapp
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# (by default /source)
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# - FULL reindex is needed once this is used
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# (old already indexed files won't be refreshed)
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# - OPENGROK_WPREFIX Disable wildcard prefix search query
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane# - OPENGROK_DERBY if set, then indexer tries to use derby as
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane# historycache (see derby command of this
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane# - OPENGROK_DERBY_URL Use specific URL to JavaDB, e.g.
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane# "jdbc:derby://localhost:1528/cachedb;create=true"
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane# (default port is 1527)
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane# - OPENGROK_TAG Enable parsing of revision tags into the History
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane# - READ_XML_CONFIGURATION file with read only configuration
d54a7f8d41d8c04a43d136ad6748281308e0b720Jean-Noel Rouvignac# - temporary workaround for bug # 327
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane# - OPENGROK_FLUSH_RAM_BUFFER_SIZE="-m 16" - set RAM buffer size for flushing,
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane# default is 16MB per thread, you might try to
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane# increase it to 256MB, but do increase JVM to
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane# 4/8/16GB ! Lucene defaults to 8 threads.
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane# Increase JVM memory as noted using JAVA_OPTS
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane# - OPENGROK_LOGGER_CONFIG_PATH Set path to custom logging.properties file.
d54a7f8d41d8c04a43d136ad6748281308e0b720Jean-Noel Rouvignac# (*) Any Non-Empty String will enable these options
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane# Copyright (c) 2008, 2014, Oracle and/or its affiliates. All rights reserved.
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane# Print usage to stdout and exit.
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane echo "Usage: ${progname} <deploy|derby|update|updateQuietly|usage|help>"
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane echo " ${progname} index [<directory>]"
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane echo " ${progname} indexpart <src_root> <directory1> [..]"
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane echo " ${progname} clearHistory [<repository_name>]"
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane echo " Optional environment variables:"
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane echo " OPENGROK_CONFIGURATION - location of your configuration"
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane echo " e.g. $ OPENGROK_CONFIGURATION=/var/opengrok/myog.conf ${0} ... "
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane echo " See the code for more information on configuration options /" \
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane# Runtime Configuration
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montaneif [ -x "/bin/uname" ]; then
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montaneelif [ -x "/usr/bin/uname" ]; then
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane echo "Cannot determine operating system version"
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane# TODO: Handle symlinks correctly (especially in ${0})
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-MontaneSCRIPT_DIRECTORY="`cd ${SCRIPT_DIRECTORY}; pwd`"
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# Default Instance Configuration
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # Use the built-in defaults. This section can be copied to its own
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # file and tailored to your local requirements. Then simply set
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # OPENGROK_CONFIGURATION=/path/to/your/configuration, before using
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # this wrapper. It will save you hand editing in your settings
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # on each new release. A sample cron(1M) entry might look like:
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # 15 0 * * * OPENGROK_CONFIGURATION=/pkgs/etc/OpenGrok.sh /pkgs/sbin/OpenGrok updateQuietly
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # Note: It is not really possible to ever provided defaults for
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # these values which will run in every UNIX-like environment.
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # So I have provided a set which are functional for a given
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # environment on which you can based you own configuration.
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # This has been updated to support more environment variables and
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # operating systems, if you have any reasonably generic
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # improvements please feel free to submit a patch.
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane OPENGROK_INSTANCE_BASE="${OPENGROK_INSTANCE_BASE:-/var/opengrok}"
a8b1f24a577acf3d2bd1154974d6bbe86ddf460bViolette Roche-Montane LOGGER_CONFIG_FILE="logging.properties"
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane if [ -z "${OPENGROK_DISTRIBUTION_BASE}" ]
35f4c9400e583aa53856c929a5fbcb52f66cd96bViolette Roche-Montane if [ -d "${SCRIPT_DIRECTORY}/dist" -a \
abfe66cd244bd02b21219b62a623d75cc4994949Violette Roche-Montane -f "${SCRIPT_DIRECTORY}/dist/opengrok.jar" -a \
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane -f "${SCRIPT_DIRECTORY}/dist/source.war" \
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane # Handle Developer Build Environments
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane OPENGROK_DISTRIBUTION_BASE="${SCRIPT_DIRECTORY}/dist"
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane LOGGER_CONF_SOURCE="${SCRIPT_DIRECTORY}/${LOGGER_CONFIG_FILE}"
abfe66cd244bd02b21219b62a623d75cc4994949Violette Roche-Montane OPENGROK_DISTRIBUTION_BASE="${SCRIPT_DIRECTORY}/../lib"
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane LOGGER_CONF_SOURCE="${OPENGROK_DISTRIBUTION_BASE}/../doc/"
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane LOGGER_CONF_SOURCE="${LOGGER_CONF_SOURCE}${LOGGER_CONFIG_FILE}"
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # REQUIRED: Source Code/Repository Root
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # (your source code or the root of all repositories)
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane SRC_ROOT="${OPENGROK_INSTANCE_BASE}/src"
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane # REQUIRED: OpenGrok Generate Data Root
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # (for Lucene index and hypertext cross-references)
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # This area is rebuilt by "update" / "updateQuietly"
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane DATA_ROOT="${OPENGROK_INSTANCE_BASE}/data"
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane # OPTIONAL: User Provided Source Path to Description Mapping
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # (The user maintained source of the generated EftarFile file)
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane PATH_DESC="${OPENGROK_INSTANCE_BASE}/etc/paths.tsv"
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # (the configuration used by Web/GUI interfaces)
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane XML_CONFIGURATION="${OPENGROK_INSTANCE_BASE}/etc/configuration.xml"
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # OPTIONAL: read only XML config, if it exists, it will be read
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane READ_XML_CONFIGURATION="${READ_XML_CONFIGURATION:-}"
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane if [ -f "${READ_XML_CONFIGURATION}" ] ; then
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane READ_XML_CONF="-R ${READ_XML_CONFIGURATION}"
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane if [ -n "${OPENGROK_LOGGER_CONFIG_PATH}" ]; then
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane if [ ! -f "${OPENGROK_LOGGER_CONFIG_PATH}" ]; then
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane echo "File ${OPENGROK_LOGGER_CONFIG_PATH} does not exist"
35f4c9400e583aa53856c929a5fbcb52f66cd96bViolette Roche-Montane LOGGER_CONFIG_PATH=${OPENGROK_LOGGER_CONFIG_PATH}
35f4c9400e583aa53856c929a5fbcb52f66cd96bViolette Roche-Montane LOGGER_CONFIG_PATH="${OPENGROK_INSTANCE_BASE}/${LOGGER_CONFIG_FILE}"
35f4c9400e583aa53856c929a5fbcb52f66cd96bViolette Roche-Montane LOGGER_PROPERTIES="-Djava.util.logging.config.file=${LOGGER_CONFIG_PATH}"
35f4c9400e583aa53856c929a5fbcb52f66cd96bViolette Roche-Montane # REQUIRED: Java Archive of OpenGrok (Installation Location)
35f4c9400e583aa53856c929a5fbcb52f66cd96bViolette Roche-Montane OPENGROK_JAR="${OPENGROK_DISTRIBUTION_BASE}/opengrok.jar"
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # REQUIRED(deploy): Web Archive of OpenGrok (Distribution Location)
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # (user building from source code will find this and other key
35f4c9400e583aa53856c929a5fbcb52f66cd96bViolette Roche-Montane # files in the "dist" directory after the build is completed)
35f4c9400e583aa53856c929a5fbcb52f66cd96bViolette Roche-Montane OPENGROK_DIST_WAR="${OPENGROK_DISTRIBUTION_BASE}/source.war"
35f4c9400e583aa53856c929a5fbcb52f66cd96bViolette Roche-Montane # REQUIRED: Exuberant CTags (http://ctags.sf.net)
35f4c9400e583aa53856c929a5fbcb52f66cd96bViolette Roche-Montane EXUBERANT_CTAGS="${EXUBERANT_CTAGS:-`FindExuberantCTags`}"
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # OPTIONAL: supply extra command line options to CTags program
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane if [ -n "${OPENGROK_CTAGS_OPTIONS_FILE}" ]; then
6acb5680cc685afc071ca5bcc358d31690bb1786Jean-Noel Rouvignac CTAGS_OPTIONS_FILE="${OPENGROK_CTAGS_OPTIONS_FILE}"
6acb5680cc685afc071ca5bcc358d31690bb1786Jean-Noel Rouvignac elif [ -r "${OPENGROK_INSTANCE_BASE}/etc/ctags.config" ]; then
6acb5680cc685afc071ca5bcc358d31690bb1786Jean-Noel Rouvignac CTAGS_OPTIONS_FILE="${OPENGROK_INSTANCE_BASE}/etc/ctags.config"
6acb5680cc685afc071ca5bcc358d31690bb1786Jean-Noel Rouvignac JAVA_HOME="${JAVA_HOME:-`FindJavaHome`}"
6acb5680cc685afc071ca5bcc358d31690bb1786Jean-Noel Rouvignac # DEVELOPMENT: Debug option, if enabled current indexer will listen on the
6acb5680cc685afc071ca5bcc358d31690bb1786Jean-Noel Rouvignac #JAVA_DEBUG="-agentlib:jdwp=transport=dt_socket"
6acb5680cc685afc071ca5bcc358d31690bb1786Jean-Noel Rouvignac #JAVA_DEBUG="$JAVA_DEBUG,server=y,address=8010,suspend=y"
6acb5680cc685afc071ca5bcc358d31690bb1786Jean-Noel Rouvignac # OPTIONAL: Ignore these patterns as names of files or directories
6acb5680cc685afc071ca5bcc358d31690bb1786Jean-Noel Rouvignac # To ignore skipping just the history cache creation for a particular
6acb5680cc685afc071ca5bcc358d31690bb1786Jean-Noel Rouvignac # directory and all of it's subdirectories, touch an empty
6acb5680cc685afc071ca5bcc358d31690bb1786Jean-Noel Rouvignac # .opengrok_skip_history file at the root of that directory
6acb5680cc685afc071ca5bcc358d31690bb1786Jean-Noel Rouvignac # (Every directory in SRC_ROOT is considered a separate project)
6acb5680cc685afc071ca5bcc358d31690bb1786Jean-Noel Rouvignac # OPTIONAL: Scanning Options (for Mercurial repositories)
6acb5680cc685afc071ca5bcc358d31690bb1786Jean-Noel Rouvignac # OPTIONAL: Disable remote repository support (CVS or SVN) [on by default]
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane REMOTE_REPOSITORIES="-r ${OPENGROK_REMOTE_REPOS}"
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane # OPTIONAL: override depth of scanning for repositories
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane SCAN_DEPTH="-z${OPENGROK_SCAN_DEPTH}"
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane # OPTIONAL: Allow Leading Wildcard Searches
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # (Options: default, offwhite and polished.
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # OPTIONAL: Configuration Address (host:port)
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # (conf/web.xml default is localhost:2424)
6acb5680cc685afc071ca5bcc358d31690bb1786Jean-Noel Rouvignac if [ -n "${OPENGROK_WEBAPP_CFGADDR}" ]; then
6acb5680cc685afc071ca5bcc358d31690bb1786Jean-Noel Rouvignac WEBAPP_CONFIG_ADDRESS=${OPENGROK_WEBAPP_CFGADDR}
6acb5680cc685afc071ca5bcc358d31690bb1786Jean-Noel Rouvignac if [ "${OPENGROK_WEBAPP_CFGADDR}" == "none" ]; then
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane WEBAPP_CONFIG_ADDRESS="localhost:2424"
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane if [ -n "${WEBAPP_CONFIG_ADDRESS}" ]; then
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane WEBAPP_CONFIG="-U ${WEBAPP_CONFIG_ADDRESS}"
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # OPTIONAL: Context URL of the OpenGrok webapp
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane if [ -n "${OPENGROK_WEBAPP_CONTEXT}" ]; then
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane WEBAPP_CONTEXT="-w ${OPENGROK_WEBAPP_CONTEXT}"
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # OPTIONAL: Full Path to History Utilities
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # OPTIONAL: Override Built-in Properties
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # Assumption: We should not set properties to the empty string
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane${HG:+-Dorg.opensolaris.opengrok.history.Mercurial=$HG} \
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane${CVS:+-Dorg.opensolaris.opengrok.history.cvs=$CVS} \
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane${SVN:+-Dorg.opensolaris.opengrok.history.Subversion=$SVN} \
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane${SCCS:+-Dorg.opensolaris.opengrok.history.SCCS=$SCCS} \
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane${CLEARCASE:+-Dorg.opensolaris.opengrok.history.ClearCase=$CLEARCASE} \
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane${GIT:+-Dorg.opensolaris.opengrok.history.git=$GIT} \
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane${P4:+-Dorg.opensolaris.opengrok.history.Perforce=$P4} \
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane${MTN:+-Dorg.opensolaris.opengrok.history.Monotone=$MTN} \
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane${BZR:+-Dorg.opensolaris.opengrok.history.Bazaar=$BZR} \
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane # OPTIONAL: Store The History Cache in Java DB (derby),
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane # instead of file system (in gzipped xml files).
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # - derbyclient.jar - See README.txt for more details
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # - Running Derby Server - Defaults to localhost:1527
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane if [ -n "${OPENGROK_DERBY_URL}" ]; then
0b84d2442ea178dc9989a239f26be28327476c48Jean-Noel Rouvignac DERBY_OPTIONS="${DERBY_OPTIONS} -u ${OPENGROK_DERBY_URL}"
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # OPTIONAL: Show revision tags in History view.
6acb5680cc685afc071ca5bcc358d31690bb1786Jean-Noel Rouvignac # Turn this off if you want to increase indexing performance a bit
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # DELIVERED: An update program for EftarFile
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # Usage: <class> inputFile [inputFile ...] outputFile
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane # EftarFile == An Extremely Fast Tagged Attribute Read-only File System
ae2964516ff5296a50b354b4c1283879a637dc0cViolette Roche-Montane EFTAR_UPDATE="org.opensolaris.opengrok.web.EftarFile"
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # HARDCODED: Generated EftarFile (See web/*.jsp)
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane EFTAR_OUTPUT_FILE="${DATA_ROOT}/index/dtags.eftar"
6acb5680cc685afc071ca5bcc358d31690bb1786Jean-Noel Rouvignac # Be Quiet? (set indirectly by command line arguments in the main program)
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# Helper Functions - Logging
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# In general, non-interactive use like cron jobs and automated
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# installation environments should not generate unnecessary
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# progress information or warnings, as usage and configuration
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# will have generally been debugged prior to automation.
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane if [ -z "${OPENGROK_NON_INTERACTIVE}" ]
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane if [ -z "${OPENGROK_NON_INTERACTIVE}" ]
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane# Helper Functions - Autodetection of Runtime Environment
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane file=`which "$f" 2>/dev/null | grep -v '^no '`
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # Search for Exuberant ctags intelligently, skipping
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane for program in ctags-exuberant exctags ctags; do
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane for path in `echo $PATH | tr ':' '\n'`; do
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # Verify that this really is Exuberant Ctags.
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane $binary --version 2>&1 | grep "Exuberant Ctags" > /dev/null
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane if [ $? -eq 0 ]; then
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane if [ $found -eq 1 ]; then
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane if [ $found -ne 1 ]; then
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane Error "Unable to determine Exuberant CTags command name" \
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane SunOS:5.10) javaHome="/usr/jdk/instances/jdk1.7.0" ;;
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane SunOS:5.11) javaHome="/usr/jdk/latest" ;;
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane SunOS:5.12) javaHome="/usr/jdk/latest" ;;
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane Darwin:*) javaHome=`/usr/libexec/java_home` ;;
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane javaHome=`ls -l /etc/alternatives/java | cut -f 2 -d \> `
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane Error "Unable to determine Java 7 Home" \
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane Error "Missing Java Home ${javaHome}"
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # Use this function to determine which environment the deploy the
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # web application function into. Some users (especially
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # developers) will have many deployment environments or will wish
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # to specify directly the application server to deploy to.
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # Either use the environment variable OPENGROK_APP_SERVER or
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # reimplement this function in your configuration file (as
9fb13259bb1add404edb5dd42c4d51a69096617eViolette Roche-Montane # specified by OPENGROK_CONFIGURATION)
35f4c9400e583aa53856c929a5fbcb52f66cd96bViolette Roche-Montane # This implementation favours Tomcat, but needs a lot of work,
35f4c9400e583aa53856c929a5fbcb52f66cd96bViolette Roche-Montane # especially if Glassfish is perferrerd or it is under the control
35f4c9400e583aa53856c929a5fbcb52f66cd96bViolette Roche-Montane # of SMF (Service Management Facility)
35f4c9400e583aa53856c929a5fbcb52f66cd96bViolette Roche-Montane # Maybe a better implementation would be to call Application
35f4c9400e583aa53856c929a5fbcb52f66cd96bViolette Roche-Montane # Server specific WAR Directory and see if they exist.
${OPENGROK_TOMCAT_BASE} \
if [ ! -d ${OPENGROK_INSTANCE_BASE}/log ]
${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} \
${DERBY_OPTIONS} \
${HISTORY_TAGS} \
${REMOTE_REPOSITORIES} \
${SCAN_DEPTH} \
${PROGRESS} \
${EXUBERANT_CTAGS:+-c} ${EXUBERANT_CTAGS} \
${CTAGS_OPTIONS_FILE:+-o} ${CTAGS_OPTIONS_FILE} \
${OPENGROK_FLUSH_RAM_BUFFER_SIZE} ${SKIN} ${LEADING_WILDCARD} \
${READ_XML_CONF} \
-W ${XML_CONFIGURATION} \
${SCAN_FOR_REPOSITORY} \
${ENABLE_PROJECTS} \
${WEBAPP_CONFIG} \
${WEBAPP_CONTEXT} \
-s ${SRC_ROOT} \
-d ${DATA_ROOT} \
${DO} ${JAVA} -classpath ${OPENGROK_JAR} \
${EFTAR_UPDATE} ${PATH_DESC} ${EFTAR_OUTPUT_FILE}
SunOS:5.11)
SunOS:5.12)
mkdir -p $DATA_ROOT/derby
Linux:*)
mkdir -p $DATA_ROOT/derby