Skip to content

Commit

Permalink
Update dispatcher readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tsudmi authored Jan 22, 2021
1 parent 3889788 commit 836eb74
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions dispatcher/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,13 @@ The dispatcher simplifies the communication between the horcruxes.
It should be deployed on a machine that is reachable by every participating horcrux.
The dispatcher transmits secret shares between horcruxes.
All the messages are encrypted with the RSA public key of the recipient, so there is no way for a dispatcher to access the secret data.
In order for the participants to interact with the dispatcher, they must provide `AUTHENTICATION_KEY`.

# Local setup

Run the following command from the home directory to start the dispatcher locally:
```shell script
DATABASE_PATH=sqlite:///./dispatcher.db uvicorn dispatcher.main:app --reload
AUTHENTICATION_KEY=securekey DATABASE_PATH=sqlite:///./dispatcher.db uvicorn dispatcher.main:app --reload
```

# Remote access
Expand All @@ -19,7 +20,7 @@ to allow other horcruxes to connect to your locally running dispatcher.

Run the following command in first terminal window:
```shell script
DATABASE_PATH=sqlite:///./dispatcher.db uvicorn dispatcher.main:app --reload
AUTHENTICATION_KEY=securekey DATABASE_PATH=sqlite:///./dispatcher.db uvicorn dispatcher.main:app --reload
```

Run the following command in second terminal window:
Expand Down

0 comments on commit 836eb74

Please sign in to comment.