Warn if config folder misses original image configs or files differ

[flortsch]

Implements a check in the Docker entrypoint that compares the special config files of this Docker image with the config files of the user folder. It prints a warning if those config files are missing or they differ from the original Docker image config files. This is a first step, as suggested by @joshtrichards in #1533. In the long run, these files should be treated as special config files not to be messed with by the user, and they should be copied over into the user config folder on every update.

Fixes #1533

[joshtrichards]

Thanks @flortsch!

I'm thinking we should include a new paragraph in the README to refer people to with questions about what is going on here / help them know what they should do. Based on experience with the setup warnings in Nextcloud's Admin Overview, many people pay a lot of attention to these things and get frustrated if they're not able to remedy warnings (understandable reaction + remedying this is the goal!).

Ideally we include that in this PR, but it can also be in an immediately following one if you'd prefer to keep separate.

[flortsch]

Hey @joshtrichards! Sound good. I can extend the PR with a section in the readme and a link to it in the console output. Since you mentioned warnings in the Nextcloud admin overview: is it possible to generate such UI warnings in the entrypoint script? I think that warnings in the UI would be a nice addition to the console output which can often be overlooked.

[flortsch]

@joshtrichards Please check if the text and link is ok. I updated the README and added a link in the docker-entrypoint echo statement. Also, I inlined your last text feedback.

[joshtrichards]

Since you mentioned warnings in the Nextcloud admin overview: is it possible to generate such UI warnings in the entrypoint script? I think that warnings in the UI would be a nice addition to the console output which can often be overlooked.

Not currently.

[joshtrichards]

Finally got a chance to test this a bit. Made some proposed adjustments. Let me know what you think.

[flortsch]

Hey @joshtrichards! I included your suggestions. Only fixed the formatting and the uninitialized variable access. Tested locally with docker-compose (fresh start + changes in existing container/volume). Missing or changed image-specific files trigger the warning & file listing. Custom config files don't trigger anything. Commits squashed and rebased on latest master.

[joshtrichards]

@J0WI What do you think about this?

I think a warning when the configs are out-of-date is a good step forward without introducing a breaking change. It's also something easy to check (or request the reporter check) in the container logs whenever a new bug comes in is unknowingly bogus due to out-of-date config files.

The other option is we take the full leap: documenting all the image config/ files (names) as being "special" and exclusive to the image. Then we update them automatically whenever needed. That'll cause it's own problems (at least in the short-term) IMO.

We can always take the bigger leap later on after we add the warning. So I think this is a good compromise.

[flortsch]

@joshtrichards I reverted the changes and simplified the code back to just print a one-line warning for every config file that differs. What do you think?

[J0WI]

This looks much cleaner, thanks!

[joshtrichards]

Thanks, @flortsch for getting this started and hanging in there! :-)

[joshtrichards]

First sighting in the wild: https://help.nextcloud.com/t/question-on-some-warnings-on-outdated-files-since-update-to-29-0-3/196297

Maybe the docs link should get added back in :-)

[flortsch]

I myself got this warning today after updating to 28.0.7 🤣 Will double-check my configs, but it seems the check fulfills its purpose 😄 If the confusion gets to big I can provide a PR with the link to the README back in place.

[joshtrichards]

Warning: /var/www/html/config/autoconfig.php differs from the latest version of this image at /usr/src/nextcloud/config/autoconfig.php

I guess this one should be excluded from the check. It's removed automatically (by the Nextcloud installer) after use.