keycloak-scim/topics/network/ports.adoc
2016-12-16 11:11:03 -05:00

58 lines
3 KiB
Text
Executable file

[[_ports]]
=== Socket Port Bindings
The ports opened for each socket have a pre-defined default that can be overriden at the command line or within configuration.
To illustrate this configuration, let's pretend you are running in <<fake/../../operating-mode/standalone.adoc#_standalone-mode,standalone mode>> and
open up the _.../standalone/configuration/standalone.xml_. Search for `socket-binding-group`.
[source,xml]
----
<socket-binding-group name="standard-sockets" default-interface="public" port-offset="${jboss.socket.binding.port-offset:0}">
<socket-binding name="management-http" interface="management" port="${jboss.management.http.port:9990}"/>
<socket-binding name="management-https" interface="management" port="${jboss.management.https.port:9993}"/>
<socket-binding name="ajp" port="${jboss.ajp.port:8009}"/>
<socket-binding name="http" port="${jboss.http.port:8080}"/>
<socket-binding name="https" port="${jboss.https.port:8443}"/>
<socket-binding name="txn-recovery-environment" port="4712"/>
<socket-binding name="txn-status-manager" port="4713"/>
<outbound-socket-binding name="mail-smtp">
<remote-destination host="localhost" port="25"/>
</outbound-socket-binding>
</socket-binding-group>
----
`socket-bindings` define socket connections that will be opened by the server. These bindings specify the
`interface` (bind address) they use as well as what port number they will open. The ones you will be most interested in are:
http::
Defines the port used for {{book.project.name}} HTTP connections
https::
Defines the port used for {{book.project.name}} HTTPS connections
ajp::
This socket binding defines the port used for the AJP protocol. This protocol is used by Apache HTTPD server
in conjunction `mod-cluster` when you are using Apache HTTPD as a load balancer.
management-http::
Defines the HTTP connection used by {{book.appserver.name}} CLI and web console.
When running in <<fake/../../operating-mode/domain.adoc#_domain-mode,domain mode>> setting the socket configurations
is a bit trickier as the example _domain.xml_ file has multiple `socket-binding-groups` defined. If you scroll down
to the `server-group` definitions you can see what `socket-binding-group` is used for each `server-group`.
.domain socket bindings
[source,xml]
----
<server-groups>
<server-group name="load-balancer-group" profile="load-balancer">
...
<socket-binding-group ref="load-balancer-sockets"/>
</server-group>
<server-group name="auth-server-group" profile="auth-server-clustered">
...
<socket-binding-group ref="ha-sockets"/>
</server-group>
</server-groups>
----
NOTE: There are many more options available when setting up `socket-binding-group` definitions. For more information, see link:{{book.appserver.doc_base_url}}{{book.appserver.version}}{{book.appserver.socket_ref.link}}[{{book.appserver.socket_ref.name}}] in the _{{book.appserver.admindoc.name}}_.