ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2025-01-21 03:55:00 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Docsite: minor fixes

Browse Source
This commit is contained in:
Mike Hearn 2016-11-29 11:36:42 +00:00
parent ac93eb3cd6
commit 3325985a49
5 changed files with 18 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/source/node-administration.rst
View File

@ -24,7 +24,7 @@ The JDBC URL is printed during node startup to the log and will typically look l
``jdbc:h2:tcp://192.168.0.31:31339/node``
The username and password can be altered in the :doc:`corda-configuration-files` but default to username "sa" and a blank
The username and password can be altered in the :doc:`corda-configuration-file` but default to username "sa" and a blank
password.
Any database browsing tool that supports JDBC can be used, but if you have IntelliJ Ultimate edition then there is

1
docs/source/node-explorer.rst
View File

@ -81,6 +81,7 @@ Network
Settings
User can configure the client preference in this view.
.. note:: Although the reporting currency is configurable, FX conversion won't be applied to the values as we don't have an FX service yet.

2
docs/source/permissioning.rst
View File

@ -2,7 +2,7 @@ Network permissioning
=====================
The keystore located in ``<workspace>/certificates/sslkeystore.jks`` is required to connect to the Corda network securely.
In development mode (when ``devMode = true``, see :doc:`corda-configuration-files` for more information) a pre-configured keystore will be used if the keystore does not exist.
In development mode (when ``devMode = true``, see :doc:`corda-configuration-file` for more information) a pre-configured keystore will be used if the keystore does not exist.
This is to ensure developers can get the nodes working as quickly as possible.
However this is not secure for the real network. This documentation will explain the procedure of obtaining a signed certificate for TestNet.

2
docs/source/running-a-notary.rst
View File

@ -11,7 +11,7 @@ At present we have several prototype notary implementations:
we are using the `Copycat <http://atomix.io/copycat/>`_ framework.
To have a node run a notary service, you need to set appropriate configuration values before starting it
(see :doc:`corda-configuration-files` for reference).
(see :doc:`corda-configuration-file` for reference).
For ``SimpleNotaryService``, simply add the following service id to the list of advertised services:

23
docs/source/setting-up-a-corda-network.rst
View File

@ -1,11 +1,13 @@
.. _log4j2: http://logging.apache.org/log4j/2.x/
Introduction - What is a corda network?
========================================================
=======================================
A Corda network consists of a number of machines running nodes, including a single node operating as the network map service. These nodes communicate using persistent protocols in order to create and validate transactions.
A Corda network consists of a number of machines running nodes, including a single node operating as the network map
service. These nodes communicate using persistent protocols in order to create and validate transactions.
There are four broader categories of functionality one such node may have. These pieces of functionality are provided as services, and one node may run several of them.
There are four broader categories of functionality one such node may have. These pieces of functionality are provided as
services, and one node may run several of them.
* Network map: The node running the network map provides a way to resolve identities to physical node addresses and associated public keys.
* Notary: Nodes running a notary service witness state spends and have the final say in whether a transaction is a double-spend or not.
@ -36,7 +38,7 @@ certificate with a fixed test root:
Configuration
-------------
A node can be configured by adding/editing ``node.conf`` in the node's directory. For details see :doc:`corda-configuration-files`
A node can be configured by adding/editing ``node.conf`` in the node's directory. For details see :doc:`corda-configuration-file`.
An example configuration:
@ -45,9 +47,12 @@ An example configuration:
The most important fields regarding network configuration are:
* ``artemisAddress``: This specifies a host and port. Note that the address bound will **NOT** be ``my-corda-node``, but rather ``::`` (all addresses on all interfaces). The hostname specified is the hostname *that must be externally resolvable by other nodes in the network*. In the above configuration this is the resolvable name of a machine in a vpn.
* ``artemisAddress``: This specifies a host and port. Note that the address bound will **NOT** be ``my-corda-node``,
but rather ``::`` (all addresses on all interfaces). The hostname specified is the hostname *that must be externally
resolvable by other nodes in the network*. In the above configuration this is the resolvable name of a machine in a vpn.
* ``webAddress``: The address the webserver should bind. Note that the port should be distinct from that of ``artemisAddress``.
* ``networkMapAddress``: The resolvable name and artemis port of the network map node. Note that if this node itself is to be the network map this field should not be specified.
* ``networkMapAddress``: The resolvable name and artemis port of the network map node. Note that if this node itself
is to be the network map this field should not be specified.
Starting the nodes
------------------
@ -56,8 +61,7 @@ You may now start the nodes in any order. Note that the node is not fully starte
You should see a banner, some log lines and eventually ``Node started up and registered``, indicating that the node is fully started.
.. TODO: Add a better way of polling for startup
A programmatic way of determining whether a node is up is to check whether it's ``webAddress`` is bound.
.. TODO: Add a better way of polling for startup. A programmatic way of determining whether a node is up is to check whether it's ``webAddress`` is bound.
In terms of process management there is no prescribed method. You may start the jars by hand or perhaps use systemd and friends.
@ -74,7 +78,8 @@ are by default redirected to files in ``NODE_DIRECTORY/logs/``.
Connecting to the nodes
-----------------------
Once a node has started up successfully you may connect to it as a client to initiate protocols/query state etc. Depending on your network setup you may need to tunnel to do this remotely.
Once a node has started up successfully you may connect to it as a client to initiate protocols/query state etc.
Depending on your network setup you may need to tunnel to do this remotely.
See the :doc:`tutorial-clientrpc-api` on how to establish an RPC link.