traefik_whois_middleware

README

Traefik v3 middleware which displays user connection information about each client that accesses a container with this middleware applied.

♾️ Traefik Whois Middleware ♾️

(Under Development): This middleware allows you to view detailed information about a connecting client when they access a container where this middleware is enabled.

---

• Configuration
  • Static File
    • File (YAML)
    • File (TOML)
    • CLI
  • Dynamic File
    • File (YAML)
    • File (TOML)
    • Kubernetes Custom Resource Definition
• Parameters
  • debugLogs
• Full Examples
• Local Install
  • Static File
    • File (YAML)
    • File (TOML)
  • Dynamic File
    • File (YAML)
    • File (TOML)
• Contributors ✨

---

Configuration

The following provides examples for usage scenarios.

Static File

If you are utilizing a Traefik Static File, review the following examples:

File (YAML)

## Static configuration
experimental:
  plugins:
    traefik-whois-middleware:
      moduleName: "github.com/Aetherinox/traefik-whois-middleware"
      version: "v0.1.0"

File (TOML)

## Static configuration
[experimental.plugins.traefik-whois-middleware]
  moduleName = "github.com/Aetherinox/traefik-whois-middleware"
  version = "v0.1.0"

CLI

## Static configuration
--experimental.plugins.traefik-whois-middleware.modulename=github.com/Aetherinox/traefik-whois-middleware
--experimental.plugins.traefik-whois-middleware.version=v0.1.0

Dynamic File

If you are utilizing a Traefik Dynamic File, review the following examples:

File (YAML)

# Dynamic configuration
http:
  middlewares:
    whois:
      plugin:
        traefik-whois-middleware:
          debugLogs: false

File (TOML)

# Dynamic configuration
[http]
  [http.middlewares]
    [http.middlewares.whois]
      [http.middlewares.whois.plugin]
        [http.middlewares.whois.plugin.traefik-whois-middleware]
          debugLogs = false

Kubernetes Custom Resource Definition

# Dynamic configuration
apiVersion: traefik.containo.us/v1alpha1
kind: Middleware
metadata:
  name: whois
spec:
  plugin:
    traefik-whois-middleware:
      debugLogs: false

---

Parameters

This plugin accepts the following parameters:

Parameter	Description	Default	Type	Required
debugLogs	Shows debug logs in console	false	bool	⭕ Optional

debugLogs

If set true, gives you a more detailed outline of what is going on behind the scenes in your console.

---

Full Examples

A few extra examples have been provided.

http:
  middlewares:
    whois:
      plugin:
        traefik-whois-middleware:
          debugLogs: true

    routers:
        traefik-http:
            service: "traefik"
            rule: "Host(`yourdomain.com`)"
            entryPoints:
                - http
            middlewares:
                - https-redirect@file

        traefik-https:
            service: "traefik"
            rule: "Host(`yourdomain.com`)"
            entryPoints:
                - https
            middlewares:
                - whois@file
            tls:
                certResolver: cloudflare
                domains:
                    - main: "yourdomain.com"
                      sans:
                          - "*.yourdomain.com"

---

Local Install

Traefik comes with the ability to install this plugin locally without fetching it from Github.

Download a local copy of this plugin to your server within your Traefik installation folder.

git clone https://github.com/Aetherinox/traefik-whois-middleware.git

If you are running Docker, you need to mount a new volume:

[!WARNING] The path to the plugin is case sensitive, do not change the casing of the folders, or the plugin will fail to load.

services:
    traefik:
        container_name: traefik
        image: traefik:latest
        restart: unless-stopped
        volumes:
            - ./traefik-whois-middleware:/plugins-local/src/github.com/Aetherinox/traefik-whois-middleware/

Static File

Open your Traefik Static File and change plugins to localPlugins.

File (YAML)

# Static configuration
experimental:
  localPlugins:
    traefik-whois-middleware:
      moduleName: "github.com/Aetherinox/traefik-whois-middleware"
      version: "v0.1.0"

File (TOML)

# Static configuration
[experimental.localPlugins.traefik-whois-middleware]
  moduleName = "github.com/Aetherinox/traefik-whois-middleware"
  version = "v0.1.0"

Dynamic File

For local installation, your dynamic file will contain the same contents as it would if you installed the plugin normally.

File (YAML)

# Dynamic configuration
http:
  middlewares:
    whois:
      plugin:
        traefik-whois-middleware:
          debugLogs: true

File (TOML)

# Dynamic configuration
[http]
  [http.middlewares]
    [http.middlewares.whois]
      [http.middlewares.whois.plugin]
        [http.middlewares.whois.plugin.traefik-whois-middleware]
          debugLogs = true

---

Contributors ✨

We are always looking for contributors. If you feel that you can provide something useful to Gistr, then we'd love to review your suggestion. Before submitting your contribution, please review the following resources:

• Pull Request Procedure
• Contributor Policy

Want to help but can't write code?

• Review active questions by our community and answer the ones you know.

The following people have helped get this project going:

Aetherinox 💻 📆 🔍

Documentation

Index

• Variables
• func New(ctx context.Context, next http.Handler, config *Config, name string) (http.Handler, error)
• type Config
  • func CreateConfig() *Config
• type KeyAuth
  • func (ka *KeyAuth) ServeHTTP(rw http.ResponseWriter, req *http.Request)

Variables

var BBlack = "\033[1;30m"

var BBlue = "\033[1;34m"

var BCyan = "\033[1;36m"

var BGreen = "\033[1;32m"

var BPurple = "\033[1;35m"

var BRed = "\033[1;31m"

var BWhite = "\033[1;37m"

var BYellow = "\033[1;33m"

var Blue = "\033[34m"

var BlueL = "\033[94m"

var Cyan = "\033[36m"

var Gray = "\033[37m"

var GrayD = "\033[90m"

var Green = "\033[32m"

var GreenL = "\033[92m"

var Magenta = "\033[35m"

var Orange = "\033[33m"

var PurpleL = "\033[95m"

var Red = "\033[31m"

var RedL = "\033[91m"

var Reset = "\033[0m"

var White = "\033[97m"

var Yellow = "\033[93m"

Functions

func New

func New(ctx context.Context, next http.Handler, config *Config, name string) (http.Handler, error)

Types

type Config

type Config struct {
	DebugLogs bool `json:"debugLogs,omitempty"`
}

func CreateConfig

func CreateConfig() *Config

type KeyAuth

type KeyAuth struct {
	// contains filtered or unexported fields
}

func (*KeyAuth) ServeHTTP

func (ka *KeyAuth) ServeHTTP(rw http.ResponseWriter, req *http.Request)