From 59504beeb7ae4170c024f6770bb28bc5c3863e7c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Erich=20K=C3=A4stner?= <36450093+jdknives@users.noreply.github.com> Date: Mon, 19 Oct 2020 15:29:50 +0300 Subject: [PATCH] Update README.md --- README.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index c1114dcd05..efaa999e89 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ [![Build Status](https://travis-ci.com/skycoin/skywire.svg?branch=master)](https://travis-ci.com/skycoin/skywire) -# Skywire Mainnet +# Skywire -- [Skywire Mainnet](#skywire-mainnet) +- [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) @@ -81,17 +81,14 @@ In the above example, we have two other visors running on localhost (that we wis Every node can be controlled by one or more hypervisors. The hypervisor allows to control and configure multiple visors. 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", - "address":"127.0.0.1:7080" - }], + "hypervisors":["024a2dd77de324d543561a6d9e62791723be26ddf6b9587060a10b9ba498e096f1"], ``` ### Run `skywire-visor` `skywire-visor` hosts apps, proxies app's requests to remote visors and exposes communication API 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). @@ -143,6 +140,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.