Skip to content

Reverse Proxy Configuration

v0.6.7

When hosting Trailarr behind a reverse proxy (like Nginx, Apache, Caddy, Traefik, etc.), certain configurations are necessary to ensure that the application functions correctly. This includes proper routing of requests and handling of headers.

There are two common scenarios for reverse proxy setups:

  1. https://trailarr.mydomain.com/ (Sub-domain)
  2. https://mydomain.com/trailarr/ (Sub-directory)

Sub-domain Reverse Proxy Configuration

When hosting the application behind a reverse proxy in a sub-domain (e.g., https://trailarr.mydomain.com/), the following configurations can be used as examples.

These are example configurations for common reverse proxies, adjust them as needed for your specific setup.

No special configuration is needed in Trailarr for sub-domain setups, but ensure that your reverse proxy forwards the necessary headers.

Sub-directory Reverse Proxy Configuration

When hosting the application behind a reverse proxy in a sub-directory (e.g., https://mydomain.com/trailarr/), additional configuration is required to ensure proper routing and resource loading.

URL Base Setting

  • Make sure to set the URL Base in the General Settings of the application to match the sub-directory path used in the reverse proxy. For example, if your application is accessible at https://mydomain.com/trailarr/, set the URL Base to /trailarr.

Example Configurations

Warning

Remember to replace these with actual values:

  • http://192.168.1.231:7889 -> Trailarr internal IP and port
  • trailarr.mydomain.com -> Your Sub-Domain
  • /trailarr/ -> Your Sub-Directory path -> set the same for URL Base setting in Trailarr

Nginx

server {
    server_name trailarr.mydomain.com;

    location / {
        proxy_pass http://192.168.1.231:7889;

        proxy_set_header Host                $host;
        proxy_set_header X-Real-IP           $remote_addr;
        proxy_set_header X-Forwarded-For     $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto   $scheme;

    }
}

server {
    server_name mydomain.com;

    location /trailarr/ {
        proxy_pass http://192.168.1.231:7889;

        proxy_set_header Host                $host;
        proxy_set_header X-Real-IP           $remote_addr;
        proxy_set_header X-Forwarded-For     $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto   $scheme;
        proxy_set_header X-Forwarded-Prefix  /trailarr;
    }
}

Apache

<VirtualHost *:80>
    ServerName trailarr.mydomain.com
    ProxyPreserveHost On
    ProxyPass "/" "http://192.168.1.231:7889/" 
    ProxyPassReverse "/" "http://192.168.1.231:7889/"

</VirtualHost>

<VirtualHost *:80>
    ServerName mydomain.com
    ProxyPreserveHost On
    ProxyPass "/trailarr/" "http://192.168.1.231:7889/" 
    ProxyPassReverse "/trailarr/" "http://192.168.1.231:7889/"
    RequestHeader set X-Forwarded-Prefix "/trailarr"
</VirtualHost>

Caddy

trailarr.mydomain.com {
    reverse_proxy http://192.168.1.231:7889 
}

reverse_proxy /trailarr/* http://192.168.1.231:7889 { 
    header_up X-Forwarded-Prefix /trailarr
}

Traefik

http:
  routers:
    trailarr:
      rule: "Host(`trailarr.mydomain.com`)"
      service: trailarr-service
  services:
    trailarr-service:
      loadBalancer:
        servers:
          - url: "http://192.168.1.231:7889" 

http:
  routers:
    trailarr:
      rule: "PathPrefix(`/trailarr`)"
      service: trailarr-service
      middlewares:
        - strip-trailarr
  services:
    trailarr-service:
    loadBalancer:
      servers:
        - url: "http://192.168.1.231:7889" 
  middlewares:
    strip-trailarr:
      stripPrefix:
        prefixes:
          - "/trailarr"

Additional Notes

  • Forward the X-Forwarded-Prefix header from reverse proxy to Trailarr. Optional but helps
  • Restart Trailarr and reverse proxy to apply the new configuration.
  • Once you add the URL Base and restart Trailarr, you will NOT be able to access the application at the root URL or local IP and port.

  • You may need to clear your browser cache or perform a hard refresh to load the resources correctly.

    Tip

    Ctrl + Shift + I to open Developer Tools -> right-click the Refresh button -> select Empty Cache and Hard Reload

  • If you encounter any issues, and want to revert back to root access, find the .env file in config/ folder and remove the value set for URL_BASE, then restart the application.

Success

If you are using a different reverse proxy, and successfully configured it to work with Trailarr in a sub-directory, please consider sharing your configuration by opening a new issue or a pull request on our GitHub repository and we will update the documentation accordingly.

How It Works

When the URL Base is set and restart Trailarr, Trailarr does the following:

  • Identifies that a URL Base is set.
  • Adds a root-path option to the FastAPI application, which tells FastAPI to serve all routes under the specified base path.
  • Adjusts the base href in the HTML templates to ensure that all relative URLs for resources (like CSS, JS, images) are correctly prefixed with the URL Base.

This ensures that when the application is accessed via the reverse proxy in a sub-directory, all routes and resources are correctly resolved.