Traefik Plugin: CORS Preflight

Short Description

Pass the browser cors preflight with response status 204 for Method OPTIONS

Configuration

Requirements: Traefik >= v2.5.5

Static

Copy
--pilot.token=xxx
--experimental.plugins.corspreflight.modulename=github.com/Medzoner/traefik-plugin-cors-preflight
--experimental.plugins.corspreflight.version=v1.1.1

Copy
pilot:
  token: xxx

experimental:
  plugins:
    corspreflight:
      modulename: github.com/Medzoner/traefik-plugin-cors-preflight
      version: v1.1.1

Copy
[pilot]
    token = "xxx"

[experimental.plugins.corspreflight]
    modulename = "github.com/Medzoner/traefik-plugin-cors-preflight"
    version = "v1.1.1"

Copy
testData:
  testData:
    code: 204
    method: 'OPTIONS'
    debug: false
    allowOrigins: '*'
    allowMethods: 'GET,POST,OPTIONS'
    allowHeaders: 'Content-Type,Authorization'

Dynamic

To configure the CorsPreflight plugin you should create a middleware in your dynamic configuration as explained here.

File

Copy
http:
  middlewares:
    corspreflight-middleware:
      plugin:
        corspreflight:
          code: 200
          method: OPTIONS
          debug: false
          allowOrigins: '*'
          allowMethods: 'GET,POST,OPTIONS'
          allowHeaders: 'Content-Type,Authorization'

  routers:
    my-router:
      rule: Host(`localhost`)
      middlewares:
        - corspreflight-middleware
      service: my-service

  services:
    my-service:
      loadBalancer:
        servers:
          - url: 'http://127.0.0.1'

Copy
[http.middlewares]
  [http.middlewares.corspreflight-middleware.plugin.corspreflight]
    code = 200
    method = "OPTIONS"
    debug = false
    allowOrigins = "*"
    allowMethods = "GET,POST,OPTIONS"
    allowHeaders = "Content-Type,Authorization"

[http.routers]
  [http.routers.my-router]
    rule = "Host(`localhost`)"
    middlewares = ["corspreflight-middleware"]
    service = "my-service"

[http.services]
  [http.services.my-service]
    [http.services.my-service.loadBalancer]
      [[http.services.my-service.loadBalancer.servers]]
        url = "http://127.0.0.1"

Kubernetes

Copy
---
apiVersion: traefik.containo.us/v1alpha1
kind: Middleware
metadata:
  name: corspreflight-middleware
spec:
  plugin:
    corspreflight:
      code: 200
      method: OPTIONS
      debug: false
      allowOrigins: '*'
      allowMethods: 'GET,POST,OPTIONS'
      allowHeaders: 'Content-Type,Authorization'

---
apiVersion: traefik.containo.us/v1alpha1
kind: IngressRoute
metadata:
  name: whoami
spec:
  entryPoints:
    - web
  routes:
    - kind: Rule
      match: Host(`whoami.localhost`)
      middlewares:
        - name: corspreflight-middleware
      services:
        - kind: Service
          name: whoami-svc
          port: 80

Copy
---
apiVersion: traefik.containo.us/v1alpha1
kind: Middleware
metadata:
  name: corspreflight-middleware
spec:
  plugin:
    corspreflight:
      code: 200
      method: OPTIONS
      debug: false
      allowOrigins: '*'
      allowMethods: 'GET,POST,OPTIONS'
      allowHeaders: 'Content-Type,Authorization'

---
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: myingress
  annotations:
    traefik.ingress.kubernetes.io/router.middlewares: default-corspreflight-middleware@kubernetescrd

spec:
  rules:
    - host: whoami.localhost
      http:
        paths:
          - path: /
            pathType: Prefix
            backend:
              service:
                name:  whoami
                port:
                  number: 80

Docker

Copy
services:
  whoami:
    image: traefik/whoami:v1.7.1
    labels:
      traefik.enable: 'true'

      traefik.http.routers.app.rule: Host(`whoami.localhost`)
      traefik.http.routers.app.entrypoints: websecure
      traefik.http.routers.app.middlewares: corspreflight-middleware

      traefik.http.middlewares.corspreflight-middleware.plugin.corspreflight.code: 204
      traefik.http.middlewares.corspreflight-middleware.plugin.corspreflight.method: 'OPTIONS'
      traefik.http.middlewares.corspreflight-middleware.plugin.corspreflight.debug: false
      traefik.http.middlewares.corspreflight-middleware.plugin.corspreflight.allowOrigins: '*'
      traefik.http.middlewares.corspreflight-middleware.plugin.corspreflight.allowMethods: 'GET,POST,OPTIONS'
      traefik.http.middlewares.corspreflight-middleware.plugin.corspreflight.allowHeaders: 'Content-Type,Authorization'

Developed & Maintained by

Mehdi Youb

License