From b0b8b75258afd6316720ec3e7d6a0cd550ee3424 Mon Sep 17 00:00:00 2001 From: mpl Date: Fri, 5 Apr 2019 15:18:04 +0200 Subject: [PATCH] Fix doc about removing headers --- docs/content/middlewares/headers.md | 19 +++++++++---------- pkg/middlewares/headers/headers.go | 2 +- 2 files changed, 10 insertions(+), 11 deletions(-) diff --git a/docs/content/middlewares/headers.md b/docs/content/middlewares/headers.md index dce032183..84d8ec6a2 100644 --- a/docs/content/middlewares/headers.md +++ b/docs/content/middlewares/headers.md @@ -43,13 +43,10 @@ spec: ### Adding and Removing Headers -`X-Script-Name` header added to the proxied request, the `X-Custom-Request-Header` header removed from the request, and the `X-Custom-Response-Header` header removed from the response. +`X-Script-Name` header added to the proxied request, the `X-Custom-Request-Header` header removed from the request, +and the `X-Custom-Response-Header` header removed from the response. -```yaml tab="Docker" -labels: - - "traefik.http.middlewares.testHeader.Headers.CustomRequestHeaders.X-Script-Name=test" - - "traefik.http.middlewares.testHeader.Headers.CustomResponseHeaders.X-Custom-Response-Header=True" -``` +Please note that is not possible to remove headers through the use of Docker labels for now. ```yaml tab="Kubernetes" apiVersion: traefik.containo.us/v1alpha1 @@ -59,18 +56,20 @@ metadata: spec: headers: CustomRequestHeaders: - X-Script-Name: "test" + X-Script-Name: "test" # Adds + X-Custom-Request-Header: "" # Removes CustomResponseHeaders: - X-Custom-Response-Header: "True" + X-Custom-Response-Header: "" # Removes ``` ```toml tab="File" [http.middlewares] [http.middlewares.testHeader.headers] [http.middlewares.testHeader.headers.CustomRequestHeaders] - X-Script-Name = "test" + X-Script-Name = "test" # Adds + X-Custom-Request-Header = "" # Removes [http.middlewares.testHeader.headers.CustomResponseHeaders] - X-Custom-Response-Header = "True" + X-Custom-Response-Header = "" # Removes ``` ### Using Security Headers diff --git a/pkg/middlewares/headers/headers.go b/pkg/middlewares/headers/headers.go index 44a64d0c0..547fb7ef8 100644 --- a/pkg/middlewares/headers/headers.go +++ b/pkg/middlewares/headers/headers.go @@ -166,7 +166,7 @@ func (s *Header) ServeHTTP(rw http.ResponseWriter, req *http.Request) { } } -// modifyRequestHeaders set or delete request headers. +// modifyRequestHeaders sets or deletes request headers. func (s *Header) modifyRequestHeaders(req *http.Request) { // Loop through Custom request headers for header, value := range s.headers.CustomRequestHeaders {