mirror of
https://github.com/mudler/LocalAI.git
synced 2026-06-25 09:09:07 -04:00
* fix(http): harden BaseURL proxy scheme/host detection Split comma-separated X-Forwarded-Proto and honor the RFC 7239 Forwarded header so generated links use https behind common reverse-proxy setups. Refs #10482 Assisted-by: Claude:claude-opus-4-8 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(http): honor explicit external base URL in BaseURL When _external_base_url is set in the request context it dictates the origin (scheme+host+port); the proxy path prefix is still appended. Refs #10482 Assisted-by: Claude:claude-opus-4-8 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(config): generalize LOCALAI_BASE_URL to ExternalBaseURL LOCALAI_BASE_URL now sets a single instance-wide external base URL used for OAuth callbacks and all self-referential links. A Pre middleware stamps it into the request context for middleware.BaseURL. Refs #10482 Assisted-by: Claude:claude-opus-4-8 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: document LOCALAI_BASE_URL and reverse-proxy headers Refs #10482 Assisted-by: Claude:claude-opus-4-8 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(http): cover parseForwarded edge cases; clarify base-url flag group Adds direct unit coverage for quoted/malformed/multi-element Forwarded headers and regroups the external base URL flag away from auth-only. Refs #10482 Assisted-by: Claude:claude-opus-4-8 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> --------- Signed-off-by: Ettore Di Giacinto <mudler@localai.io> Co-authored-by: Ettore Di Giacinto <mudler@localai.io>
171 lines
5.4 KiB
Markdown
171 lines
5.4 KiB
Markdown
---
|
|
title: TLS Reverse Proxy Configuration
|
|
description: Configure LocalAI behind a TLS termination reverse proxy (HAProxy, Apache, Nginx)
|
|
weight: 100
|
|
---
|
|
|
|

|
|
|
|
# TLS Reverse Proxy Configuration
|
|
|
|
When running LocalAI behind a TLS termination reverse proxy, the Web UI may fail to load static assets (CSS, JS) correctly because the application doesn't automatically detect that it's being served over HTTPS. This guide explains how to properly configure your reverse proxy to work with LocalAI.
|
|
|
|
## How It Works
|
|
|
|
LocalAI uses the `X-Forwarded-Proto` HTTP header to determine the protocol used by clients. When this header is set to `https`, LocalAI will generate HTTPS URLs for static assets in the Web UI.
|
|
|
|
## Running behind a reverse proxy (HTTPS / subpath)
|
|
|
|
LocalAI does not terminate TLS itself, so HTTPS is provided by a reverse
|
|
proxy in front of it. Self-referential links (generated image and video
|
|
URLs, async job status URLs, OAuth callbacks) need the externally visible
|
|
scheme, host and port.
|
|
|
|
LocalAI determines these in this order:
|
|
|
|
1. `LOCALAI_BASE_URL` - if set, it is authoritative for the origin. Set it to
|
|
the externally visible base URL, e.g. `LOCALAI_BASE_URL=https://localai.example.com`
|
|
or `https://192.168.0.13:34567`. Recommended whenever links come back with
|
|
the wrong scheme or host.
|
|
2. Otherwise, the `X-Forwarded-Proto` and `X-Forwarded-Host` headers (or the
|
|
RFC 7239 `Forwarded` header) sent by the proxy. Ensure your proxy forwards
|
|
`X-Forwarded-Proto: https`.
|
|
|
|
A reverse-proxy subpath mount is supported via `X-Forwarded-Prefix`; it is
|
|
appended to `LOCALAI_BASE_URL` when both are present.
|
|
|
|
## Required Headers
|
|
|
|
Your reverse proxy must forward these headers to LocalAI:
|
|
|
|
| Header | Purpose |
|
|
|--------|---------|
|
|
| `X-Forwarded-Proto` | Set to `https` when TLS is terminated at the proxy |
|
|
| `X-Forwarded-Host` | The original host requested by the client |
|
|
| `X-Forwarded-Prefix` | Any path prefix if LocalAI is served under a sub-path |
|
|
|
|
## HAProxy Configuration
|
|
|
|
```haproxy
|
|
frontend https-in
|
|
bind *:443 ssl crt /path/to/cert.pem
|
|
mode http
|
|
|
|
# Set the X-Forwarded-Proto header
|
|
http-request set-header X-Forwarded-Proto https
|
|
|
|
# Pass the original host
|
|
http-request set-header X-Forwarded-Host %[hdr(host)]
|
|
|
|
# If serving under a sub-path, set the prefix
|
|
# http-request set-header X-Forwarded-Prefix /localai
|
|
|
|
default_backend localai
|
|
|
|
backend localai
|
|
mode http
|
|
server localai1 127.0.0.1:8080 check
|
|
```
|
|
|
|
## Apache Configuration
|
|
|
|
```apache
|
|
<VirtualHost *:443>
|
|
ServerName your-domain.com
|
|
SSLEngine on
|
|
SSLCertificateFile /path/to/cert.pem
|
|
SSLCertificateKeyFile /path/to/key.pem
|
|
|
|
# Enable proxy and headers modules
|
|
ProxyRequests Off
|
|
ProxyPreserveHost On
|
|
|
|
<Proxy *>
|
|
Require all granted
|
|
</Proxy>
|
|
|
|
# Set the X-Forwarded-Proto header
|
|
RequestHeader set X-Forwarded-Proto "https"
|
|
|
|
# Set the X-Forwarded-Host header (optional, usually automatic)
|
|
RequestHeader set X-Forwarded-Host "%{HTTP_HOST}s"
|
|
|
|
# If serving under a sub-path
|
|
# RequestHeader set X-Forwarded-Prefix "/localai"
|
|
|
|
ProxyPass / http://127.0.0.1:8080/
|
|
ProxyPassReverse / http://127.0.0.1:8080/
|
|
</VirtualHost>
|
|
```
|
|
|
|
## Nginx Configuration
|
|
|
|
```nginx
|
|
server {
|
|
listen 443 ssl;
|
|
server_name your-domain.com;
|
|
|
|
ssl_certificate /path/to/cert.pem;
|
|
ssl_certificate_key /path/to/key.pem;
|
|
|
|
# Set the X-Forwarded-Proto header
|
|
proxy_set_header X-Forwarded-Proto $scheme;
|
|
|
|
# Pass the original host
|
|
proxy_set_header X-Forwarded-Host $host;
|
|
|
|
# If serving under a sub-path
|
|
# proxy_set_header X-Forwarded-Prefix /localai;
|
|
|
|
# Other proxy settings
|
|
proxy_pass http://127.0.0.1:8080;
|
|
proxy_http_version 1.1;
|
|
proxy_set_header Upgrade $http_upgrade;
|
|
proxy_set_header Connection "upgrade";
|
|
proxy_set_header Host $host;
|
|
proxy_cache_bypass $http_upgrade;
|
|
}
|
|
```
|
|
|
|
## Serving Under a Sub-Path
|
|
|
|
If you serve LocalAI under a sub-path (e.g., `https://your-domain.com/localai`), you need to:
|
|
|
|
1. Configure your reverse proxy to set the `X-Forwarded-Prefix` header
|
|
|
|
Example with Nginx:
|
|
|
|
```nginx
|
|
proxy_set_header X-Forwarded-Prefix /localai;
|
|
```
|
|
|
|
## Testing Your Configuration
|
|
|
|
1. Start LocalAI: `localai`
|
|
2. Configure your reverse proxy as shown above
|
|
3. Access the Web UI through the proxy
|
|
4. Check the browser's developer console for any mixed content warnings or failed asset loads
|
|
5. Verify that the HTML source contains `https://` URLs for static assets
|
|
|
|
## Troubleshooting
|
|
|
|
### Static Assets Not Loading
|
|
|
|
- Verify the `X-Forwarded-Proto` header is being forwarded
|
|
- Check that the header value is exactly `https` (lowercase)
|
|
- Inspect the network tab in your browser to see which requests are failing
|
|
|
|
### Mixed Content Warnings
|
|
|
|
- Ensure LocalAI is generating HTTPS URLs (check the BaseURL middleware is working)
|
|
- Verify the `X-Forwarded-Proto` header is set before LocalAI processes the request
|
|
|
|
### Redirect Loops
|
|
|
|
- Check that your proxy is not adding duplicate headers
|
|
- Verify `X-Forwarded-Proto` is not being set to both `http` and `https`
|
|
|
|
## Security Note
|
|
|
|
When using reverse proxies, ensure your proxy only accepts connections from trusted sources and properly validates SSL certificates. Never expose LocalAI directly to the internet without TLS termination.
|