xref: /OpenGrok/README.md (revision d7020238aba2ff2d3232a8c6d939ea2b36a914e8) 
1
2Copyright (c) 2006, 2021 Oracle and/or its affiliates. All rights reserved.
3
4
5# OpenGrok - a wicked fast source browser
6[![Github actions build](https://github.com/oracle/opengrok/workflows/Build/badge.svg?branch=master)](https://github.com/oracle/opengrok/actions)
7[![Coverage status](https://coveralls.io/repos/oracle/opengrok/badge.svg?branch=master)](https://coveralls.io/r/oracle/opengrok?branch=master)
8[![SonarQube status](https://sonarcloud.io/api/project_badges/measure?project=org.opengrok%3Aopengrok-top&metric=alert_status)](https://sonarcloud.io/dashboard?id=org.opengrok%3Aopengrok-top)
9[![Total alerts](https://img.shields.io/lgtm/alerts/g/oracle/opengrok.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/oracle/opengrok/alerts/)
10[![License](https://img.shields.io/badge/License-CDDL%201.0-blue.svg)](https://opensource.org/licenses/CDDL-1.0)
11
12- [OpenGrok - a wicked fast source browser](#opengrok---a-wicked-fast-source-browser)
13  - [1. Introduction](#1-introduction)
14  - [2. OpenGrok install and setup](#2-opengrok-install-and-setup)
15  - [3. Information for developers](#3-information-for-developers)
16  - [4. Authors](#4-authors)
17  - [5. Contact us](#5-contact-us)
18  - [6. Run as container](#6-run-as-container)
19
20## 1. Introduction
21
22OpenGrok is a fast and usable source code search and cross reference
23engine, written in Java. It helps you search, cross-reference and navigate
24your source tree. It can understand various program file formats and
25version control histories of many source code management systems.
26
27Official page of the project is on:
28<https://oracle.github.io/opengrok/>
29
30## 2. OpenGrok install and setup
31
32See https://github.com/oracle/opengrok/wiki/How-to-setup-OpenGrok
33
34### 2. 1. Updating
35
36OpenGrok uses [semantic versioning](https://semver.org/) 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:
37
38 - major - major backwards incompatible update
39 - minor - full clean reindex of your repositories is needed (e. g. index format has changed)
40 - micro - redeploy web application
41
42Generally it is possible to go backward only within the micro version.
43
44## 3. Information for developers
45
46See https://github.com/oracle/opengrok/wiki/Developer-intro and https://github.com/oracle/opengrok/wiki/Developers
47
48## 4. Authors
49
50The project has been originally conceived in [Sun Microsystems](https://en.wikipedia.org/wiki/Sun_Microsystems) by Chandan B.N.
51
52For full list of contributors see https://github.com/oracle/opengrok/graphs/contributors
53
54## 5. Contact us
55
56There are Slack channels on https://opengrok.slack.com/
57
58## 6. Run as container
59
60You can run OpenGrok as a Docker container as described [here](docker/README.md).
61
62In fact, http://demo.opengrok.org/ is using the `opengrok/docker:master` Docker image.
63