corda/docs/build/html/getting-set-up-fault-finding.html
2017-01-31 13:02:43 +00:00

381 lines
21 KiB
HTML

<!-- If you edit this, then please make the same changes to layout_for_doc_website.html, as that is used for the web
doc site generation which we put analytics tracking on to identify any potential problem pages -->
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Troubleshooting &mdash; R3 Corda latest documentation</title>
<link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
<link rel="next" title="Running the demos" href="running-the-demos.html"/>
<link rel="prev" title="Getting set up" href="getting-set-up.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> R3 Corda
</a>
<div class="version">
latest
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<br>
API reference: <a href="api/kotlin/corda/index.html">Kotlin</a>/ <a href="api/javadoc/index.html">JavaDoc</a>
<br>
<a href="https://discourse.corda.net">Discourse Forums</a>
<br>
<a href="http://slack.corda.net">Slack</a>
<br>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Getting started</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="inthebox.html">What&#8217;s included?</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting-set-up.html">Getting set up</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Troubleshooting</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#milestone-releases">Milestone releases</a></li>
<li class="toctree-l2"><a class="reference internal" href="#java-issues">Java issues</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#outdated-non-oracle-jdks">Outdated/non-Oracle JDKs</a></li>
<li class="toctree-l3"><a class="reference internal" href="#unresolved-reference-javafx">&#8220;Unresolved reference: javafx&#8221;</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#idea-issues">IDEA issues</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#no-source-files-are-present">No source files are present</a></li>
<li class="toctree-l3"><a class="reference internal" href="#run-configurations-are-missing">Run configurations are missing</a></li>
<li class="toctree-l3"><a class="reference internal" href="#idea-complains-about-lack-of-an-sdk">IDEA complains about lack of an SDK</a></li>
<li class="toctree-l3"><a class="reference internal" href="#kotlin-plugin">Kotlin plugin</a></li>
<li class="toctree-l3"><a class="reference internal" href="#unable-to-make-the-module-related-gradle-configuration-was-not-found-please-re-import-the-gradle-project-and-try-again">&#8220;Unable to make the module: related gradle configuration was not found. Please, re-import the Gradle project and try again&#8221;</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#other-common-issues">Other common issues</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#xterm-command-not-found">“xterm: command not found”</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="running-the-demos.html">Running the demos</a></li>
<li class="toctree-l1"><a class="reference internal" href="CLI-vs-IDE.html">CLI vs IDE</a></li>
</ul>
<p class="caption"><span class="caption-text">Key concepts</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="key-concepts.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="key-concepts-ecosystem.html">Corda ecosystem</a></li>
<li class="toctree-l1"><a class="reference internal" href="key-concepts-data-model.html">Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="key-concepts-core-types.html">Core types</a></li>
<li class="toctree-l1"><a class="reference internal" href="key-concepts-financial-model.html">Financial model</a></li>
<li class="toctree-l1"><a class="reference internal" href="key-concepts-flow-framework.html">Flow framework</a></li>
<li class="toctree-l1"><a class="reference internal" href="key-concepts-consensus-notaries.html">Consensus and notaries</a></li>
<li class="toctree-l1"><a class="reference internal" href="key-concepts-vault.html">Vault</a></li>
<li class="toctree-l1"><a class="reference internal" href="key-concepts-security-model.html">Security model</a></li>
</ul>
<p class="caption"><span class="caption-text">CorDapps</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="creating-a-cordapp.html">CorDapp basics</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial-cordapp.html">The CorDapp template</a></li>
</ul>
<p class="caption"><span class="caption-text">The Corda node</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="clientrpc.html">Client RPC</a></li>
<li class="toctree-l1"><a class="reference internal" href="messaging.html">Networking and messaging</a></li>
<li class="toctree-l1"><a class="reference internal" href="persistence.html">Persistence</a></li>
<li class="toctree-l1"><a class="reference internal" href="node-administration.html">Node administration</a></li>
<li class="toctree-l1"><a class="reference internal" href="corda-configuration-file.html">Node configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="corda-plugins.html">The Corda plugin framework</a></li>
<li class="toctree-l1"><a class="reference internal" href="node-services.html">Brief introduction to the node services</a></li>
<li class="toctree-l1"><a class="reference internal" href="node-explorer.html">Node Explorer</a></li>
<li class="toctree-l1"><a class="reference internal" href="permissioning.html">Network permissioning</a></li>
</ul>
<p class="caption"><span class="caption-text">Tutorials</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="tutorial-contract.html">Writing a contract</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial-contract-clauses.html">Writing a contract using clauses</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial-test-dsl.html">Writing a contract test</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial-integration-testing.html">Integration testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial-clientrpc-api.html">Client RPC API tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial-building-transactions.html">Building transactions</a></li>
<li class="toctree-l1"><a class="reference internal" href="flow-state-machines.html">Writing flows</a></li>
<li class="toctree-l1"><a class="reference internal" href="flow-testing.html">Writing flow tests</a></li>
<li class="toctree-l1"><a class="reference internal" href="running-a-notary.html">Running a notary service</a></li>
<li class="toctree-l1"><a class="reference internal" href="using-a-notary.html">Using a notary service</a></li>
<li class="toctree-l1"><a class="reference internal" href="oracles.html">Writing oracle services</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial-attachments.html">Using attachments</a></li>
<li class="toctree-l1"><a class="reference internal" href="event-scheduling.html">Event scheduling</a></li>
</ul>
<p class="caption"><span class="caption-text">Other</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="network-simulator.html">Network Simulator</a></li>
<li class="toctree-l1"><a class="reference internal" href="clauses.html">Clauses</a></li>
<li class="toctree-l1"><a class="reference internal" href="merkle-trees.html">Transaction tear-offs</a></li>
</ul>
<p class="caption"><span class="caption-text">Component library</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="contract-catalogue.html">Contract catalogue</a></li>
<li class="toctree-l1"><a class="reference internal" href="contract-irs.html">Interest rate swaps</a></li>
</ul>
<p class="caption"><span class="caption-text">Appendix</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="loadtesting.html">Load testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="setting-up-a-corda-network.html">What is a corda network?</a></li>
<li class="toctree-l1"><a class="reference internal" href="secure-coding-guidelines.html">Secure coding guidelines</a></li>
<li class="toctree-l1"><a class="reference internal" href="release-process.html">Release process</a></li>
<li class="toctree-l1"><a class="reference internal" href="release-notes.html">Release notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="codestyle.html">Code style guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="building-the-docs.html">Building the documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="further-notes-on-kotlin.html">Further notes on Kotlin</a></li>
<li class="toctree-l1"><a class="reference internal" href="publishing-corda.html">Publishing Corda</a></li>
<li class="toctree-l1"><a class="reference internal" href="azure-vm.html">Working with the Corda Demo on Azure Marketplace</a></li>
</ul>
<p class="caption"><span class="caption-text">Glossary</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">R3 Corda</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> &raquo;</li>
<li>Troubleshooting</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/getting-set-up-fault-finding.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="troubleshooting">
<h1>Troubleshooting<a class="headerlink" href="#troubleshooting" title="Permalink to this headline"></a></h1>
<div class="section" id="milestone-releases">
<h2>Milestone releases<a class="headerlink" href="#milestone-releases" title="Permalink to this headline"></a></h2>
<p>When you clone the corda or cordapp-template repos, they will default to the master branch. The master branch is being continuously developed upon, and its features may not align with the state of Corda as described in the docs. Additionally, the master branch of the CorDapp Template may break in response to changes in the main corda repo.</p>
<p>When developing on Corda, you should always check out the latest stable branch instead, by running <code class="docutils literal"><span class="pre">git</span> <span class="pre">checkout</span> <span class="pre">release-M7</span></code>.</p>
</div>
<div class="section" id="java-issues">
<h2>Java issues<a class="headerlink" href="#java-issues" title="Permalink to this headline"></a></h2>
<div class="section" id="outdated-non-oracle-jdks">
<h3>Outdated/non-Oracle JDKs<a class="headerlink" href="#outdated-non-oracle-jdks" title="Permalink to this headline"></a></h3>
<p>Many users have faced issues when running versions of Java that are either outdated, or are produced by organisations other than Oracle (e.g. OpenJDK). The errors generated by these issues will not always clearly point to the JDK as the cause. If in doubt, check your JDK version by following the instructions <a class="reference external" href="https://java.com/en/download/help/version_manual.xml">here</a>. You can download the latest version of Oracle&#8217;s JDK <a class="reference external" href="http://www.oracle.com/technetwork/java/javase/downloads/index.html">here</a>.</p>
</div>
<div class="section" id="unresolved-reference-javafx">
<h3>&#8220;Unresolved reference: javafx&#8221;<a class="headerlink" href="#unresolved-reference-javafx" title="Permalink to this headline"></a></h3>
<p>JavaFX is not bundled with OpenJDK. If you are using OpenJDK and get an &#8216;Unresolved reference: javafx&#8217; error, this means that you need to install OpenJFX. Do this by running <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">apt</span> <span class="pre">install</span> <span class="pre">openjfx</span></code>, and possibly <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">apt</span> <span class="pre">install</span> <span class="pre">libopenjfx-jav</span></code>.</p>
</div>
</div>
<div class="section" id="idea-issues">
<h2>IDEA issues<a class="headerlink" href="#idea-issues" title="Permalink to this headline"></a></h2>
<div class="section" id="no-source-files-are-present">
<h3>No source files are present<a class="headerlink" href="#no-source-files-are-present" title="Permalink to this headline"></a></h3>
<p>When opening a project in IDEA for the first time, you will need to build the project. You should see &#8220;Unlinked Gradle project?&#8221;
in a pop-up window in the top-right corner or in a popup alert window. It will also appear in the &#8220;Event Log&#8221; window which can be
opened by clicking on &#8220;Event Log&#8221; at the bottom right of the IDEA window. Find one of these links and click on &#8220;Import Gradle Project&#8221;.</p>
<a class="reference internal image-reference" href="_images/unlinked-gradle.png"><img alt="IDEA Gradle Prompt" src="_images/unlinked-gradle.png" style="width: 410px; height: 50px;" /></a>
<p>Wait for it to download the dependencies. You may then see another popup titled &#8220;Unindexed remote maven repositories found.&#8221; This won&#8217;t affect Corda,
so you can choose to leave them unindexed.</p>
<p>If still have problems, the JetBrains website has more information on <a class="reference external" href="https://www.jetbrains.com/help/idea/2016.2/working-with-gradle-projects.html">here</a>.</p>
</div>
<div class="section" id="run-configurations-are-missing">
<h3>Run configurations are missing<a class="headerlink" href="#run-configurations-are-missing" title="Permalink to this headline"></a></h3>
<p>If you opened the Corda project by clicking &#8220;Import Project&#8221; on the IDEA splash screen rather than clicking &#8220;Open&#8221;, a bug
in IDEA will cause it to wipe and recreate the <code class="docutils literal"><span class="pre">.idea</span></code> directory where the run configurations are stored. The fix is
simple and doesn&#8217;t require you to re-import the project: just undelete the files! You can do that by either:</p>
<ol class="arabic simple">
<li>Running <code class="docutils literal"><span class="pre">git</span> <span class="pre">checkout</span> <span class="pre">.idea/runConfigurations</span></code> to redownload the files.</li>
<li>Using the &#8220;Version Control&#8221; pane in IDEA to undelete the files via the GUI.</li>
</ol>
</div>
<div class="section" id="idea-complains-about-lack-of-an-sdk">
<h3>IDEA complains about lack of an SDK<a class="headerlink" href="#idea-complains-about-lack-of-an-sdk" title="Permalink to this headline"></a></h3>
<p>If IDEA refuses to open a project because an SDK has not been selected, you may need to fix the project structure. Do this by following <a class="reference external" href="https://www.jetbrains.com/help/idea/2016.2/configuring-global-project-and-module-sdks.html">these instructions</a>. The correct JDK is often found on a path such as <code class="docutils literal"><span class="pre">jdk1.8.0_xx…/Contents/Home</span></code>. Ensure that you have the Project language level set at 8.</p>
<p>If you are having trouble selecting the correct JDK, the JetBrains website provides the <a class="reference external" href="https://intellij-support.jetbrains.com/hc/en-us/articles/206544879-Selecting-the-JDK-version-the-IDE-will-run-under">following guidelines</a>.</p>
</div>
<div class="section" id="kotlin-plugin">
<h3>Kotlin plugin<a class="headerlink" href="#kotlin-plugin" title="Permalink to this headline"></a></h3>
<p>There are two ways to configure Kotlin in IDEA:</p>
<ol class="arabic simple">
<li>Via the initial project opening screen, by using the <code class="docutils literal"><span class="pre">Configure</span> <span class="pre">&gt;</span> <span class="pre">Plugins</span></code> tab.</li>
<li>From an open IDEA project, by clicking <code class="docutils literal"><span class="pre">IDEA</span> <span class="pre">-&gt;</span> <span class="pre">Preferences</span> <span class="pre">...</span></code> (on OS X) or <code class="docutils literal"><span class="pre">File</span> <span class="pre">-&gt;</span> <span class="pre">Settings</span></code> (on Windows). Select the Plugins bar to confirm that Kotlin is installed and up-to-date.</li>
</ol>
<p>If you are still having trouble installing Kotlin, first try upgrading the Kotlin plugin. At the time of writing, you can
identify the latest version of the Kotlin plugin on <a class="reference external" href="https://plugins.jetbrains.com/plugin/6954">this page</a>.</p>
</div>
<div class="section" id="unable-to-make-the-module-related-gradle-configuration-was-not-found-please-re-import-the-gradle-project-and-try-again">
<h3>&#8220;Unable to make the module: related gradle configuration was not found. Please, re-import the Gradle project and try again&#8221;<a class="headerlink" href="#unable-to-make-the-module-related-gradle-configuration-was-not-found-please-re-import-the-gradle-project-and-try-again" title="Permalink to this headline"></a></h3>
<p>This can usually be solved by updating IDEA. Check that you have the latest version <a class="reference external" href="https://www.jetbrains.com/idea/download/">here</a>.</p>
</div>
</div>
<div class="section" id="other-common-issues">
<h2>Other common issues<a class="headerlink" href="#other-common-issues" title="Permalink to this headline"></a></h2>
<div class="section" id="xterm-command-not-found">
<h3>“xterm: command not found”<a class="headerlink" href="#xterm-command-not-found" title="Permalink to this headline"></a></h3>
<p>On some machines, running the samples requires xterm. You can download it <a class="reference external" href="http://invisible-island.net/xterm/#download">here</a>.</p>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="running-the-demos.html" class="btn btn-neutral float-right" title="Running the demos" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="getting-set-up.html" class="btn btn-neutral" title="Getting set up" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2016, R3 Limited.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'latest',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>