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

Minor: fix some minor indent/formatting issues in the docs

Browse Source
This commit is contained in:
Mike Hearn 2016-09-23 11:55:40 +02:00
parent 9551b0c7e5
commit 3f9fc2db85
2 changed files with 42 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/source/corda-configuration-files.rst
View File

@ -19,7 +19,7 @@ Corda uses the Typesafe configuration library to parse the configuration see the
uses HOCON format see `HOCON documents <https://github.com/typesafehub/config/blob/master/HOCON.md>`_ uses HOCON format see `HOCON documents <https://github.com/typesafehub/config/blob/master/HOCON.md>`_
Configuration File Examples Configuration File Examples
-------------------------- ---------------------------
General node configuration file for hosting the IRSDemo services. General node configuration file for hosting the IRSDemo services.
@ -59,13 +59,13 @@ NetworkMapService plus Simple Notary configuration file.
useHTTPS : false useHTTPS : false
Configuration File Fields Configuration File Fields
-------------------------- -------------------------
:basedir: This specifies the node workspace folder either as an absolute path, or relative to the current working directory. It can be overidden by the ``--base-directory`` command line option, in which case the the value in the file is ignored and a ``node.conf`` file is expected in that workspace directory as the configuration source. :basedir: This specifies the node workspace folder either as an absolute path, or relative to the current working directory. It can be overidden by the ``--base-directory`` command line option, in which case the the value in the file is ignored and a ``node.conf`` file is expected in that workspace directory as the configuration source.
: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 acts as a human readable alias to the node's public key and several demos use this to lookup the NodeInfo.
:nearestCity: The location of the node as used to locate coordinates on the world map when running the network visualiser demo. See :doc:`visualiser`. :nearestCity: The location of the node as used to locate coordinates on the world map when running the network simulator demo. See :doc:`network-simulator`.
:keyStorePassword: :keyStorePassword:
The password to unlock the KeyStore file (``<workspace>/certificates/sslkeystore.jks``) containing the node certificate and private key. The password to unlock the KeyStore file (``<workspace>/certificates/sslkeystore.jks``) containing the node certificate and private key.

8
docs/source/creating-a-cordapp.rst
View File

@ -13,15 +13,13 @@ To create an app plugin you must you must extend from `CordaPluginRegistry`_. Th
specific details of the implementation, but you can extend the server in the following ways: specific details of the implementation, but you can extend the server in the following ways:
1. Required protocols: Specify which protocols will be whitelisted for use in your web APIs. 1. Required protocols: Specify which protocols will be whitelisted for use in your web APIs.
2. Service plugins: Register your :ref:`services`. 2. Service plugins: Register your services (see below).
3. Web APIs: You may register your own endpoints under /api/ of the built-in web server. 3. Web APIs: You may register your own endpoints under /api/ of the built-in web server.
4. Static web endpoints: You may register your own static serving directories for serving web content. 4. Static web endpoints: You may register your own static serving directories for serving web content.
Services Services
-------- --------
.. _services:
Services are classes which are constructed after the node has started. It is provided a `ServiceHubInternal`_ which Services are classes which are constructed after the node has started. It is provided a `ServiceHubInternal`_ which
allows a richer API than the `ServiceHub`_ exposed to contracts. It enables adding protocols, registering allows a richer API than the `ServiceHub`_ exposed to contracts. It enables adding protocols, registering
message handlers and more. The service does not run in a separate thread, so the only entry point to the service is during message handlers and more. The service does not run in a separate thread, so the only entry point to the service is during
@ -44,7 +42,7 @@ execution of the node server there will be many other configuration and persiste
.. warning:: Also note that the bootstrapping process of the ``corda.jar`` unpacks the Corda dependencies into a temporary folder. It is therefore suggested that the CAPSULE_CACHE_DIR environment variable be set before starting the process to control this location. .. warning:: Also note that the bootstrapping process of the ``corda.jar`` unpacks the Corda dependencies into a temporary folder. It is therefore suggested that the CAPSULE_CACHE_DIR environment variable be set before starting the process to control this location.
Installing Apps Installing Apps
------------------ ---------------
Once you have created your app JAR you can install it to a node by adding it to ``<node_dir>/plugins/``. In this Once you have created your app JAR you can install it to a node by adding it to ``<node_dir>/plugins/``. In this
case the ``node_dir`` is the location where your node server's JAR and configuration file is. case the ``node_dir`` is the location where your node server's JAR and configuration file is.
@ -69,7 +67,7 @@ The configuration file and workspace paths can be overidden on the command line
Otherwise the workspace folder for the node is created based upon the ``basedir`` property in the ``node.conf`` file and if this is relative it is applied relative to the current working path. Otherwise the workspace folder for the node is created based upon the ``basedir`` property in the ``node.conf`` file and if this is relative it is applied relative to the current working path.
Debugging your Node Debugging your Node
------------------ -------------------
To enable remote debugging of the corda process use a command line such as: To enable remote debugging of the corda process use a command line such as: