mirror of
https://github.com/bigchaindb/bigchaindb.git
synced 2024-10-13 13:34:05 +00:00
177 lines
9.0 KiB
HTML
177 lines
9.0 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
|
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
|
|
<title>BigchainDB Documentation — Bigchain 0.0.1 documentation</title>
|
|
|
|
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
|
|
<script type="text/javascript">
|
|
var DOCUMENTATION_OPTIONS = {
|
|
URL_ROOT: './',
|
|
VERSION: '0.0.1',
|
|
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>
|
|
<link rel="top" title="Bigchain 0.0.1 documentation" href="#" />
|
|
<link rel="next" title="1. Installing BigchainDB" href="installing.html" />
|
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
|
|
|
</head>
|
|
<body role="document">
|
|
|
|
<div class="document">
|
|
<div class="documentwrapper">
|
|
<div class="bodywrapper">
|
|
<div class="body" role="main">
|
|
|
|
<div class="section" id="bigchaindb-documentation">
|
|
<h1>BigchainDB Documentation<a class="headerlink" href="#bigchaindb-documentation" title="Permalink to this headline">¶</a></h1>
|
|
<div class="section" id="table-of-contents">
|
|
<h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Permalink to this headline">¶</a></h2>
|
|
<p>Note to reviewers of this documentation: For now, <em>all</em> documentation files (.rst and .md) are at the same level in the Table of Contents heirarchy. Later, we can organize them into a more sensible heirarchy.</p>
|
|
<div class="toctree-wrapper compound">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="installing.html">1. Installing BigchainDB</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="getting-started.html">2. Getting Started</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="admin.html">3. Server/Cluster Deployment and Administration</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">4. Contributing to the BigchainDB Project</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="faq.html">5. Frequently Asked Questions (FAQ)</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="faq.html#questions-about-the-bigchaindb-whitepaper">5.1. Questions About the BigchainDB Whitepaper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="faq.html#other-questions">5.2. Other Questions</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="release-notes.html">6. Release Notes</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="software-architecture.html">7. BigchainDB Software Architecture</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="software-architecture.html#bigspool">7.1. bigspool</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="software-architecture.html#bigchain">7.2. bigchain</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="software-architecture.html#validator">7.3. validator</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="software-architecture.html#processor">7.4. processor</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="the-bigchain-class.html">8. The Bigchain Class</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cryptography.html">9. Cryptography</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="cryptography.html#hashes">9.1. Hashes</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cryptography.html#keys">9.2. Keys</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="models.html">10. The Transaction, Block and Vote Models</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="models.html#the-transaction-model">10.1. The Transaction Model</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="models.html#the-block-model">10.2. The Block Model</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="models.html#the-vote-model">10.3. The Vote Model</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="json-serialization.html">11. JSON Serialization</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="transaction-validation.html">12. Transaction Validation</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="transaction-validation.html#generic-validation">12.1. Generic Validation</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="transaction-validation.html#specific-validation">12.2. Specific Validation</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="rethinkdb-benchmarks.html">13. RethinkDB Benchmarks</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="rethinkdb-benchmarks.html#goal">13.1. Goal</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="rethinkdb-benchmarks.html#terminology">13.2. Terminology</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="rethinkdb-benchmarks.html#settings">13.2.1. Settings</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="rethinkdb-benchmarks.html#write-units">13.2.2. Write units</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="rethinkdb-benchmarks.html#sharding">13.2.3. Sharding</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="rethinkdb-benchmarks.html#tests">13.3. Tests</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="rethinkdb-benchmarks.html#test-1">13.3.1. Test 1</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="rethinkdb-benchmarks.html#test-2">13.3.2. Test 2</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="rethinkdb-benchmarks.html#test-3">13.3.3. Test 3</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="rethinkdb-benchmarks.html#test-4">13.3.4. Test 4</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="rethinkdb-benchmarks.html#test-5">13.3.5. Test 5</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="rethinkdb-benchmarks.html#test-6">13.3.6. Test 6</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="rethinkdb-benchmarks.html#testing-replication">13.4. Testing replication</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="indices-and-tables">
|
|
<h1>Indices and Tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
|
|
<ul class="simple">
|
|
<li><a class="reference internal" href="genindex.html"><span>Index</span></a></li>
|
|
<li><a class="reference internal" href="py-modindex.html"><span>Module Index</span></a></li>
|
|
<li><a class="reference internal" href="search.html"><span>Search Page</span></a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
<div class="sphinxsidebarwrapper">
|
|
<h3><a href="#">Table Of Contents</a></h3>
|
|
<ul>
|
|
<li><a class="reference internal" href="#">BigchainDB Documentation</a><ul>
|
|
<li><a class="reference internal" href="#table-of-contents">Table of Contents</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a class="reference internal" href="#indices-and-tables">Indices and Tables</a></li>
|
|
</ul>
|
|
<div class="relations">
|
|
<h3>Related Topics</h3>
|
|
<ul>
|
|
<li><a href="#">Documentation overview</a><ul>
|
|
<li>Next: <a href="installing.html" title="next chapter">1. Installing BigchainDB</a></li>
|
|
</ul></li>
|
|
</ul>
|
|
</div>
|
|
<div role="note" aria-label="source link">
|
|
<h3>This Page</h3>
|
|
<ul class="this-page-menu">
|
|
<li><a href="_sources/index.txt"
|
|
rel="nofollow">Show Source</a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="searchbox" style="display: none" role="search">
|
|
<h3>Quick search</h3>
|
|
<form class="search" action="search.html" method="get">
|
|
<input type="text" name="q" />
|
|
<input type="submit" value="Go" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
<p class="searchtip" style="font-size: 90%">
|
|
Enter search terms or a module, class or function name.
|
|
</p>
|
|
</div>
|
|
<script type="text/javascript">$('#searchbox').show(0);</script>
|
|
</div>
|
|
</div>
|
|
<div class="clearer"></div>
|
|
</div>
|
|
<div class="footer">
|
|
©2016, ascribe GmbH.
|
|
|
|
|
|
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.5</a>
|
|
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.7</a>
|
|
|
|
|
|
|
<a href="_sources/index.txt"
|
|
rel="nofollow">Page source</a>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</body>
|
|
</html> |