Update demo documentation about the use of the demo fleet in the examples/ directory.

pull/2256/head
derekpierre 2020-09-16 16:25:54 -04:00
parent 11a9eba376
commit 46ecc6ca1d
5 changed files with 41 additions and 18 deletions

View File

@ -7,11 +7,6 @@ Finnegan's Wake Demo
Overview
--------
.. important::
This demo requires connecting to a running network. By default the demo is hardcoded to connect to the :doc:`local demo fleet </demos/local_fleet_demo>`.
This demo is an example of a NuCypher decentralized network allowing Alice to share
data with Bob using proxy re-encryption. This enables the private sharing of data across public consensus networks,
without revealing data keys to intermediary entities.
@ -42,6 +37,16 @@ Install NuCypher
Acquire the ``nucypher`` application code and install the dependencies.
For a full installation guide see the :doc:`/guides/installation_guide`.
Run a fleet of federated Ursulas
--------------------------------
Run the local fleet of federated Ursulas in a separate terminal. This provides a network of 12 federated
Ursulas.
.. code::
(nucypher)$ python examples/run_demo_ursula_fleet.py
Download the Book Text
----------------------
For your convenience we have provided a bash script to acquire the "Finnegan's Wake" text. However,

View File

@ -7,11 +7,6 @@ Heartbeat Demo
Overview
--------
.. important::
This demo requires connecting to a running network. By default the demo is hardcoded to connect to the :doc:`local demo fleet </demos/local_fleet_demo>`.
Alicia has a Heart Monitor device that measures her heart rate and outputs this data in encrypted form.
Since Alicia knows that she may want to share this data in the future, she uses NuCypher to create
a *policy public key* for her Heart Monitor to use, so she can read and delegate access to the encrypted
@ -68,13 +63,19 @@ For a full installation guide see the :doc:`/guides/installation_guide`.
Run the Demo
------------
Assuming you already have ``nucypher`` installed with the ``demos`` extra
and a :doc:`local fleet of Ursulas </demos/local_fleet_demo>` alive,
running the Heartbeat demo only involves executing the
``alicia.py`` and ``doctor.py`` scripts, contained in the
``examples/heartbeat_demo`` directory.
Assuming you already have ``nucypher`` installed with the ``demos`` extra,
running the Heartbeat demo only involves running a local fleet of federated Ursulas in the ``examples/`` directory,
and executing the ``alicia.py`` and ``doctor.py`` scripts contained in the ``examples/heartbeat_demo`` directory.
First, run ``alicia.py``:
First, run the local fleet of federated Ursulas in a separate terminal:
.. code::
(nucypher)$ python examples/run_demo_ursula_fleet.py
This provides a network of 12 local federated Ursulas.
Next, from the ``examples/heartbeat_demo`` directory, run ``alicia.py``:
.. code::

View File

@ -7,6 +7,9 @@ Local Development Fleet Testing
Overview
--------
To aid in application development, a network of federated Ursulas can be run locally. These Ursulas do not utilize
blockchain functionality, but afford the same cryptographic capabilities of the public NuCypher network.
.. note::
Currently only "Federated Only" mode is supported for local fleets

View File

@ -11,6 +11,11 @@ without revealing private keys to intermediary entities.
5. Bob receives and reconstructs the Enrico from Policy public key and Enrico public key
6. Bob retrieves the original message from Enrico and MessageKit
### Run a fleet of federated Ursulas
`python3 ../run_demo_ursula_fleet.py`
### Download the Book!
`./download_finnegans_wake.sh`

View File

@ -27,8 +27,17 @@ This simple use case showcases many interesting and distinctive aspects of NuCyp
he only needs the encrypted data and some policy metadata.
### How to run the demo
Assuming you already have `nucypher` installed and a local demo fleet of Ursulas deployed,
running the demo only involves running the `alicia.py` and `doctor.py` scripts. You should run `alicia.py` first:
Ensure that you already have `nucypher` installed.
Run a fleet of federated Ursulas in a separate terminal:
```sh
(nucypher)$ python examples/run_demo_ursula_fleet.py
```
This will create a local network of federated Ursulas that will be used by the demo for re-encryption of data.
Subsequently, running the demo only involves running the `alicia.py` and `doctor.py` scripts.
You should run `alicia.py` first:
```sh
(nucypher)$ python examples/heartbeat_demo/alicia.py