corda/docs/source/index.rst
Marek Skocovsky 262c87a5c6 Integrate CRaSH shell (SSHD). Joint effort between Mike Hearn and Marek Skocovsky.
The shell is embedded in the node and offers the ability to monitor
and control the node via the launching terminal.

Still to do:

* Switch to a fork of CRaSH that we can maintain ourselves, and merge in Marek's SSH patch so we can enable SSH access.
* Add persistent command history that survives restarts.
* Tab completion for the 'flow' and 'run' commands.
* Remove the 'jul' command and replace it with a command that lets you see and tail the log4j logs instead.
* Fix or remove the other crash commands that have bitrotted since 2015.
2017-03-24 12:44:54 +01:00

4.4 KiB

Welcome to the Corda documentation!

Warning

This build of the docs is from the "" branch, not a milestone release. It may not reflect the current state of the code. Read the docs for milestone release M9.0.

Corda is an open-source distributed ledger platform. The latest milestone (i.e. stable) release is M9.2. The codebase is on GitHub, and our community can be found on Slack and in our forum.

If you're new to Corda, you should start by learning about its motivating vision and architecture. A good introduction is the Introduction to Corda webinar and the Introductory white paper. As you become more familiar with Corda, readers with a technical background will also want to dive into the Technical white paper, which describes the platform's envisioned end-state.

Note

Corda training is now available in London, New York and Singapore! Learn more.

Corda is designed so that developers can easily extend its functionality by writing CorDapps (Corda Distributed Applications). Some example CorDapps are available in the Corda repo's samples directory. To run these yourself, make sure you follow the instructions in getting-set-up, then go to running-the-demos.

If, after running the demos, you're interested in writing your own CorDapps, you can use the CorDapp template as a base. A simple example CorDapp built upon the template is available here, and a video primer on basic CorDapp structure is available here.

From there, you'll be in a position to start extending the example CorDapp yourself (e.g. by writing new states, contracts, and/or flows). For this, you'll want to refer to this docsite, and to the tutorials in particular. If you get stuck, get in touch on Slack or the forum.

Once you're familiar with Corda and CorDapp development, we'd encourage you to get involved in the development of the platform itself. Find out more about contributing to Corda.

Documentation Contents:

inthebox getting-set-up getting-set-up-fault-finding running-the-demos CLI-vs-IDE

key-concepts key-concepts-ecosystem key-concepts-data-model key-concepts-core-types key-concepts-financial-model key-concepts-flow-framework key-concepts-consensus-notaries key-concepts-vault key-concepts-security-model

creating-a-cordapp tutorial-cordapp

shell serialization clientrpc messaging persistence node-administration corda-configuration-file corda-plugins node-services node-explorer permissioning

tutorial-contract tutorial-contract-clauses tutorial-test-dsl contract-upgrade tutorial-integration-testing tutorial-clientrpc-api tutorial-building-transactions flow-state-machines flow-testing running-a-notary using-a-notary oracles tutorial-attachments event-scheduling

network-simulator clauses merkle-trees json

contract-catalogue contract-irs

loadtesting setting-up-a-corda-network secure-coding-guidelines release-process release-notes changelog codestyle building-the-docs further-notes-on-kotlin publishing-corda azure-vm

glossary