From 649d6d385874a6f5120075df88074bd19713e43b Mon Sep 17 00:00:00 2001
From: Dan Ballard <dan@mindstab.net>
Date: Sun, 27 Sep 2020 19:30:35 -0700
Subject: [PATCH] nginx instructions comment

---
 README.md | 4 ++++
 main.go   | 3 +++
 2 files changed, 7 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c8ddd3c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,4 @@
+Requires
+	proxy_set_header X-Real-IP $remote_addr;
+in nginx server config
+
diff --git a/main.go b/main.go
index 3a9cb9f..a2194d7 100644
--- a/main.go
+++ b/main.go
@@ -61,6 +61,9 @@ func listen(listenPort, proxyPort int) {
 func filter(res http.ResponseWriter, req *http.Request, listenPort, proxyPort int) {
 	ip := req.RemoteAddr
 
+	// requires
+	// proxy_set_header X-Real-IP $remote_addr;
+	// in nginx server config
 	if realIp := req.Header.Get("X-Real-IP"); realIp != "" {
 		ip = realIp
 	}