Tip
Skip forward to step 9 to see what the whole configuration file should look like when you have finished the modifications described here.
Jump toSuggest an edit
Using Proxy Protocol v2 with your Load Balancer
Reviewed on 04 March 2024 • Published on 28 June 2019
- compute
- Proxy-Protocol
- IP
- Load-Balancer
Proxy Protocol allows a backend application, like an Apache or Nginx web server, to retrieve client connection information that has passed through a load-balanced infrastructure. The protocol transports connection information including the originating IP address, the proxy server IP address, and both ports.
This tutorial shows you how and why to enable Proxy Protocol on your Scaleway Load Balancer, and how to configure your backend server application to correctly handle the protocol.
Before you start
To complete the actions presented below, you must have:
- A Scaleway account logged into the console
- Owner status or IAM permissions allowing you to perform actions in the intended Organization
- An SSH key
- Created and configured a Load Balancer
Do I need to enable Proxy Protocol on my Load Balancer?
Without Proxy Protocol enabled, the backend server receives only the Load Balancer’s IP address in its access logs, and not the IP address of the original client:
In the example above, the IP 51.159.26.16 is visible in the log file, which is the Load Balancer’s IP address and not the IP of the different users.
With Proxy Protocol enabled, an additional header is added, showing the proxy (Load Balancer) IP address, but also the client IP address and source/destination ports:
In the example above, the IP 51.159.26.16 represents the Load Balancer’s IP, 203.0.113.1 is the original client’s IP, and 12345 and 80 are the source and destination ports.
This additional information can be useful for delivery of localized content, blacklisting of abusive users or logging purposes. If these use cases do not apply to you, it may not be useful to enable Proxy Protocol.
Note that Proxy Protocol is more commonly activated for Load Balancers using TCP protocol. Load Balancers using HTTP protocol already pass information about the client IP address to the backend servers via an HTTP X-Forwarded-For header, without needing to activate Proxy Protocol. If your Load Balancer uses HTTP protocol and you do not require the standardized information in the Proxy Protocol headers at the backend server, the X-Forwarded-For headers may be sufficient.
Enabling Proxy Protocol on your Load Balancer
You can enable Proxy Protocol for your Load Balancer when you create your Load Balancer’s backend, or after creation by editing a backend. Proxy protocol is one of the basic backend settings you are prompted to configure.
See our advanced documentation on configuring backends for full information about the different Proxy Protocol versions available, and the configuration process.
Configuring your backend web server for Proxy Protocol
Once you have enabled Proxy Protocol on your Load Balancer, you must configure your backend web server to handle this information. The sections below show how to configure some common backend web server applications for Proxy Protocol:
Configuring Proxy Protocol in Nginx Web Server
The proxy_protocol parameter must be set within the http {} block of the listen directive of a server block to configure NGINX to accept Proxy protocol headers.
-
Make sure that Nginx is installed with the
http_realip_module. This is the case in the precompiled version that is delivered with Ubuntu Bionic Beaver (18.04).nginx -V 2>&1 | grep -- 'http_realip_module' -
Open the configuration file of nginx, i.e.
/etc/nginx/nginx.confin a text editor, for example,nano:nano /etc/nginx/nginx.conf -
Enable the
proxy_protocolby adding/modifying the following lines in theserver {}block:server {...listen 80 proxy_protocol;listen 443 ssl proxy_protocol;...} -
Set the IP address of the Load Balancer with the
set_real_ip_fromdirective in theserver {}block. Make sure you replace{LB_IP}with the IP address of your Load Balancer:set_real_ip_from {LB_IP}; -
To change the IP address of the Load Balancer to the clients IP address, received from the PROXY protocol header, specify in the
server {}block theproxy_protocolparameter to the real_ip_header directive:real_ip_header proxy_protocol; -
As the client’s IP address is now known to Nginx, configure its correct logging. Set the
proxy_set_headerdirective with the$remote_addrvariable in thehttp {}block:http {proxy_set_header X-Real-IP $remote_addr;proxy_set_header X-Forwarded-For $remote_addr;} -
Configure the
$remote_addrvariable to thelog_formatdirective in the http block:http {#...log_format logs '$remote_addr - $remote_user [$time_local] ''"$request" $status $body_bytes_sent ''"$http_referer" "$http_user_agent"';} -
Add a log line at the end of the configuration block:
access_log /var/log/nginx/access.log logs; -
Check that your configuration file looks like the following example:
http {proxy_set_header X-Real-IP $remote_addr;proxy_set_header X-Forwarded-For $remote_addr;log_format logs '$remote_addr - $remote_user [$time_local] ''"$request" $status $body_bytes_sent ''"$http_referer" "$http_user_agent"';#...server {server_name example.com;listen 80 proxy_protocol;set_real_ip_from {LB_IP};real_ip_header proxy_protocol;#...}access_log /var/log/nginx/access.log logs;} -
Save the configuration file, exit the editor, and test the syntax of the file:
nginx -t -
Restart Nginx:
systemctl restart nginx.service195.154.228.158 - - [28/Jun/2019:15:44:23 +0000] "GET /favicon.ico HTTP/1.1" 200 26062 "http://51.159.26.16/index.php" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/74.0.3729.169 Safari/537.36"51.159.26.16 - - [28/Jun/2019:15:44:31 +0000] "GET /index.php HTTP/1.1" 200 26100 "-" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/74.0.3729.169 Safari/537.36"195.154.228.158 - - [28/Jun/2019:15:44:32 +0000] "GET /favicon.ico HTTP/1.1" 200 26065 "http://51.159.26.16/index.php" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/74.0.3729.169 Safari/537.36"51.159.26.16 - - [28/Jun/2019:15:44:50 +0000] "GET /index.php HTTP/1.1" 200 26097 "-" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/74.0.3729.169 Safari/537.36"ImportantOnce Proxy Protocol is enabled the Nginx virtual host will no longer accept direct connections. See the NGINX Proxy Protocol documentation for full details.
Configuring Proxy Protocol in Apache Web Server
The Proxy Protocol support in Apache is still in an early stage. It is currently not natively supported with the Apache version provided by Ubuntu. An unofficial plugin is available for Apache versions prior to 2.4.30. To use it, follow these steps:
-
Download and install the required software components:
apt install git apache2-dev -
Download the sources of the plugin and enter their directory:
git clone https://github.com/roadrunner2/mod-proxy-protocol.gitcd mod-proxy-protocol -
Build the plugin:
apxs -i -a -c mod_proxy_protocol.c -
Activate the module in the configuration of the virtual host:
<VirtualHost *:80>...ProxyProtocol On...</VirtualHost> -
Replace all
%hby%aof theLogFormatdirectives in the Apache configuration file (/etc/apache2/apache2.conf):LogFormat "%v:%p %h %l %u %t \"%r\" %>s %O \"%{Referer}i\" \"%{User-Agent}i\"" vhost_combinedLogFormat "%a %l %u %t \"%r\" %>s %O \"%{Referer}i\" \"%{User-Agent}i\"" combinedLogFormat "%a %l %u %t \"%r\" %>s %O" commonLogFormat "%{Referer}i -> %U" refererLogFormat "%{User-agent}i" agent -
Restart Apache to activate the new configuration:
apache2ctl restartImportantOnce ProxyProtocol is enabled the Apache virtual host will no longer accept direct connections.
Configuring Proxy Protocol in Apache with mod_remoteip
Important
An Apache version >= 2.4.30 is required to use mod_remoteip. This version is currently not yet available in Ubuntu’s repositories, and you have to install it by yourself. Use it only if you know what you are doing.
- Enable the module
remoteip:a2enmod remoteip - Configure the Apache virtual host configuration:
<VirtualHost *:80>...RemoteIPProxyProtocol On...</VirtualHost>
- Restart the Apache web server:
apache2ctl restart
Important
Once ProxyProtocol is enabled the Apache virtual host will no longer accept direct connections.
Configuring Proxy protocol for ingress-nginx
Deployed through kubectl
-
Add the two annotations below to your ingress controller
service:service.beta.kubernetes.io/scw-loadbalancer-proxy-protocol-v2: "true"service.beta.kubernetes.io/scw-loadbalancer-use-hostname: "true"
kubectl annotate -n ingress-nginx services ingress-nginx-controller "service.beta.kubernetes.io/scw-loadbalancer-proxy-protocol-v2=true"kubectl annotate -n ingress-nginx services ingress-nginx-controller "service.beta.kubernetes.io/scw-loadbalancer-use-hostname=true" -
Add the configuration below to the ingress controller
configmap:kubectl patch -n ingress-nginx configmaps ingress-nginx-controller \-p '{"data":{"use-forwarded-headers": "true", "compute-full-forwarded-for": "true", "use-proxy-protocol": "true"}}'
Deployed through helm
If you are using the ingress-nginx Helm chart, find below a custom values file that will automatically create a load balancer resource and configure it to use proxy-protocol-v2, and add the required ingress controller configuration to support this new communication protocol:
-
Create the file below (e.g.
ingress-nginx-scw.yaml) using a text editor.controller:# Do not use Deployment if using `externalTrafficPolicy: "Local"`kind: DaemonSetservice:# Your LB IP here if you want (optional)#loadBalancerIP: "X.X.X.X"# This means that each node will deliver traffic only to the node-local endpoints of the service,# without masquerading the client source IP. (Traffic mistakenly sent to a node with no endpoints will be dropped.)externalTrafficPolicy: "Local"annotations:# Configure the Scaleway LB to use Proxy-Protocolservice.beta.kubernetes.io/scw-loadbalancer-proxy-protocol-v2: "true"service.beta.kubernetes.io/scw-loadbalancer-use-hostname: "true"config:# Configure the ingress controller to use Proxy-Protocoluse-forwarded-headers: "true"compute-full-forwarded-for: "true"use-proxy-protocol: "true" -
Apply the above, on a new or an existing
ingress-nginxinstallation:# Once the above file is created, you can run the below# https://kubernetes.github.io/ingress-nginx/deploy/#quick-starthelm upgrade --install ingress-nginx ingress-nginx \--repo https://kubernetes.github.io/ingress-nginx \--namespace ingress-nginx --create-namespace \-f ingress-nginx-scw.yaml