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

Fix mistake in the documentation of several backends #4133

Merged
merged 1 commit into from Oct 30, 2018
Merged

Fix mistake in the documentation of several backends #4133

merged 1 commit into from Oct 30, 2018

Conversation

ghost
Copy link

@ghost ghost commented Oct 29, 2018

What does this PR do?

This PR changes the documentation for the following three labels to say that they add a HPKP header instead of a pinned HTST public key header.

<prefix>.frontend.headers.publicKey=VALUE (Consul Catalog)
traefik.frontend.headers.publicKey=VALUE (Azure Service Fabric, Docker, ECS, Marathon, Mesos, Rancher)
ingress.kubernetes.io/public-key: VALUE (Kubernetes Ingress)

Motivation

The documentation for these labels currently says that they add a pinned HTST public key header. The problem with this is that there is no such thing as a pinned HTST (?) or even HSTS (HTTP Strict Transport Security) public key header. What these labels actually do is add a HPKP (HTTP Public Key Pinning) header.

More

  • Added/updated tests
  • Added/updated documentation

Additional Notes

N/A

Copy link
Contributor

@ldez ldez left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@juliens juliens left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@geraldcroes geraldcroes left a comment

Choose a reason for hiding this comment

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

LGTM

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.

4 participants