Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add pihole-FTL create-default-config option and use it to upload pihole.toml to ftl.pi-hole.net #2540

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.

Sign up for GitHub

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

Jump to bottom
Merged
yubiuser merged 4 commits into from
Jun 30, 2025
Merged

Add pihole-FTL create-default-config option and use it to upload pihole.toml to ftl.pi-hole.net #2540

yubiuser merged 4 commits into from
Jun 30, 2025

Conversation

@yubiuser
Copy link
Member

@yubiuser yubiuser commented Jun 27, 2025

What does this PR aim to accomplish?:

Add new undocumented flag pihole-FTL create-default-config <file.toml> which will generate a default config file without starting FTL. This pihole.toml is then uploaded during the build process to ftl.pi-hole.net for later use (e.g. in pi-hole/docs#1215)

Supersedes #2537

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 and I have tested my changes.
  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)
  6. I have checked that another pull request for this purpose does not exist.
  7. I have considered, and confirmed that this submission will be valuable to others.
  8. I accept that this submission may not be used, and the pull request closed at the will of the maintainer.
  9. I give this submission freely, and claim no ownership to its content.
  • I have read the above and my PR is ready for review. Check this box to confirm

@yubiuser yubiuser requested a review from a team as a code owner June 27, 2025 08:25
@yubiuser yubiuser changed the title New/gen config Add pihole-FTL create-default-config option and use it to upload pihole.toml to ftl.pi-hole.net Jun 27, 2025
@yubiuser
Copy link
Member Author

yubiuser commented Jun 27, 2025

Successfully uploaded to https://ftl.pi-hole.net/new/gen_config/

github-advanced-security[bot]
github-advanced-security bot found potential problems Jun 27, 2025
View reviewed changes
DL6ER
DL6ER previously approved these changes Jun 29, 2025
View reviewed changes
@DL6ER
Copy link
Member

DL6ER commented Jun 29, 2025

@yubiuser I will leave the final merge to you as I pushed a commit on my own to this branch. It addressed a concern of CodeQL to avoid users putting the generated file anywhere on the system. I don't mind too much, it could have stayed like it was as well...

@DL6ER
Copy link
Member

DL6ER commented Jun 29, 2025

Just thinking out aloud here: Now that we upload the pihole.toml file from various branches, it may be useful to include the branch (if != master) in the header of the file as well

yubiuser
yubiuser commented Jun 29, 2025
View reviewed changes
@yubiuser yubiuser merged commit ba1144b into development Jun 30, 2025
18 checks passed
@yubiuser yubiuser deleted the new/gen_config branch June 30, 2025 11:14
@rdwebdesign rdwebdesign mentioned this pull request Jul 2, 2025
Closed
1 task
@PromoFaux PromoFaux mentioned this pull request Oct 25, 2025
Merged
@rdwebdesign
Copy link
Member

rdwebdesign commented Oct 26, 2025 •
edited
Loading

@yubiuser

The file upload is not needed anymore. FTL#2558 already handles the docs update.

I'm not sure if we should keep the file generation and upload or if we remove them.
Will this improve the build speed?

@yubiuser
Copy link
Member Author

yubiuser commented Oct 26, 2025

I'm undecided here. The file is not used for its intended purpose because it's superseded by the other FTL PR's solution. On the other hand it adds only little time to the overall build process and might be useful in other context in the future.

I'm not bond to it when you think this can be removed, we should just do it.
Thoughts, @DL6ER ?

@rdwebdesign
Copy link
Member

rdwebdesign commented Oct 26, 2025

I have the same doubt.
I'm not sure the file upload is a problem.
I think we should remove it only if we will improve the build process. If not, leave it as it is.

@DL6ER
Copy link
Member

DL6ER commented Oct 27, 2025

It is also "archived" like here: https://ftl.pi-hole.net/v6.3/pihole.toml

This may turn out useful when users want to check in which version what change happened without wanting to navigate through git blame walking down prior versions and checking the related tag.

@yubiuser
Copy link
Member Author

yubiuser commented Oct 27, 2025

Then we should keep it for now

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

Reviewers

@DL6ER DL6ER DL6ER approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@yubiuser @DL6ER @rdwebdesign