ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2025-02-21 09:51:57 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Documents increasing heap size when running nodes locally.

Browse Source
This commit is contained in:
joeldudleyr3 2017-11-30 10:38:06 +00:00
parent a88e7c9035
commit ada1fe2438
1 changed files with 18 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/source/running-a-node.rst
View File

@ -22,6 +22,12 @@ Start the nodes with ``runnodes`` by running the following command from the root
.. warn:: On macOS, do not click/change focus until all the node terminal windows have opened, or some processes may .. warn:: On macOS, do not click/change focus until all the node terminal windows have opened, or some processes may
fail to start. 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-an-individual-corda-node:
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: Run the node by opening a terminal window in the node's folder and running:
@ -30,9 +36,18 @@ Run the node by opening a terminal window in the node's folder and running:
java -jar corda.jar java -jar corda.jar
.. warning:: By default, the node will look for a configuration file called ``node.conf`` and a CorDapps folder called By default, the node will look for a configuration file called ``node.conf`` and a CorDapps folder called ``cordapps``
``cordapps`` in the current working directory. You can override the configuration file and workspace paths on the in the current working directory. You can override the configuration file and workspace paths on the command line (e.g.
command line (e.g. ``./corda.jar --config-file=test.conf --base-directory=/opt/r3corda/nodes/test``). ``./corda.jar --config-file=test.conf --base-directory=/opt/corda/nodes/test``).
You can increase the amount of Java heap memory available to the node using the ``-Xmx`` command line argument. For
example, the following would run the node with a heap size of 2048MB:
.. code-block:: shell
java -jar corda.jar -Xmx2048m
You should do this if you receive an ``OutOfMemoryError`` exception when interacting with the node.
Optionally run the node's webserver as well by opening a terminal window in the node's folder and running: Optionally run the node's webserver as well by opening a terminal window in the node's folder and running: