diff --git a/docs/source/running-a-node.rst b/docs/source/running-a-node.rst index 1628f5ab52..6f325bc1c2 100644 --- a/docs/source/running-a-node.rst +++ b/docs/source/running-a-node.rst @@ -51,8 +51,8 @@ To enable remote debugging of the node, run the following from the terminal wind 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 ------------------------------------------------- +Starting all nodes at once from the command line (native) +--------------------------------------------------------- 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. @@ -68,3 +68,15 @@ Start the nodes with ``runnodes`` by running the following command from the root 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 all nodes at once from the command line (docker-compose) +----------------------------------------------------------------- +If you created your nodes using ``Dockerform``, the ``docker-compose.yml`` file and corresponding ``Dockerfile`` for +nodes has been created and configured appropriately. Navigate to ``build/nodes`` directory and run ``docker-compose up`` +command. This will startup nodes inside new, internal network. +After the nodes are started up, you can use ``docker ps`` command to see how the ports are mapped. + +.. warning:: You need both ``Docker`` and ``docker-compose`` installed and enabled to use this method. Docker CE + (Community Edition) is enough. Please refer to `Docker CE documentation `_ + and `Docker Compose documentation `_ for installation instructions for all + major operating systems.