Awesome Open Source
Awesome Open Source

Copyright (c) 2006, 2021 Oracle and/or its affiliates. All rights reserved.

OpenGrok - a wicked fast source browser

Github actions build Coverage status SonarQube status Total alerts License

1. Introduction

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

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

2. OpenGrok install and setup

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

2. 1. Updating

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

  • major - major backwards incompatible update
  • 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.

3. Information for developers

See https://github.com/oracle/opengrok/wiki/Developer-intro and https://github.com/oracle/opengrok/wiki/Developers

4. Authors

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

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

5. Contact us

There are Slack channels on https://opengrok.slack.com/

6. Run as container

You can run OpenGrok as a Docker container as described here.

In fact, http://demo.opengrok.org/ is using the opengrok/docker:master Docker image.


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
java (31,734
search (405
engine (224
code (161
source (51