Skip to content

Replace dots with underscores when creating env var examples #2669

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
DL6ER merged 1 commit into from
Oct 27, 2025
Merged

Replace dots with underscores when creating env var examples #2669

DL6ER merged 1 commit into from
Oct 27, 2025

Conversation

@rdwebdesign
Copy link
Member

@rdwebdesign rdwebdesign commented Oct 27, 2025 •
edited
Loading

What does this PR aim to accomplish?

Fix pi-hole/docs#1298

The environment variables should contain only underscore characters, not dots, but the current code is printing the section names with dots, resulting in invalid variable names.

image

How does this PR accomplish the above?

Replacing the dots before printing

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

@rdwebdesign rdwebdesign requested a review from a team as a code owner October 27, 2025 03:31
DL6ER
DL6ER approved these changes Oct 27, 2025
View reviewed changes
Copy link
Member

@DL6ER DL6ER left a comment •
edited
Loading

Choose a reason for hiding this comment

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

That's how FTL does it, too

image

@DL6ER DL6ER merged commit f9f5f72 into development Oct 27, 2025
18 checks passed
@DL6ER DL6ER deleted the fix/docs_pihole_toml branch October 27, 2025 06:54
@PromoFaux PromoFaux mentioned this pull request Oct 27, 2025
Merged
1 task
truecharts-admin added a commit to trueforge-org/truecharts that referenced this pull request Oct 27, 2025
@truecharts-admin
chore(helm): update image ghcr.io/pi-hole/pihole 2025.10.1 → 2025.10.2 (
377f126 
#41169)

This PR contains the following updates:

| Package | Update | Change |
|---|---|---|
|
[ghcr.io/pi-hole/pihole](https://redirect.github.com/pi-hole/docker-pi-hole)
| patch | `4fe41ce` -> `db6cdcd` |

---

> [!WARNING]
> Some dependencies could not be looked up. Check the Dependency
Dashboard for more information.

Add the preset `:preserveSemverRanges` to your config if you don't want
to pin your dependencies.

---

### Release Notes

<details>
<summary>pi-hole/docker-pi-hole (ghcr.io/pi-hole/pihole)</summary>

###
[`v2025.10.2`](https://redirect.github.com/pi-hole/docker-pi-hole/releases/tag/2025.10.2)

[Compare
Source](https://redirect.github.com/pi-hole/docker-pi-hole/compare/2025.10.1...2025.10.2)

Nothing Docker-specific

Tagging to include FTL v6.3.1

<!-- Release notes generated using configuration in .github/release.yml
at master -->

#### What's Changed

- Fix pihole.format\_path(string) modifying string in-place by
[@&#8203;DL6ER](https://redirect.github.com/DL6ER) in
[pi-hole/FTL#2661](https://redirect.github.com/pi-hole/FTL/pull/2661)
- Do not try to renew certificate that is not used by
[@&#8203;DL6ER](https://redirect.github.com/DL6ER) in
[pi-hole/FTL#2666](https://redirect.github.com/pi-hole/FTL/pull/2666)
- Replace dots with underscores when creating env var examples by
[@&#8203;rdwebdesign](https://redirect.github.com/rdwebdesign) in
[pi-hole/FTL#2669](https://redirect.github.com/pi-hole/FTL/pull/2669)
- Grammar corrections in documentation by
[@&#8203;alexxroche](https://redirect.github.com/alexxroche) in
[pi-hole/FTL#2670](https://redirect.github.com/pi-hole/FTL/pull/2670)
- Add new config option for hiding some warnings from diagnosis system
by [@&#8203;DL6ER](https://redirect.github.com/DL6ER) in
[pi-hole/FTL#2657](https://redirect.github.com/pi-hole/FTL/pull/2657)

#### New Contributors

- [@&#8203;alexxroche](https://redirect.github.com/alexxroche) made
their first contribution in
[pi-hole/FTL#2670](https://redirect.github.com/pi-hole/FTL/pull/2670)

**Full Changelog**:
<pi-hole/FTL@v6.3...v6.3.1>

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Renovate
Bot](https://redirect.github.com/renovatebot/renovate).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0MS44Mi4xMCIsInVwZGF0ZWRJblZlciI6IjQxLjgyLjEwIiwidGFyZ2V0QnJhbmNoIjoibWFzdGVyIiwibGFiZWxzIjpbImF1dG9tZXJnZSIsInJlbm92YXRlL2NvbnRhaW5lciIsInR5cGUvcGF0Y2giXX0=-->
@truenasbot truenasbot mentioned this pull request Oct 28, 2025
Merged
github-actions bot pushed a commit to bigbeartechworld/big-bear-universal-apps that referenced this pull request Oct 30, 2025
@renovate
chore(deps): update jacklul/pihole docker tag to v2025.10.3
dffc7d3 
This PR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [jacklul/pihole](https://redirect.github.com/pi-hole/docker-pi-hole) | patch | `2025.10.1` -> `2025.10.3` |

---

### Release Notes

<details>
<summary>pi-hole/docker-pi-hole (jacklul/pihole)</summary>

### [`v2025.10.3`](https://redirect.github.com/pi-hole/docker-pi-hole/releases/tag/2025.10.3)

[Compare Source](https://redirect.github.com/pi-hole/docker-pi-hole/compare/2025.10.2...2025.10.3)

Pi-hole releases are a lot like London Buses. You don't see one for ages, and then they all come along at once

<!-- Release notes generated using configuration in .github/release.yml at master -->

#### What's Changed (Docker Specific)

- Remove remaining hard-coded FTL log paths by [@&#8203;casperklein](https://redirect.github.com/casperklein) in [#&#8203;1929](https://redirect.github.com/pi-hole/docker-pi-hole/pull/1929)

**Full Changelog**: <pi-hole/docker-pi-hole@2025.10.2...2025.10.3>

<!-- Release notes generated using configuration in .github/release.yml at master -->

#### What's Changed (FTL v6.3.2)

- Fix pihole.format\_path() memory handling by [@&#8203;DL6ER](https://redirect.github.com/DL6ER) in [pi-hole/FTL#2675](https://redirect.github.com/pi-hole/FTL/pull/2675)

**Full Changelog**: <pi-hole/FTL@v6.3.1...v6.3.2>

<!-- Release notes generated using configuration in .github/release.yml at development -->

#### What's Changed (Core v6.2.2)

- Create version file, if not existing (on first Container start) by [@&#8203;casperklein](https://redirect.github.com/casperklein) in [pi-hole/pi-hole#6440](https://redirect.github.com/pi-hole/pi-hole/pull/6440)
- Add log file path variables and ensure log files are created if missing by [@&#8203;Yannick7777](https://redirect.github.com/Yannick7777) in [pi-hole/pi-hole#6441](https://redirect.github.com/pi-hole/pi-hole/pull/6441)
- Add bind9-dnsutils as dependency for APT based systems by [@&#8203;yubiuser](https://redirect.github.com/yubiuser) in [pi-hole/pi-hole#6444](https://redirect.github.com/pi-hole/pi-hole/pull/6444)

#### New Contributors

- [@&#8203;Yannick7777](https://redirect.github.com/Yannick7777) made their first contribution in [pi-hole/pi-hole#6441](https://redirect.github.com/pi-hole/pi-hole/pull/6441)

**Full Changelog**: <pi-hole/pi-hole@v6.2.1...v6.2.2>

### [`v2025.10.2`](https://redirect.github.com/pi-hole/docker-pi-hole/releases/tag/2025.10.2)

[Compare Source](https://redirect.github.com/pi-hole/docker-pi-hole/compare/2025.10.1...2025.10.2)

Nothing Docker-specific

Tagging to include FTL v6.3.1

<!-- Release notes generated using configuration in .github/release.yml at master -->

#### What's Changed

- Fix pihole.format\_path(string) modifying string in-place by [@&#8203;DL6ER](https://redirect.github.com/DL6ER) in [pi-hole/FTL#2661](https://redirect.github.com/pi-hole/FTL/pull/2661)
- Do not try to renew certificate that is not used by [@&#8203;DL6ER](https://redirect.github.com/DL6ER) in [pi-hole/FTL#2666](https://redirect.github.com/pi-hole/FTL/pull/2666)
- Replace dots with underscores when creating env var examples by [@&#8203;rdwebdesign](https://redirect.github.com/rdwebdesign) in [pi-hole/FTL#2669](https://redirect.github.com/pi-hole/FTL/pull/2669)
- Grammar corrections in documentation by [@&#8203;alexxroche](https://redirect.github.com/alexxroche) in [pi-hole/FTL#2670](https://redirect.github.com/pi-hole/FTL/pull/2670)
- Add new config option for hiding some warnings from diagnosis system by [@&#8203;DL6ER](https://redirect.github.com/DL6ER) in [pi-hole/FTL#2657](https://redirect.github.com/pi-hole/FTL/pull/2657)

#### New Contributors

- [@&#8203;alexxroche](https://redirect.github.com/alexxroche) made their first contribution in [pi-hole/FTL#2670](https://redirect.github.com/pi-hole/FTL/pull/2670)

**Full Changelog**: <pi-hole/FTL@v6.3...v6.3.1>

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR was generated by [Mend Renovate](https://mend.io/renovate/). View the [repository job log](https://developer.mend.io/github/bigbeartechworld/big-bear-universal-apps).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0MS4xNTkuNCIsInVwZGF0ZWRJblZlciI6IjQxLjE1OS40IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJkZXBlbmRlbmNpZXMiLCJyZW5vdmF0ZSJdfQ==-->
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

@yubiuser yubiuser yubiuser 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

@rdwebdesign @DL6ER @yubiuser