added '_build' to the gitignore. added auth_rules.md file, changed co…

…nf.py to have right remot_conf repo. Signed-off-by: michael <michael.boyd@sovrin.org>
hyperledger · Dec 8, 2018 · 03fc523 · 03fc523
1 parent 72902a8
commit 03fc523
Show file tree

Hide file tree

Showing 63 changed files with 417 additions and 554 deletions.
diff --git a/.gitignore b/.gitignore
@@ -10,6 +10,7 @@ __pycache__/
 # Distribution / packaging
 bin/
 build/
+_build/
 develop-eggs/
 dist/
 eggs/

diff --git a/docs/README.md b/docs/README.md
@@ -1,12 +1,12 @@
 # Documentation README
-Check out the node docs at http://indy.readthedocs.io/projects/node
+Check out the sdk docs at http://indy.readthedocs.io/projects/node
 
-Learn more about how our docs are built and maintained at http://indy.readthedocs.io/en/latest/docs.html
+Learn more about how our docs are built and maintained at http://hyperledger-indy.readthedocs.io/en/latest/docs.html
 
 ## How to Add Documentation
 For new features and pull requests, maintainers should make sure that the **contributor has added an explanation for their changes in the docs folder before merging the PR.**
 
-Contributors should write an addition to a current file or add a new file to the docs/source/ folder that explains what their feature is and how it works. If needed, they may also add a link to more technical README's located nearer to the code.
+Contributors should add a new file to the docs/source/ folder or write an addition to a current file that explains what their feature is and how it works. If needed, they may also add a link to more technical README's located nearer to the code.
 
 Whenever additions are made to the docs, make sure to update the `index.rst` in whichever folder the file has been added, and build the docs locally to confirm they work (TODO: add the `sphinx-build` command to our CI/CD flow).
 
@@ -18,7 +18,9 @@ For example, if I wanted to add another file to the indy-sdk docs/ folder named
 
   getting-started/index.rst
   ...
-  other files
+  key-concepts.md
+  ...
+  contributing/index.rst
   ...
   glossary.md                   .. <-- this is your new file!
 
@@ -28,7 +30,6 @@ To add a new file to a subfolder, simply update the subfolder's `index.rst` with
 
 If you'd like to link to a file outside of the docs/ folder, you'll need to provide an external github link (this is by design, to keep our docs organized into a single folder)
 
-
 ## Building the docs on your machine
 
 Here are the quick steps to achieve this on a local machine without depending on ReadTheDocs. Note: Instructions may differ depending on your OS.
@@ -44,4 +45,8 @@ make html
 This will generate all the html files in `docs/source/_build/html` which you can then browse locally in your browser. Every time you make a change to the documentation you will need to rerun `make html`.
 
 ## Additional Instructions
-This section is to be used for repo maintainers to add additional documentation guidelines or instructions. 
+This section is to be used for repo maintainers to add additional documentation guidelines or instructions. 
+**TODO: Build the respective code API's into the readthedocs website**
+
+**TODO: Add table support for markdown files** 
+* This link may help: https://github.com/ryanfox/sphinx-markdown-tables
diff --git a/docs/source/_build/doctrees/1.3_to_1.4_migration_guide.doctree b/docs/source/_build/doctrees/1.3_to_1.4_migration_guide.doctree
diff --git a/docs/source/_build/doctrees/add-node.doctree b/docs/source/_build/doctrees/add-node.doctree
diff --git a/docs/source/_build/doctrees/auth_rules.doctree b/docs/source/_build/doctrees/auth_rules.doctree
diff --git a/docs/source/_build/doctrees/ci-cd.doctree b/docs/source/_build/doctrees/ci-cd.doctree
diff --git a/docs/source/_build/doctrees/cluster-simulation.doctree b/docs/source/_build/doctrees/cluster-simulation.doctree
diff --git a/docs/source/_build/doctrees/environment.pickle b/docs/source/_build/doctrees/environment.pickle
diff --git a/docs/source/_build/doctrees/helper-scripts.doctree b/docs/source/_build/doctrees/helper-scripts.doctree
diff --git a/docs/source/_build/doctrees/index.doctree b/docs/source/_build/doctrees/index.doctree
diff --git a/docs/source/_build/doctrees/indy-file-structure-guideline.doctree b/docs/source/_build/doctrees/indy-file-structure-guideline.doctree
diff --git a/docs/source/_build/doctrees/indy-running-locally.doctree b/docs/source/_build/doctrees/indy-running-locally.doctree
diff --git a/docs/source/_build/doctrees/introduction.doctree b/docs/source/_build/doctrees/introduction.doctree
diff --git a/docs/source/_build/doctrees/node-monitoring-tools-for-stewards.doctree b/docs/source/_build/doctrees/node-monitoring-tools-for-stewards.doctree
diff --git a/docs/source/_build/doctrees/node-state-diagnostic-tools.doctree b/docs/source/_build/doctrees/node-state-diagnostic-tools.doctree
diff --git a/docs/source/_build/doctrees/pool-upgrade.doctree b/docs/source/_build/doctrees/pool-upgrade.doctree
diff --git a/docs/source/_build/doctrees/requests-new.doctree b/docs/source/_build/doctrees/requests-new.doctree
diff --git a/docs/source/_build/doctrees/requests.doctree b/docs/source/_build/doctrees/requests.doctree
diff --git a/docs/source/_build/doctrees/rtd-index.doctree b/docs/source/_build/doctrees/rtd-index.doctree
diff --git a/docs/source/_build/doctrees/setup-dev.doctree b/docs/source/_build/doctrees/setup-dev.doctree
diff --git a/docs/source/_build/doctrees/setup-iptables.doctree b/docs/source/_build/doctrees/setup-iptables.doctree
diff --git a/docs/source/_build/doctrees/start-nodes.doctree b/docs/source/_build/doctrees/start-nodes.doctree
diff --git a/docs/source/_build/doctrees/toc.doctree b/docs/source/_build/doctrees/toc.doctree
diff --git a/docs/source/_build/doctrees/transactions.doctree b/docs/source/_build/doctrees/transactions.doctree
diff --git a/docs/source/_build/doctrees/write-code-guideline.doctree b/docs/source/_build/doctrees/write-code-guideline.doctree
diff --git a/docs/source/_build/html/1.3_to_1.4_migration_guide.html b/docs/source/_build/html/1.3_to_1.4_migration_guide.html
@@ -85,6 +85,7 @@
 <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="start-nodes.html">Create a Network and Start Nodes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="add-node.html">Add Node to Existing Pool</a></li>
+<li class="toctree-l1"><a class="reference internal" href="auth_rules.html">Current implemented rules in auth_map</a></li>
 <li class="toctree-l1"><a class="reference internal" href="ci-cd.html">Continuous Integration / Delivery</a></li>
 <li class="toctree-l1"><a class="reference internal" href="cluster-simulation.html">Running a Simulation of a Indy Cluster and Agents</a></li>
 <li class="toctree-l1"><a class="reference internal" href="helper-scripts.html">Helper Scripts</a></li>
@@ -185,8 +186,6 @@
 <ul class="simple">
 <li><strong>Change REPLY format for WRITE transactions and using digest as a key</strong>:
 <a class="reference external" href="https://github.com/hyperledger/indy-node/blob/master/data/migrations/deb/1_3_428_to_1_3_429.py">1_3_428_to_1_3_429.py</a></li>
-</ul>
-<ul class="simple">
 <li><strong>From levelDb to Rocksdb</strong>:
 <a class="reference external" href="https://github.com/hyperledger/indy-node/blob/master/data/migrations/deb/1_3_396_to_1_3_397.py">1_3_396_to_1_3_397.py</a></li>
 </ul>

diff --git a/docs/source/_build/html/_images/indy-logo.png b/docs/source/_build/html/_images/indy-logo.png
diff --git a/docs/auth_rules.md → ...ce/_build/html/_sources/auth_rules.md.txt b/docs/auth_rules.md → ...ce/_build/html/_sources/auth_rules.md.txt
diff --git a/docs/source/_build/html/_sources/ci-cd.md.txt b/docs/source/_build/html/_sources/ci-cd.md.txt
@@ -78,10 +78,12 @@ Use cases for artifacts
 We use [fpm](https://github.com/jordansissel/fpm) for packaging python code into deb packages. Build scripts are placed in `build-scripts` folders:
 - https://github.com/hyperledger/indy-node/blob/master/build-scripts
 - https://github.com/hyperledger/indy-plenum/blob/master/build-scripts
+- https://github.com/hyperledger/indy-anoncreds/blob/master/build-scripts
 
 We also pack some 3rd parties dependencies which are not presented in canonical ubuntu repositories:
 - https://github.com/hyperledger/indy-node/blob/master/build-scripts/ubuntu-1604/build-3rd-parties.sh
 - https://github.com/hyperledger/indy-plenum/blob/master/build-scripts/ubuntu-1604/build-3rd-parties.sh
+- https://github.com/hyperledger/indy-anoncreds/blob/master/build-scripts/ubuntu-1604/build-3rd-parties.sh
 
 Each `build-scripts` folder includes `Readme.md`. Please check them for more details.
 
@@ -90,7 +92,7 @@ Each `build-scripts` folder includes `Readme.md`. Please check them for more det
 - Please note, that we are using semver-like approach for versioning (major, minor, build) for each of the components.
 - Major and minor parts are set in the code (see [\_\_metadata\_\_.py](https://github.com/hyperledger/indy-node/blob/master/indy_node/__metadata__.py)). They must be incremented for new releases manually from code if needed.
 - Build part is incremented with each build on Jenkins (so it always increases, but may be not sequentially)
-- Each dependency (including indy-plenum) has a strict version (see [setup.py](https://github.com/hyperledger/indy-node/blob/master/setup.py))
+- Each dependency (including indy-plenum and indy-anoncreds) has a strict version (see [setup.py](https://github.com/hyperledger/indy-node/blob/master/setup.py))
 - If you install indy-node (either from pypi, or from deb package), the specified in setup.py version of indy-plenum is installed.
 - Master and Stable builds usually have different versions.
 - Differences in master and stable code:

diff --git a/docs/source/_build/html/_sources/index.rst.txt b/docs/source/_build/html/_sources/index.rst.txt
@@ -13,6 +13,7 @@ Welcome to Hyperledger Indy Node's documentation!
    introduction.md
    start-nodes.md 
    add-node.md
+   auth_rules.md
    ci-cd.md
    cluster-simulation.md
    helper-scripts.md
@@ -31,3 +32,4 @@ Welcome to Hyperledger Indy Node's documentation!
 
 
 
+
diff --git a/docs/source/_build/html/_sources/rtd-index.rst.txt b/docs/source/_build/html/_sources/rtd-index.rst.txt
diff --git a/docs/source/_build/html/_sources/setup-dev.md.txt b/docs/source/_build/html/_sources/setup-dev.md.txt
@@ -18,7 +18,7 @@ You can also have a look at the scripts mentioned below to follow them and perfo
 1. Get scripts from [dev-setup-ubuntu](https://github.com/hyperledger/indy-node/tree/master/dev-setup/ubuntu)
 1. Run `setup-dev-python.sh` to setup Python3.5, pip and virtualenv
 1. Run `source ~/.bashrc` to apply virtual environment wrapper installation
-1. Run `setup-dev-depend-ubuntu16.sh` to setup dependencies (libindy, libindy-crypto, libsodium)
+1. Run `setup-dev-depend-ubuntu16.sh` to setup dependencies (charm-crypto, libindy, libindy-crypto, libsodium)
 1. Fork [indy-plenum](https://github.com/hyperledger/indy-plenum) and [indy-node](https://github.com/hyperledger/indy-node)
 1. Go to the destination folder for the project
 1. Run `init-dev-project.sh <github-name> <new-virtualenv-name>` to clone indy-plenum and indy-node projects and
@@ -81,6 +81,13 @@ Run ```sudo yum install python3.5```
 
 Download the latest build (pywin32-220.win-amd64-py3.5.exe is the latest build as of this writing) from  [here](https://sourceforge.net/projects/pywin32/files/pywin32/Build%20220/) and run the downloaded executable.
 
+### Setup Charm-Crypto
+
+Indy-client requires anonymous credentials library which requires a cryptographic library.
+The default configuration includes an example that uses Charm-Crypto framework.
+You can install it as described in [Anonymous Credentials](https://github.com/evernym/anoncreds) repository 
+(in particular, running `setup-charm.sh`).
+
 ### Setup Libsodium
 
 Indy also depends on libsodium, an awesome crypto library. These need to be installed separately.

diff --git a/docs/source/_build/html/_sources/setup-iptables.md.txt b/docs/source/_build/html/_sources/setup-iptables.md.txt
@@ -1,15 +1,7 @@
 # Setup iptables rules (recommended)
 
-It is strongly recommended to add iptables (or some other firewall) rule that limits the number of simultaneous clients
-connections for client port.
-There are at least two important reasons for this:
- - preventing the indy-node process from reaching of open file descriptors limit caused by clients connections
- - preventing the indy-node process from large memory usage as ZeroMQ creates the separate queue for each TCP connection.
-
-NOTE: limitation of the number of *simultaneous clients connections* does not mean that we limit the
-number of *simultaneous clients* the indy-node works with in any time. The IndySDK client does not keep
-connection infinitely, it uses the same connection for request-response session with some optimisations,
-so it's just about **connections**, **not** about **clients**.
+In order to prevent the indy-node process from reaching of open file descriptors limit caused by clients connections it is strongly
+recommended to add iptables rule that limits the number of simultaneous clients connections for client port.
 
 Also iptables can be used to deal with various DoS attacks (e.g. syn flood) but rules' parameters are not estimated yet.
 
@@ -25,7 +17,7 @@ This environment file contains client port (NODE_CLIENT_PORT) and recommended cl
 This parameters can be used to add the iptables rule for chain INPUT:
 
 ```
-# iptables -I INPUT -p tcp --syn --dport 9702 -m connlimit --connlimit-above 500 --connlimit-mask 0 -j REJECT --reject-with tcp-reset
+# iptables -I INPUT -p tcp --syn --dport 9702 -m connlimit --connlimit-above 15360 --connlimit-mask 0 -j REJECT --reject-with tcp-reset
 ```
 Some key options:
  - --dport - a port for which limit is set
@@ -63,8 +55,8 @@ NOTE: this script should be called *after* `init_indy_node` script.
 
 ###### For pip installation
 The `setup_indy_node_iptables` script can not be used in case of pip installation as indy-node environment file does not exist,
-use the `setup_iptables` script instead (9702 is a client port, 500 is recommended limit for now)
+use the `setup_iptables` script instead (9702 is a client port, 15360 is recommended limit for now)
 ```
-# setup_iptables 9702 500
+# setup_iptables 9702 15360
 ```
 In fact, the `setup_indy_node_iptables` script is just a wrapper for the `setup_iptables` script.
diff --git a/docs/source/_build/html/_sources/start-nodes.md.txt b/docs/source/_build/html/_sources/start-nodes.md.txt
@@ -75,12 +75,6 @@ We can run the script multiple times for different networks.
 
 #### Setup iptables (recommended)
 
-It is strongly recommended to add iptables (or some other firewall) rule that limits the number of simultaneous clients
-connections for client port.
-There are at least two important reasons for this:
- - preventing the indy-node process from reaching of open file descriptors limit caused by clients connections
- - preventing the indy-node process from large memory usage as ZeroMQ creates the separate queue for each TCP connection.
-
 Instructions related to iptables setup can be found [here](https://github.com/hyperledger/indy-node/blob/master/docs/setup-iptables.md).
 
 #### Running Node

diff --git a/docs/source/_build/html/_sources/toc.rst.txt b/docs/source/_build/html/_sources/toc.rst.txt
diff --git a/docs/source/_build/html/add-node.html b/docs/source/_build/html/add-node.html
@@ -28,7 +28,7 @@
   <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="Continuous Integration / Delivery" href="ci-cd.html" />
+    <link rel="next" title="Current implemented rules in auth_map" href="auth_rules.html" />
     <link rel="prev" title="Create a Network and Start Nodes" href="start-nodes.html" /> 
 
 
@@ -91,6 +91,7 @@
 <li class="toctree-l2"><a class="reference internal" href="#make-sure-that-node-is-workable">Make sure that Node is workable</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="auth_rules.html">Current implemented rules in auth_map</a></li>
 <li class="toctree-l1"><a class="reference internal" href="ci-cd.html">Continuous Integration / Delivery</a></li>
 <li class="toctree-l1"><a class="reference internal" href="cluster-simulation.html">Running a Simulation of a Indy Cluster and Agents</a></li>
 <li class="toctree-l1"><a class="reference internal" href="helper-scripts.html">Helper Scripts</a></li>
@@ -231,7 +232,7 @@
 
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 
-        <a href="ci-cd.html" class="btn btn-neutral float-right" title="Continuous Integration / Delivery" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+        <a href="auth_rules.html" class="btn btn-neutral float-right" title="Current implemented rules in auth_map" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 
 
         <a href="start-nodes.html" class="btn btn-neutral" title="Create a Network and Start Nodes" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
-Original file line number
+Diff line change
@@ Expand Up / @@ -10,6 +10,7 @@ __pycache__/ @@
     # Distribution / packaging
     bin/
     build/
+    _build/
     develop-eggs/
     dist/
     eggs/
@@ Expand Down @@