Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docker-compose.example.yml to the repository to prevent user configurations from being overwritten #3447

Open
Guanchishan opened this issue Oct 11, 2024 · 0 comments

Comments

@Guanchishan
Copy link
Contributor

Guanchishan commented Oct 11, 2024

Is your feature request related to a problem? Please describe.
Currently, every time the docker-compose.yml file is pulled from the Git repository, it overwrites any local modifications. This is frustrating, as the docker-compose.yml often contains user-specific configurations that are essential for adapting the deployment to the user’s environment. While the changes can be manually handled by staging or skipping updates, this process is cumbersome and prone to errors.

Describe the solution you'd like
A more elegant solution would be to add a docker-compose.example.yml to the Git repository and track that file instead. In the installation documentation, users should be instructed to create their own configuration by copying from this example file:

cp docker-compose.example.yml docker-compose.yml

This approach would help users preserve their local environment-specific configuration changes without the risk of them being overwritten during repository updates.

Describe alternatives you've considered
An alternative is to use git to stash changes to docker-compose.yml before pulling updates, then reapply those changes afterward. However, this solution is not as user-friendly and adds an extra layer of manual work each time the repository is updated.

Additional context
Including this change in the documentation would enhance the usability of the project and reduce the chances of users accidentally overwriting their deployment configurations.

@Guanchishan Guanchishan changed the title Add docker-compose.yml.example to the repository to prevent user configurations from being overwritten Add docker-compose.example.yml to the repository to prevent user configurations from being overwritten Oct 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant