Friday, July 20, 2012

Installing OpenGrok on Windows


Installing OpenGrok on Windows


Steps for installing OpenGrok.

  1. Download the OpenGrok binary from OpenGrok Binary.
  2. Unzip the tar to a location say "G:\OpenGrok"
  3. Download Ctags from Ctags Windows Binary.
  4. Extract Ctags to a location say "G:\Ctags"
  5. Download and install Tomcat.
  6. OpenGrok needs the following to run
    1. A configuration.xml that is generated using the command in step 8.
    2. Location to the source being indexed. (SRC_ROOT)
    3. Location to the "Ctag" generated grokData, again refer to step 8.  (DATA_ROOT)
  7. Extract the "war" file in the "lib" folder in the extracted OpenGrok location. In this case  G:\opengrok-0.11.1\lib.
  8. Edit the WEB-INF\web.xml file to include the information discussed above (step 6)
  9.  <context-param>  
       <param-name>CONFIGURATION</param-name>  
       <param-value>G:\opengrok-0.11.1\configuration.xml</param-value>  
       <description>Full path to the configuration file where OpenGrok can read it's configuration</description>  
      </context-param>  
      -------Added the below------  
      <context-param>    
       <param-name>SRC_ROOT</param-name>  
       <param-value>G:\CodeSource</param-value>  
      </context-param>  
      <context-param>  
       <param-name>DATA_ROOT</param-name>  
       <param-value>G:\opengrok-0.11.1\grokdata</param-value>    
      </context-param>  
    
  10. Copy the the extracted source.war with the modified web.xml to the tomcat webapps folder. 
  11. Index the source and generate the configuration.xml file using the below command (G:\opengrok-0.11.1\lib has the jar file)
  12.  java -jar opengrok.jar -W G:\opengrok-0.11.1\configuration.xml -c G:\ctags58\ctags.exe -P -S -v -s G:\CodeSource -d G:\opengrok-0.11.1\grokdata  
    
  13. Launch Tomcat after the indexing in done. Open http://localhost:8080/source and wola you have a wicked fast source browser. 
  14. Reindex if you need to add new projects/pick new source etc.