Skip to content

Commit d5abd60

Browse files
committed
nits
1 parent 9d31dcf commit d5abd60

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

doc/authorization_howto.txt

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Using OpenGrok authorization
2-
------------------------
2+
----------------------------
33

44
This howto provides information about opengrok authorization with authorization framework.
55
You can use this package along with project groupings (merged before) which allows
@@ -15,7 +15,9 @@ Configuration
1515
--------------
1616

1717
You can configure:
18+
1819
1) Plugin directory
20+
1921
In web.xml for the webapp, there is a context parameter dedicated to this.
2022

2123
<context-param>
@@ -26,14 +28,15 @@ You can configure:
2628
Default value is OPENGROK_DATA_ROOT/plugins
2729
</description>
2830
</context-param>
29-
31+
3032
It is commented out by default so that the framework does not do anything.
3133
The OPENGROK_DATA_ROOT is the dataRoot directory set in configuration.xml.
3234

3335
Opengrok authorization expects plugin classes in that directory, it loads those classes in
3436
memory as plugins and then perform the authorization for each request.
3537

3638
2) Watchdog service
39+
3740
For easier development there is another context parameter in web.xml.
3841

3942
<context-param>
@@ -51,7 +54,8 @@ You can configure:
5154
plugin directory are loaded.
5255

5356
3) Provide a plugin
54-
You can provide your own plugin by putting the compiled
57+
58+
You can provide your own plugin by putting the compiled
5559
plugin class (.class or in .jar) into plugin directory.
5660

5761

@@ -116,8 +120,8 @@ Also JVM can forbid you to extend some packages which are not meant to be extend
116120
Set up
117121
------
118122

119-
The plugin class must be compiled to the .class file (and the it can be packaged into .jar file).
120-
The frameworks supports both .class and .jar files.
123+
The plugin class must be compiled to the .class file (and then it can be packaged into .jar file).
124+
The framework supports both .class and .jar files.
121125
For compiling you have to provide opengrok.jar in the classpath
122126

123127
Example (for the SampleAuthorizationPlugin which is included):
@@ -127,12 +131,12 @@ Then you can just drop the compiled .class file into plugin directory and deploy
127131
If the plugin is a part of a package. Then you have to copy the full directory path which is made
128132
by the compiler relatively to the source file.
129133

130-
If anything goes wrong, you should find information in the logs.
134+
If anything goes wrong, you will find information in the logs.
131135

132136
Running
133137
-------
134138

135-
The framework consists of three parts
139+
The framework consists of three parts:
136140

137141
1) PluginFramework
138142
Plugin container
@@ -155,4 +159,4 @@ The framework consists of three parts
155159

156160
Every 403 error is logged. But information about the user is missing
157161
because the decision is made by plugins and the filter does not know
158-
how to interpret the request to get the user from it.
162+
how to interpret the request to get the user from it.

0 commit comments

Comments
 (0)