Go to file
Jeff Leung 9311ba2b59 Fix the names 2023-01-08 13:37:15 -08:00
AS1024.CommunityDocumentationPage Fix the names 2023-01-08 13:37:15 -08:00
.gitattributes Add .gitattributes, .gitignore, README.md, and LICENSE.txt. 2022-12-10 18:51:24 -08:00
.gitignore Add .gitattributes, .gitignore, README.md, and LICENSE.txt. 2022-12-10 18:51:24 -08:00
AS1024.CommunityDocumentationPage.sln Add project files. 2022-12-10 18:51:26 -08:00
LICENSE.txt Add .gitattributes, .gitignore, README.md, and LICENSE.txt. 2022-12-10 18:51:24 -08:00
README.md Update readme 2022-12-10 20:53:00 -08:00

README.md

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
  • NOCEmail - This is to display for NOC E-Mail Inquries