For the complete documentation index, see llms.txt. This page is also available as Markdown.

Reverse Proxy

Trusted proxy headers

When Wizarr runs behind a reverse proxy such as Nginx, Traefik, Caddy, SWAG, or Nginx Proxy Manager, the browser may connect to the proxy over HTTPS while the proxy connects to Wizarr over plain HTTP.

Enable trusted proxy headers so Wizarr can use the original public request details when generating URLs and redirects.

Add the following environment variables to the Wizarr service:

TRUST_PROXY_HEADERS=true
PROXY_FIX_X_FOR=1
PROXY_FIX_X_PROTO=1
PROXY_FIX_X_HOST=1
PROXY_FIX_X_PORT=1
PROXY_FIX_X_PREFIX=1

For a typical setup with one reverse proxy in front of Wizarr, use 1 for each PROXY_FIX_* value.

Only enable TRUST_PROXY_HEADERS when Wizarr is reachable only through your trusted reverse proxy. Do not enable it if clients can connect directly to the Wizarr container.

If Wizarr is behind multiple trusted proxy hops, increase the relevant PROXY_FIX_* value to match the number of trusted proxies.

Nginx

Create a new file wizarr.subdomain.conf in proxy-confs with the following configuration:

server {
    listen 443 ssl http2;
    listen [::]:443 ssl http2;

    server_name wizarr.*;

    include /config/nginx/ssl.conf;

    client_max_body_size 0;

    location / {
        include /config/nginx/proxy.conf;
        resolver 127.0.0.11 valid=30s;
        set $upstream_app wizarr;
        set $upstream_port 5690;
        set $upstream_proto http;
        proxy_pass $upstream_proto://$upstream_app:$upstream_port;
    }

}

Add a new proxy host with the following settings:

Details

  • Domain Names: Your desired external wizarr hostname; e.g., wizarr.example.com

  • Scheme: http

  • Forward Hostname / IP: Internal wizarr hostname or IP

  • Forward Port: 5690

  • Cache Assets: yes

  • Block Common Exploits: no

SSL

  • SSL Certificate: Select one of the options; if you are not sure, pick “Request a new SSL Certificate”

  • Force SSL: yes

  • HTTP/2 Support: yes

Add the following configuration to a new file /etc/nginx/sites-available/wizarr.example.com.conf:

Then, create a symlink to /etc/nginx/sites-enabled:

Traefik (v2)

Add the following labels to the wizarr service in your docker-compose.yml file:

For more information, please refer to the Traefik documentation.

Caddy

Add the following site block to your Caddyfile:

You need the response replacement module to use this config.

Add the following site block to your Caddyfile:

Last updated