Improve documentation and add request flow diagram

Author: fox34

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "nginx-auth-server"
-version = "0.2.0"
+version = "0.3.0"
 authors = ["Steffen Manzer"]
 edition = '2024'
 

README.md

@@ -2,6 +2,10 @@
 
 This is a **small and lightweight** http server, to be used by nginx to authenticate users against linux system users via PAM and an auxiliary totp file with `ngx_http_auth_request_module`.
 
+## Request flow
+
+![Request flow diagram](docs/nginx-auth-request.svg)
+
 ## Scope and code quality
 
 ### Project goals

docs/nginx-auth-request.drawio

@@ -1 +1,2 @@
-proxy_set_header Remote-User $auth_user;
+# Include this snippet in your `location`-block to implement Single-Sign-On for reverse proxy use cases
+proxy_set_header Remote-User $auth_user;

docs/nginx-auth-request.svg

@@ -25,7 +25,7 @@ auth_request_set $auth_user $upstream_http_remote_user;
 add_header Remote-User $auth_user always;
 error_page 401 $scheme://$host/auth/;
 
-# To implement Single-Sign-On: Add to location-Block:
+# To implement Single-Sign-On for reverse proxy use cases: Add to location-Block:
 # include /etc/nginx/snippets/auth-sso.conf;
 # or
 # proxy_set_header Remote-User $auth_user;

examples/etc/nginx/snippets/auth-sso.conf

@@ -89,7 +89,7 @@ async fn main() {
     }
 
     let app = Router::new()
-        .route("/auth/check", get(check_login))
+        .route("/auth/check", get(check_session))
         .route("/auth/login", post(handle_login))
         .with_state(sessions.into())
     ;
@@ -100,7 +100,7 @@ async fn main() {
 }
 
 /// Internal session / auth check, used by nginx
-async fn check_login(
+async fn check_session(
     State(sessions): State<Arc<SessionStore>>,
     jar: CookieJar,
 ) -> Response