<!-- review: finished -->

<a id="http-realip"></a>

# RealIP

O módulo é usado para alterar o endereço do cliente e porta opcional para aqueles enviados no campo de cabeçalho especificado.

Ao [compilar a partir do código fonte](https://pt.angie.software//angie/docs/installation/sourcebuild.md#sourcebuild),
este módulo não é compilado por padrão;
ele deve ser habilitado com a
`‑‑with‑http_realip_module`
[opção de compilação](https://pt.angie.software//angie/docs/installation/sourcebuild.md#configure).

Em pacotes e imagens dos [nossos repositórios](https://pt.angie.software//angie/docs/installation/index.md#install-packages),
o módulo está incluído na compilação.

<a id="configuration-example-36"></a>

## Exemplo de Configuração

```nginx
set_real_ip_from  192.168.1.0/24;
set_real_ip_from  192.168.2.1;
set_real_ip_from  2001:0db8::/32;
real_ip_header    X-Forwarded-For;
real_ip_recursive on;
```

<a id="directives-37"></a>

## Diretivas

<a id="index-0"></a>

<a id="set-real-ip-from"></a>

### set_real_ip_from

| [Sintaxe](https://pt.angie.software//angie/docs/configuration/configfile.md#configfile)   | `set_real_ip_from` address | CIDR | `unix:`;   |
|-------------------------------------------------------------------------------------------|------------------------------------------------|
| Padrão                                                                                    | —                                              |
| [Contexto](https://pt.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                         |

Define endereços confiáveis que são conhecidos por enviar endereços de substituição corretos.
Se o valor especial `unix:` for especificado, todos os sockets de domínio UNIX serão
confiáveis. Endereços confiáveis também podem ser especificados usando um hostname.

<a id="index-1"></a>

<a id="real-ip-header"></a>

### real_ip_header

| [Sintaxe](https://pt.angie.software//angie/docs/configuration/configfile.md#configfile)   | `real_ip_header` field | `X-Real-IP` | `X-Forwarded-For` | `proxy_protocol`;   |
|-------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------|
| Padrão                                                                                    | `real_ip_header X-Real-IP;`                                                    |
| [Contexto](https://pt.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                                                         |

Define o campo de cabeçalho da requisição cujo valor será usado para substituir o endereço do cliente.

O valor do campo de cabeçalho da requisição que contém uma porta opcional também é usado para substituir a porta do cliente. O endereço e porta devem ser especificados de acordo com a [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986).

O parâmetro `proxy_protocol` altera o endereço do cliente para aquele do cabeçalho do protocolo PROXY. O protocolo PROXY deve ser previamente habilitado definindo o parâmetro proxy_protocol na diretiva [listen](https://pt.angie.software//angie/docs/configuration/modules/http/index.md#listen).

<a id="index-2"></a>

<a id="real-ip-recursive"></a>

### real_ip_recursive

| [Sintaxe](https://pt.angie.software//angie/docs/configuration/configfile.md#configfile)   | `real_ip_recursive` `on` | `off`;   |
|-------------------------------------------------------------------------------------------|-------------------------------------|
| Padrão                                                                                    | `real_ip_recursive off;`            |
| [Contexto](https://pt.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location              |

Se a busca recursiva estiver desabilitada, o endereço original do cliente que corresponde a um dos endereços confiáveis é substituído pelo último endereço enviado no campo de cabeçalho da requisição definido pela diretiva [real_ip_header](#real-ip-header). Se a busca recursiva estiver habilitada, o endereço original do cliente que corresponde a um dos endereços confiáveis é substituído pelo último endereço não confiável enviado no campo de cabeçalho da requisição.

<a id="built-in-variables-7"></a>

## Variáveis Integradas

<a id="v-realip-remote-addr"></a>

### `$realip_remote_addr`

mantém o endereço original do cliente

<a id="v-realip-remote-port"></a>

### `$realip_remote_port`

mantém a porta original do cliente