Skip to content
Parses CloudFlare's CF-Connecting-IP header into Plug.Conn's remote_ip field.
Elixir
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
test
.formatter.exs
.gitignore
.travis.yml
LICENSE
README.md
ips-v4
ips-v6
mix.exs

README.md

plug_cloudflare

Inspired by mod_cloudflare, this Elixir plug parses CloudFlare's CF-Connecting-IP HTTP request header into Plug.Conn's remote_ip field.

Hex.pm Version Build Status

Setup

To use plug_cloudflare in your projects, edit your mix.exs file and add plug_cloudflare as a dependency:

defp deps do
  [
    {:plug_cloudflare, ">= 1.2.0"}
  ]
end

Usage

This plug should be one of the first ones in your pipeline. It is therefore recommended to put it in the endpoint instead of a pipeline.

defmodule MyApp.Endpoint do
  use Phoenix.Endpoint, otp_app: my_app

  plug Plug.CloudFlare

  # Other plugs omitted for clarity
  
end

Contribution Process

This project uses the C4.1 process for all code changes.

"Everyone, without distinction or discrimination, SHALL have an equal right to become a Contributor under the terms of this contract."

License

Apache License, Version 2.0

You can’t perform that action at this time.