mirror of
https://github.com/corda/corda.git
synced 2025-01-18 18:56:28 +00:00
Improves node.conf page. Shows the defaults used.
This commit is contained in:
Joel Dudley
GitHub
parent
0edfef2409
commit
7517270dde
@ -1,64 +1,47 @@
|
||||
Node configuration
|
||||
==================
|
||||
|
||||
.. contents::
|
||||
|
||||
File location
|
||||
-------------
|
||||
When starting a node, the ``corda.jar`` file defaults to reading the node's configuration from a ``node.conf`` file in
|
||||
the directory from which the command to launch Corda is executed. There are two command-line options to override this
|
||||
behaviour:
|
||||
|
||||
The Corda all-in-one ``corda.jar`` file is generated by the ``gradle buildCordaJAR`` task and defaults to reading configuration
|
||||
from a ``node.conf`` file in the present working directory. This behaviour can be overidden using the ``--config-file``
|
||||
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 ``--base-directory`` command line option alters the Corda node
|
||||
workspace location and if specified a ``node.conf`` configuration file is then expected in the root of the workspace.
|
||||
* The ``--config-file`` command line option allows you to specify a configuration file with a different name, or at
|
||||
different file location. Paths are relative to the current working directory
|
||||
|
||||
The configuration file templates used for the ``gradle deployNodes`` task are to be found in the ``/config/dev`` folder.
|
||||
Also note that there is a basic set of defaults loaded from the built in resource file ``/node/src/main/resources/reference.conf``
|
||||
of the ``:node`` 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.
|
||||
* The ``--base-directory`` command line option allows you to specify the node's workspace location. A ``node.conf``
|
||||
configuration file is then expected in the root of this workspace
|
||||
|
||||
If you specify both command line arguments at the same time, the node will fail to start.
|
||||
|
||||
Format
|
||||
------
|
||||
The Corda configuration file uses the HOCON format which is superset of JSON. Please visit
|
||||
`<https://github.com/typesafehub/config/blob/master/HOCON.md>`_ for further details.
|
||||
|
||||
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 `page <https://github.com/typesafehub/config/blob/master/HOCON.md>`_
|
||||
for further details.
|
||||
|
||||
Examples
|
||||
Defaults
|
||||
--------
|
||||
A set of default configuration options are loaded from the built-in resource file ``/node/src/main/resources/reference.conf``.
|
||||
This file can be found in the ``:node`` gradle module of the `Corda repository <https://github.com/corda/corda>`_. Any
|
||||
options you do not specify in your own ``node.conf`` file will use these defaults.
|
||||
|
||||
General node configuration file for hosting the IRSDemo services.
|
||||
Here are the contents of the ``reference.conf`` file:
|
||||
|
||||
.. literalinclude:: example-code/src/main/resources/example-node.conf
|
||||
.. literalinclude:: ../../node/src/main/resources/reference.conf
|
||||
:language: javascript
|
||||
|
||||
Simple Notary configuration file.
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
myLegalName : "O=Notary Service,OU=corda,L=London,C=GB"
|
||||
keyStorePassword : "cordacadevpass"
|
||||
trustStorePassword : "trustpass"
|
||||
p2pAddress : "localhost:12345"
|
||||
rpcSettings = {
|
||||
useSsl = false
|
||||
standAloneBroker = false
|
||||
address : "my-corda-node:10003"
|
||||
adminAddress : "my-corda-node:10004"
|
||||
}
|
||||
webAddress : "localhost:12347"
|
||||
notary : {
|
||||
validating : false
|
||||
}
|
||||
devMode : true
|
||||
compatibilityZoneURL : "https://cz.corda.net"
|
||||
|
||||
Fields
|
||||
------
|
||||
The available config fields are listed below. ``baseDirectory`` is available as a substitution value and contains the
|
||||
absolute path to the node's base directory.
|
||||
|
||||
The available config fields are listed below. ``baseDirectory`` is available as a substitution value, containing the absolute
|
||||
path to the node's base directory.
|
||||
|
||||
:myLegalName: 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.
|
||||
:myLegalName: The legal identity of the node. This acts as a human-readable alias to the node's public key and can be used with
|
||||
the network map to look up the node's info. This is the name that is used in the node's certificates (either when requesting them
|
||||
from the doorman, or when auto-generating them in dev mode). At runtime, Corda checks whether this name matches the
|
||||
name in the node's certificates.
|
||||
|
||||
:keyStorePassword: The password to unlock the KeyStore file (``<workspace>/certificates/sslkeystore.jks``) containing the
|
||||
node certificate and private key.
|
||||
@ -195,4 +178,33 @@ path to the node's base directory.
|
||||
Otherwise defaults to 10MB
|
||||
|
||||
:attachmentCacheBound: Optionally specify how many attachments should be cached locally. Note that this includes only the key and
|
||||
metadata, the content is cached separately and can be loaded lazily. Defaults to 1024.
|
||||
metadata, the content is cached separately and can be loaded lazily. Defaults to 1024.
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
General node configuration file for hosting the IRSDemo services:
|
||||
|
||||
.. literalinclude:: example-code/src/main/resources/example-node.conf
|
||||
:language: javascript
|
||||
|
||||
Simple notary configuration file:
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
myLegalName : "O=Notary Service,OU=corda,L=London,C=GB"
|
||||
keyStorePassword : "cordacadevpass"
|
||||
trustStorePassword : "trustpass"
|
||||
p2pAddress : "localhost:12345"
|
||||
rpcSettings = {
|
||||
useSsl = false
|
||||
standAloneBroker = false
|
||||
address : "my-corda-node:10003"
|
||||
adminAddress : "my-corda-node:10004"
|
||||
}
|
||||
webAddress : "localhost:12347"
|
||||
notary : {
|
||||
validating : false
|
||||
}
|
||||
devMode : true
|
||||
compatibilityZoneURL : "https://cz.corda.net"
|
||||
@ -1,16 +1,14 @@
|
||||
Node database
|
||||
=============
|
||||
|
||||
Currently, nodes store their data in an H2 database. In the future, we plan to support a wide range of databases.
|
||||
|
||||
You can connect directly to a running node's database to see its stored states, transactions and attachments as
|
||||
follows:
|
||||
Default in-memory database
|
||||
--------------------------
|
||||
By default, nodes store their data in an H2 database. You can connect directly to a running node's database to see its
|
||||
stored states, transactions and attachments as follows:
|
||||
|
||||
* Download the `h2 platform-independent zip <http://www.h2database.com/html/download.html>`_, unzip the zip, and
|
||||
navigate in a terminal window to the unzipped folder
|
||||
* Change directories to the bin folder:
|
||||
|
||||
``cd h2/bin``
|
||||
* Change directories to the bin folder: ``cd h2/bin``
|
||||
|
||||
* Run the following command to open the h2 web console in a web browser tab:
|
||||
|
||||
@ -25,4 +23,34 @@ follows:
|
||||
* Paste this string into the JDBC URL field and click ``Connect``, using the default username and password.
|
||||
|
||||
You will be presented with a web interface that shows the contents of your node's storage and vault, and provides an
|
||||
interface for you to query them using SQL.
|
||||
interface for you to query them using SQL.
|
||||
|
||||
PostgreSQL
|
||||
----------
|
||||
Nodes also have untested support for PostgreSQL 9.6, using PostgreSQL JDBC Driver 42.1.4.
|
||||
|
||||
.. warning:: This is an experimental community contribution, and is currently untested. We welcome pull requests to add
|
||||
tests and additional support for this feature.
|
||||
|
||||
Configuration
|
||||
~~~~~~~~~~~~~
|
||||
Here is an example node configuration for PostgreSQL:
|
||||
|
||||
.. sourcecode:: groovy
|
||||
|
||||
dataSourceProperties = {
|
||||
dataSourceClassName = "org.postgresql.ds.PGSimpleDataSource"
|
||||
dataSource.url = "jdbc:postgresql://[HOST]:[PORT]/postgres"
|
||||
dataSource.user = [USER]
|
||||
dataSource.password = [PASSWORD]
|
||||
}
|
||||
database = {
|
||||
transactionIsolationLevel = READ_COMMITTED
|
||||
schema = [SCHEMA]
|
||||
}
|
||||
|
||||
Note that:
|
||||
|
||||
* The ``database.schema`` property is optional
|
||||
* The value of ``database.schema`` is not wrapped in double quotes and Postgres always treats it as a lower-case value
|
||||
(e.g. ``AliceCorp`` becomes ``alicecorp``)
|
||||
Loading…
Reference in New Issue
Block a user