Per project configuration

Table of contents

• Per project properties
  • Setup
  • List of tunables

Per project properties

Each project can have its own set of properties. These control various aspects of how the project (plus its repositories) is handled.

Setup

The setting of per-project tunables is done in read-only configuration file (see https://github.com/OpenGrok/OpenGrok/wiki/Read-only-configuration). The file can look like this:

<?xml version="1.0" encoding="UTF-8"?>
<java version="1.8.0_121" class="java.beans.XMLDecoder">
 <object class="org.opengrok.indexer.configuration.Configuration" id="Configuration0">

  ...

  <void property="projects">
   <void method="put">
    <string>PROJECT_NAME</string>
    <object class="org.opengrok.indexer.configuration.Project">
     <void property="navigateWindowEnabled">
      <boolean>true</boolean>
     </void>
    </object>
   </void>
  </void>

 </object>
</java>

Warning: keep in mind that this way the read-only configuration can only be used for initial global indexing. After that comment per-project settings out in read-only configuration and use RESTful API to set per project properties. For more info see https://github.com/oracle/opengrok/issues/2147

Properties

Property	Type	Since version	Meaning
navigateWindowEnabled	boolean	1.1	display navigate window automatically when browsing xrefs
tabSize	int	pre 0.12	size of tabulator in spaces. project reindex is necessary after changing the value !
handleRenamedFiles	boolean	1.1	disables or enables handling of renamed files
historyEnabled	boolean	1.1	enables or disables history for particular project
indexed	boolean	XXX	marks the project (not) indexed. When the value is False, the project is not displayed in the web application.
mergeCommitsEnabled	boolean	1.6.5	enables or disables storing merge commits in history
bugPage	String	1.7.22	URL of service where one can query information about bugs
bugPattern	String	ditto	regular expression to extract bug identification. The regexp is expected to have a single group.
reviewPage	String	ditto	similar to bugPage but for code review links
reviewPattern	String	ditto	similar to bugPattern but for code review links