Skip to content

Commit

Permalink
Merge pull request #2
Browse files Browse the repository at this point in the history
Release v0.1.1
  • Loading branch information
bsrinivas8687 authored Jun 25, 2021
2 parents 1d4abf3 + 136d3dc commit 5ca7358
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 11 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
PACKAGES := $(shell go list ./...)
VERSION := $(shell git rev-parse --short HEAD)
VERSION := $(shell echo $(shell git describe --tags) | sed 's/^v//')
COMMIT := $(shell git log -1 --format='%H')

BUILD_TAGS := $(strip netgo,ledger)
Expand Down
37 changes: 27 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,33 +7,41 @@

Download the latest version of CLI client software from the releases section [here](https://github.com/sentinel-official/dvpn-node/releases/latest "here").

## Install WireGuard
## Install dependencies

### Linux

```sh
sudo apt-get update && \
sudo apt install wireguard-tools
sudo apt-get install resolvconf wireguard-tools
```

### Mac

```sh
TBU
brew install wireguard-tools
```

or

```sh
port install wireguard-tools
```

## Connect to a dVPN node

1. Create or recover a key

Need not perform this step again in case you have already done it once.

```sh
sentinelcli keys add \
--home "${HOME}/.sentinelcli" \
--keyring-backend file \
<KEY_NAME>
```

Pass flag `--recover` to recover the key
Pass flag `--recover` to recover the key.

2. Query the active nodes and choose one

Expand All @@ -50,16 +58,26 @@ TBU
3. Subscribe to a node

```sh
sudo sentinelcli subscription subscribe-to-node \
sentinelcli tx subscription subscribe-to-node \
--home "${HOME}/.sentinelcli" \
--keyring-backend file \
--chain-id sentinelhub-2 \
--node https://rpc.sentinel.co:443 \
--from <KEY_NAME> \
<NODE_ADDRESS> <DEPOSIT>
--from <KEY_NAME> <NODE_ADDRESS> <DEPOSIT>
```

4. Query the active subscriptions of your account address

```sh
sentinelcli query subscriptions \
--home "${HOME}/.sentinelcli" \
--node https://rpc.sentinel.co:443 \
--status Active \
--page 1 \
--address <ACCOUNT_ADDRESS>
```

4. Connect
5. Connect

```sh
sudo sentinelcli connect \
Expand All @@ -68,8 +86,7 @@ TBU
--chain-id sentinelhub-2 \
--node https://rpc.sentinel.co:443 \
--yes \
--from <KEY_NAME> \
<SUBSCRIPTION_ID> <NODE_ADDRESS>
--from <KEY_NAME> <SUBSCRIPTION_ID> <NODE_ADDRESS>
```

## Disconnect from a dVPN node
Expand Down

0 comments on commit 5ca7358

Please sign in to comment.