Mercurial > hg > nginx-site

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