summaryrefslogtreecommitdiffstats
path: root/vendor/github.com/chi-middleware/proxy/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/github.com/chi-middleware/proxy/README.md')
-rw-r--r--vendor/github.com/chi-middleware/proxy/README.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/vendor/github.com/chi-middleware/proxy/README.md b/vendor/github.com/chi-middleware/proxy/README.md
new file mode 100644
index 0000000000..2ddaedc5aa
--- /dev/null
+++ b/vendor/github.com/chi-middleware/proxy/README.md
@@ -0,0 +1,46 @@
+# [Chi](https://github.com/go-chi/chi) proxy middleware
+
+Forwarded headers middleware to use if application is run behind reverse proxy.
+
+[![Documentation](https://godoc.org/github.com/chi-middleware/proxy?status.svg)](https://pkg.go.dev/github.com/chi-middleware/proxy)
+[![codecov](https://codecov.io/gh/chi-middleware/proxy/branch/master/graph/badge.svg)](https://codecov.io/gh/chi-middleware/proxy)
+[![Go Report Card](https://goreportcard.com/badge/github.com/chi-middleware/proxy)](https://goreportcard.com/report/github.com/chi-middleware/proxy)
+[![Build Status](https://cloud.drone.io/api/badges/chi-middleware/proxy/status.svg?ref=refs/heads/master)](https://cloud.drone.io/chi-middleware/proxy)
+
+## Usage
+
+Import using:
+
+```go
+import "github.com/chi-middleware/proxy"
+```
+
+Use middleware with default options (trusted from proxy `127.0.0.1` and trusts only last IP address provided in header):
+
+```go
+ r := chi.NewRouter()
+ r.Use(proxy.ForwardedHeaders())
+```
+
+Extend default options:
+
+```go
+ r := chi.NewRouter()
+ r.Use(proxy.ForwardedHeaders(
+ proxy.NewForwardedHeadersOptions().
+ WithForwardLimit(2).
+ ClearTrustedProxies().AddTrustedProxy("10.0.0.1"),
+ ))
+```
+
+Provide custom options:
+
+```go
+ r := chi.NewRouter()
+ r.Use(proxy.ForwardedHeaders(&ForwardedHeadersOptions{
+ ForwardLimit: 1,
+ TrustedProxies: []net.IP{
+ net.IPv4(10, 0, 0, 1),
+ },
+ }))
+```