malhuda/photonglass
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

update readme

Browse Source
This commit is contained in:
Micky 2024-12-26 12:43:51 +11:00
parent fabc744e81
commit 438cb99c46
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -9,6 +9,7 @@ https://photonglass.dev
## Features ## Features
- **Multi Device Support**: Connect to multiple devices from one single interface. - **Multi Device Support**: Connect to multiple devices from one single interface.
- **Easy Deployment**: Extremely easy to deploy and scale with multiple devices. - **Easy Deployment**: Extremely easy to deploy and scale with multiple devices.
- **Webhook Logging**: Log queries to a webhook channel (optional).
## Setup (Docker) ## Setup (Docker)
1. Clone repository 1. Clone repository
@ -49,11 +50,14 @@ footer:
text: "photonglass" text: "photonglass"
peeringdb_href: "https://www.peeringdb.com" peeringdb_href: "https://www.peeringdb.com"
github_href: "https://github.com/alimickey" github_href: "https://github.com/alimickey"
webhook:
url: "https://hooks.slack.com/###"
``` ```
### instance/commands.yaml ### instance/commands.yaml
``` ```
- id: "ping" ping:
display_name: "Ping" display_name: "Ping"
format: "ping -{ip_version} -c 4 {target}" format: "ping -{ip_version} -c 4 {target}"
description: "Test network connectivity" description: "Test network connectivity"
@ -61,7 +65,7 @@ footer:
type: "text" type: "text"
placeholder: "Enter IP address or hostname" placeholder: "Enter IP address or hostname"
- id: "traceroute" traceroute:
display_name: "Traceroute" display_name: "Traceroute"
format: "traceroute -{ip_version} {target}" format: "traceroute -{ip_version} {target}"
description: "Trace network path to destination" description: "Trace network path to destination"
@ -69,7 +73,7 @@ footer:
type: "text" type: "text"
placeholder: "Enter IP address or hostname" placeholder: "Enter IP address or hostname"
- id: "mtr" mtr:
display_name: "MTR" display_name: "MTR"
format: "mtr -{ip_version} -r {target}" format: "mtr -{ip_version} -r {target}"
description: "Trace network path with stats" description: "Trace network path with stats"
@ -80,7 +84,7 @@ footer:
### instance/devices.yaml ### instance/devices.yaml
``` ```
- id: "unique-sydney" sydney1:
display_name: "Sydney" display_name: "Sydney"
subtext: "Equinix SY3" subtext: "Equinix SY3"
country_code: "AU" country_code: "AU"