witine/lookingglass
1
0
Fork 0
forked from mirrors/thatmattlove-hyperglass
Code Issues Pull requests Releases Activity

update readme

Browse source
This commit is contained in:
thatmattlove 2024-05-28 13:30:04 -04:00
parent 11c94d5713
commit 8598727814
1 changed files with 23 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

52
README.md
View file

@ -13,13 +13,8 @@
[**Documentation**](https://v2.hyperglass.dev)   |   [**Live Demo**](https://demo.hyperglass.dev/) [**Documentation**](https://v2.hyperglass.dev)   |   [**Live Demo**](https://demo.hyperglass.dev/)
[![PyPI](https://img.shields.io/pypi/v/hyperglass?style=for-the-badge)](https://pypi.org/project/hyperglass/) [![Frontend Tests](https://img.shields.io/github/actions/workflow/status/thatmattlove/hyperglass/frontend.yml?branch=v2.0.0&label=Frontend%20Tests&style=for-the-badge)](https://github.com/thatmattlove/hyperglass/actions/workflows/frontend.yml)
![PyPI - Downloads](https://img.shields.io/pypi/dm/hyperglass?color=%2340798C&style=for-the-badge) [![Backend Tests](https://img.shields.io/github/actions/workflow/status/thatmattlove/hyperglass/backend.yml?branch=v2.0.0&label=Backend%20Tests&style=for-the-badge)](https://github.com/thatmattlove/hyperglass/actions/workflows/backend.yml)
[![GitHub Contributors](https://img.shields.io/github/contributors/thatmattlove/hyperglass?color=40798C&style=for-the-badge)](https://github.com/thatmattlove/hyperglass)
[![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)
<br/> <br/>
@ -27,30 +22,30 @@ hyperglass is intended to make implementing a looking glass too easy not to do,
</div> </div>
### [Changelog](https://github.com/thatmattlove/hyperglass/blob/v1.0.0/CHANGELOG.md) ### [Changelog](https://github.com/thatmattlove/hyperglass/blob/v2.0.0/CHANGELOG.md)
## Features ## Features
- BGP Route, BGP Community, BGP AS Path, Ping, & Traceroute - BGP Route, BGP Community, BGP AS Path, Ping, & Traceroute, or [add your own commands](https://v2.hyperglass.dev/configuration/directives).
- Full IPv6 support - Full IPv6 support
- Customizable everything: features, theme, UI/API text, error messages, commands - Customizable everything: features, theme, UI/API text, error messages, commands
- Built in support for: - Built-in support for:
- Arista EOS - Arista EOS
- BIRD - BIRD
- Cisco IOS-XR - Cisco IOS
- Cisco IOS/IOS-XE - Cisco NX-OS
- Cisco NX-OS - Cisco IOS-XR
- FRRouting - FRRouting
- Huawei - Huawei VRP
- Juniper JunOS - Juniper Junos
- Mikrotik - Mikrotik
- Nokia SR OS - Nokia SR OS
- TNSR - OpenBGPD
- VyOS - TNSR
- Configurable support for any other [supported platform](https://hyperglass.dev/docs/platforms) - VyOS
- Configurable support for any other [supported platform](https://v2.hyperglass.dev/platforms)
- Optionally access devices via an SSH proxy/jump server - Optionally access devices via an SSH proxy/jump server
- VRF support - Access-list/prefix-list style query control to whitelist or blacklist query targets
- 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 - 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/), written in [TypeScript](https://www.typescriptlang.org/) - 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/)
- Query multiple devices simultaneously - Query multiple devices simultaneously
@ -77,10 +72,9 @@ Any users, potential users, or contributors of hyperglass are welcome to join an
hyperglass is built entirely on open-source software. Here are some of the awesome libraries used, check them out too! 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) - [Netmiko](https://github.com/ktbyers/netmiko)
- [Scrapli](https://github.com/carlmontanari/scrapli) - [Litestar](https://litestar.dev)
- [Pydantic](https://pydantic-docs.helpmanual.io/) - [Pydantic](https://docs.pydantic.dev/latest/)
- [Chakra UI](https://chakra-ui.com/) - [Chakra UI](https://chakra-ui.com/)
[![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) [![GitHub](https://img.shields.io/github/license/thatmattlove/hyperglass?color=330036&style=for-the-badge)](https://github.com/thatmattlove/hyperglass/blob/v2.0.0/LICENSE)