1
0
mirror of https://github.com/checktheroads/hyperglass synced 2024-05-11 05:55:08 +00:00

87 lines
4.3 KiB
Markdown
Raw Normal View History

2020-02-25 11:00:27 -07:00
<div align="center">
<br/>
2021-01-03 10:31:39 -07:00
<img src="https://res.cloudinary.com/hyperglass/image/upload/v1593916013/logo-light.svg" width=300></img>
2020-02-25 11:00:27 -07:00
<br/>
2020-02-29 08:06:18 -07:00
<h3>The network looking glass that tries to make the internet better.</h3>
<br/>
2020-02-25 11:00:27 -07:00
A looking glass is implemented by network operators as a way of providing customers, peers, or the general public with a way to easily view elements of, or run tests from the provider's network.
</div>
2019-06-10 13:06:55 -07:00
2020-02-25 11:00:27 -07:00
<hr/>
2019-06-24 14:03:11 -07:00
<div align="center">
2019-05-07 23:21:41 -07:00
2021-05-31 18:31:14 -07:00
[**Documentation**](https://hyperglass.dev)&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;[**Live Demo**](https://demo.hyperglass.dev/)
2020-02-25 11:00:27 -07:00
[![PyPI](https://img.shields.io/pypi/v/hyperglass?style=for-the-badge)](https://pypi.org/project/hyperglass/)
2020-03-29 20:10:05 -07:00
![PyPI - Downloads](https://img.shields.io/pypi/dm/hyperglass?color=%2340798C&style=for-the-badge)
2021-06-23 19:22:30 -07:00
[![GitHub Contributors](https://img.shields.io/github/contributors/thatmattlove/hyperglass?color=40798C&style=for-the-badge)](https://github.com/thatmattlove/hyperglass)
2019-05-07 23:21:41 -07:00
2022-12-26 10:12:26 -05:00
[![Frontend Tests](https://img.shields.io/github/actions/workflow/status/thatmattlove/hyperglass/frontend.yml?label=Frontend%20Tests&style=for-the-badge)](https://github.com/thatmattlove/hyperglass/actions/workflows/frontend.yml)
[![Backend Tests](https://img.shields.io/github/actions/workflow/status/thatmattlove/hyperglass/backend.yml?label=Backend%20Tests&style=for-the-badge)](https://github.com/thatmattlove/hyperglass/actions/workflows/backend.yml)
[![Installer Tests](https://img.shields.io/github/actions/workflow/status/thatmattlove/hyperglass/installer.yml?label=Installer%20Tests&style=for-the-badge)](https://github.com/thatmattlove/hyperglass/actions/workflows/installer.yml)
2020-02-29 08:06:18 -07:00
<br/>
hyperglass is intended to make implementing a looking glass too easy not to do, with the lofty goal of improving the internet community at large by making looking glasses more common across autonomous systems of any size.
2019-06-24 14:03:11 -07:00
2020-02-29 08:06:18 -07:00
</div>
2019-06-24 14:03:11 -07:00
2021-06-23 19:22:30 -07:00
### [Changelog](https://github.com/thatmattlove/hyperglass/blob/v1.0.0/CHANGELOG.md)
2019-05-07 23:21:41 -07:00
## Features
2020-02-25 11:00:27 -07:00
- BGP Route, BGP Community, BGP AS Path, Ping, & Traceroute
- Full IPv6 support
- Customizable everything: features, theme, UI/API text, error messages, commands
- Built in support for:
2020-10-18 12:15:13 -07:00
- Arista EOS
- BIRD
- Cisco IOS-XR
2020-02-25 11:00:27 -07:00
- Cisco IOS/IOS-XE
2020-04-28 09:14:41 -07:00
- Cisco NX-OS
2020-10-18 12:15:13 -07:00
- FRRouting
2020-02-25 11:00:27 -07:00
- Huawei
2020-10-18 12:15:13 -07:00
- Juniper JunOS
2020-10-05 15:02:42 -07:00
- Mikrotik
2021-01-18 14:06:03 -07:00
- Nokia SR OS
2020-10-18 12:15:13 -07:00
- TNSR
2020-07-04 19:30:46 -07:00
- VyOS
2021-05-31 18:31:14 -07:00
- Configurable support for any other [supported platform](https://hyperglass.dev/docs/platforms)
2020-02-25 11:00:27 -07:00
- Optionally access devices via an SSH proxy/jump server
- VRF support
- Access List/prefix-list style query control to whitelist or blacklist query targets on a per-VRF basis
- REST API with automatic, configurable OpenAPI documentation
2021-01-01 01:45:39 -07:00
- Modern, responsive UI built on [ReactJS](https://reactjs.org/), with [NextJS](https://nextjs.org/) & [Chakra UI](https://chakra-ui.com/), written in [TypeScript](https://www.typescriptlang.org/)
2020-02-25 11:00:27 -07:00
- Query multiple devices simultaneously
- Browser-based DNS-over-HTTPS resolution of FQDN queries
2021-06-23 19:22:30 -07:00
*To request support for a specific platform, please [submit a Github Issue](https://github.com/thatmattlove/hyperglass/issues/new) with the **feature** label.*
2020-02-25 11:00:27 -07:00
2021-05-31 18:31:14 -07:00
### [Get Started →](https://hyperglass.dev/docs/introduction)
2019-05-07 23:21:41 -07:00
2019-06-24 14:03:11 -07:00
## Community
- [Slack](https://netdev.chat/)
2020-06-27 12:20:15 -07:00
- [Telegram](https://t.me/hyperglasslg)
2020-02-25 11:00:27 -07:00
Any users, potential users, or contributors of hyperglass are welcome to join and discuss usage, feature requests, bugs, and other things.
2019-06-24 14:03:11 -07:00
**hyperglass is developed with the express intention of being free to the networking community**.
2019-05-07 23:21:41 -07:00
2021-05-31 18:31:14 -07:00
*However, if you're feeling particularly helpful or generous, small donations are welcome.*
2019-06-19 08:58:50 -07:00
2020-02-25 11:00:27 -07:00
[![Donate](https://img.shields.io/badge/Donate-blue.svg?logo=paypal&style=for-the-badge)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=ZQFH3BB2B5M3E&source=url)
2019-06-19 08:58:50 -07:00
2021-01-03 10:31:39 -07:00
## Acknowledgements
2021-01-03 10:31:39 -07:00
hyperglass is built entirely on open-source software. Here are some of the awesome libraries used, check them out too!
- [FastAPI](https://fastapi.tiangolo.com/)
- [Netmiko](https://github.com/ktbyers/netmiko)
- [Scrapli](https://github.com/carlmontanari/scrapli)
- [Pydantic](https://pydantic-docs.helpmanual.io/)
- [Chakra UI](https://chakra-ui.com/)
2021-06-23 19:22:30 -07:00
[![GitHub](https://img.shields.io/github/license/thatmattlove/hyperglass?color=330036&style=for-the-badge)](https://github.com/thatmattlove/hyperglass/blob/v1.0.0/LICENSE)