config.toml: add cautionary note around basic auth (#1109)

gomods · Mar 7, 2019 · a4450c1 · a4450c1
1 parent 36dae02
commit a4450c1
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/config.dev.toml b/config.dev.toml
@@ -72,6 +72,15 @@ Port = ":3000"
 # Env override: ATHENS_GLOBAL_ENDPOINT
 GlobalEndpoint = "http://localhost:3001"
 
+# BASIC AUTH OPTIONS 
+# ==================
+# PLASE NOTE THAT THIS IS A BAD HACK AROUND 
+# THE FACT THAT GO DOES NOT SUPPORT PROPER AUTHENTICATION 
+# YET! YOUR BASIC AUTH CREDENTIALS CAN EASILY LEAK 
+# IN ATHENS LOGS AS WELL AS GO COMMAND LOGS.
+# THIS WILL BE ADDRESSED IN 1.13.
+# SEE https://github.com/golang/go/issues/30610
+
 # Username for basic auth
 # Env override: BASIC_AUTH_USER
 BasicAuthUser = ""