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

80 lines
4.0 KiB
Markdown
Raw Normal View History

2020-02-25 11:00:27 -07:00
<div align="center">
<br/>
<img src="logo.png" width=300></img>
<br/>
2020-02-29 08:06:18 -07:00
<h3>The network looking glass that tries to make the internet better.</h3>
2020-02-25 11:00:27 -07:00
<br/>
<div style="color: #808080;">
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>
</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
2020-02-25 11:00:27 -07:00
[**Documentation**](https://hyperglass.io)&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;[**Screenshots**](https://hyperglass.io/screenshots)&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;[**Live Demo**](https://hyperglass.allroads.io/)
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)
[![CI](https://img.shields.io/travis/checktheroads/hyperglass/v1.0.0?style=for-the-badge)](https://travis-ci.org/checktheroads/hyperglass)
2020-02-25 11:00:27 -07:00
[![GitHub Contributors](https://img.shields.io/github/contributors/checktheroads/hyperglass?color=40798C&style=for-the-badge)](https://github.com/checktheroads/hyperglass)
[![Gitter](https://img.shields.io/gitter/room/checktheroads/hyperglass?color=ff5e5b&style=for-the-badge)](https://gitter.im/hyperglass)
2020-03-29 20:10:05 -07:00
[![Telegram](https://img.shields.io/badge/chat-telegram-blue?style=for-the-badge&color=blue&logo=telegram)](https://t.me/hyperglasslg)
2019-05-07 23:21:41 -07:00
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
<br/>
2019-06-24 14:03:11 -07:00
2020-02-29 08:06:18 -07:00
⚠️ **v1.0.0** *is currently in beta. While everything should work, some things might not. Documentation and the live demo are not yet complete. For a fully working and documented version of hyperglass, **please go to the [master branch](https://github.com/checktheroads/hyperglass/tree/master)**.*
</div>
2019-06-24 14:03:11 -07:00
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:
- Cisco IOS/IOS-XE
2020-04-28 09:14:41 -07:00
- Cisco NX-OS
2020-02-25 11:00:27 -07:00
- Cisco IOS-XR
- Juniper JunOS
- Arista EOS
- Huawei
- FRRouting
- BIRD
- Configurable support for any other [supported platform](https://hyperglass.io/docs/platforms)
- 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
- Modern, responsive UI built on [ReactJS](https://reactjs.org/), with [NextJS](https://nextjs.org/) & [Chakra UI](https://chakra-ui.com/)
- Query multiple devices simultaneously
- Browser-based DNS-over-HTTPS resolution of FQDN queries
*To request support for a specific platform, please [submit a Github Issue](https://github.com/checktheroads/hyperglass/issues/new) with the **enhancement** label.*
2020-02-29 08:06:18 -07:00
### [Get Started →](https://hyperglass.io/)
2019-05-07 23:21:41 -07:00
2019-06-24 14:03:11 -07:00
## Community
2020-02-25 11:00:27 -07:00
- [Gitter](https://gitter.im/hyperglass)
- [Keybase](https://keybase.io/team/hyperglass)
- [Twitter](https://twitter.com/checktheroads)
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
2020-02-29 08:06:18 -07:00
*However, the hyperglass demo does cost [@checktheroads](https://github.com/checktheroads) about $15/month for 3 Digital Ocean droplets, and $60/year for the [hyperglass.io](https://hyperglass.io) domain. If you're feeling particularly helpful and want to help offset that cost, 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
2019-05-07 23:21:41 -07:00
## License
2020-02-25 11:00:27 -07:00
[Clear BSD License](https://github.com/checktheroads/hyperglass/v1.0.0/LICENSE)