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.

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

Update the NGINX guide #1132

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update the NGINX guide #1132

wants to merge 1 commit into from

Conversation

clayoster
Copy link

  • The PHP version included with Raspbian 12 is 8.2. Update version numbers accordingly
  • Consistently use systemctl for service management
  • Include fastcgi settings discussed in issue nginx config in documentatation does not work well #962
  • Remove basic auth configuration since Pi-hole webpage has authentication
  • Remove autoindex setting as this is already the NGINX default
  • Remove permission steps that are already handled by the Pi-hole install

This is intended to supersede existing PRs for updating this guide (#604 and #926).

Thank you for your contribution to the Pi-hole Community!

Please read the comments below to help us consider your Pull Request.

We are all volunteers and completing the process outlined will help us review your commits quicker.

Please make sure you

  1. Base your code and PRs against the repositories developmental branch.
  2. Sign Off all commits as we enforce the DCO for all contributions
  3. Sign all your commits as they must have verified signatures
  4. File a pull request for any change that requires changes to our documentation at our documentation repo

What does this PR aim to accomplish?:

This adds number of improvements to the NGINX guide.

How does this PR accomplish the above?:

Updates PHP version numbers to match the current Raspbian release, removes unnecessary configuration and other steps already handled by the Pi-hole install.

Link documentation PRs if any are needed to support this PR:

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

@clayoster
Update the NGINX guide
840b637 
- The PHP version included with Raspbian 12 is 8.2. Update version numbers accordingly
- Consistently use systemctl for service management
- Include fastcgi settings discussed in issue pi-hole#962
- Remove basic auth configuration since Pi-hole webpage has authentication
- Remove autoindex setting as this is already the NGINX default
- Remove permission steps that are already handled by the Pi-hole install

Signed-off-by: Clay Oster <iamclayoster@gmail.com>
@netlify Netlify
Copy link

netlify bot commented Nov 19, 2024

✅ Deploy Preview for pihole-docs ready!

Name Link
🔨 Latest commit 840b637
🔍 Latest deploy log https://app.netlify.com/sites/pihole-docs/deploys/673c065a83a3920008f19dcc
😎 Deploy Preview https://deploy-preview-1132--pihole-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@yubiuser
Copy link
Member

Thanks for your PR. We are in the transition to Pi-hole v6 and update our docs as well. As the guides were out-of date, we were going to remove them (#1099). But as you are updating nginx, we could also keep this one.
My suggestion would be to base and target your PR on branch remove-restartdns which will be merged into release/v6.0 which will at some point reach master.

Piging @PromoFaux as he authored #1099

@rdwebdesign
Copy link
Member

Note:

The v5 nginx guide in this PR is focused in PHP configuration and setting nginx as a web server, but Pi-hole v6 doesn't have PHP pages and the web server is integrated into pihole-FTL.

@clayoster
Copy link
Author

Thanks for the heads up! Given that information, my current updates to the guide probably wouldn’t make sense as part of the v6 docs.

I’ll leave this PR targeted at the master branch as the updates may be useful up until v6 is released. Feel free to close it out if you don’t feel it is needed!

If there is any desire to have a guide for running NGINX in front of Pi-hole as a reverse proxy in the v6 docs, I could look at submitting another PR for that purpose. I haven’t done testing with v6 yet, but I will likely run that setup for my personal deployment.

@github-actions GitHub Actions
Copy link
Contributor

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

@yubiuser
Copy link
Member

Pi-hole v6 has been released now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
Merge Conflict
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@clayoster @yubiuser @rdwebdesign