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

Update readme and license text

This commit is contained in:
Jeff Leung 2024-01-07 11:11:20 -08:00
parent 01ccc1ab91
commit 4ea9f2ca7f
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -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. 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 ## Getting Started
To build and run the application, follow these steps: 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`. 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. 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 ## Endpoints
The application provides the following key endpoints: The application provides the following key endpoints: