Local Development Fleet Testing¶
Currently only “Federated Only” mode is supported for local fleets
- All Demo Ursulas:
- Run on
- On the
- Using temporary resources (files, database, etc.)
- Run on
Running A Local Fleet¶
- Install Nucypher
Acquire the Nucypher application code and install the dependencies. For a full installation guide see the Installation Guide.
- Run a Lonely Ursula
The first step is to launch the first Ursula on the network by running:
$ python run_lonely_demo_ursula.py
- This will start an Ursula node:
- With seednode discovery disabled
- On port
- Run a Local Fleet of Ursulas
Next, launch subsequent Ursulas, informing them of the first Ursula:
$ python run_demo_ursula_fleet.py
- This will run 5 temporary Ursulas that:
- All specify the lonely Ursula as a seednode
- Run on ports
- Run an Entry-Point Ursula (Optional)
While the local fleet is running, you may want an entry-point to introspect the code in a debugger.
For this we provide the optional script
run_single_demo_ursula.py for your convenience.
$ python run_single_demo_ursula.py
This will run a single temporary Ursula:
- That specifies a random fleet node as a teacher
- On a random available port
Connecting to the Local Fleet¶
Alternately, you can connect any node run from the CLI by specifying one of the nodes
in the local fleet as a teacher, the same network domain, and the same operating mode.
By default, nodes started with the
--dev flag run on a dedicated domain (
on a different port than the production default port (
Local fleet Ursulas range from ports
11506 by default.
Here is an example of connecting to a node in the local development fleet:
nucypher ursula run --dev --teacher-uri localhost:11501
The local development fleet is an example meant to demonstrate how to design and use your own local fleet.