PhoenixApiToolkit.Security.Plugs.set_forwarded_ip

You're seeing just the function set_forwarded_ip, go back to PhoenixApiToolkit.Security.Plugs module for more information.
Link to this function

set_forwarded_ip(conn, opts \\ [])

View Source

Specs

set_forwarded_ip(Plug.Conn.t(), Plug.opts()) :: Plug.Conn.t()

Set conn.remote_ip to the value in header "x-forwarded-for", if present.

## Examples

use Plug.Test

def conn_with_ip, do: conn(:get, "/") |> Map.put(:remote_ip, {127, 0, 0, 12})

# by default, the value of `remote_ip` is left alone
iex> conn = conn_with_ip() |> set_forwarded_ip()
iex> conn.remote_ip
{127, 0, 0, 12}

# if header "x-forwarded-for" is set, remote ip is overwritten
iex> conn = conn_with_ip() |> put_req_header("x-forwarded-for", "10.0.0.1") |> set_forwarded_ip()
iex> conn.remote_ip
{10, 0, 0, 1}