Merge branch 'add-dockerfile2' of https://github.com/wy193777/opengrok into wy193777-add-dockerfile2

Vladimir Kotal · Vladimir Kotal · commit 6dce66a34f27 · 2019-06-28T12:35:03.000+02:00
diff --git a/README.md b/README.md
@@ -10,12 +10,13 @@ Copyright (c) 2006, 2018 Oracle and/or its affiliates. All rights reserved.
 [![AppVeyor status](https://ci.appveyor.com/api/projects/status/8oqlk5yx2c5fnwqw/branch/master?svg=true)](https://ci.appveyor.com/project/vladak/opengrok-b5hnp/branch/master)
 [![License](https://img.shields.io/badge/License-CDDL%201.0-blue.svg)](https://opensource.org/licenses/CDDL-1.0)
 
-1. [Introduction](#1-introduction)
-2. [OpenGrok setup](#2-opengrok-install-and-setup)
-3. [Information for developers](#3-information-for-developers)
-4. [Authors](#4-authors)
-5. [Contact us](#5-contact-us)
-7. [Demo](#6-demo)
+- [OpenGrok - a wicked fast source browser](#opengrok---a-wicked-fast-source-browser)
+  - [1. Introduction](#1-introduction)
+  - [2. OpenGrok install and setup](#2-opengrok-install-and-setup)
+  - [3. Information for developers](#3-information-for-developers)
+  - [4. Authors](#4-authors)
+  - [5. Contact us](#5-contact-us)
+  - [6. Run as container](#6-run-as-container)
 
 ## 1. Introduction
 
@@ -53,6 +54,6 @@ To subscribe, send email to `<mailing_list_name>-subscribe@yahoogroups.com`
 
 There are also Slack channels on https://opengrok.slack.com/
 
-## 6. Demo
+## 6. Run as container
 
-Anyway, just demo it yourself - there are Docker images available on https://hub.docker.com/r/opengrok/docker/
+You can run opengrok as a docker container as described [here](docker/readme.md).
diff --git a/docker/docker.logging.properties b/docker/docker.logging.properties
@@ -0,0 +1,42 @@
+# Copyright 2017 Google Inc. All Rights Reserved.
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+handlers = java.util.logging.ConsoleHandler
+
+.handlers = java.util.logging.ConsoleHandler
+
+############################################################
+# Handler specific properties.
+# Describes specific configuration info for Handlers.
+############################################################
+
+java.util.logging.ConsoleHandler.level = FINE
+java.util.logging.ConsoleHandler.formatter = org.apache.juli.OneLineFormatter
+
+############################################################
+# Facility specific properties.
+# Provides extra control for each logger.
+############################################################
+
+org.apache.catalina.core.ContainerBase.[Catalina].[localhost].level = INFO
+org.apache.catalina.core.ContainerBase.[Catalina].[localhost].handlers = java.util.logging.ConsoleHandler
+
+org.apache.catalina.core.ContainerBase.[Catalina].[localhost].[/manager].level = INFO
+org.apache.catalina.core.ContainerBase.[Catalina].[localhost].[/manager].handlers =  java.util.logging.ConsoleHandler
+
+org.apache.catalina.core.ContainerBase.[Catalina].[localhost].[/host-manager].level = INFO
+org.apache.catalina.core.ContainerBase.[Catalina].[localhost].[/host-manager].handlers = java.util.logging.ConsoleHandler
diff --git a/docker/index.sh b/docker/index.sh
@@ -0,0 +1,33 @@
+#!/bin/bash
+
+LOCKFILE=/var/run/opengrok-indexer
+URI="http://localhost:8080"
+# $OPTS an be overwriteb by environment variable
+OPS=${INDEXER_FLAGS:='-H -P -S -G'}
+
+if [ -f "$LOCKFILE" ]; then
+	date +"%F %T Indexer still locked, skipping indexing"
+	exit 1
+fi
+
+touch $LOCKFILE
+
+if [ -z $NOMIRROR ]; then
+	date +"%F %T Mirroring starting"
+	opengrok-mirror --all --uri "$URI"
+	date +"%F %T Mirroring finished"
+fi
+
+date +"%F %T Indexing starting"
+opengrok-indexer \
+    -a /opengrok/lib/opengrok.jar -- \
+    -s /opengrok/src \
+    -d /opengrok/data \
+    --leadingWildCards on \
+    -W /var/opengrok/etc/configuration.xml \
+    -U "$URI" \
+    $OPS \
+    $INDEXER_OPT "$@"
+date +"%F %T Indexing finished"
+
+rm -f $LOCKFILE
diff --git a/docker/readme.md b/docker/readme.md
@@ -0,0 +1,83 @@
+[![Travis status](https://travis-ci.com/OpenGrok/docker.svg?branch=master)](https://travis-ci.com/OpenGrok/docker)
+
+# A Docker container for OpenGrok
+
+## OpenGrok from official source
+
+Directly downloaded from official source:
+https://github.com/oracle/opengrok/releases/
+
+You can learn more about OpenGrok at http://oracle.github.io/opengrok/
+
+The container is available from DockerHub at https://hub.docker.com/r/opengrok/docker/
+
+## When not to use it
+
+This image is simple wrapper around OpenGrok environment. The indexer and the web container are **not** tuned for large workloads. If you happen to have either large source data (e.g. [AOSP](https://en.wikipedia.org/wiki/Android_Open_Source_Project) or the like) or stable service or both, it is advisable to run the service standalone.
+
+## Additional info about the container
+
+* Tomcat 9
+* JRE 8 (Required for Opengrok 1.0+)
+* Configurable mirroring/reindexing (default every 10 min)
+
+The mirroring step works by going through all projects and attempting to
+synchronize all its repositories (e.g. it will do `git pull` for Git
+repositories).
+
+The indexer/mirroring is set so that it does not log into files.
+
+## How to run
+
+### From DockerHub
+
+    docker run -d -v <path/to/your/src>:/opengrok/src -p 8080:8080 opengrok/docker:latest
+
+### Build image locally
+
+    docker build -t opengrok-dev .
+
+Then run the container,
+
+    docker run -d -v <path/to/your/src>:/opengrok/src -p 8080:8080 opengrok-dev
+
+The container exports ports 8080 for OpenGrok.
+
+The volume mounted to `/opengrok/src` should contain the projects you want to make searchable (in sub directories). You can use common revision control checkouts (git, svn, etc...) and OpenGrok will make history and blame information available.
+
+By default, the index will be rebuild every ten minutes. You can adjust this
+time (in minutes) by passing the `REINDEX` environment variable:
+
+    docker run -d -e REINDEX=30 -v <path/to/your/src>:/opengrok/src -p 8080:8080 opengrok/docker:latest
+
+Setting `REINDEX` to `0` will disable automatic indexing. You can manually trigger an reindex using docker exec:
+
+    docker exec <container> /scripts/index.sh
+
+Setting `INDEXER_OPT` could pass extra options to opengrok-indexer. For example, you can run with:
+
+    docker run -d -e INDEXER_OPT="-i d:vendor" -v <path/to/your/src>:/opengrok/src -p 8080:8080 opengrok/docker:latest
+
+To remove all the `*/vendor/*` files from the index. You can check the indexer options on
+
+https://github.com/oracle/opengrok/wiki/Python-scripts-transition-guide
+
+To avoid the mirroring step, set the `NOMIRROR` variable to non-empty value.
+
+## OpenGrok Web-Interface
+
+The container has OpenGrok as default web app installed (accessible directly from `/`). With the above container setup, you can find it running on
+
+http://localhost:8080/
+
+The first reindex will take some time to finish. Subsequent reindex will be incremental so will take signigicantly less time.
+
+## Inspecting the container
+
+You can get inside a container using the [command below](https://docs.docker.com/engine/reference/commandline/exec/):
+
+```
+docker exec -it <container> bash
+```
+
+Enjoy.
diff --git a/docker/start.sh b/docker/start.sh
@@ -0,0 +1,49 @@
+#!/bin/bash
+
+# default period for reindexing (in minutes)
+if [ -z "$REINDEX" ]; then
+	REINDEX=10
+fi
+
+indexer(){
+	# Wait for Tomcat startup.
+	date +"%F %T Waiting for Tomcat startup..."
+	while [ "`curl --silent --write-out '%{response_code}' -o /dev/null 'http://localhost:8080/'`" == "000" ]; do
+		sleep 1;
+	done
+	date +"%F %T Startup finished"
+
+	if [[ ! -d /opengrok/data/index ]]; then
+		# Populate the webapp with bare configuration.
+		BODY_INCLUDE_FILE="/opengrok/data/body_include"
+		if [[ -f $BODY_INCLUDE_FILE ]]; then
+			mv "$BODY_INCLUDE_FILE" "$BODY_INCLUDE_FILE.orig"
+		fi
+		echo '<p><h1>Waiting on the initial reindex to finish.. Stay tuned !</h1></p>' > "$BODY_INCLUDE_FILE"
+		/scripts/index.sh --noIndex
+		rm -f "$BODY_INCLUDE_FILE"
+		if [[ -f $BODY_INCLUDE_FILE.orig ]]; then
+			mv "$BODY_INCLUDE_FILE.orig" "$BODY_INCLUDE_FILE"
+		fi
+
+		# Perform initial indexing.
+		NOMIRROR=1 /scripts/index.sh
+		date +"%F %T Initial reindex finished"
+	fi
+
+	# Continue to index every $REINDEX minutes.
+	if [ "$REINDEX" == "0" ]; then
+		date +"%F %T Automatic reindexing disabled"
+		return
+	else
+		date +"%F %T Automatic reindexing in $REINDEX minutes..."
+	fi
+	while true; do
+		sleep `expr 60 \* $REINDEX`
+		/scripts/index.sh
+	done
+}
+
+# Start all necessary services.
+indexer &
+catalina.sh run
diff --git a/dockerfile b/dockerfile
@@ -0,0 +1,60 @@
+FROM maven:latest as builder
+
+COPY ./ /opengrok-source
+WORKDIR /opengrok-source
+
+RUN apt-get update && apt-get install -y python3 python3-venv
+RUN mvn -f pom.xml clean package -DskipTests=true
+# find most recent package file
+RUN cp `ls -t distribution/target/*.tar.gz | head -n1 |awk '{printf("%s",$0)}'` /opengrok.tar.gz
+
+FROM tomcat:9-jre8
+LABEL maintainer "opengrok-dev@yahoogroups.com"
+
+# prepare OpenGrok binaries and directories
+COPY --from=builder opengrok.tar.gz /opengrok.tar.gz
+RUN mkdir -p /opengrok /var/opengrok/etc /opengrok/data /opengrok/src && \
+    tar -zxvf /opengrok.tar.gz -C /opengrok --strip-components 1 && \
+    rm -f /opengrok.tar.gz
+
+# install dependencies
+RUN apt-get update && apt-get install -y git subversion mercurial unzip inotify-tools python3 python3-pip && \
+    python3 -m pip install /opengrok/tools/opengrok-tools*
+# compile and install universal-ctags
+RUN apt-get install -y pkg-config autoconf build-essential && git clone https://github.com/universal-ctags/ctags /root/ctags && \
+    cd /root/ctags && ./autogen.sh && ./configure && make && make install && \
+    apt-get remove -y autoconf build-essential && apt-get -y autoremove && apt-get -y autoclean && \
+    cd /root && rm -rf /root/ctags
+
+# environment variables
+ENV SRC_ROOT /opengrok/src
+ENV DATA_ROOT /opengrok/data
+ENV OPENGROK_WEBAPP_CONTEXT /
+ENV OPENGROK_TOMCAT_BASE /usr/local/tomcat
+ENV CATALINA_HOME /usr/local/tomcat
+ENV PATH $CATALINA_HOME/bin:$PATH
+ENV CATALINA_BASE /usr/local/tomcat
+ENV CATALINA_HOME /usr/local/tomcat
+ENV CATALINA_TMPDIR /usr/local/tomcat/temp
+ENV JRE_HOME /usr
+ENV CLASSPATH /usr/local/tomcat/bin/bootstrap.jar:/usr/local/tomcat/bin/tomcat-juli.jar
+
+
+# custom deployment to / with redirect from /source
+RUN rm -rf /usr/local/tomcat/webapps/* && \
+    opengrok-deploy /opengrok/lib/source.war /usr/local/tomcat/webapps/ROOT.war && \
+    mkdir "/usr/local/tomcat/webapps/source" && \
+    echo '<% response.sendRedirect("/"); %>' > "/usr/local/tomcat/webapps/source/index.jsp"
+
+# disable all file logging
+ADD docker/logging.properties /usr/local/tomcat/conf/logging.properties
+RUN sed -i -e 's/Valve/Disabled/' /usr/local/tomcat/conf/server.xml
+
+# add our scripts
+ADD docker /scripts
+RUN chmod -R +x /scripts
+
+# run
+WORKDIR $CATALINA_HOME
+EXPOSE 8080
+CMD ["/scripts/start.sh"]
