AS1024
/
AS1024BGPCommunityDocPage
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README

This commit is contained in:
Jeff Leung 2022-12-10 18:58:45 -08:00
parent 1e6a1fc84b
commit f4be250595
1 changed files with 28 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -1 +1,28 @@
# AS1024.CommunityDocumentationPage
# AS1024 - BGP Community Documentation Page
This web app pulls data from Netbox's Route Targets API and converts it to a public friendly webpage to document what your BGP Communities does to the wider public. This ensures that NetBox always remains your source of truth for BGP Communities.
# Installation
## System Pre-Requsities
- A supported platform for .NET 6 LTS
## Actual Install Steps
Ensure there is a line of communication to your NetBox from this web app. Without it, it will not run properly.
1. Clone this repository
2. Build the .NET App to your taste and target platform
3. Run the app
*In theory this app can run on Azure App Service, but this has not been confirmed or tested with*
# Configuration
This web app must be configured with asppsettings.json with the following values:
## Values
- ``APIKey`` - This is a netbox API Key. We strongly recommend that you do this as a read only thing
- ``ASN`` - This is required, without it, the AS's will not display properly