Hoe voeg je een aangepaste response header toe in Nginx met proxy_pass?

Nginx Configureren voor Aangepaste Headers

De add_header directive in Nginx werkt met proxy_pass, waardoor u aangepaste headers kunt toevoegen aan antwoorden van upstream servers. Deze functie is nuttig voor het toevoegen van extra informatie of het wijzigen van het antwoord voordat het de client bereikt.

Om add_header met proxy_pass te gebruiken, neemt u het op in hetzelfde locatieblok als uw proxy_pass directive. Hier is een voorbeeld Nginx configuratie:

server {
    server_name example.com;

    location / {
        proxy_pass http://backend_server;
        add_header X-Custom-Header "Custom Value";
    }
}

In deze configuratie zal Nginx de X-Custom-Header met de waarde "Custom Value" toevoegen aan alle antwoorden van de backend_server. Deze header zal in het antwoord naar de client staan, ongeacht of Nginx of de upstream server het antwoord heeft gegenereerd.

De add_header directive is van toepassing op het huidige niveau en alle lagere niveaus tenzij overschreven. Als u alleen voor specifieke locaties headers wilt toevoegen, plaatst u de add_header directive in het juiste locatieblok.

location / {
    proxy_pass http://backend_server;
    add_header X-Response-Time $request_time;
    add_header X-Cache-Status $upstream_cache_status;
}

Stap-voor-Stap Handleiding

Om aangepaste headers toe te voegen bij het gebruik van proxy_pass in Nginx, volgt u deze stappen:

1. Bewerk het Nginx configuratiebestand: Open uw Nginx configuratiebestand met een teksteditor. Het bestand bevindt zich meestal op /etc/nginx/nginx.conf of /usr/local/nginx/conf/nginx.conf.

2. Voeg de add_header directive toe: Voeg in het server- of locatieblok de add_header directive toe. Plaats deze na de proxy_pass directive om het toe te passen op de proxied antwoorden.

3. Stel de aangepaste header en zijn waarde in: Definieer uw aangepaste headernaam en waarde met behulp van de add_header directive. De syntaxis is:

   add_header <header_name> <header_value>;

Hier is een voorbeeld van hoe uw configuratie eruit zou kunnen zien:

server {
    listen 80;
    server_name example.com;

    location / {
        proxy_pass http://backend_server;
        add_header X-Custom-Header "Custom Value";
        add_header X-Served-By $hostname;
    }
}

In dit voorbeeld worden twee aangepaste headers toegevoegd:

• X-Custom-Header met een statische waarde "Custom Value"
• X-Served-By met de waarde van de $hostname variabele, die de naam van de Nginx server bevat

Nadat u deze wijzigingen heeft aangebracht, slaat u het configuratiebestand op en herlaadt u Nginx om de nieuwe instellingen toe te passen:

sudo nginx -t
sudo nginx -s reload

Het eerste commando controleert de configuratie op syntaxfouten, terwijl het tweede Nginx herlaadt met de nieuwe configuratie.

add_header X-Request-ID $request_id;
add_header X-Client-IP $remote_addr;

De 'always' Parameter Gebruiken

De 'always' parameter in Nginx's add_header directive laat u aangepaste headers toevoegen aan alle antwoorden, inclusief foutantwoorden. Deze functie is nuttig wanneer u uw aangepaste headers in elk antwoord wilt, ongeacht de statuscode.

Nginx voegt standaard alleen aangepaste headers toe aan succesvolle antwoorden (2xx en 3xx statuscodes). Om aangepaste headers op te nemen in foutantwoorden (4xx en 5xx statuscodes), gebruikt u de 'always' parameter.

Hier is hoe u de 'always' parameter gebruikt:

location / {
    proxy_pass http://backend_server;
    add_header X-Custom-Header "Custom Value" always;
}

In deze configuratie zal de X-Custom-Header worden toegevoegd aan alle antwoorden, inclusief foutantwoorden.

U kunt de 'always' parameter gebruiken met meerdere headers:

location / {
    proxy_pass http://backend_server;
    add_header X-Custom-Header1 "Value1" always;
    add_header X-Custom-Header2 "Value2" always;
    add_header X-Server-Name $hostname always;
}

Deze configuratie voegt drie aangepaste headers toe aan alle antwoorden, inclusief die met foutstatuscodes.

location / {
    proxy_pass http://backend_server;
    add_header X-Cache-Status $upstream_cache_status always;
    if ($status = 404) {
        add_header X-Error-Type "Not Found" always;
    }
}

server {
    listen 80;
    server_name example.com;

    add_header X-Frame-Options "SAMEORIGIN" always;
    add_header X-XSS-Protection "1; mode=block" always;
    add_header X-Content-Type-Options "nosniff" always;
    add_header Referrer-Policy "strict-origin-when-cross-origin" always;
    add_header Content-Security-Policy "default-src 'self';" always;

    location / {
        proxy_pass http://backend_server;
    }
}

Houd er rekening mee dat het gebruik van de 'always' parameter gevoelige informatie in foutantwoorden kan tonen. Controleer uw aangepaste headers om te voorkomen dat gevoelige gegevens weglekken.