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

Create traefik-v2-docker.md #882

Merged
merged 4 commits into from
May 10, 2023
Merged

Create traefik-v2-docker.md #882

merged 4 commits into from
May 10, 2023

Conversation

williamtrelawny
Copy link
Contributor

@williamtrelawny williamtrelawny commented May 6, 2023

Current docs for Traefik config seem to be for Traefik v1 so I've provided some for v2.

I also have provided 2 scenarios- a) both Traefik and Pi-hole are containers on same Docker host, and b) Traefik is containerized but Pi-hole is remote.

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?:

Improve docs on using Traefik to proxy Pi-hole web.

How does this PR accomplish the above?:

Providing brand new doc for Traefik v2 which includes Docker config.


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

@netlify
Copy link

netlify bot commented May 6, 2023

Deploy Preview for pihole-docs ready!

Name Link
🔨 Latest commit 2e3911b
🔍 Latest deploy log https://app.netlify.com/sites/pihole-docs/deploys/645b49c5d047ff000892d45f
😎 Deploy Preview https://deploy-preview-882--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 settings.

@yubiuser
Copy link
Member

yubiuser commented May 6, 2023

I think @PromoFaux uses Traefik, so request his review.

@yubiuser yubiuser requested a review from PromoFaux May 6, 2023 09:26
@PromoFaux
Copy link
Member

Overall looks good to me, however the navigation option is missing in the sidebar.

image

It should be added in here: https://github.com/pi-hole/docs/blob/master/mkdocs.yml#L185

Copy link
Member

@PromoFaux PromoFaux left a comment

Choose a reason for hiding this comment

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

See comment

PromoFaux

This comment was marked as duplicate.

@williamtrelawny
Copy link
Contributor Author

Overall looks good to me, however the navigation option is missing in the sidebar.

Check it out now @PromoFaux :)

@yubiuser yubiuser requested a review from PromoFaux May 10, 2023 06:36
Current docs for Traefik config seem to be for Traefik v1 so I've provided some for v2.

I also have provided 2 scenarios- a) both Traefik and Pi-hole are containers on same Docker host, and b) Traefik is containerized but Pi-hole is remote.

Signed-off-by: William Trelawny <22324745+willman42@users.noreply.github.com>
Fixed markdown-lint errors

Signed-off-by: William Trelawny <22324745+willman42@users.noreply.github.com>
Added link to Traefik docs

Signed-off-by: William Trelawny <22324745+willman42@users.noreply.github.com>
Added "Traefik v2 (with Docker)" and distinguished other Traefik doc link as being for v1.

Signed-off-by: William Trelawny <22324745+willman42@users.noreply.github.com>
@yubiuser yubiuser merged commit e40a0e0 into pi-hole:master May 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants