Go to file
Jeff Leung c32f3596ec Update launch settings 2024-01-11 16:10:42 -08:00
AS1024.CommunityDocumentationPage Update launch settings 2024-01-11 16:10:42 -08:00
.dockerignore Add initial docker support 2024-01-11 16:10:17 -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 the readme file 2023-01-08 15:32:07 -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
  • NetBoxHostname - The hostname to communicate to the netbox instance - This always assumes your netbox instance is secured by TLS running on port 443