After hyperglass is installed, you can run the
hyperglass --help command to see the available options:
To start the setup wizard, run
hyperglass setup and you'll receive the following prompts:
hyperglass 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
hyperglass can install example configuration files to your hyperglass installation directory to make it a little easier to get up and running.
hyperglass also includes a systemd service file, which can be installed if you use systemd. If selected, a systemd service file will be generated and copied to the installation directory. Then, it will be symlinked to
/etc/systemd/system. All you need to do to enable the service is run:
hyperglass is build with NextJS, a React-based UI framework that supports server-side rendering and static exporting, which contribute to hyperglass's speed and SEO-friendliness. At startup, hyperglass creates a new "UI build", which is a static export of the site and includes some elements of the configuration.
It is recommended to run an initial UI build after running the setup wizard, so that you can verify that the installation is working prior to diving into configuration.
The UI build will run automatically any time the hyperglass configuration or version changes.