![\"\"](\"https:\/\/opstree.com\/blog\/\/wp-content\/uploads\/2021\/07\/untitled-design-9.png?w=300\")
<\/figure><\/div>\n\n\n\nOpenGrok is a Java-based application that helps you to search in source code in a fast manner. It is developed by Oracle and supports a large number of languages and formats.<\/p>\n\n\n\n\n\n\n\n
Grok means understand i.e. to understand your source code. Some of the features of OpenGrok are as- <\/p>\n\n\n\n
- Search for full text<\/li>
- Definitions search<\/li>
- Symbols search<\/li>
- Path based search<\/li>
- Revision history. <\/li>
- Limit searches to any subtree. <\/li>
- Search for files modified within a date range.<\/li><\/ul>\n\n\n\n
Let\u2019s start the setup of OpenGrok, we need multiple applications to set up the OpenGrok.<\/p>\n\n\n\n
To set up the latest version of OpenGrok and If you want any other version of Opengrok you can do that but you will need a different version of Java and Web Application. Rest of the things will be the same. <\/p>\n\n\n\n
- Java – OpenJDK11 or Higher.<\/li>
- Tomcat 10 or Higher.<\/li>
- Universal Ctags<\/li><\/ol>\n\n\n\n
To make this blog short I have not covered the Java and Tomcat Installation. You can refer to the official site or any other link to download this software.<\/p>\n\n\n\n
https:\/\/www.java.com\/en\/download\/<\/p>\n\n\n\n
https:\/\/tomcat.apache.org\/download-10.cgi<\/p>\n\n\n\n
For installing the universal ctags-<\/p>\n\n\n\n
$ git clone https:\/\/github.com\/universal-ctags\/ctags.git\n $ cd ctags\n $ .\/autogen.sh\n $ .\/configure --prefix=\/where\/you\/want # defaults to \/usr\/local\n $ make\n $ make install # may require extra privileges depending on where to install\n<\/code><\/pre>\n\n\n\nOnce all the prerequisites have been Installed, you can proceed with Opengrok.<\/p>\n\n\n\n
<\/p>\n\n\n\n
Source Root is the date or source code that needs to be indexed. Each Directory in this source root act as a Project.<\/p>\n\n\n\n
Data Root is where the index data will be created.<\/p>\n\n\n\n
Step 1: Download the Opengrok Tar file from https:\/\/github.com\/oracle\/opengrok\/releases<\/a><\/p>\n\n\n\n
Step2 : Create a opengrok directory-<\/p>\n\n\n\n
$ mkdir \/opengrok<\/code><\/pre>\n\n\n\nStep3: Create subdirectories in opengrok directory<\/p>\n\n\n\n
$ mkdir src\n $ mkdir data\n $ mkdir dist\n $ mkdir log\n $ mkdir etc\n<\/code><\/pre>\n\n\n\nStep 4: Unpack the release tarball as follows:<\/p>\n\n\n\n
$ tar -C \/opengrok\/dist --strip-components=1 -xzf opengrok-*.tar.gz<\/code><\/pre>\n\n\n\nStep 5: Copy the logging configuration:<\/p>\n\n\n\n
$ cp \/opengrok\/dist\/doc\/logging.properties \/opengrok\/etc<\/code><\/pre>\n\n\n\nStep 6 : Clone the source code in the src directory which you want to search in opengrok. For the demo, you can add two codes-<\/p>\n\n\n\n
$ cd \/opengrok\/src\n\n# use one of the training modules at GitHub as an example small app. \n$ git clone https:\/\/github.com\/githubtraining\/hellogitworld.git\n\n# use OpenGrok as an example large app\n$ git clone https:\/\/github.com\/OpenGrok\/OpenGrok<\/a>\n<\/code><\/pre>\n\n\n\nStep7 : Copy source.war from \/opengrok\/dist\/lib\/source.war to the \/opt\/tomcat\/webapps<\/p>\n\n\n\n
$ cp \/opengrok\/dist\/lib\/source.war \/opt\/tomcat\/webapps<\/code><\/pre>\n\n\n\nStep8 : Tomcat will automatically extract the content of the source.war in the source directory. In this directory go to the source\/WEB-INF\/web.xml, edit param-value if your opengrok directory lies anywhere else.<\/p>\n\n\n\n
<param-value>\/opengrok\/etc\/configuration.xml<\/param-value><\/code><\/pre>\n\n\n\nStep9 : Now, it’s time to create Index for the Opengrok.<\/p>\n\n\n\n
$ java \\\n-Djava.util.logging.config.file=\/opengrok\/etc\/logging.properties \\\n-jar \/opengrok\/dist\/lib\/opengrok.jar \\\n-c \/usr\/local\/bin\/ctags \\\n-s \/opengrok\/src\/ -d \/opengrok\/data -H -P -S -G \\\n-W \/opengrok\/etc\/configuration.xml -U http:\/\/localhost:8080\/source<\/code><\/pre>\n\n\n\nRun the command with -h to get more information, from this you can understand why these flags used in above command<\/p>\n\n\n\n
$ java -jar \/opengrok\/dist\/lib\/opengrok.jar -h<\/code><\/pre>\n\n\n\nFinally your Opengrok is ready, browse these Link to access Opengrok –<\/p>\n\n\n\n
http:\/\/localhost:8080\/source or http:\/\/ServerIP:8080\/source.\n<\/code><\/pre>\n\n\n\n![\"\"](\"https:\/\/opstree.com\/blog\/\/wp-content\/uploads\/2021\/07\/image-2.png?w=518\")
<\/figure>\n\n\n\n<\/p>\n\n\n\n
It is much recommended for the developers who work on huge code like Android project and finds difficulty in searching in the code. <\/p>\n\n\n\n
Search the most out of your code and Happy Searching.<\/p>\n\n\n\n
Reference Image <\/a><\/p>\n\n\n\n
Blog Pundit:<\/strong> Naveen Verma<\/strong><\/a> and <\/strong><\/a>Abhishek Dubey<\/strong><\/a><\/strong><\/p>\n\n\n\n
Opstree is an End to End DevOps solution provider<\/p>\n\n\n\n