Added README.md

vslinko · Apr 1, 2024 · ca21c67 · ca21c67
1 parent 25884db
commit ca21c67
Showing 1 changed file with 42 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,42 @@
+# Secret Auth
+
+Authorise requests by secret cookie
+
+## Configuration
+
+```yaml
+# Static configuration
+
+experimental:
+  plugins:
+    example:
+      moduleName: github.com/vslinko/secret-auth
+      version: v0.1.0
+```
+
+```yaml
+# Dynamic configuration
+
+http:
+  routers:
+    my-router:
+      rule: host(`demo.localhost`)
+      service: service-foo
+      entryPoints:
+        - web
+      middlewares:
+        - secret-auth
+
+  services:
+    service-foo:
+      loadBalancer:
+        servers:
+          - url: http://127.0.0.1:5000
+
+  middlewares:
+    secret-auth:
+      plugin:
+        secret-auth:
+          cookieName: myCookie
+          secretKey: mySecretKey
+```