Getting Started

Automatic installation

If your system runs on:

  • Ubuntu Linux
  • CentOS/Red Had Linux
  • macOS (requires homebrew)

You should be able to proceed with the automatic installation:

$ curl | sudo bash
Piping to bash

You should be very worried when someone asks you to do what I just did. Downloading a bash script from the internet and piping it to bash with root privileges is a terrible idea, unless you fully trust the source. Please don't trust me - go look at the code and determine for your self if it's safe to execute. If you feel it's not, please proceed with the manual installation (and tell me why, so I can fix it).

Manual Installation

System Dependencies


hyperglass is written in Python 3 and requires Python version 3.6 as a minimum dependency.

If you're confident upgrading your system's version of Python won't break your system (many Linux operating systems rely heavily on Python for package management and other system functions), you can install Python 3.6:

$ sudo apt install -y python3.6-dev python3-pip redis-server

You can then verify your Python 3 version:

$ python3 --version
Python 3.6.9

Other Dependencies

The hyperglass UI is written in ReactJS. As such, some Javascript dependencies are required. hyperglass also relies on Redis for caching purposes.

$ curl -sL | sudo -E bash -
$ curl -sS | sudo apt-key add -
$ echo "deb stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
$ sudo apt update
$ sudo apt install -y nodejs yarn redis-server
From the Developer

I've attempted to abstract away most of the Javascript-related configuration and operational steps, because I think I might be the only network engineer on the planet who actually doesn't mind JS 😂. If you run into any issues with the NodeJS/Yarn installation processes, don't hesitate to raise an issue on Github, and I'll do my best to help out.


$ pip3 install hyperglass