2019-01-28 20:19:08 +00:00
|
|
|
# Nucypher Quickstart
|
2019-01-22 20:05:34 +00:00
|
|
|
|
2019-01-24 00:46:48 +00:00
|
|
|
## Ursula
|
|
|
|
|
|
2019-01-28 20:19:08 +00:00
|
|
|
### Install Nucypher
|
2019-01-22 20:05:34 +00:00
|
|
|
|
2019-01-23 05:58:41 +00:00
|
|
|
```bash
|
2019-01-25 00:48:24 +00:00
|
|
|
$ pip3 install -U nucypher
|
2019-01-23 05:58:41 +00:00
|
|
|
```
|
2019-01-22 20:05:34 +00:00
|
|
|
|
2019-01-24 00:46:48 +00:00
|
|
|
### Run a Federated-Only Development Ursula
|
2019-01-22 20:05:34 +00:00
|
|
|
|
2019-01-23 05:58:41 +00:00
|
|
|
```bash
|
|
|
|
|
$ nucypher ursula run --dev --federated-only
|
|
|
|
|
```
|
2019-01-22 20:05:34 +00:00
|
|
|
|
2019-01-25 00:48:24 +00:00
|
|
|
### Configure a Persistent Ursula
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
$ nucypher ursula init --federated-only
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Run a Persistent Ursula
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
$ nucypher ursula run --teacher-uri <SEEDNODE_URI> --federated-only
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Replace `<SEEDNODE_URI>` with the URI of a node running on the network and domain you want
|
|
|
|
|
to connect to (for example `0.0.0.0:9151` or `0xdeadbeef@0.0.0.0:9151`).
|
|
|
|
|
|
2019-01-24 00:46:48 +00:00
|
|
|
### Run a Geth-Connected Development Ursula
|
2019-01-22 20:05:34 +00:00
|
|
|
|
2019-01-23 05:58:41 +00:00
|
|
|
Run a local geth node in development mode:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
$ geth --dev
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Run a local development Ursula connected to the geth node
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
$ nucypher ursula run --dev --provider-uri /tmp/geth.ipc --checksum-address <GETH_ADDRESS>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Replace `<GETH_ADDRESS>` with the geth node's public checksum address.
|
