appendix-ports-used.xml revision 7b85693a3ced68e4f3697280b999a5a710b7a17d
<?xml version="1.0" encoding="UTF-8"?>
<!--
! CCPL HEADER START
!
! This work is licensed under the Creative Commons
! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
! To view a copy of this license, visit
! http://creativecommons.org/licenses/by-nc-nd/3.0/
! or send a letter to Creative Commons, 444 Castro Street,
! Suite 900, Mountain View, California, 94041, USA.
!
! You can also obtain a copy of the license at
! legal/CC-BY-NC-ND.txt.
! See the License for the specific language governing permissions
! and limitations under the License.
!
! If applicable, add the following below this CCPL HEADER, with the fields
! enclosed by brackets "[]" replaced with your own identifying information:
! Portions Copyright [yyyy] [name of copyright owner]
!
! CCPL HEADER END
!
! Copyright 2012-2014 ForgeRock AS
!
-->
<appendix xml:id='appendix-ports-used'
version='5.0' xml:lang='en'
xmlns='http://docbook.org/ns/docbook'
xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
xsi:schemaLocation='http://docbook.org/ns/docbook
http://docbook.org/xml/5.0/xsd/docbook.xsd'>
<title>Ports Used</title>
<variablelist>
<para>
By default, OpenIDM ${docTargetVersion} listens on the following ports
(specified in the file
<filename>/path/to/openidm/conf/boot/boot.properties</filename>):
</para>
<varlistentry>
<term><literal>8080</literal></term>
<listitem>
<indexterm>
<primary>Ports</primary>
<secondary>8080</secondary>
</indexterm>
<para>HTTP access to the REST API, requiring OpenIDM authentication. This
port is not secure, exposing clear text passwords and all data that is not
encrypted. This port is therefore not suitable for production use.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>8443</literal></term>
<listitem>
<indexterm>
<primary>Ports</primary>
<secondary>8443</secondary>
</indexterm>
<para>HTTPS access to the REST API, requiring OpenIDM authentication</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>8444</literal></term>
<listitem>
<indexterm>
<primary>Ports</primary>
<secondary>8444</secondary>
</indexterm>
<para>
HTTPS access to the REST API, requiring SSL mutual authentication. Clients
that present certificates found in the truststore under
<filename>openidm/security/</filename> are granted access to the system.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
The Jetty configuration (in <filename>openidm/conf/jetty.xml</filename>)
references the ports that are specified in the <filename>boot.properties</filename>
and <filename>config.properties</filename> files.
</para>
</appendix>