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 read-only config option #1988

Merged
merged 3 commits into from
Jun 25, 2024
Merged

Add read-only config option #1988

merged 3 commits into from
Jun 25, 2024

Conversation

DL6ER
Copy link
Member

@DL6ER DL6ER commented Jun 2, 2024

What does this implement/fix?

Add new misc.readOnly config option to force the configuration to be read-only. It can only be modified through the config file but neither the API nor the CLI as long as read-only mode is enabled.

Related issue or feature (if applicable): https://discourse.pi-hole.net/t/support-writing-to-pihole-toml-directly/70522/

Pull request in docs with documentation (if applicable): N/A


By submitting this pull request, I confirm the following:

  1. I have read and understood the contributors guide, as well as this entire template. I understand which branch to base my commits and Pull Requests against.
  2. I have commented my proposed changes within the code.
  3. I am willing to help maintain this change if there are issues with it later.
  4. It is compatible with the EUPL 1.2 license
  5. I have squashed any insignificant commits. (git rebase)

Checklist:

  • The code change is tested and works locally.
  • I based my code and PRs against the repositories developmental branch.
  • I signed off all commits. Pi-hole enforces the DCO for all contributions
  • I signed all my commits. Pi-hole requires signatures to verify authorship
  • I have read the above and my PR is ready for review.

…read-only. It can only be modified through the config file but neither the API nor the CLI as long as read-only mode is enabled

Signed-off-by: DL6ER <dl6er@dl6er.de>
Copy link

github-actions bot commented Jun 5, 2024

This pull request has conflicts, please resolve those before we can evaluate the pull request.

Signed-off-by: DL6ER <dl6er@dl6er.de>
Copy link

github-actions bot commented Jun 6, 2024

Conflicts have been resolved.

@DL6ER DL6ER marked this pull request as ready for review June 6, 2024 04:50
@DL6ER DL6ER requested a review from a team June 6, 2024 04:51
@DL6ER
Copy link
Member Author

DL6ER commented Jun 6, 2024

Has been confirmed working by original requestor on Discourse

Copy link
Member

@yubiuser yubiuser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried it and setting this option to trueworks as expected. However, setting it back to false needs a manual FTL restart before the change applied. It seems from the logging, FTL stoppend watching the file for changes and therefor does not realize that readOnly is now back to default false

…d-only mode

Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Copy link
Member Author

DL6ER commented Jun 6, 2024

Thank you, this was some very good review hint! The issue was that we skipped recomputing the checksum in read-only mode and, hence, FTL did not realize that the file actually changed once you went back from false -> true. However, this bug was only triggered if you have changed other settings before this, effectively hiding it from my tests where I have set misc.readOnly = true as the first thing during testing.

@DL6ER DL6ER merged commit 96f7dff into development-v6 Jun 25, 2024
17 checks passed
@DL6ER DL6ER deleted the new/misc_readOnly branch June 25, 2024 12:32
@pralor-bot
Copy link

This pull request has been mentioned on Pi-hole Userspace. There might be relevant details there:

https://discourse.pi-hole.net/t/support-writing-to-pihole-toml-directly/70522/11

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants