Setup
After hyperglass is installed, you can run the hyperglass --help
command to see the available options:
#
Setup WizardTo start the setup wizard, run hyperglass setup
.
You'll receive the following prompts:
#
Installation Directoryhyperglass requires a directory on your system to store configuration files, the web UI, logos, etc. You may choose between the current user's home directory or /etc
(use the up/down arrow keys).
#
UI BuildAfter running the setup, the build-ui
command needs to be run for the first time. This command creates the required file structure for the UI, initializes frontend dependencies, and generates favicons.
caution
If your system's compute resources are too low, the build-ui
step will likely fail. You can use the --timeout
flag to increase the default timeout of 180 seconds. You can also set the environment variable HYPERGLASS_UI_BUILD_TIMEOUT
for the same result. See the system requirements section for more information about system resources.
#
StartupTo start hyperglass from the console run hyperglass start
.
important
hyperglass won't start without a devices.yaml
file. See the Adding Devices section for instructions on how add devices.
Production
Remember to check the Production section for instructions on how to run hyperglass in production. It includes instructions and examples for setting up a Reverse Proxy (such as NGINX or Caddy), and running hyperglass as a system service with systemd.