Home

Welcome to the Skywire wiki!

Organization

• Important: Skywire Mainnet Rules Article
• ̶S̶k̶y̶w̶i̶r̶e̶ ̶W̶h̶i̶t̶e̶l̶i̶s̶t̶i̶n̶g̶ ̶S̶y̶s̶t̶e̶m̶
• ̶S̶k̶y̶w̶i̶r̶e̶ ̶A̶u̶t̶h̶e̶n̶t̶i̶c̶a̶t̶i̶o̶n̶ ̶S̶y̶s̶t̶e̶m̶

---

Setup

Software

• Skywire Package Installation
• Skywire Binary Installation
• Run Skywire from Source

Hypervisor

• Run HypervisorUI on local machine
• Run HypervisorUI on manager board

VPN

• Skywire VPN Client
• Skywire VPN Server

Socks Proxy

• Skywire SOCKS5 Proxy User Guide
• SSH over SOCKS5 Proxy

Skyfwding

• Forward Ports Over Skywire

Dmsg

• dmsgpty-cli
• dmsghttp
• dmsgweb (proposed #229)
• dmsghttp-logserver

Skyminer

• Skybian User Guide
• Official Skyminer Guide
• Official Skyminer Wiring
• Networking Guide Official Skyminer

Android

• Skywire on android via termux

Other

• Troubleshooting
• Skywire Mainnet Update FAQ
• Skyminer setup from base Armbian or Raspbian

Old Documentation

• ̶U̶p̶g̶r̶a̶d̶i̶n̶g̶ ̶S̶k̶y̶m̶i̶n̶e̶r̶ ̶V̶i̶s̶o̶r̶s̶ ̶t̶o̶ ̶S̶k̶y̶b̶i̶a̶n̶ ̶v̶0̶.̶4̶.̶1̶
• ̶S̶k̶y̶i̶m̶a̶g̶e̶r̶ ̶U̶s̶e̶r̶ ̶G̶u̶i̶d̶e̶

---

Skywire Overview

Skywire is a Software Defined Network. It separates the Data Plane from the Control Plane of the network. Skywire currently functions as an overlay network that allows nodes to establish routes to each other by PubKey but it will be able to establish local networks that function independently of the Internet. There are several prototype applications built that use the Skywire network such as:

• Skychat
• SOCKS5 proxy client & server
• VPN client & server

Skywire Data Plane

The main software module making up the Skywire network is called the skywire-visor.

• A visor is identified by a unique PubKey.

Data or connections may be encrypted to the visor's public key, which can then be decrypted with the secret key.

The public key of the visor represents a dmsg client. Dmsg clients can connect to each other over the dmsg network, and as such the visor is able to connect to the services directly over dmsghttp when using a dmsghttp-config.

• A visor acts as a gateway to the Skywire network

Visors can establish transports to other visors and request or provide routes to remote visors over the Skywire network.

• A visor can host apps and exposes an API for applications to use the network.

Current applications include:

• vpn server
• vpn client
• proxy server
• proxy client
• skychat

Skywire Control Plane

The Skywire Control Plane is responsible for establishing routes between Skywire visors. It consists of separate services. The deployment is currently documented in skywire-deployment:

• address-resolver
• dmsg-discovery
• dmsg-server
• transport-discovery
• route-finder
• service-discovery
• setup-node

The visors requests routes from the control plane ; the control plane is responsible for:

• Determining efficient paths through the network and establishing a route by delivering routing rules to the visors along a route.

The control plane, specifically the transport discovery, maintains an overview over the network topology by storing the transports between visors that currently exist in a given network. The record of these transports is not persisted, except locally in transport logs, which are used for reward calculations.