bin/tau: update README and taud_config

This commit is contained in:
Dastan-glitch
2022-05-04 01:15:15 +03:00
parent 93a2fc7722
commit 62cb7fc9a4
2 changed files with 22 additions and 2 deletions

View File

@@ -1,6 +1,6 @@
# Tau
Tasks management app using peer-to-peer network and raft consensus.
Encrypted tasks management app using peer-to-peer network and raft consensus.
multiple users can collaborate by working on the same tasks, and all users will have synced task list.
@@ -10,7 +10,7 @@ multiple users can collaborate by working on the same tasks, and all users will
% git clone https://github.com/darkrenaissance/darkfi
% cd darkfi
% make BINS="taud tau"
% make install "BINS=taud tau" PREFIX=/home/XX/.local
% make install "BINS=taud tau" PREFIX=/home/${USER}/.local
```
## Usage (Local Deployment)
@@ -32,6 +32,23 @@ seed node shouldn't be advertised in the list of connectable nodes. The seed
node does not participate as a normal node in the p2p network. It simply allows
new nodes to discover other nodes in the network during the bootstrapping phase.
Also note that for the first time ever running seed node you must run it with
`--key-gen`:
```shell
% taud --key-gen
```
This will generate a new secret key in `/home/${USER}/.config/tau/secret_key` that
you can share with nodes you want them to get and decrypt your tasks, otherwise if you
have already generated or got a copy from a peer place it either in the same directory
`/home/${USER}/.config/tau/secret_key`, or in the config file.
in config file:
## Secret key
key="SECRET_KEY_GOES_HERE"
DO NOT use `--key` in terminal to pass the secret key.
### Inbound Node
This is a node accepting inbound connections on the network but which is not

View File

@@ -4,6 +4,9 @@
## Sets Datastore Path
#datastore="~/.config/tau"
## Secret key
#key=""
## Raft net settings
[net]
## P2P accept address