blob: 374c44d8985a43e83b6a23c96127a94fe3e01eb6 [file] [log] [blame]
<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">5.6.&#160;Customising Configuration using Configuration Properties</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Initial-Configuration-Type.html">Prev</a>&#160;</td><th align="center" width="60%">Chapter&#160;5.&#160;Initial Configuration</th><td align="right" width="20%">&#160;<a accesskey="n" href="Java-Broker-Initial-Configuration-Example.html">Next</a></td></tr></table><hr /></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Java-Broker-Initial-Configuration-Configuration-Properties"></a>5.6.&#160;Customising Configuration using Configuration Properties</h2></div></div></div><p> It is possible for 'Initial Configuration' (and Configuration Store) files to contain
${properties} that can be resolved to String values at startup, allowing a degree of
customisation using a fixed file. Configuration Property values can be set either via
Java System Properties, or by specifying ConfigurationProperties on the broker command
line. If both are defined, System Property values take precedence. </p><p> The broker has the following set of core configuration properties, with the indicated
default values if not otherwise configured by the user: </p><div class="table"><a id="d0e1613"></a><p class="title"><strong>Table&#160;5.1.&#160;Base Configuration Properties</strong></p><div class="table-contents"><table border="1" summary="Base Configuration Properties"><colgroup><col /><col /><col /></colgroup><thead><tr><th> Name </th><th> Description </th><th> Value </th></tr></thead><tbody><tr><td> qpid.amqp_port </td><td> Port number used for the brokers default AMQP messaging port </td><td> "5672" </td></tr><tr><td> qpid.http_port </td><td> Port number used for the brokers default HTTP management port </td><td> "8080" </td></tr><tr><td> qpid.home_dir </td><td> Location of the broker installation directory, which contains
the 'lib' directory and the 'etc' directory often used to store
files such as group and ACL files. </td><td> Defaults to the value set into the QPID_HOME system property if
it is set, or remains unset otherwise unless configured by the user.
</td></tr><tr><td> qpid.work_dir </td><td> Location of the broker working directory, which might contain
the persistent message store and broker configuration store files. </td><td> Defaults to the value set into the QPID_WORK system property if
it is set, or the 'work' subdirectory of the JVMs current working
directory. </td></tr></tbody></table></div></div><p><br class="table-break" />
</p><p> Use of these core properties can be seen in the <a class="link" href="Java-Broker-Initial-Configuration-Example.html" title="5.7.&#160;Example of JSON 'Initial Configuration'">default 'Initial Configuration' example</a>. </p><p> Configuration Properties can be set on the command line using the
<span class="emphasis"><em>-prop</em></span> (or <span class="emphasis"><em>--configuration-property</em></span>)
command line argument: </p><pre class="screen">
$ ./qpid-server -prop "qpid.amqp_port=10000" -prop "qpid.http_port=10001"
</pre><p> In the example above, property used to set the port number of the default AMQP port
is specified with the value 10000, overriding the default value of 5672, and similarly
the value 10001 is used to override the default HTTP port number of 8080. When using the
'Initial Configuration' to initialise a new Configuration Store at first broker
startup these new values will be used for the port numbers instead. </p><p> NOTE: When running the broker on Windows and starting it via the qpid-server.bat
file, the "name=value" argument MUST be quoted. </p></div><div class="navfooter"><hr /><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="Java-Broker-Initial-Configuration-Type.html">Prev</a>&#160;</td><td align="center" width="20%"><a accesskey="u" href="Java-Broker-Initial-Configuration.html">Up</a></td><td align="right" width="40%">&#160;<a accesskey="n" href="Java-Broker-Initial-Configuration-Example.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">5.5.&#160;Configuration Store Type&#160;</td><td align="center" width="20%"><a accesskey="h" href="Apache-Qpid-Broker-J-Book.html">Home</a></td><td align="right" valign="top" width="40%">&#160;5.7.&#160;Example of JSON 'Initial Configuration'</td></tr></table></div></div>