ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2025-06-13 20:58:19 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Minor tweaks to the configuration docs: make the use of : and = consistent, rename titles

Browse Source
This commit is contained in:
Andrius Dagys
2016-11-28 18:00:03 +00:00
parent 570470f255
commit eec079ed62
2 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/source/corda-configuration-file.rst
View File

@ -1,8 +1,8 @@
The Corda configuration file Node configuration
============================ ==================
Location File location
-------- -------------
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. 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). 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).
@ -24,11 +24,11 @@ Examples
General node configuration file for hosting the IRSDemo services. General node configuration file for hosting the IRSDemo services.
.. literalinclude:: example-code/src/main/resources/example-node.conf .. literalinclude:: example-code/src/main/resources/example-node.conf
:language: cfg :language: javascript
NetworkMapService plus Simple Notary configuration file. NetworkMapService plus Simple Notary configuration file.
.. code-block:: text .. parsed-literal::
basedir : "./nameserver" basedir : "./nameserver"
myLegalName : "Notary Service" myLegalName : "Notary Service"
@ -39,9 +39,9 @@ NetworkMapService plus Simple Notary configuration file.
webAddress : "localhost:12346" webAddress : "localhost:12346"
extraAdvertisedServiceIds: "" extraAdvertisedServiceIds: ""
useHTTPS : false useHTTPS : false
devMode = true devMode : true
// Certificate signing service will be hosted by R3 in the near future. // Certificate signing service will be hosted by R3 in the near future.
//certificateSigningService = "https://testnet.certificate.corda.net" //certificateSigningService : "https://testnet.certificate.corda.net"
Fields Fields
------ ------
@ -97,9 +97,9 @@ Fields
:permissions: A list of permission strings which RPC methods can use to control access :permissions: A list of permission strings which RPC methods can use to control access
If this field is absent or an empty list then RPC is effectively locked down. If this field is absent or an empty list then RPC is effectively locked down.
:devMode: :devMode:
This flag indicate if the node is running in development mode. On startup, if the keystore ``<workspace>/certificates/sslkeystore.jks`` does not exist, a developer keystore will be used if ``devMode`` is true. The node will exit if ``devMode`` is false and keystore does not exist. This flag indicate if the node is running in development mode. On startup, if the keystore ``<workspace>/certificates/sslkeystore.jks`` does not exist, a developer keystore will be used if ``devMode`` is true. The node will exit if ``devMode`` is false and keystore does not exist.
:certificateSigningService: :certificateSigningService:
Certificate Signing Server address. It is used by the certificate signing request utility to obtain SSL certificate. (See :doc:`permissioning` for more information.) Certificate Signing Server address. It is used by the certificate signing request utility to obtain SSL certificate. (See :doc:`permissioning` for more information.)

4
docs/source/example-code/src/main/resources/example-node.conf
View File

@ -17,6 +17,6 @@ useHTTPS : false
rpcUsers : [ rpcUsers : [
{ user=user1, password=letmein, permissions=[ StartProtocol.net.corda.protocols.CashProtocol ] } { user=user1, password=letmein, permissions=[ StartProtocol.net.corda.protocols.CashProtocol ] }
] ]
devMode = true devMode : true
// Certificate signing service will be hosted by R3 in the near future. // Certificate signing service will be hosted by R3 in the near future.
//certificateSigningService = "https://testnet.certificate.corda.net" //certificateSigningService : "https://testnet.certificate.corda.net"