@@ -23,24 +23,24 @@ engine, written in Java. It helps you search, cross-reference and navigate
23
23
your source tree. It can understand various program file formats and
24
24
version control histories of many source code management systems.
25
25
26
- Official page of the project is on:
26
+ Official page of the project is on:
27
27
< http://opengrok.github.com/OpenGrok/ >
28
28
29
29
## 2. Requirements
30
- * Latest Java (at least 1.8)
30
+ * Latest Java (at least 1.8)
31
31
< http://www.oracle.com/technetwork/java/ >
32
- * A servlet container like Tomcat (8.x or later) supporting Servlet 2.5 and JSP 2.1
32
+ * A servlet container like Tomcat (8.x or later) supporting Servlet 2.5 and JSP 2.1
33
33
< http://tomcat.apache.org/ >
34
- * Exuberant Ctags or Universal Ctags
35
- < http://ctags.sourceforge.net/ >
34
+ * Exuberant Ctags or Universal Ctags
35
+ < http://ctags.sourceforge.net/ >
36
36
< https://ctags.io/ >
37
37
* Source Code Management installation depending on type of repositories indexed
38
38
* If you want to build OpenGrok:
39
- * Ant (1.9.4 and later)
39
+ * Ant (1.9.4 and later)
40
40
< http://ant.apache.org/ >
41
- * JFlex
41
+ * JFlex
42
42
< http://www.jflex.de/ >
43
- * Netbeans (optional, at least 8.2, will need Ant 1.9.4)
43
+ * Netbeans (optional, at least 8.2, will need Ant 1.9.4)
44
44
< http://netbeans.org/ >
45
45
46
46
## 3. Usage
@@ -114,7 +114,7 @@ Currently supported message types:
114
114
3 . ** StatsMessage (stats)** – this message is designed to retrieve some information from the web application.
115
115
116
116
The purpose of the message is specified in the text field as one of:
117
-
117
+
118
118
* ** reload** – the application reloads the statistics file
119
119
and returns the loaded statistics
120
120
* ** clean** – the application cleans its current statistics
@@ -132,7 +132,7 @@ Currently supported message types:
132
132
5 . ** RefreshMesssage (refresh)** – sent at the end of partial reindex to trigger refresh of ` SearcherManagers ` .
133
133
134
134
6 . ** ProjectMessage** – used for adding/deleting projects and partial (per-project) reindex.
135
-
135
+
136
136
* ** add** – adds project(s) and its repositories to the configuration.
137
137
If the project already exists, refresh list of its repositories.
138
138
* ** delete** – removes project(s) and its repositores from the configuration.
@@ -211,7 +211,7 @@ stored (can vary on your system).
211
211
Note that now you might need to change to user which owns the target
212
212
directories for data, e.g. on Solaris you'd do:
213
213
214
- ``` bash
214
+ ``` bash
215
215
pfexec su - webservd
216
216
cd /usr/opengrok/bin
217
217
```
@@ -328,7 +328,7 @@ them and index them.
328
328
It basically works like this:
329
329
330
330
1 . bootstrap initial configuration: OpenGrok bootstrap
331
-
331
+
332
332
* this will create ` /var/opengrok/etc/configuration.xml ` with basic set of
333
333
properties. If more is needed use:
334
334
@@ -443,13 +443,13 @@ There are 2 (or 3) steps needed for this task.
443
443
444
444
#### 5.4.1 Populate DATA_ROOT Directory
445
445
446
- * ** Option 1. OpenGrok** :
446
+ * ** Option 1. OpenGrok** :
447
447
There is a sample shell script ` OpenGrok ` that is suitable
448
448
for using in a cron job to run regularly. Modify the variables in the script
449
449
to point appropriate directories, or as the code suggests factor your local
450
450
configuration into a separate file and simplify future upgrades.
451
451
452
- * ** Option 2. opengrok.jar** :
452
+ * ** Option 2. opengrok.jar** :
453
453
You can also directly use the Java application. If
454
454
the sources are all located in a directory ` SRC_ROOT ` and the data and
455
455
hypertext files generated by OpenGrok are to be stored in ` DATA_ROOT ` , run
@@ -523,12 +523,12 @@ Note that only some paths can have a description.
523
523
` web.xml ` is the deployment descriptor for the web application. It is in a Jar
524
524
file named ` source.war ` , you can change it as follows:
525
525
526
- * ** Option 1** :
526
+ * ** Option 1** :
527
527
Unzip the file to ` TOMCAT/webapps/source/ ` directory and
528
528
change the ` source/WEB-INF/web.xml ` and other static html files like
529
529
` index.html ` to customize to your project.
530
530
531
- * ** Option 2** :
531
+ * ** Option 2** :
532
532
Extract the ` web.xml ` file from ` source.war ` file
533
533
534
534
``` bash
@@ -543,7 +543,7 @@ file named `source.war`, you can change it as follows:
543
543
544
544
Then copy the war files to ` TOMCAT/webapps ` directory.
545
545
546
- * ** Option 3** :
546
+ * ** Option 3** :
547
547
Edit the Context container element for the webapp
548
548
549
549
Copy ` source.war ` to ` TOMCAT/webapps `
@@ -554,7 +554,7 @@ file named `source.war`, you can change it as follows:
554
554
555
555
After the index is built, there's a couple different ways to set the
556
556
Context for the servlet container:
557
-
557
+
558
558
* Add the Context inside a Host element in ` TOMCAT/conf/server.xml `
559
559
560
560
``` xml
@@ -649,10 +649,10 @@ source.war WEB-INF/web.xml`) file, edit `web.xml` and re-package the jar file
649
649
parameters appropriately. These sample parameters need modifying(there are
650
650
more options, refer to manual or read param comments).
651
651
652
- * ** CONFIGURATION** – the absolute path to XML file containing project configuration
652
+ * ** CONFIGURATION** – the absolute path to XML file containing project configuration
653
653
(e.g. ` /var/opengrok/etc/configuration.xml ` )
654
654
* ** ConfigAddress** – port for remote updates to configuration, optional, but advised(since there is no authentication)
655
- to be set to ` localhost:<some_port> ` (e.g. ` localhost:2424 ` ), if you choose ` some_port ` below 1024 you have to have
655
+ to be set to ` localhost:<some_port> ` (e.g. ` localhost:2424 ` ), if you choose ` some_port ` below 1024 you have to have
656
656
root privileges
657
657
658
658
If you need to change name of the web application from source to something
@@ -663,16 +663,16 @@ deploying `source.war`, but you can use it to deploy your `new_name.war` too.
663
663
664
664
Deploy the modified ` .war ` file in glassfish/Sun Java App Server:
665
665
666
- * ** Option 1** :
667
- Use browser and log into glassfish web administration interface: Common Tasks / Applications / Web Applications
666
+ * ** Option 1** :
667
+ Use browser and log into glassfish web administration interface: Common Tasks / Applications / Web Applications
668
668
, button Deploy and point it to your ` source.war ` webarchive
669
669
670
- * ** Option 2** :
670
+ * ** Option 2** :
671
671
Copy the ` source.war ` file to
672
672
` GLASSFISH/domains/YOURDOMAIN/autodeploy ` directory, glassfish will try
673
673
to deploy it "auto magically".
674
674
675
- * ** Option 3** :
675
+ * ** Option 3** :
676
676
Use cli from GLASSFISH directory:
677
677
678
678
``` bash
@@ -690,7 +690,7 @@ Just run `ant` from command line in the top-level directory or use build
690
690
process driven by graphical developer environment such as Netbeans.
691
691
692
692
Note: in case you are behind http proxy, use ` ANT_OPTS ` to download jflex, lucene.
693
- E.g.
693
+ E.g.
694
694
``` bash
695
695
ANT_OPTS=" -Dhttp.proxyHost=?.? -Dhttp.proxyPort=80" ant
696
696
```
@@ -722,7 +722,7 @@ ant -lib ./lib test
722
722
```
723
723
724
724
To check if the test completed without error look for ` AssertionFailedError `
725
- occurences in the ` TESTS-TestSuites.xml ` file produced by the test run.
725
+ occurrences in the ` TESTS-TestSuites.xml ` file produced by the test run.
726
726
727
727
### 8.2 Using Findbugs
728
728
@@ -1001,9 +1001,9 @@ export JAVA_OPTS
1001
1001
For tomcat you might also hit a limit for http header size (we use it to send
1002
1002
the project list when requesting search results):
1003
1003
1004
- * increase(add) in ` conf/server.xml `
1005
-
1006
- ``` xml
1004
+ * increase(add) in ` conf/server.xml `
1005
+
1006
+ ``` xml
1007
1007
maxHttpHeaderSize
1008
1008
connectionTimeout="20000"
1009
1009
maxHttpHeaderSize="65536"
@@ -1057,7 +1057,7 @@ The project has been originally conceived in Sun Microsystems by Chandan B.N.
1057
1057
Feel free to participate in discussion on the mailing lists:
1058
1058
1059
1059
1060
-
1060
+
1061
1061
` [email protected] ` (developers' discussion)
1062
1062
1063
1063
To subscribe, send email to
` <mailing_list_name>[email protected] `
0 commit comments