Welcome to the official docker repository for OpenSettings!
OpenSettings is a centralized settings management system designed for .NET applications. It simplifies app settings management by providing a structured and scalable approach to handling settings.
The latest OpenSettings documentation is available at docs.opensettings.net
This repository contains the necessary files and configurations to run OpenSettings as a provider inside a Docker container. It is designed to make deployment easy while ensuring compatibility with various environments.
To contribute or run the documentation locally, follow these steps. You can choose between using docker run or Docker Compose:
If you don't need to modify the code and just want to quickly run OpenSettings, you can use the following docker run command. This method doesn't require cloning the repository.
Run the OpenSettings container directly from Docker Hub:
docker run -d -p 5388:8080 --name container-open-settings opensettings/open-settings:latestThis will start the OpenSettings application in a Docker container and map port 8080 from the container to port 5388 on your host machine. You can then navigate to http://localhost:5388 to preview the OpenSettings app.
For more information on docker usage, please check our comprehensive Docker guide.
If you need to modify the code or work with multiple containers (like databases or other services), you can use Docker Compose.
First, clone the repository:
git clone https://github.com/OpenSettings/open-settings-docker.git
cd open-settings-docker/Before running the project, ensure that Docker and Docker Compose are installed on your machine. If you're unsure, check the Docker installation guide.
Run the following command to bring up the necessary containers:
docker-compose upOnce the containers are running, Open your browser and navigate to http://localhost:5388 to preview the OpenSettings! 🚀
By default, the Docker Compose configuration uses Sqlite as the database provider. However, you can choose a different database provider by updating the docker-compose.yml file.
# Default to Sqlite database (this is active by default)
- OPENSETTINGS_Configuration__DbProviderName=Sqlite
- OPENSETTINGS_Configuration__ConnectionString=Data Source=OpenSettings.dbcomment out the default Sqlite lines and uncomment the database provider you want to use. Be sure to also update the connection string with your own credentials.
Licensed under the OpenSettings License.
By contributing this repository, you agree to the Contribution Terms.
If you encounter any issues or have suggestions, please report them to the appropriate GitHub repository.
- 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.
- Search for Existing Issues: Check if your issue has already been reported in the relevant repository.
- 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.
- Be specific about the issue, including environment and configuration details.
- Include relevant error logs or screenshots if available.
For security-related issues, do not use GitHub Issues. Contact us directly at security@opensettings.net.
We appreciate your feedback and will address your concerns as soon as possible!
- 🌍 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! 🚀