mirror of
https://github.com/corda/corda.git
synced 2024-12-22 22:32:26 +00:00
496 lines
28 KiB
HTML
496 lines
28 KiB
HTML
<!-- If you edit this, then please make the same changes to layout_for_doc_website.html, as that is used for the web
|
|
doc site generation which we put analytics tracking on to identify any potential problem pages -->
|
|
|
|
|
|
|
|
|
|
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<title>Node configuration — R3 Corda latest documentation</title>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
|
<link rel="next" title="The Corda plugin framework" href="corda-plugins.html"/>
|
|
<link rel="prev" title="Node administration" href="node-administration.html"/>
|
|
|
|
|
|
<script src="_static/js/modernizr.min.js"></script>
|
|
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search">
|
|
|
|
|
|
|
|
|
|
<a href="index.html" class="icon icon-home"> R3 Corda
|
|
|
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
<div class="version">
|
|
latest
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div role="search">
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
|
|
|
|
<br>
|
|
API reference: <a href="api/kotlin/corda/index.html">Kotlin</a>/ <a href="api/javadoc/index.html">JavaDoc</a>
|
|
<br>
|
|
<a href="https://discourse.corda.net">Discourse Forums</a>
|
|
<br>
|
|
<a href="http://slack.corda.net">Slack</a>
|
|
<br>
|
|
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
|
|
|
|
|
|
<p class="caption"><span class="caption-text">Getting started</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="inthebox.html">What’s included?</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="getting-set-up.html">Getting set up</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="getting-set-up-fault-finding.html">Troubleshooting</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="running-the-demos.html">Running the demos</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="CLI-vs-IDE.html">CLI vs IDE</a></li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Key concepts</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="data-model.html">Data model</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="transaction-data-types.html">Data types</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="merkle-trees.html">Transaction tear-offs</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="consensus.html">Consensus model</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="clauses.html">Clauses</a></li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">CorDapps</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="creating-a-cordapp.html">CorDapp basics</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="tutorial-cordapp.html">The CorDapp template</a></li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">The Corda node</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="clientrpc.html">Client RPC</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="messaging.html">Networking and messaging</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="persistence.html">Persistence</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="node-administration.html">Node administration</a></li>
|
|
<li class="toctree-l1 current"><a class="current reference internal" href="#">Node configuration</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="#file-location">File location</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#format">Format</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#examples">Examples</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#fields">Fields</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="corda-plugins.html">The Corda plugin framework</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="node-services.html">Brief introduction to the node services</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="node-explorer.html">Node Explorer</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="permissioning.html">Network permissioning</a></li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Tutorials</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="tutorial-contract.html">Writing a contract</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="tutorial-contract-clauses.html">Writing a contract using clauses</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="tutorial-test-dsl.html">Writing a contract test</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="tutorial-integration-testing.html">Integration testing</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="tutorial-clientrpc-api.html">Client RPC API tutorial</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="tutorial-building-transactions.html">Building transactions</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="flow-state-machines.html">Writing flows</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="flow-testing.html">Writing flow tests</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="running-a-notary.html">Running a notary service</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="using-a-notary.html">Using a notary service</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="oracles.html">Writing oracle services</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="tutorial-attachments.html">Using attachments</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="event-scheduling.html">Event scheduling</a></li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Other</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="network-simulator.html">Network Simulator</a></li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Component library</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="contract-catalogue.html">Contract catalogue</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="contract-irs.html">Interest rate swaps</a></li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Appendix</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="loadtesting.html">Load testing</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="setting-up-a-corda-network.html">What is a corda network?</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="secure-coding-guidelines.html">Secure coding guidelines</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="release-process.html">Release process</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="release-notes.html">Release notes</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="codestyle.html">Code style guide</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="building-the-docs.html">Building the documentation</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="publishing-corda.html">Publishing Corda</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="azure-vm.html">Working with the Corda Demo on Azure Marketplace</a></li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Glossary</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="index.html">R3 Corda</a>
|
|
</nav>
|
|
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="index.html">Docs</a> »</li>
|
|
|
|
<li>Node configuration</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="_sources/corda-configuration-file.txt" rel="nofollow"> View page source</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
<div class="section" id="node-configuration">
|
|
<h1>Node configuration<a class="headerlink" href="#node-configuration" title="Permalink to this headline">¶</a></h1>
|
|
<div class="section" id="file-location">
|
|
<h2>File location<a class="headerlink" href="#file-location" title="Permalink to this headline">¶</a></h2>
|
|
<p>The Corda all-in-one <code class="docutils literal"><span class="pre">corda.jar</span></code> file is generated by the <code class="docutils literal"><span class="pre">gradle</span> <span class="pre">buildCordaJAR</span></code> task and defaults to reading configuration
|
|
from a <code class="docutils literal"><span class="pre">node.conf</span></code> file in the present working directory. This behaviour can be overidden using the <code class="docutils literal"><span class="pre">--config-file</span></code>
|
|
command line option to target configuration files with different names, or different file location (relative paths are
|
|
relative to the current working directory). Also, the <code class="docutils literal"><span class="pre">--base-directory</span></code> command line option alters the Corda node
|
|
workspace location and if specified a <code class="docutils literal"><span class="pre">node.conf</span></code> configuration file is then expected in the root of the workspace.</p>
|
|
<p>The configuration file templates used for the <code class="docutils literal"><span class="pre">gradle</span> <span class="pre">deployNodes</span></code> task are to be found in the <code class="docutils literal"><span class="pre">/config/dev</span></code> folder.
|
|
Also note that there is a basic set of defaults loaded from the built in resource file <code class="docutils literal"><span class="pre">/node/src/main/resources/reference.conf</span></code>
|
|
of the <code class="docutils literal"><span class="pre">:node</span></code> gradle module. All properties in this can be overidden in the file configuration and for rarely changed
|
|
properties this defaulting allows the property to be excluded from the configuration file.</p>
|
|
</div>
|
|
<div class="section" id="format">
|
|
<h2>Format<a class="headerlink" href="#format" title="Permalink to this headline">¶</a></h2>
|
|
<p>The Corda configuration file uses the HOCON format which is superset of JSON. It has several features which makes it
|
|
very useful as a configuration format. Please visit their <a class="reference external" href="https://github.com/typesafehub/config/blob/master/HOCON.md">page</a>
|
|
for further details.</p>
|
|
</div>
|
|
<div class="section" id="examples">
|
|
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
|
|
<p>General node configuration file for hosting the IRSDemo services.</p>
|
|
<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="nx">myLegalName</span> <span class="o">:</span> <span class="s2">"Bank A"</span>
|
|
<span class="nx">nearestCity</span> <span class="o">:</span> <span class="s2">"London"</span>
|
|
<span class="nx">keyStorePassword</span> <span class="o">:</span> <span class="s2">"cordacadevpass"</span>
|
|
<span class="nx">trustStorePassword</span> <span class="o">:</span> <span class="s2">"trustpass"</span>
|
|
<span class="nx">dataSourceProperties</span> <span class="o">:</span> <span class="p">{</span>
|
|
<span class="nx">dataSourceClassName</span> <span class="o">:</span> <span class="nx">org</span><span class="p">.</span><span class="nx">h2</span><span class="p">.</span><span class="nx">jdbcx</span><span class="p">.</span><span class="nx">JdbcDataSource</span>
|
|
<span class="s2">"dataSource.url"</span> <span class="o">:</span> <span class="s2">"jdbc:h2:file:"</span><span class="nx">$</span><span class="p">{</span><span class="nx">basedir</span><span class="p">}</span><span class="s2">"/persistence"</span>
|
|
<span class="s2">"dataSource.user"</span> <span class="o">:</span> <span class="nx">sa</span>
|
|
<span class="s2">"dataSource.password"</span> <span class="o">:</span> <span class="s2">""</span>
|
|
<span class="p">}</span>
|
|
<span class="nx">artemisAddress</span> <span class="o">:</span> <span class="s2">"my-corda-node:10002"</span>
|
|
<span class="nx">webAddress</span> <span class="o">:</span> <span class="s2">"localhost:10003"</span>
|
|
<span class="nx">extraAdvertisedServiceIds</span><span class="o">:</span> <span class="s2">"corda.interest_rates"</span>
|
|
<span class="nx">networkMapService</span> <span class="o">:</span> <span class="p">{</span>
|
|
<span class="nx">address</span> <span class="o">:</span> <span class="s2">"my-network-map:10000"</span>
|
|
<span class="nx">legalName</span> <span class="o">:</span> <span class="s2">"Network Map Service"</span>
|
|
<span class="p">}</span>
|
|
<span class="nx">useHTTPS</span> <span class="o">:</span> <span class="kc">false</span>
|
|
<span class="nx">rpcUsers</span> <span class="o">:</span> <span class="p">[</span>
|
|
<span class="p">{</span> <span class="nx">user</span><span class="o">=</span><span class="nx">user1</span><span class="p">,</span> <span class="nx">password</span><span class="o">=</span><span class="nx">letmein</span><span class="p">,</span> <span class="nx">permissions</span><span class="o">=</span><span class="p">[</span> <span class="nx">StartProtocol</span><span class="p">.</span><span class="nx">net</span><span class="p">.</span><span class="nx">corda</span><span class="p">.</span><span class="nx">protocols</span><span class="p">.</span><span class="nx">CashProtocol</span> <span class="p">]</span> <span class="p">}</span>
|
|
<span class="p">]</span>
|
|
<span class="nx">devMode</span> <span class="o">:</span> <span class="kc">true</span>
|
|
<span class="c1">// Certificate signing service will be hosted by R3 in the near future.</span>
|
|
<span class="c1">//certificateSigningService : "https://testnet.certificate.corda.net"</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>NetworkMapService plus Simple Notary configuration file.</p>
|
|
<div class="highlight-kotlin"><div class="highlight"><pre><span></span><span class="n">myLegalName</span> <span class="p">:</span> <span class="s">"Notary Service"</span>
|
|
<span class="n">nearestCity</span> <span class="p">:</span> <span class="s">"London"</span>
|
|
<span class="n">keyStorePassword</span> <span class="p">:</span> <span class="s">"cordacadevpass"</span>
|
|
<span class="n">trustStorePassword</span> <span class="p">:</span> <span class="s">"trustpass"</span>
|
|
<span class="n">artemisAddress</span> <span class="p">:</span> <span class="s">"localhost:12345"</span>
|
|
<span class="n">webAddress</span> <span class="p">:</span> <span class="s">"localhost:12346"</span>
|
|
<span class="n">extraAdvertisedServiceIds</span><span class="p">:</span> <span class="s">""</span>
|
|
<span class="n">useHTTPS</span> <span class="p">:</span> <span class="k">false</span>
|
|
<span class="n">devMode</span> <span class="p">:</span> <span class="k">true</span>
|
|
<span class="c1">// Certificate signing service will be hosted by R3 in the near future.</span>
|
|
<span class="c1">//certificateSigningService : "https://testnet.certificate.corda.net"</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="fields">
|
|
<h2>Fields<a class="headerlink" href="#fields" title="Permalink to this headline">¶</a></h2>
|
|
<p>The available config fields are listed below. <code class="docutils literal"><span class="pre">basedir</span></code> is available as a substitution value, containing the absolute
|
|
path to the node’s base directory.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field-odd field"><th class="field-name">myLegalName:</th><td class="field-body"><p class="first">The legal identity of the node acts as a human readable alias to the node’s public key and several demos use
|
|
this to lookup the NodeInfo.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">nearestCity:</th><td class="field-body"><p class="first">The location of the node as used to locate coordinates on the world map when running the network simulator
|
|
demo. See <a class="reference internal" href="network-simulator.html"><span class="doc">Network Simulator</span></a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name" colspan="2">keyStorePassword:</th></tr>
|
|
<tr class="field-odd field"><td> </td><td class="field-body"><p class="first">The password to unlock the KeyStore file (<code class="docutils literal"><span class="pre"><workspace>/certificates/sslkeystore.jks</span></code>) containing the
|
|
node certificate and private key.</p>
|
|
<div class="admonition note">
|
|
<p class="first admonition-title">Note</p>
|
|
<p class="last">This is the non-secret value for the development certificates automatically generated during the first node run.
|
|
Longer term these keys will be managed in secure hardware devices.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name" colspan="2">trustStorePassword:</th></tr>
|
|
<tr class="field-even field"><td> </td><td class="field-body"><p class="first">The password to unlock the Trust store file (<code class="docutils literal"><span class="pre"><workspace>/certificates/truststore.jks</span></code>) containing
|
|
the Corda network root certificate. This is the non-secret value for the development certificates automatically
|
|
generated during the first node run.</p>
|
|
<div class="admonition note">
|
|
<p class="first admonition-title">Note</p>
|
|
<p class="last">Longer term these keys will be managed in secure hardware devices.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name" colspan="2">dataSourceProperties:</th></tr>
|
|
<tr class="field-odd field"><td> </td><td class="field-body"><p class="first">This section is used to configure the jdbc connection and database driver used for the nodes persistence.
|
|
Currently the defaults in <code class="docutils literal"><span class="pre">/node/src/main/resources/reference.conf</span></code> are as shown in the first example. This is currently
|
|
the only configuration that has been tested, although in the future full support for other storage layers will be validated.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">artemisAddress:</th><td class="field-body"><p class="first">The host and port on which the node is available for protocol operations over ArtemisMQ.</p>
|
|
<div class="admonition note">
|
|
<p class="first admonition-title">Note</p>
|
|
<p class="last">In practice the ArtemisMQ messaging services bind to all local addresses on the specified port. However,
|
|
note that the host is the included as the advertised entry in the NetworkMapService. As a result the value listed
|
|
here must be externally accessible when running nodes across a cluster of machines.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name" colspan="2">messagingServerAddress:</th></tr>
|
|
<tr class="field-odd field"><td> </td><td class="field-body"><p class="first">The address of the ArtemisMQ broker instance. If not provided the node will run one locally.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">webAddress:</th><td class="field-body"><p class="first">The host and port on which the node is available for web operations.</p>
|
|
<div class="admonition note">
|
|
<p class="first admonition-title">Note</p>
|
|
<p class="last">If HTTPS is enabled then the browser security checks will require that the accessing url host name is one
|
|
of either the machine name, fully qualified machine name, or server IP address to line up with the Subject Alternative
|
|
Names contained within the development certificates. This is addition to requiring the <code class="docutils literal"><span class="pre">/config/dev/corda_dev_ca.cer</span></code>
|
|
root certificate be installed as a Trusted CA.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name" colspan="2">extraAdvertisedServiceIds:</th></tr>
|
|
<tr class="field-odd field"><td> </td><td class="field-body"><p class="first">A list of ServiceType id strings to be advertised to the NetworkMapService and thus be available
|
|
when other nodes query the NetworkMapCache for supporting nodes. This can also include plugin services loaded from .jar
|
|
files in the plugins folder. Optionally, a custom advertised service name can be provided by appending it to the service
|
|
type id: <code class="docutils literal"><span class="pre">"corda.notary.validating|Notary</span> <span class="pre">A"</span></code></p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name" colspan="2">notaryNodeAddress:</th></tr>
|
|
<tr class="field-even field"><td> </td><td class="field-body"><p class="first">The host and port to which to bind the embedded Raft server. Required only when running a distributed
|
|
notary service. A group of Corda nodes can run a distributed notary service by each running an embedded Raft server and
|
|
joining them to the same cluster to replicate the committed state log. Note that the Raft cluster uses a separate transport</p>
|
|
<blockquote>
|
|
<div><p>layer for communication that does not integrate with ArtemisMQ messaging services.</p>
|
|
</div></blockquote>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name" colspan="2">notaryClusterAddresses:</th></tr>
|
|
<tr class="field-odd field"><td> </td><td class="field-body"><p class="first">List of Raft cluster member addresses used to join the cluster. At least one of the specified
|
|
members must be active and be able to communicate with the cluster leader for joining. If empty, a new cluster will be
|
|
bootstrapped. Required only when running a distributed notary service.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name" colspan="2">networkMapService:</th></tr>
|
|
<tr class="field-even field"><td> </td><td class="field-body"><p class="first">If <cite>null</cite>, or missing the node is declaring itself as the NetworkMapService host. Otherwise this is
|
|
a config object with the details of the network map service:</p>
|
|
<blockquote>
|
|
<div><table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field-odd field"><th class="field-name">address:</th><td class="field-body">Host and port string of the ArtemisMQ broker hosting the network map node</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">legalName:</th><td class="field-body">Legal name of the node. This is required as part of the TLS host verification process. The node will
|
|
reject the connection to the network map service if it provides a TLS common name which doesn’t match with this value.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div></blockquote>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">useHTTPS:</th><td class="field-body"><p class="first">If false the node’s web server will be plain HTTP. If true the node will use the same certificate and private
|
|
key from the <code class="docutils literal"><span class="pre"><workspace>/certificates/sslkeystore.jks</span></code> file as the ArtemisMQ port for HTTPS. If HTTPS is enabled
|
|
then unencrypted HTTP traffic to the node’s <strong>webAddress</strong> port is not supported.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">rpcUsers:</th><td class="field-body"><p class="first">A list of users who are authorised to access the RPC system. Each user in the list is a config object with the
|
|
following fields:</p>
|
|
<blockquote>
|
|
<div><table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field-odd field"><th class="field-name">user:</th><td class="field-body">Username consisting only of word characters (a-z, A-Z, 0-9 and _)</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">password:</th><td class="field-body">The password</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">permissions:</th><td class="field-body">A list of permission strings which RPC methods can use to control access</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div></blockquote>
|
|
<p>If this field is absent or an empty list then RPC is effectively locked down.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">devMode:</th><td class="field-body"><p class="first">This flag indicate if the node is running in development mode. On startup, if the keystore <code class="docutils literal"><span class="pre"><workspace>/certificates/sslkeystore.jks</span></code>
|
|
does not exist, a developer keystore will be used if <code class="docutils literal"><span class="pre">devMode</span></code> is true. The node will exit if <code class="docutils literal"><span class="pre">devMode</span></code> is false
|
|
and keystore does not exist.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name" colspan="2">certificateSigningService:</th></tr>
|
|
<tr class="field-odd field"><td> </td><td class="field-body"><p class="first last">Certificate Signing Server address. It is used by the certificate signing request utility to
|
|
obtain SSL certificate. (See <a class="reference internal" href="permissioning.html"><span class="doc">Network permissioning</span></a> for more information.)</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="corda-plugins.html" class="btn btn-neutral float-right" title="The Corda plugin framework" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
|
|
|
|
|
|
<a href="node-administration.html" class="btn btn-neutral" title="Node administration" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
|
|
|
</div>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>
|
|
© Copyright 2016, R3 Limited.
|
|
|
|
</p>
|
|
</div>
|
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
var DOCUMENTATION_OPTIONS = {
|
|
URL_ROOT:'./',
|
|
VERSION:'latest',
|
|
COLLAPSE_INDEX:false,
|
|
FILE_SUFFIX:'.html',
|
|
HAS_SOURCE: true
|
|
};
|
|
</script>
|
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
jQuery(function () {
|
|
SphinxRtdTheme.StickyNav.enable();
|
|
});
|
|
</script>
|
|
|
|
|
|
</body>
|
|
</html> |