opensettings/open-settings repository overview

⁠ OpenSettings

• • • • •

⁠💭 About

OpenSettings is a powerful, flexible, and centralized settings management solution for .NET applications. It simplifies settings storage, retrieval, and synchronization. This Docker image provides an easy way to deploy OpenSettings as a provider for managing configurations across multiple services.

⁠⚙️ Features

✅ Centralized Settings Management – Manage settings across multiple services.
✅ Provider-Consumer Model – Define settings on a provider and sync them with consumers.
✅ Database-Backed Storage – Choose your storage and customize it on your own (e.g. SQL Server, PostgreSQL, InMemory etc.)
✅ Built-in Spa – Comes with a UI dashboard for managing settings easily.
✅ Easy Integration – Works seamlessly with .NET.

⁠🚀 Quick Start

Run OpenSettings with:

docker run -d -p 5388:8080 --name container-open-settings opensettings/open-settings:latest

Access it at: http://localhost:5388/settings⁠

⁠Configuration

By default, the OpenSettings Docker setup uses Sqlite storage.

⁠Supported Databases

You may set DbProviderName to one of the following: MySql, Oracle, PostgreSql, Sqlite, SqlServer or InMemory.

Example using Sqlite:

services:
  open-settings:
    image: opensettings/open-settings
    container_name: container-open-settings
    environment:
      - OPENSETTINGS_Configuration__DbProviderName=Sqlite
      - OPENSETTINGS_Configuration__ConnectionString=Data Source=OpenSettings.db
    ports:
      - "5388:8080"

For more information on docker usage, please check our comprehensive Docker guide⁠.

⁠📖 Documentation

The latest OpenSettings documentation is available at docs.opensettings.net⁠.

⁠💡 License

Licensed under the OpenSettings License⁠.

⁠🐞 Issues & Reports

If you encounter any issues or have suggestions, please report them to the appropriate GitHub repository.

⁠Where to Report?

• For Docker-related issues (e.g., container setup, networking, environment variables):
  👉 Report at open-settings-docker Issues⁠.
• For OpenSettings framework issues (e.g., settings management, API behavior):
  👉 Report at open-settings Issues⁠.

⁠How to Report an Issue:

1. Search for Existing Issues: Check if your issue has already been reported in the relevant repository.
2. Submit a New Issue:
   • Choose the correct repository based on the issue type.
   • Click "New issue" and describe the problem in detail, including steps to reproduce, error messages, and logs.

⁠Reporting Guidelines:

• Be specific about the issue, including environment and configuration details.
• Include relevant error logs or screenshots if available.

⁠Security Concerns:

For security-related issues, do not use GitHub Issues. Contact us directly at [email protected]⁠.

We appreciate your feedback and will address your concerns as soon as possible!

⁠🔗 Useful Links

• 🌍 Website: opensettings.net⁠
• 🌍 Docs Website: docs.opensettings.net⁠
• ❤️ Become a Sponsor: opensettings.net/become-a-sponsor⁠
• 📜 License: opensettings.net/license⁠
• ⚖️ Terms & Conditions: opensettings.net/terms-and-conditions⁠
• 🔒 Privacy Policy: opensettings.net/privacy-policy⁠

✨ OpenSettings makes settings management simple, powerful, and flexible! 🚀