Update Documentation

README.md

@@ -2,4 +2,132 @@
 
 If Traefik is behind a load balancer, it won't be able to get the Real IP from the external client by checking the remote IP address.
 
-This plugin solves this issue by overwriting the X-Real-Ip with an IP from the X-Forwarded-For or Cf-Connecting-Ip (if from Cloudflare) header. The real IP will be the first one that is not included in any of the CIDRs passed as the ExcludedNets parameter. The evaluation of the X-Forwarded-For or Cf-Connecting-Ip (if from Cloudflare) IPs will go from the last to the first one.
+This plugin solves this issue by overwriting the X-Real-Ip with an IP from the X-Forwarded-For or Cf-Connecting-Ip (if from Cloudflare) header. The real IP will be the first one that is not included in any of the CIDRs passed as the ExcludedNets parameter. The evaluation of the X-Forwarded-For or Cf-Connecting-Ip (if from Cloudflare) IPs will go from the last to the first one.
+
+#
+## Configuration
+
+### Static
+
+```yaml
+pilot:
+  token: xxxx
+
+experimental:
+  plugins:
+    traefik-real-ip:
+      modulename: github.com/soulbalz/traefik-real-ip
+      version: v1.0.5
+```
+
+### Dynamic configuration
+
+```yaml
+http:
+  routers:
+    my-router:
+      rule: Path(`/whoami`)
+      service: service-whoami
+      entryPoints:
+        - http
+      middlewares:
+        - traefik-real-ip
+
+  services:
+   service-whoami:
+      loadBalancer:
+        servers:
+          - url: http://127.0.0.1:5000
+
+  middlewares:
+    traefik-real-ip:
+      plugin:
+        traefik-real-ip:
+          excludednets:
+            - "1.1.1.1/24"
+```
+
+### Kubernetes configuration
+
+```yaml
+kind: Deployment
+apiVersion: apps/v1
+metadata:
+  namespace: default
+  name: traefik
+  labels:
+    app: traefik
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: traefik
+  template:
+    metadata:
+      labels:
+        app: traefik
+    spec:
+      terminationGracePeriodSeconds: 60
+      serviceAccountName: traefik-ingress-controller
+      containers:
+        - name: traefik
+          image: traefik:v2.4
+          args:
+            - --api.insecure
+            - --accesslog
+            - --entrypoints.web.Address=:80
+            - --providers.kubernetescrd
+            - --pilot.token={YOUR_PILOT_TOKEN}
+            - --experimental.plugins.traefik-real-ip.modulename=github.com/soulbalz/traefik-real-ip
+            - --experimental.plugins.traefik-real-ip.version=v1.0.2
+          ports:
+            - name: web
+              containerPort: 80
+            - name: admin
+              containerPort: 8080
+          resources:
+            requests:
+              cpu: 300m
+            limits:
+              cpu: 500m
+
+---
+apiVersion: traefik.containo.us/v1alpha1
+kind: Middleware
+metadata:
+  name: traefik-real-ip
+spec:
+  plugin:
+    traefik-real-ip:
+      excludednets:
+        - "1.1.1.1/24"
+
+---
+apiVersion: traefik.containo.us/v1alpha1
+kind: IngressRoute
+metadata:
+  name: ingress-example
+  namespace: default
+spec:
+  entryPoints:
+    - web
+  routes:
+    - kind: Rule
+      match: Host(`domain.ltd`) && PathPrefix(`/`)
+      services:
+        - name: example-service
+          port: 80
+      middlewares:
+        - name: traefik-real-ip
+```
+
+#
+## Configuration documentation
+
+Supported configurations per body
+
+| Setting           | Allowed values      | Required    | Description |
+| :--               | :--                 | :--         | :--         |
+| excludednets      | []string            | No          | IP or IP range to exclude forward IP |
+
+#