Settings Management
26 items
Events
Everything that occurs within Fig is logged in the database and is available in the event history.
Settings Table
All settings can be reviewed in table format, including when they were last changed. This is useful when searching for specific settings or reviewing recent changes. All columns can be filtered or sorted as required.
User Management
Administrators in the Fig web client have the ability to manage users. They are able to create and delete users (or other administrators) as well as set and reset passwords.
Connected Clients
Administrators in Fig are able to see a list of all currently connected clients. Clients are considered connected if they poll the API at least once every 2 times the configured poll interval for that client. Clients will poll automatically as part of the Fig.Client nuget package and default to 30 seconds per poll.
API Management
The Fig API is stateless and as a result, it is possible to run multiple instances of the API pointing towards the same database.
Import / Export
Fig supports a number of different types of import and export.
Configuration
There are a few parameters which can be configured for Fig which enable or disable certain features in the application.
Web Hooks
Fig has a web hook integration point which allows third party integrations to be called by Fig in response to certain events occurring. This allows events from Fig to be available more widely for example sent to someone via email or posted to a Slack or Teams channel.
Time Machine
Fig features a built in time machine feature which allows users to reset the settings back to how they were at an earlier point in time.
Scheduling
The Scheduling feature in Fig allows users to defer the application of setting changes or schedule the automatic reverting of settings changes to a later time.
Lookup Tables
Fig supports the concept of lookup tables. This is where a set of setting values supplied by a client can be used to create a dropdown to help the user select a valid value.
Keyboard Shortcuts
The fig web application supports keyboard shortcuts for common operations.
Find / Search
The Find / Search feature in Fig allows you to quickly locate and navigate to any setting across all clients and instances. You can open the search dialog using the keyboard shortcut Alt + F or by pressing the magnifying glass in the nav bar.
Authentication
Fig Web is protected by user authentication. Fig-managed mode (the default) uses a username and password. An admin account is created when the database is first created:
Client Descriptions
When configuring many different clients, having a description of that application and what it does can be useful to the person performing the configuration. Fig forces developers to enter a value in for the client description when they start using Fig and this description is then available when performing the configuration.
Compact View
When there are lots of settings for a client or settings have large descriptions it can be difficult to get an overview of the settings and their values. This is where compact view can be useful. An individual setting can have their compact view toggled by clicking on the name. All settings under a client can be collapsed or expanded using the command buttons at the top of the settings.
Health Checks
When the Fig client is registered with UseFig() in Program.cs, it adds a Fig configuration health check and reports application health to the Fig API on each poll. Health checks are ASP.NET Core's mechanism for querying whether an application (and its dependencies) is healthy.
Change Message
When you save settings changes, you will be prompted to enter a change message. This message will be stored in the event log along with the value changes. It can be a good way to record the motivation behind the change.
Instances
Fig supports overriding the default settings for a client with an instance. An instance is a special key that can be passed by the calling client. When an instance is provided, Fig attempts to find settings matching that instance name. If none are found, the default settings for that client are returned.
Offline Settings
By default, clients using the Fig.Client nuget package will support offline settings. This is a fallback mechanism for when the Fig.API is offline. If the client application starts and it is unable to contact the API, it will attempt to load the last values that it got from the API and run with those. It will continue to attempt to contact the API and will update the settings once successfully reconnected.
Live Reload
By default, clients using the Fig.Client nuget package will support the live reload of settings. This means that when a setting value is updated in the Web Client, that updated value will immediately be available in the settings class for that client. In addition, a settings changed event will be raised on the settings class which can be used to take action when it occurs.
Externally Managed Settings
When using Fig with a CICD pipeline, you may want some or all settings to be managed by that pipeline (e.g. stored in git). In this case, you might use the powershell module to import setting values into Fig so they can be read by the applications.
Client Settings Overrides
In some situations you want the settings to be driven by the client. For example when deploying applications using Docker compose if you have address to other containers within the compose file, you can reference them by their container name. In that case, you would like the setting to be set by the docker compose file rather than having to be manually set in Fig or use a default.
Client Self Updates
In some situations the client application is the right place to update a setting value. For example, an application might rotate its own password, persist generated connection details, or write operational information back to Fig for later reference.
Environment Variables
Fig reads a number of environment variables. Some are required for base functionality while others can be used to override setting configuration without having to made code changes.
App.config File Generation
Fig integrates into the configuration framework built into ASP.NET core. As part of that framework it is possible to draw configuration from a variety of sources including appSettings.json files, environment variables and app.config files. App.config files are largely legacy but are sometimes required for backwards compatibility. They can be tricky to write so they are compatible with the nested structure of the appSettings.json files.
Azure Key Vault Integration
Fig can handle secret values with all setting values being stored encrypted in an enterprise database. However for some high security deployments it may be desirable to store secret values in a dedicated secret store such as Azure Key Vault. Fig has an integration to Azure Key Vault and if enabled, all values marked as secret attribute will be stored there rather than the fig database.
Custom Actions
Custom Actions in Fig allow you to define executable operations in your applications that can be triggered from the Fig web interface. These actions provide a way to perform administrative tasks, maintenance operations, query information, diagnostics checks or other custom behaviors directly from your settings management interface.
Client Secrets
6 items
Metadata Properties
Fig automatically tracks when your settings are loaded and updated, providing you with metadata about the state of your configuration. This feature is particularly useful for monitoring, debugging, and implementing health checks in your applications.
Provider Defined Lookup Tables
Fig supports provider-defined lookup tables through the ILookupProvider and IKeyedLookupProvider interfaces. This feature allows applications to dynamically provide lookup table data at runtime, eliminating the need to manually create and maintain lookup tables in the Fig web interface.
Client Timeline
The Client Timeline feature provides a chronological view of all setting changes and registration events for a specific client. By default the dialog shows the last 30 days of activity (the period is configurable). This feature helps administrators and users track configuration changes, understand when settings were modified, and audit client changes.
Client Registration History
Fig tracks the registration history of all clients, capturing details each time a client registers with new or updated settings. This feature is valuable for administrators who need to understand how client configurations have evolved and identify when new settings were introduced that may require specific values.
Setting Compare
Overview
Groups page
Overview
AppSettings.json Generation
Fig can generate an appsettings.json file from your application's settings class, including encrypted secrets. This is useful for running applications in an offline mode without a Fig server.
Registration Checksum
By default, the Fig client compares a checksum of your settings definition against a file stored on disk at startup. When the checksum matches, the client skips the POST /clients registration call and goes straight to requesting setting values. This reduces startup time when your settings class has not changed since the last successful registration.
Reports
Fig includes a server-side reporting framework that generates printable HTML reports. Administrators select a report, supply parameters, and open the result in a new browser tab where they can print or Save as PDF using the browser print dialog.
Fig Assistant
Fig Assistant is an in-app chatbot for administrators. It can answer questions about your Fig configuration and prepare pending changes for you to review and save.
Custom Status Properties
Fig clients can send developer-defined operational properties with each status poll. Values are stored on the run session, shown on the Connected Clients page, and available via lightweight REST endpoints for integrations.
Dashboards
Dashboards are configurable, read-only views of Fig status and settings data. Use them for wallboards, operations boards, and fleet health summaries.