elysia-ip's Introduction

elysia-ip

Get the Client Ip Address in Elysia.

It supports Cloudflare, Fastly and other runtimes as well.

Installation

Requires Bun v1.0.4 or above.

bun a elysia-ip

Documentation

Introduction

This plugin let's you get client's ip address in Elysia.js

It supports Multiple runtimes (Cloudflare, Fastly Edge, etc.)

Usage

import { Elysia } from "elysia";
import { ip } from "elysia-ip";

new Elysia().use(ip()).get("/", ({ ip }) => ip).listen(3000);

How does it work?

It relies on headers for runtimes other than Bun. Cloudflare and other providers send back specific headers, containing the IP address. For example CF-Connecting-IP for Cloudflare and Fastly-Client-IP for Fastly.

We also add support for X-Forwarded-For header (de-facto standard header) and other various headers.

Priority list:

User specified
X-Forwarded-For (de-facto standard header)
CF-Connecting-IP (Cloudflare)
Fastly-Client-IP (Fastly)
X-Real-IP (Apache)
X-Client-IP (Nginx)
X-Cluster-Client-IP (GCP)
X-Forwarded (RFC 7239)
Forwarded-For (RFC 7239)
Forwarded (RFC 7239)
appengine-user-ip (GCP)
true-client-ip (Akamai and Cloudflare)
cf-pseudo-ipv4 (Cloudflare)

You can even specify your own header or list of headers if you want to as following

import { Elysia } from "elysia";
import { ip } from "elysia-ip";

new Elysia().use(ip({ checkHeaders: ["X-Forwarded-For", "X-Real-IP"] })).get("/", ({ ip }) => ip).listen(3000);

import { Elysia } from "elysia";
import { ip } from "elysia-ip";

new Elysia().use(ip({ checkHeaders: "X-Forwarded-For" })).get("/", ({ ip }) => ip).listen(3000);