realip

README

RealIP [fasthttp]

Go package that can be used to get client's real public IP, which usually useful for logging HTTP server.

Feature

• Follows the rule of X-Real-IP
• Follows the rule of X-Forwarded-For
• Exclude local or private address

Example

package main

import "github.com/krecu/fasthttp-realip"

func RealIpHandler(ctx *fasthttp.RequestCtx) {
	clientIP := realip.FromRequest(ctx)
	log.Println("GET / from", clientIP)
}

Developing

Commited code must pass:

• golint
• go vet
• gofmt
• go test:

Documentation

Index

• func FromHeader(req fasthttp.Request) string
• func FromRequest(ctx *fasthttp.RequestCtx) string
• func RealIP(ctx *fasthttp.RequestCtx) string

Functions

func FromHeader

func FromHeader(req fasthttp.Request) string

FromHeader return client's real public IP address from http request headers.

func FromRequest

func FromRequest(ctx *fasthttp.RequestCtx) string

FromRequest return client's real public IP address from http request headers.

func RealIP

func RealIP(ctx *fasthttp.RequestCtx) string

RealIP is depreciated, use FromRequest instead