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.
This UI build process can be run manually via the hyperglass CLI:
Or with the
--build CLI flag on startup:
The UI build will run automatically any time the hyperglass configuration or version changes.
web subsection contains multiple subsections of its own, should you wish to customize various aspects of the UI:
|Developer credit & GitHub Link||➡️|
|DNS over HTTPS Provider||➡️|
|Link to external site||➡️|
|Logo & Favicons||➡️|
|Terms & Conditions||➡️|
|Text, title, & names||➡️|
|Colors & Fonts||➡️|
|Boolean||Enable or disable the display of developer credit & link to hyperglass GitHub repository|
From the developer
If your organization's policy allows, and you don't mind, I request that you keep
credit enabled. Remember: my goal for this project is get more networks to use looking glasses to make all of our lives easier. Because it's primarily other network operators who will use this tool to begin with, I'd love for any operators that use your looking glass to know where they can get their own.
|String||DNS over HTTPS provider for in-browser DNS resolution. Cloudflare & Google supported. |
Must be cloudflare or google
|Boolean||Enable or disable the display of an external link|
|String||Target URL. |
|Boolean||Enable or disable the greeting modal.|
|String||Path to a markdown file containing the modal body content.|
If you're not familiar with OpenGraph, it's the thing that generates the pretty pictures, titles, and descriptions for links when you post them to sites/tools such as Facebook, Twitter, Slack, etc.
By default, this Opengraph image is set. If you define one with
image, hyperglass will automatically generate an Opengraph image using the following methodology:
- If the image is already 1200x630, it will be used
- If the image is or is not 1200x630, but contains transparency (like in a
.pngformatted image), it will be converted to a JPEG file with the
blackused as the background color.
|String||Path to opengraph image|
|Boolean||Enable or display the display of the help menu|
|String||Path to a plain text or markdown file with content to override the default help menu content|
|String||Help menu title|
|Boolean||Enable or display the display of terms & conditions|
|String||Path to a plain text or markdown file with content to override the default terms & conditions|
|String||Terms & conditions title|