Installation

Installation

The repository includes Docker and manual installation paths. Docker is the quickest way to try Ultraglass with the sample configuration.

Docker

git clone https://github.com/WilhelmZA/ultraglass.git --depth=1
cd ultraglass
mkdir -p /etc/hyperglass
cp .samples/sample_devices.yaml /etc/hyperglass/devices.yaml
docker compose up

Open http://localhost:8001 after the containers start. The sample device returns fake output and does not connect to a network device.

See the full Docker guide for production setup.

Manual installation

Manual installation requires Python 3.13 or later, Node.js 22 or later, pnpm 11, and Redis 7. Follow the manual installation guide for the complete procedure.