diff --git a/README.md b/README.md index 260a1b5..900d3ef 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ The application is implemented in C# using .NET 8.0, ensuring a robust and moder - **GeoFeed Generation**: Dynamically generates a geolocation feed in CSV format as specified in RFC 8805. - **Caching Mechanism**: Implements an efficient caching strategy to reduce redundant API calls and enhance performance. +- **Local Disk Fallback Caching Mechanism**: In the event of a failure to communicate with the NetBox instance specified, the web app will return data that is locally cached inside a SQLite database. - **Secure Communication**: Ensures secure data retrieval from NetBox over HTTPS. ## Configuration @@ -18,6 +19,7 @@ The application requires the following configuration variables to be set: 1. **APIKey**: This is the API key used for authenticating with the NetBox API. Ensure this key has the necessary permissions to access the required resources. 2. **NetBoxHost**: The hostname of the NetBox instance from which the application retrieves data. For example, `netbox.example.com`. +3. **LocalFeedCache**: This connection string is for a local SQLite Database that caches the geofeed data from Netbox. These variables can be set in your application's configuration file or through environment variables, depending on your deployment strategy.