Repository files navigation

• OpenGrok - a wicked fast source browser
  • 1. Introduction
  • 2. OpenGrok install and setup
  • 3. Information for developers
  • 4. Authors
  • 5. Contact us
  • 6. Run as container

OpenGrok is a fast and usable source code search and cross referenceengine, written in Java. It helps you search, cross-reference and navigateyour source tree. It can understand various program file formats andversion control histories of many source code management systems.

Official page of the project is on:https://oracle.github.io/opengrok/

Seehttps://github.com/oracle/opengrok/wiki/How-to-setup-OpenGrok

OpenGrok usessemantic versioning and the version components further indicate more details about updating to newer version. The version scheme ismajor.minor.micro and change in any component is interpreted as:

• major - major backwards incompatible update, will require full reindex as well as configuration changes
• minor - full clean reindex of your repositories is needed (e. g. index format has changed)
• micro - redeploy web application

Generally it is possible to go backward only within the micro version.

Seehttps://github.com/oracle/opengrok/wiki/Developer-intro andhttps://github.com/oracle/opengrok/wiki/Developers

The project has been originally conceived inSun Microsystems by Chandan B.N.

For full list of contributors seehttps://github.com/oracle/opengrok/graphs/contributors

Use theGithub Discussions.

You can run OpenGrok as a Docker container as describedhere.

This project welcomes contributions from the community. Before submitting a pull request, pleasereview our contribution guide

Please consult thesecurity guide for our responsible security vulnerability disclosure process

Copyright (c) 2006, 2025 Oracle and/or its affiliates.