Skip to content

Commit

Permalink
Merge pull request #559 from skycoin/jdknives-patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
jdknives authored Oct 19, 2020
2 parents 22a265c + 7cf41a7 commit 67af04e
Showing 1 changed file with 14 additions and 9 deletions.
23 changes: 14 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
[![Build Status](https://travis-ci.com/skycoin/skywire.svg?branch=master)](https://travis-ci.com/skycoin/skywire)

# Skywire Mainnet
# Skywire

- [Skywire Mainnet](#skywire)

- [Skywire](#skywire)
- [Build and run](#build-and-run)
- [Requirements](#requirements)
- [Build](#build)
- [Configure](#configure)
- [Configure](#conigure)
- [`stcp` setup](#stcp-setup)
- [`dmsgpty` setup](#dmsgpty-setup)
- [`hypervisor` setup](#hypervisor-setup)
Expand Down Expand Up @@ -90,11 +91,7 @@ In order to allow a hypervisor to access a visor,
the address and PubKey of the hypervisor needs to be configured first on the visor. Here is an example configuration:

```json
{
"hypervisors": [{
"public_key":"02b72766f0ebade8e06d6969b5aeedaff8bf8efd7867f362bb4a63135ab6009775"
}]
}
"hypervisors":["024a2dd77de324d543561a6d9e62791723be26ddf6b9587060a10b9ba498e096f1"],
```

### Run `skywire-visor`
Expand All @@ -104,7 +101,7 @@ that apps can use to implement communication protocols.
App binaries are spawned by the visor,
communication between visor and app is performed via unix pipes provided on app startup.

Note that `skywire-visor` requires a valid configuration file in order to execute.
Note that `skywire-visor` requires a valid configuration file in order to execute. If you want to run the VPN client application distributed with Skywire you need to run the following command with `sudo`

```bash
# Run skywire-visor. It takes one argument; the path of a configuration file (`skywire-config.json` if unspecified).
Expand Down Expand Up @@ -251,6 +248,14 @@ $ skywire-cli visor add-tp 0276ad1c5e77d7945ad6343a3c36a8014f463653b3375b6e02ebe
$ skywire-cli visor ls-tp
```

Currently there are 4 available transport types.

- [stcpr](https://github.com/skycoin/skywire/wiki/Transports#stcpr)
- [sudph](https://github.com/skycoin/skywire/wiki/Transports#sudph)
- [stcp](https://github.com/skycoin/skywire/wiki/Transports#stcp)
- [dmsg](https://github.com/skycoin/skywire/wiki/Transports#dmsg)


## Creating a GitHub release

To maintain actual `skywire-visor` state on users' Skywire nodes we have a mechanism for updating `skywire-visor` binaries.
Expand Down

0 comments on commit 67af04e

Please sign in to comment.