From ee70b30a97205ac1f32889f41d8a494b3b2c81a5 Mon Sep 17 00:00:00 2001
From: Endless Paradox <129645532+EndlessParadox1@users.noreply.github.com>
Date: Wed, 13 Mar 2024 23:22:05 +0800
Subject: [PATCH] docs: Add document  to constant `AuthProxyUserKey` and 
 `BasicAuthForProxy`. (#3887)

---
 auth.go | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/auth.go b/auth.go
index 2ed33ac..5d3222d 100644
--- a/auth.go
+++ b/auth.go
@@ -15,6 +15,8 @@ import (
 
 // AuthUserKey is the cookie name for user credential in basic auth.
 const AuthUserKey = "user"
+
+// AuthProxyUserKey is the cookie name for proxy_user credential in basic auth for proxy.
 const AuthProxyUserKey = "proxy_user"
 
 // Accounts defines a key/value for user/pass list of authorized logins.
@@ -92,6 +94,7 @@ func authorizationHeader(user, password string) string {
 }
 
 // BasicAuthForProxy returns a Basic HTTP Proxy-Authorization middleware.
+// If the realm is empty, "Proxy Authorization Required" will be used by default.
 func BasicAuthForProxy(accounts Accounts, realm string) HandlerFunc {
 	if realm == "" {
 		realm = "Proxy Authorization Required"