From f025cd6761be8cd9672d56bf8f9f33d77464d146 Mon Sep 17 00:00:00 2001 From: Neale Pickett Date: Sun, 5 Dec 2021 17:18:57 -0700 Subject: [PATCH] Update the README --- README.md | 41 ++++++++++++++++++++++++++++++++++++++++- 1 file changed, 40 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ddd44e2..97fa7fc 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,46 @@ +# Simple Auth + All this does is present a login page. Upon successful login, the browser gets a cookie, and further attempts to access will get the success page. I made this to use with the Traefik forward-auth middleware. -All I need was a simple password, that's easy to fill with a password manager. +All I need is a simple password, that's easy to fill with a password manager. This checks those boxes. + +## Installation with Traefik + +I only use docker swarm. You'd do something like the following: + +```yaml +services: + my-cool-service: + # All your cool stuff here + deploy: + labels: + # Keep all your existing traefik stuff + traefik.http.routers.dashboard.middlewares: forward-auth + traefik.http.middlewares.forward-auth.forwardauth.address: http://simpleauth:8080/ + simpleauth: + image: ghcr.io/nealey/simpleauth + secrets: + - password + deploy: + labels: + traefik.enable: "true" + traefik.http.routers.simpleauth.rules: "PathPrefix(`/`)" + traefik.http.services.simpleauth.loadbalancer.server.port: "8080" + +secrets: + password: + file: password + name: password-v1 +``` + +## Note + +For some reason that I haven't bothered looking into, +I have to first load `/` in the browser. +I think it has something to do with cookies going through traefik simpleauth, +and I could probably fix it with some JavaScript, +but this is good enough for me.