Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 2.86 KB

NOTE.md

File metadata and controls

51 lines (33 loc) · 2.86 KB

NOTES ON THE SKYWIRE DEBIAN PACKAGE

updated 5-17-2020

The skywire package now includes only binaries and systemd service files. The helper / autoconfiguration scripts are now in the skybian-skywire package

Skywire manual configuration steps:

Create visor or hypervisor .json config file (at the path and name which they are found in Skybian)

skywire-hypervisor gen-config -ro /etc/skywire-hypervisor.json

and / or

skywire-cli visor gen-config -ro /etc/skywire-visor.json

Refer to the skywire-mainnet readme for setting the hypervisor key in the /etc/skywire-visor.json visor configuration file!

NOTES ON THE SKYBIAN-SKYWIRE DEBIAN PACKAGE

The skybian skywire package includes the skybian-firstrun script and the skybian-firstrun systemd service file which are provided with skybian; and additionally the skyconf binary.

The aforementioned script / service / binary are meant to work in conjunction with images which have been prepared with skyimager.

The skybian-skywire package now also includes scripts to configure the hypervisor public key on the visors - which does not require using an image which was processed by skyimager. Currently these two methods of autoconfiguration are not cross-compatible.

All these scripts may be run directly from the terminal by typing the name of the script (i.e. skywire) NOTE: not all scripts require being run directly as they may be called by other scripts

These scripts and their functions are as follows:

  • skywire script will configure either a hypervisor and visor or just a visor.
  • local-deb-repo a script which is called by the skywire script to create a local debian package repo and add the package with the hypervisor public key (the hypervisorkey package)
  • remote-deb-repo script will configure the repo which was created by local-deb-repo on the hypervisor. The hypervisor's IP address must be provided when running this script
  • readonlycache a golang binary for a very simple webserver which hosts the local package repository on the hypervisor at port 8079. This binary is called by the local-deb-repo script

IMPORTANT NOTE: when configuring a visor using these scripts, you must first run remote-deb-repo to configure the package repository on visors. You must then do apt update and install the hypervisorkey package with apt install hypervisorkey

Then you may run skywire and the hypervisor's public key will be parsed into the visor's config.json.

These scripts are a work in progress and if you have difficulty you may use the manual method detailed at the beginning of this document.

NOTES ON THE SKYBIAN PACKAGE

The skybian package includes all the other configurations which are added to skybian during the build. This package is not required to be installed for skywire to function.