From f5a1be38ffe35f8474888b0dbb096733ac9009d4 Mon Sep 17 00:00:00 2001 From: szymonsztuka Date: Mon, 2 Jul 2018 15:24:12 +0100 Subject: [PATCH] ENT-2174 documentation (#1145) Links to Bintray to download Corda binaries replaced by mentioning binaries made available to an organization. --- docs/source/deploying-a-node.rst | 13 ++++++------- docs/source/generating-a-node.rst | 10 ++++++---- docs/source/node-structure.rst | 2 +- 3 files changed, 13 insertions(+), 12 deletions(-) diff --git a/docs/source/deploying-a-node.rst b/docs/source/deploying-a-node.rst index 83eea328aa..318d7214f0 100644 --- a/docs/source/deploying-a-node.rst +++ b/docs/source/deploying-a-node.rst @@ -24,11 +24,10 @@ handling, and ensures the Corda service is run at boot. ``mkdir /opt/corda; chown corda:corda /opt/corda`` -3. Download the `Corda jar `_ - (under ``/VERSION_NUMBER/corda-VERSION_NUMBER.jar``) and place it in ``/opt/corda`` +3. Place the Enterprise Corda JAR ``corda-VERSION_NUMBER.jar`` in ``/opt/corda`` -4. (Optional) Download the `Corda webserver jar `_ - (under ``/VERSION_NUMBER/corda-VERSION_NUMBER.jar``) and place it in ``/opt/corda`` +4. (Optional) Copy the Corda webserver JAR provided to your organization + (under ``/corda-webserver-VERSION_NUMBER.jar``) and place it in ``/opt/corda`` 5. Create a directory called ``cordapps`` in ``/opt/corda`` and save your CorDapp jar file to it. Alternatively, download one of our `sample CorDapps `_ to the ``cordapps`` directory @@ -191,11 +190,11 @@ at boot, and means the Corda service stays running with no users connected to th * Oracle Java 8. The supported versions are listed in :doc:`getting-set-up` -1. Create a Corda directory and download the Corda jar. Replace ``VERSION_NUMBER`` with the desired version. Here's an - example using PowerShell:: +1. Create a Corda directory and copy the Enterprise Corda JAR ``corda-VERSION_NUMBER.jar``. + Replace ``VERSION_NUMBER`` with the desired version. Here's an example using PowerShell:: mkdir C:\Corda - wget http://jcenter.bintray.com/net/corda/corda/VERSION_NUMBER/corda-VERSION_NUMBER.jar -OutFile C:\Corda\corda.jar + copy PATH_TO_CORDA_JAR/corda-VERSION_NUMBER.jar C:\Corda\corda.jar 2. Create a directory called ``cordapps`` in ``C:\Corda\`` and save your CorDapp jar file to it. Alternatively, download one of our `sample CorDapps `_ to the ``cordapps`` directory diff --git a/docs/source/generating-a-node.rst b/docs/source/generating-a-node.rst index 4e11939e79..40ed405736 100644 --- a/docs/source/generating-a-node.rst +++ b/docs/source/generating-a-node.rst @@ -7,17 +7,17 @@ Handcrafting a node ------------------- A node can be created manually by creating a folder that contains the following items: -* The Corda JAR +* The Corda Enterprise JAR - * Can be downloaded from https://r3.bintray.com/corda/net/corda/corda/ (under /VERSION_NUMBER/corda-VERSION_NUMBER.jar) + * The binary ``corda-VERSION_NUMBER.jar`` provided to your organisation. * A node configuration file entitled ``node.conf``, configured as per :doc:`corda-configuration-file` * A folder entitled ``cordapps`` containing any CorDapp JARs you want the node to load -* **Optional:** A webserver JAR entitled ``corda-webserver.jar`` that will connect to the node via RPC +* **Optional:** A webserver JAR entitled ``corda-webserver-VERSION_NUMBER.jar`` that will connect to the node via RPC - * The (deprecated) default webserver can be downloaded from http://r3.bintray.com/corda/net/corda/corda-webserver/ (under /VERSION_NUMBER/corda-VERSION_NUMBER.jar) + * The (deprecated) default webserver is available to you for testing and should not be used in a production environment. * A Spring Boot alternative can be found here: https://github.com/corda/spring-webserver The remaining files and folders described in :doc:`node-structure` will be generated at runtime. @@ -80,6 +80,8 @@ in the `Kotlin CorDapp Template `. + Running this task will create three nodes in the ``build/nodes`` folder: * A ``Notary`` node that: diff --git a/docs/source/node-structure.rst b/docs/source/node-structure.rst index 374548f8ee..0b65211a96 100644 --- a/docs/source/node-structure.rst +++ b/docs/source/node-structure.rst @@ -19,7 +19,7 @@ A Corda node has the following structure: ├── logs // The node logs ├── network-parameters // The network parameters automatically downloaded from the network map server ├── node.conf // The node's configuration files - ├── persistence.mv.db // The node's database + ├── persistence.mv.db // The node's database (present when the node uses the embedded H2 database instance) └── shell-commands // Custom shell commands defined by the node owner The node is configured by editing its ``node.conf`` file (see :doc:`corda-configuration-file`). You install CorDapps on