Documentation
What are the base requirements for jRevProxy?
- Java JDK/JRE version 1.4
- Xerces2 Java XML libraries: these libraries are included in this distribution (/lib directory).
Xerces2 Java is distributed under the Apache Software License.
A copy of this license can be found in the Appendix (§3.1) of the v0.4 package.
How do I start jRevProxy?
You start the jRevProxy server by executing
jrevproxy.bat (Windows)
jrevproxy.sh (Unix)
You can find these startup scripts under the /bin directory.
Before you start jRevProxy, you need to check the different properties in
jrevproxy.properties. You also need to update the jrevproxy XML file by
adding some rules.
Each rule specifies how external requests to a specific virtual directory
should be mapped to new internal request. It specifies also which users
are allowed to access the specified virtual directory.
Where do I modify the jRevProxy settings?
1. Open in the /etc directory the file jrevproxy.properties
2. Fill in the logpath property.
3. In case you want jRevProxy listen on another port than 443,
remove '#' in front of #PORT=80 and provide the right port.
4. In case you want jRevProxy to use a specific IP address,
uncomment #INTERFACE and specify the IP address
5. In case you want to use client authentication you need to change
the CLIENTAUTHENTICATION property in the jrevproxy.properties file to true.
Furthermore you need to add the DN (Distinguished Names) of these users to
the
rules that you want to allow access to the virtual directories.
How do add additional virtual directories and access rules for these directories?
1. Open in the /etc directory the file jrevproxy.xml2. Each rule has the following syntax:
<rule>
<name>...</name>
<virtualdir>...</virtualdir>
<junction>...</junction>
<users>
<subjectdn>...</subjectdn>
</users>
</rule>
The name is just a rule alias. The virtual directory tag gets mapped
by jRevProxy to the URL specified by the junction tag. Virtualdir values
should start with a '/'.
The subject distinguished name tag has the following format:
EMAILADDRESS=john.doe@somewhere.com, CN=John Doe, GIVENNAME=John, SURNAME=Doe
This DN should be retrieved from the certificate imported in the truststore.
The truststore holds all the user certificates that are trusted by jRevProxy.
When you import (with 'keytool') a user certificate into the truststore, be
carefull to import the whole certificate chain.>
Where can I find source code/API documentation?
The JavaDoc source code documentation can be found here. You can of course jump into the sourcecode itself :).
Last update: April 26 2003