From f4be2505958f98d49ecfdbad367eea0fb73f3552 Mon Sep 17 00:00:00 2001 From: Jeff Leung Date: Sat, 10 Dec 2022 18:58:45 -0800 Subject: [PATCH] Update README --- README.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8acc036..b2c5470 100644 --- a/README.md +++ b/README.md @@ -1 +1,28 @@ -# AS1024.CommunityDocumentationPage \ No newline at end of file +# 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 \ No newline at end of file