Mercurial > hg > nginx-site

comparison xml/en/docs/mail/ngx_mail_realip_module.xml @ 2677:3760176ba83e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Documented ngx_mail_realip_module.
author Yaroslav Zhuravlev <yar@nginx.com>
date Wed, 10 Mar 2021 20:35:36 +0000
parents
children
comparison
equal deleted inserted replaced
2676:468e6e14e5cc 2677:3760176ba83e
1 <?xml version="1.0"?>
2
3 <!--
4 Copyright (C) Nginx, Inc.
5 -->
6
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
8
9 <module name="Module ngx_mail_realip_module"
10 link="/en/docs/mail/ngx_mail_realip_module.html"
11 lang="en"
12 rev="1">
13
14 <section id="summary">
15
16 <para>
17 The <literal>ngx_mail_realip_module</literal> module is used
18 to change the client address and port
19 to the ones sent in the PROXY protocol header (1.19.8).
20 The PROXY protocol must be previously enabled by setting the
21 <link doc="ngx_mail_core_module.xml" id="proxy_protocol"/> parameter
22 in the <literal>listen</literal> directive.
23 </para>
24
25 </section>
26
27
28 <section id="example" name="Example Configuration">
29
30 <para>
31 <example>
32 listen 110 proxy_protocol;
33
34 set_real_ip_from 192.168.1.0/24;
35 set_real_ip_from 192.168.2.1;
36 set_real_ip_from 2001:0db8::/32;
37 </example>
38 </para>
39
40 </section>
41
42
43 <section id="directives" name="Directives">
44
45 <directive name="set_real_ip_from">
46 <syntax>
47 <value>address</value> |
48 <value>CIDR</value> |
49 <literal>unix:</literal></syntax>
50 <default/>
51 <context>mail</context>
52 <context>server</context>
53
54 <para>
55 Defines trusted addresses that are known to send correct
56 replacement addresses.
57 If the special value <literal>unix:</literal> is specified,
58 all UNIX-domain sockets will be trusted.
59 </para>
60
61 </directive>
62
63 </section>
64
65 </module>