diff --git a/docs/source/running-a-node.rst b/docs/source/running-a-node.rst index e4d44e0726..1628f5ab52 100644 --- a/docs/source/running-a-node.rst +++ b/docs/source/running-a-node.rst @@ -8,29 +8,15 @@ Running nodes locally There are several ways to run a Corda node locally for testing purposes. -Starting all nodes at once --------------------------- - -.. note:: ``runnodes`` is a shell script (or batch file on Windows) that is generated by ``deployNodes`` to allow you - to quickly start up all nodes and their webservers. ``runnodes`` should only be used for testing purposes. - -Start the nodes with ``runnodes`` by running the following command from the root of the project: - -* Linux/macOS: ``build/nodes/runnodes`` -* Windows: ``call build\nodes\runnodes.bat`` - -.. warning:: On macOS, do not click/change focus until all the node terminal windows have opened, or some processes may - fail to start. - -If you receive an ``OutOfMemoryError`` exception when interacting with the nodes, you need to increase the amount of -Java heap memory available to them, which you can do when running them individually. See -:ref:`starting-an-individual-corda-node`. +Starting a Corda node using DemoBench +------------------------------------- +See the instructions in :doc:`demobench`. .. _starting-an-individual-corda-node: -Starting an individual Corda node ---------------------------------- -Run the node by opening a terminal window in the node's folder and running: +Starting a Corda node from the command line +------------------------------------------- +Run a node by opening a terminal window in the node's folder and running: .. code-block:: shell @@ -57,10 +43,28 @@ Optionally run the node's webserver as well by opening a terminal window in the .. warning:: The node webserver is for testing purposes only and will be removed soon. -Starting a node with remote debugging enabled ---------------------------------------------- +Enabling remote debugging +~~~~~~~~~~~~~~~~~~~~~~~~~ To enable remote debugging of the node, run the following from the terminal window: ``java -Dcapsule.jvm.args="-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005" -jar corda.jar`` This command line will start the debugger on port 5005 and pause the process awaiting debugger attachment. + +Starting all nodes at once from the command line +------------------------------------------------ +If you created your nodes using ``deployNodes``, a ``runnodes`` shell script (or batch file on Windows) will have been +generated to allow you to quickly start up all nodes and their webservers. ``runnodes`` should only be used for testing +purposes. + +Start the nodes with ``runnodes`` by running the following command from the root of the project: + +* Linux/macOS: ``build/nodes/runnodes`` +* Windows: ``call build\nodes\runnodes.bat`` + +.. warning:: On macOS, do not click/change focus until all the node terminal windows have opened, or some processes may + fail to start. + +If you receive an ``OutOfMemoryError`` exception when interacting with the nodes, you need to increase the amount of +Java heap memory available to them, which you can do when running them individually. See +:ref:`starting-an-individual-corda-node`.