Module ngx_stream_proxy_module

Example Configuration
Directives
     proxy_bind
     proxy_buffer_size
     proxy_connect_timeout
     proxy_download_rate
     proxy_next_upstream
     proxy_next_upstream_timeout
     proxy_next_upstream_tries
     proxy_pass
     proxy_protocol
     proxy_responses
     proxy_ssl
     proxy_ssl_certificate
     proxy_ssl_certificate_key
     proxy_ssl_ciphers
     proxy_ssl_crl
     proxy_ssl_name
     proxy_ssl_password_file
     proxy_ssl_server_name
     proxy_ssl_session_reuse
     proxy_ssl_protocols
     proxy_ssl_trusted_certificate
     proxy_ssl_verify
     proxy_ssl_verify_depth
     proxy_timeout
     proxy_upload_rate

The ngx_stream_proxy_module module (1.9.0) allows proxying data streams over TCP, UDP (1.9.13), and UNIX-domain sockets.

Example Configuration

server {
    listen 127.0.0.1:12345;
    proxy_pass 127.0.0.1:8080;
}

server {
    listen 12345;
    proxy_connect_timeout 1s;
    proxy_timeout 1m;
    proxy_pass example.com:12345;
}

server {
    listen 53 udp;
    proxy_responses 1;
    proxy_timeout 20s;
    proxy_pass dns.example.com:53;
}

server {
    listen [::1]:12345;
    proxy_pass unix:/tmp/stream.socket;
}

Directives

Syntax: proxy_bind address [transparent] | off;
Default:
Context: stream, server

This directive appeared in version 1.9.2.

Makes outgoing connections to a proxied server originate from the specified local IP address. Parameter value can contain variables (1.11.2). The special value off cancels the effect of the proxy_bind directive inherited from the previous configuration level, which allows the system to auto-assign the local IP address.

The transparent parameter (1.11.0) allows outgoing connections to a proxied server originate from a non-local IP address, for example, from a real IP address of a client:

proxy_bind $remote_addr transparent;

In order for this parameter to work, it is necessary to run nginx worker processes with the superuser privileges and configure kernel routing table to intercept network traffic from the proxied server.

Syntax: proxy_buffer_size size;
Default:
proxy_buffer_size 16k;
Context: stream, server

This directive appeared in version 1.9.4.

Sets the size of the buffer used for reading data from the proxied server. Also sets the size of the buffer used for reading data from the client.

Syntax: proxy_connect_timeout time;
Default:
proxy_connect_timeout 60s;
Context: stream, server

Defines a timeout for establishing a connection with a proxied server.

Syntax: proxy_download_rate rate;
Default:
proxy_download_rate 0;
Context: stream, server

This directive appeared in version 1.9.3.

Limits the speed of reading the data from the proxied server. The rate is specified in bytes per second. The zero value disables rate limiting. The limit is set per a connection, so if nginx simultaneously opens two connections to the proxied server, the overall rate will be twice as much as the specified limit.

Syntax: proxy_next_upstream on | off;
Default:
proxy_next_upstream on;
Context: stream, server

When a connection to the proxied server cannot be established, determines whether a client connection will be passed to the next server.

Passing a connection to the next server can be limited by the number of tries and by time.

Syntax: proxy_next_upstream_timeout time;
Default:
proxy_next_upstream_timeout 0;
Context: stream, server

Limits the time allowed to pass a connection to the next server. The 0 value turns off this limitation.

Syntax: proxy_next_upstream_tries number;
Default:
proxy_next_upstream_tries 0;
Context: stream, server

Limits the number of possible tries for passing a connection to the next server. The 0 value turns off this limitation.

Syntax: proxy_pass address;
Default:
Context: server

Sets the address of a proxied server. The address can be specified as a domain name or IP address, and a port:

proxy_pass localhost:12345;

or as a UNIX-domain socket path:

proxy_pass unix:/tmp/stream.socket;

If a domain name resolves to several addresses, all of them will be used in a round-robin fashion. In addition, an address can be specified as a server group.

The address can also be specified using variables (1.11.3):

proxy_pass $upstream;

In this case, the server name is searched among the described server groups, and, if not found, is determined using a resolver.

Syntax: proxy_protocol on | off;
Default:
proxy_protocol off;
Context: stream, server

This directive appeared in version 1.9.2.

Enables the PROXY protocol for connections to a proxied server.

Syntax: proxy_responses number;
Default:
Context: stream, server

This directive appeared in version 1.9.13.

Sets the number of datagrams expected from the proxied server in response to the client request if the UDP protocol is used. By default, the number of datagrams is not limited: the response datagrams will be sent until the proxy_timeout value expires.

Syntax: proxy_ssl on | off;
Default:
proxy_ssl off;
Context: stream, server

Enables the SSL/TLS protocol for connections to a proxied server.

Syntax: proxy_ssl_certificate file;
Default:
Context: stream, server

Specifies a file with the certificate in the PEM format used for authentication to a proxied server.

Syntax: proxy_ssl_certificate_key file;
Default:
Context: stream, server

Specifies a file with the secret key in the PEM format used for authentication to a proxied server.

Syntax: proxy_ssl_ciphers ciphers;
Default:
proxy_ssl_ciphers DEFAULT;
Context: stream, server

Specifies the enabled ciphers for connections to a proxied server. The ciphers are specified in the format understood by the OpenSSL library.

The full list can be viewed using the “openssl ciphers” command.

Syntax: proxy_ssl_crl file;
Default:
Context: stream, server

Specifies a file with revoked certificates (CRL) in the PEM format used to verify the certificate of the proxied server.

Syntax: proxy_ssl_name name;
Default:
proxy_ssl_name host from proxy_pass;
Context: stream, server

Allows overriding the server name used to verify the certificate of the proxied server and to be passed through SNI when establishing a connection with the proxied server. The server name can also be specified using variables (1.11.3).

By default, the host part of the proxy_pass address is used.

Syntax: proxy_ssl_password_file file;
Default:
Context: stream, server

Specifies a file with passphrases for secret keys where each passphrase is specified on a separate line. Passphrases are tried in turn when loading the key.

Syntax: proxy_ssl_server_name on | off;
Default:
proxy_ssl_server_name off;
Context: stream, server

Enables or disables passing of the server name through TLS Server Name Indication extension (SNI, RFC 6066) when establishing a connection with the proxied server.

Syntax: proxy_ssl_session_reuse on | off;
Default:
proxy_ssl_session_reuse on;
Context: stream, server

Determines whether SSL sessions can be reused when working with the proxied server. If the errors “SSL3_GET_FINISHED:digest check failed” appear in the logs, try disabling session reuse.

Syntax: proxy_ssl_protocols [SSLv2] [SSLv3] [TLSv1] [TLSv1.1] [TLSv1.2] [TLSv1.3];
Default:
proxy_ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
Context: stream, server

Enables the specified protocols for connections to a proxied server.

Syntax: proxy_ssl_trusted_certificate file;
Default:
Context: stream, server

Specifies a file with trusted CA certificates in the PEM format used to verify the certificate of the proxied server.

Syntax: proxy_ssl_verify on | off;
Default:
proxy_ssl_verify off;
Context: stream, server

Enables or disables verification of the proxied server certificate.

Syntax: proxy_ssl_verify_depth number;
Default:
proxy_ssl_verify_depth 1;
Context: stream, server

Sets the verification depth in the proxied server certificates chain.

Syntax: proxy_timeout timeout;
Default:
proxy_timeout 10m;
Context: stream, server

Sets the timeout between two successive read or write operations on client or proxied server connections. If no data is transmitted within this time, the connection is closed.

Syntax: proxy_upload_rate rate;
Default:
proxy_upload_rate 0;
Context: stream, server

This directive appeared in version 1.9.3.

Limits the speed of reading the data from the client. The rate is specified in bytes per second. The zero value disables rate limiting. The limit is set per a connection, so if the client simultaneously opens two connections, the overall rate will be twice as much as the specified limit.