From 4ea9f2ca7fe3045360a7bc5457efa7d75e4acbd8 Mon Sep 17 00:00:00 2001 From: Jeff Leung Date: Sun, 7 Jan 2024 11:11:20 -0800 Subject: [PATCH] Update readme and license text --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ac3cabe..260a1b5 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,18 @@ The application requires the following configuration variables to be set: These variables can be set in your application's configuration file or through environment variables, depending on your deployment strategy. +## NetBox Custom Fields + +Ensure that your NetBox instance is configured with the following custom fields: + +- `geoloc_city`: (Text) Represents the city and is not required to be filled in. +- `geoloc_country`: (Selection) Represents the country and is not required to be filled in. +- `geoloc_has_location`: (Boolean) Indicates if there is geolocation data available and is required. +- `geoloc_postal_code`: (Text) Represents the postal code and is not required to be filled in. +- `geoloc_region`: (Selection) Represents the region and is not required to be filled in. + +These fields are critical for the application to accurately retrieve and format geolocation data. + ## Getting Started To build and run the application, follow these steps: @@ -32,10 +44,6 @@ To build and run the application, follow these steps: 5. After a successful build, you can start the application by running `dotnet run`. 6. The application will start, and you can access the endpoints as specified. -## Docker Build - -A Dockerfile is provided for your convienence. This has not been tested as of yet. - ## Endpoints The application provides the following key endpoints: