https://github.com/opensettings/open-settings-docker
Dockerized solution for OpenSettings
https://github.com/opensettings/open-settings-docker
docker dotnet opensettings
Last synced: about 2 months ago
JSON representation
Dockerized solution for OpenSettings
- Host: GitHub
- URL: https://github.com/opensettings/open-settings-docker
- Owner: OpenSettings
- License: other
- Created: 2025-03-18T23:40:47.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-09-27T21:21:51.000Z (8 months ago)
- Last Synced: 2025-10-21T13:40:38.958Z (7 months ago)
- Topics: docker, dotnet, opensettings
- Language: C#
- Homepage: https://hub.docker.com/r/opensettings/open-settings
- Size: 126 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 
OpenSettings Docker Image
[](https://github.com/OpenSettings/open-settings-docker/actions/workflows/dotnet.yml)
[](https://docs.opensettings.net)
[](https://github.com/OpenSettings/open-settings)
[](https://github.com/OpenSettings/open-settings-spa)
Welcome to the official docker repository for [**OpenSettings**](https://opensettings.net)!
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.
## 📖 Documentation
The latest OpenSettings documentation is available at [**docs.opensettings.net**](https://docs.opensettings.net)
## 📂 Repository Structure
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.
## 🚀 Getting Started
To contribute or run the documentation locally, follow these steps. You can choose between using docker run or Docker Compose:
### 1️⃣ Method 1: Run Using Docker Run (No Need to Clone the Repository)
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:
```sh
docker run -d -p 5388:8080 --name container-open-settings opensettings/open-settings:latest
```
This 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](http://localhost:5388) to preview the OpenSettings app.
For more information on docker usage, please check our comprehensive [Docker guide](docs.opensettings.net).
### 2️⃣ Method 2: Run Using Docker Compose
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:
```sh
git clone https://github.com/OpenSettings/open-settings-docker.git
cd open-settings-docker/
```
### 3️⃣ Run Docker Compose
Before running the project, ensure that Docker and Docker Compose are installed on your machine. If you're unsure, check the [Docker installation guide](https://docs.docker.com/get-docker/).
Run the following command to bring up the necessary containers:
```sh
docker-compose up
```
### 4️⃣ Navigate to the Url
Once the containers are running, Open your browser and navigate to **[http://localhost:5388](http://localhost:5388)** to preview the OpenSettings! 🚀
### 5️⃣ Configure Database Provider (Optional)
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.
```yaml
# Default to Sqlite database (this is active by default)
- OPENSETTINGS_Configuration__DbProviderName=Sqlite
- OPENSETTINGS_Configuration__ConnectionString=Data Source=OpenSettings.db
```
comment 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.
## 💡 License
Licensed under the [OpenSettings License](https://opensettings.net/license).
## 🤝 Contributing
By contributing this repository, you agree to the [Contribution Terms](https://opensettings.net/contribution-terms).
## 🐞 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](https://github.com/OpenSettings/open-settings-docker/issues).
- **For OpenSettings framework issues** (e.g., settings management, API behavior):
👉 Report at [open-settings Issues](https://github.com/OpenSettings/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 [security@opensettings.net](mailto:security@opensettings.net).
We appreciate your feedback and will address your concerns as soon as possible!
## 🔗 Useful Links
- 🌍 **Website:** [opensettings.net](https://opensettings.net)
- 🌍 **Docs Website:** [docs.opensettings.net](https://docs.opensettings.net)
- ❤️ **Become a Sponsor:** [opensettings.net/become-a-sponsor](https://opensettings.net/become-a-sponsor)
- 📜 **License:** [opensettings.net/license](https://opensettings.net/license)
- ⚖️ **Terms & Conditions:** [opensettings.net/terms-and-conditions](https://opensettings.net/terms-and-conditions)
- 🔒 **Privacy Policy:** [opensettings.net/privacy-policy](https://opensettings.net/privacy-policy)
✨ *OpenSettings makes settings management simple, powerful, and flexible!* 🚀