Skip to content

mzbrau/fig

Repository files navigation

Build Forks Stargazers Issues Apache 2.0 License


Logo

Centralized settings management for dotnet microservices.
Explore the docs »

Table of Contents
  1. What is Fig?
  2. Built With
  3. Features
  4. Getting Started
  5. Roadmap
  6. Contributing
  7. License
  8. Contact
  9. Acknowledgments

What is Fig?

Fig is a complete solution for managing settings across multiple micro-services. It consists of three components: a client library, API and web front end.

product-diagram

To add your application to Fig, add the Fig.Client nuget package to your application and register it as a configuration provider (see documentation for details). You also need an environment variable to tell your app the API address. The Fig API and Blazor Web Application can run in containers locally or in the cloud. Fig is able to manage any number of applications including full configuration support, online status and much more.

webpage-screenshot

Configuration With Fig

Built With

(back to top)

Features

  • Free and Open Source
  • Modern, built on latest dotnet technology
  • Complete settings management
    • Offline settings support
    • Centrally manage settings
    • Setting history and audit logging
    • Import & Export of settings and values
    • Live reload of settings
    • Remote restart of settings clients
    • Configuration Provider (support for IOptions)
    • Secure - authentication required for settings management
    • Automatic settings registration
  • Features to improve setting management
    • Setting descriptions driven from markdown documentation (including images)
    • Default values driven by application
    • Different editors depending on setting type
    • Complex value validation
    • Secret setting support
    • Settings grouping
    • Setting verification support using extensible framework
    • Hide settings with reasonable defaults
    • Lookup tables for improved setting translation
    • Instance support to vary settings for individual clients
  • Stateless backend for scalability

(back to top)

Getting Started

Read the quickstart guide here

Examples can be found here.

Fig NuGet Packages

Fig provides several NuGet packages to support different integration scenarios and environments:

Core Packages

The main client library for integrating Fig into your applications. This is the primary package you'll need for most scenarios.

  • Description: Client library to include in your project when using Fig managed settings
  • Target Framework: .NET Standard 2.0
  • Usage: Configuration management, settings integration
  • Documentation: Client Configuration

Lightweight abstractions and attributes for Fig configuration settings that can be referenced by third-party libraries without requiring the full Fig.Client package.

  • Description: Abstractions and attributes for Fig configuration settings
  • Target Framework: .NET Standard 2.0
  • Usage: Third-party library integration, minimal dependencies
  • Documentation: See active pull request for integration scenarios

Secret Provider Packages

Fig supports secure secret management through specialized provider packages:

Azure Key Vault integration for secure secret management.

AWS Secrets Manager integration for secure secret management.

  • Description: Fig secret provider for AWS Secrets Manager

Google Cloud Secret Manager integration for secure secret management.

  • Description: Fig secret provider for Google Cloud Secret Manager

Docker secrets integration for containerized environments.

  • Description: Fig secret provider for Docker secrets

Windows Data Protection API (DPAPI) integration for Windows environments.

  • Description: Fig secret provider for DPAPI
  • Platform: Windows only

Testing and Development Packages

Testing framework for Fig clients that allows developers to unit and integration test settings-related functionality.

  • Description: A testing framework for Fig clients for unit and integration testing
  • Usage: Unit testing, integration testing, development workflows

Internal contracts and interfaces used by Fig client components.

  • Description: Fig client contracts
  • Usage: Internal package, typically not directly referenced

(back to top)

Roadmap

Fig is getting close to being feature complete but is accepting suggestions for new features and improvements.

Included in the roadmap are:

  • End to end integration tests with Playwright
  • Oauth 2.0 Support
  • Minor fixes and improvements

See the open issues to suggest something else.

(back to top)

Contributing

If you have any suggestions, please open an issue with the tag 'enhancement'. Don't forget to star the page if the project is useful to you.

If you are interested in contributing to the development, please raise a pull request.

(back to top)

Fig Web Application

webpage-login

License

Distributed under the Apache 2.0 License. See LICENSE.txt for more information.

(back to top)

Contact

Project Link: https://github.com/mzbrau/fig

(back to top)

Acknowledgments

Fig stands on the shoulders of giants. Many thanks to all the open source software that makes it possible.

(back to top)

About

Centralized configuration settings for dotnet microservices

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 8