traefik icon indicating copy to clipboard operation
traefik copied to clipboard

Documentation about encodedCharacters is wrong

Open gueldenstone opened this issue 3 weeks ago • 0 comments

Welcome!

  • [x] Yes, I've searched similar issues on GitHub and didn't find any.
  • [x] Yes, I've searched similar issues on the Traefik community forum and didn't find any.

What did you do?

  1. I looked up the documentation for the encoded characters after migrating to v2.11.32: https://doc.traefik.io/traefik/v2.11/routing/entrypoints/#encoded-characters. The documentation states to use --entryPoints.web.encodedCharacters.allowEncodedHash=true to allow hashes.
  2. I added --entryPoints.<my_entrypoint_name>.encodedCharacters.allowEncodedHash=true to my command.
  3. The traefik logs showed that the configuration could not be build
  4. I looked at the implemenation here checking the commit 4d7d627. This stated that the CLI option is --entryPoints.<my_entrypoint_name>.http.encodedCharacters.allowEncodedHash=true
  5. Adding http resolved the problem.

What did you see instead?

The documentation should be aligned with the implementation.

What version of Traefik are you using?

Version: 2.11.32 Codename: mimolette Go version: go1.24.11 Built: 2025-12-04T14:32:17Z OS/Arch: linux/amd64

What is your environment & configuration?

services:
  traefik:
    image: traefik:v2.11
    command: 
      # entrypoints
      - --entrypoints.http.address=:80
      - --entrypoints.https.address=:443
      - --entrypoints.https.transport.respondingTimeouts.readTimeout=180
      - --entryPoints.https.http.encodedCharacters.allowEncodedHash=true
      - --entrypoints.grpc.address=:9000

      # increase timeout for requests to upstream servers
      - --serversTransport.forwardingTimeouts.dialTimeout=180s
      
      # config
      - --providers.docker=true
      - --providers.docker.exposedByDefault=false
      - --providers.docker.network=traefik_web
      - --api=true
      - --ping.manualrouting=true
      - --metrics.prometheus=true
      - --log.level=WARN

Add more configuration information here.

If applicable, please paste the log output in DEBUG level

No response

gueldenstone avatar Dec 05 '25 10:12 gueldenstone