OpenGrok revision 340e2c0d70fade14c720931c87652727b941c167
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# OpenGrok Wrapper (initial setup and cron job updating)
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# Supported Operating Systems:
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# - Solaris 10 (SunOS 5.10)
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# - Solaris 11 (SunOS 5.11)
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# - Debian (Linux)
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# Supported Deployment Engines:
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# - Tomcat 5.5
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# - Glassfish
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# Supported Environment Variables:
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# - OPENGROK_NON_INTERACTIVE Suppress Progress and Warnings Messages (*)
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# - OPENGROK_STANDARD_ENV Run Time Shell Environment (Shell Script)
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# - OPENGROK_CONFIGURATION User Configuration (Shell Script)
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# Supported Environment Variables for configuring the default setup:
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# - OPENGROK_DISTRIBUTION_BASE Base Directory of the OpenGrok Distribution
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# - OPENGROK_INSTANCE_BASE Base Directory of the OpenGrok User Data Area
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# - EXUBERANT_CTAGS Full Path to Exuberant CTags
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# - JAVA_HOME Full Path to Java Installation Root
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# - OPENGROK_APP_SERVER Application Server ("Tomcat" or "Glassfish")
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# - OPENGROK_WAR_TARGET_TOMCAT Tomcat Specific WAR Target Directory
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# - OPENGROK_WAR_TARGET_GLASSFISH Glassfish Specific WAR Target Directory
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# - OPENGROK_WAR_TARGET Fallback WAR Target Directory
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# - OPENGROK_TOMCAT_BASE Base Directory for Tomcat (contains webapps)
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# - OPENGROK_GLASSFISH_BASE Base Directory for Glassfish
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# (contains domains)
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# - OPENGROK_GLASSFISH_DOMAIN Preferred Glassfish Domain Name
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# - OPENGROK_VERBOSE Enable Verbose Mode in opengrok.jar (*)
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# - OPENGROK_PROGRESS Shows progress in %(percentage) of working
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# through project, it's good to have Verbose
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# Mode enabled too, cost of this is one more
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# traversal of the project before indexing it(*)
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# - OPENGROK_REMOTE_REPOS Disable History Cache for (remote)
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# Repositories (*)
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# - OPENGROK_SCAN_REPOS Disable Scan for repositories (*)
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# - OPENGROK_SCAN_DEPTH how deep should scanning for repos go
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# (by default 3 directories from SRC_ROOT)
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# - OPENGROK_WEBAPP_CFGADDR Web app address to send configuration to
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# (use "none" to avoid sending it to web app)
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# - OPENGROK_WPREFIX Disable wildcard prefix search query
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# support (*)
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# - OPENGROK_DERBY if set, then indexer tries to use derby as
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# historycache (see derby command of this
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# - READ_XML_CONFIGURATION file with read only configuration
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# - temporary workaround for bug # 327
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# (*) Any Non-Empty String will enable these options
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# Copyright (c) 2008, 2012, Oracle and/or its affiliates. All rights reserved.
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye# Print usage to stderr and exit.
2e3888b9e322264fa8a5bd5c8b52df231f2eededTrond Norbye echo "Usage: ${progname} <deploy|derby|update|updateQuietly|usage>"
export JAVA_HOME
${CVS:+-Dorg.opensolaris.opengrok.history.cvs=$CVS} \
${SCCS:+-Dorg.opensolaris.opengrok.history.SCCS=$SCCS} \
${CLEARCASE:+-Dorg.opensolaris.opengrok.history.ClearCase=$CLEARCASE} \
${GIT:+-Dorg.opensolaris.opengrok.history.git=$GIT} \
${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} \
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} ${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} \
${WEBAPP_CONFIG} \
${DO} ${JAVA} -classpath ${OPENGROK_JAR} \
${EFTAR_UPDATE} ${PATH_DESC} ${EFTAR_OUTPUT_FILE}
SunOS:5.11)
Linux:*)
mkdir -p $DATA_ROOT/derby