Setup OpenGrok

This article is written based on OpenGrok Wiki and deployed in Ubuntu 20 distro. Switch to sudo mode and follow the below steps.

Method 1:

Setting OpenGrok with opengrok-1.5.12.tar.gz release.

1. Setup requires universal-ctags tomcat9 default-jre and python3

   sudo apt remove  -y exuberant-ctags # Remove if it exist
   sudo apt install -y universal-ctags python3-pip tomcat9 # tomcat automatically install jdk

2. Add required directories mkdir -p /opengrok/{src,data,dist,etc,log}

3. Copy your project sources to /opengrok/src directory. Each directories will be treated as projects

4. Extract downloaded Opengrok release package tar -C /opengrok/dist --strip-components=1 -xzf opengrok-1.5.12.tar.gz

5. Updated logging properties. Copy below contents to /opengrok/etc/logging.properties file

   handlers= java.util.logging.FileHandler, java.util.logging.ConsoleHandler
   
   java.util.logging.FileHandler.pattern = /opengrok/log/opengrok%g.%u.log
   java.util.logging.FileHandler.append = false
   java.util.logging.FileHandler.limit = 0
   java.util.logging.FileHandler.count = 30
   java.util.logging.FileHandler.level = ALL
   java.util.logging.FileHandler.formatter = org.opengrok.indexer.logger.formatter.SimpleFileLogFormatter
   
   java.util.logging.ConsoleHandler.level = WARNING
   java.util.logging.ConsoleHandler.formatter = org.opengrok.indexer.logger.formatter.SimpleFileLogFormatter
   
   org.opengrok.level = FINE

6. Install OpenGrok tools to deploy and build index pip install /opengrok/dist/tools/opengrok-tools.tar.gz

7. Deploy OpeGrok webapp to Tomcat servelet opengrok-deploy -c /opengrok/etc/configuration.xml /opengrok/dist/lib/source.war /var/lib/tomcat9/webapps

8. Generate Index for your projects

   opengrok-indexer -J=-Djava.util.logging.config.file=/opengrok/etc/logging.properties \
              -a /opengrok/dist/lib/opengrok.jar -- \
              -c /usr/bin/ctags-universal \
              -s /opengrok/src \
              -d /opengrok/data \
              -W /opengrok/etc/configuration.xml \
              -U http://localhost:8080/source \
              -H -P -S -G -i '*.out' -i '*.swo' -i '*.swp' \
              -i '*.a' -i '*.d' -i '*.o' -i '*.so' -i '*.so.*' \
              -i d:__ktags -i d:obj -i d:dist -i d:sandbox -i d:codereview -i 'd:*-build'

9. Explore the deployed projects at http://localhost:8080/source/

Method 2:

Setting OpenGrok with opengrok-1.1-rc32.tar.gz release candidate. See the transition guide here.

1. Install required software

   sudo apt install -y universal-ctags python3-pip tomcat8 # tomcat automatically install jdk

2. Add required directories mkdir -p /opengrok/{src,data,dist,etc,log}

3. Copy your project sources to /opengrok/src directory. Each directories will be treated as projects

4. Extract downloaded Opengrok release package tar -C /opengrok/dist --strip-components=1 -xzf opengrok-1.1-rc32.tar.gz

5. Updated logging properties /opengrok/etc/logging.properties as mentioned in above method at step 5.

6. Go to the directory /opengrok-1.1-rc30/bin/ follow next steps

7. Deploy OpenGrok with ./OpenGrok deploy command

8. Index your projects ./OpenGrok index command

9. Explore the deployed projects at http://localhost:8080/source/

Method 3: Docker implementation

Written based on the articles 1 and 2. Switch to sudo mode sudo -s and follow the below steps.

1. Install Docker tools

   install docker.io docker-compose

2. Create source path to save your projects

   mkdir -p /opengrok/{data,etc,src}

3. Add your projects source in /opengrok/src in host machine

4. Create docker compose file

   cat > docker-compose.yaml

   version: "3"
   services:
     opengrok:
       container_name: opengrok
       image: opengrok/docker:latest            # pull the latest docker image from the cloud
       ports:
         - "9090:8080/tcp"                      # forward the container traffics at the port 8080 to the
       environment:                             # - host machine to the port 9090
         SYNC_PERIOD_MINUTES: '10'              # sync repo for every one minutes
       volumes:                                 # volumes store your data between container upgrades
          - '~/opengrok/src/:/opengrok/src/'    # source code
          - '~/opengrok/etc/:/opengrok/etc/'    # folder contains configuration.xml
          - '~/opengrok/data/:/opengrok/data/'  # index and other things for source code

5. Run the container

   docker-compose up -d

6. Explore your project source at http://localhost:9090 in host machine

7. Index new sources

   docker exec -it opengrok opengrok-indexer -J=-Djava.util.logging.config.file=logging.properties \
               -a /opengrok/lib/opengrok.jar -- \
               -c /usr/local/bin/ctags \
               -s /opengrok/src \
               -d /opengrok/data -H -P -S -G \
               -W /opengrok/etc/configuration.xml \
               -U http://localhost:8080

8. Explore the container

   docker exec -it opengrok bash