README.md

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

OpenGrok - a wicked fast source browser

• 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

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: http://opengrok.github.com/OpenGrok/

2. OpenGrok install and setup

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

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

Feel free to participate in discussion on the mailing lists:

[email protected] (user topics)

[email protected] (developers' discussion)

To subscribe, send email to <mailing_list_name>[email protected]

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

6. Run as container

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