Set url sub-path (Reverse Proxy) #3095

senpro-ingwersenk · 2024-07-31T13:55:42Z

Is your feature request related to a problem? Please describe.
I am trying to set up a "uniform" AI server with OpenWebUI and LocalAI and would like to - at least for the time being - host the LocalAI UI on a sub-path. Take a look at this Caddyfile:

:80 {
  handle_path /localai* {
    reverse_proxy * http://localai:8080
  }
  handle /* {
    reverse_proxy * http://openwebui:8080
  }
}

It is very basic but everything runs in a local test network and we use this to triage software before we add it to the real network. Hence, I need to, for now, host it on a sub-path. API calls work fine, but the small UI it comes with, does not, as it uses /assets... URLs for resources - which obviously does not resolve.

Describe the solution you'd like
There is the env variable ADDRESS to specify the listening address and port. So, something like BASEURL would be helpful.

Describe alternatives you've considered
I can't quite think of one, apologies.

Additional context
The finite setup will be Caddy with oauth2-proxy and OpenWebUI to integrate the whole system into the rest of the network as a dedicated node. By then, the LocalAI endpoints besides the API will probably only be useable from the internal network but on it's own subdomain. But the test network does not have "domains" - it doesn't even have a dedicated local DNS. :)

Thank you for this awesome project; I am looking forward for something really neat; working on RISC-V with TensTorrent Greyskulls installed by providing a gRPC backend for localai to use. So I am looking forward to contributing this!

The text was updated successfully, but these errors were encountered:

mudler · 2024-07-31T14:27:25Z

Thanks for opening the issue @senpro-ingwersenk. Looks a feature that would be interesting indeed to have. Any chance you are up for taking a stab at it? I'd be happy to review

senpro-ingwersenk · 2024-08-01T10:35:37Z

I never wrote a webapp with "just" Go; so it will take some time to get into this.
But it's interesting and I need to learn the ins and outs anyway - so, might as well.

/cc @IngwiePhoenix (Private profile; so I don't lose this :))

senpro-ingwersenk · 2024-08-01T10:37:19Z

First thing I spotted is here:

https://github.com/mudler/LocalAI/blob/master/core/http/views/partials/head.html#L7

Off the cuff, do you know if the renderer can access configuration values? It'd be quite easy to prepend a env.BASEURL to a few of those. If you have some pointers, I could work with that. :)

Makes the web app honour the `X-Forwarded-Prefix` HTTP request header that may be sent by a reverse-proxy in order to inform the app that its public routes contain a path prefix. For instance this allows to serve the webapp via a reverse-proxy/ingress controller under a path prefix/sub path such as e.g. `/localai/` while still being able to use the regular LocalAI routes/paths without prefix when directly connecting to the LocalAI server. Changes: * Add new `StripPathPrefix` middleware to strip the path prefix (provided with the `X-Forwarded-Prefix` HTTP request header) from the request path prior to matching the HTTP route. * Add a `BaseURL` utility function to build the base URL, honouring the `X-Forwarded-Prefix` HTTP request header. * Generate the derived base URL into the HTML (`head.html` template) as `<base/>` tag. * Make all webapp-internal URLs (within HTML+JS) relative in order to make the browser resolve them against the `<base/>` URL specified within each HTML page's header. * Make font URLs within the CSS files relative to the CSS file. Closes mudler#3095 TL;DR: The header-based approach allows to move the path prefix configuration concern completely to the reverse-proxy/ingress as opposed to having to align the path prefix configuration between LocalAI, the reverse-proxy and potentially other internal LocalAI clients. The gofiber swagger handler already supports path prefixes this way, see https://github.com/gofiber/swagger/blob/e2d9e9916d8809e8b23c4365f8acfbbd8a71c4cd/swagger.go#L79 Signed-off-by: Max Goltzsche <[email protected]>

Makes the web app honour the `X-Forwarded-Prefix` HTTP request header that may be sent by a reverse-proxy in order to inform the app that its public routes contain a path prefix. For instance this allows to serve the webapp via a reverse-proxy/ingress controller under a path prefix/sub path such as e.g. `/localai/` while still being able to use the regular LocalAI routes/paths without prefix when directly connecting to the LocalAI server. Changes: * Add new `StripPathPrefix` middleware to strip the path prefix (provided with the `X-Forwarded-Prefix` HTTP request header) from the request path prior to matching the HTTP route. * Add a `BaseURL` utility function to build the base URL, honouring the `X-Forwarded-Prefix` HTTP request header. * Generate the derived base URL into the HTML (`head.html` template) as `<base/>` tag. * Make all webapp-internal URLs (within HTML+JS) relative in order to make the browser resolve them against the `<base/>` URL specified within each HTML page's header. * Make font URLs within the CSS files relative to the CSS file. * Use the new `BaseURL` function to generate absolute URLs within gallery JSON responses. Closes mudler#3095 TL;DR: The header-based approach allows to move the path prefix configuration concern completely to the reverse-proxy/ingress as opposed to having to align the path prefix configuration between LocalAI, the reverse-proxy and potentially other internal LocalAI clients. The gofiber swagger handler already supports path prefixes this way, see https://github.com/gofiber/swagger/blob/e2d9e9916d8809e8b23c4365f8acfbbd8a71c4cd/swagger.go#L79 Signed-off-by: Max Goltzsche <[email protected]>

mgoltzsche · 2024-12-25T21:27:11Z

@senpro-ingwersenk I just created PR #4497 to address this issue. However, instead of making a single static base URL configurable within LocalAI I've let it honour the X-Forwarded-Prefix HTTP header so that the base URL can be derived on a per-request basis and the path prefix concern can be entirely configured within the reverse-proxy.
That said, you'd have to make your reverse-proxy specify the path prefix within the X-Forwarded-Prefix HTTP request header. Is that fine with you or do you really need a static path prefix that is configured within LocalAI explicitly?

Makes the web app honour the `X-Forwarded-Prefix` HTTP request header that may be sent by a reverse-proxy in order to inform the app that its public routes contain a path prefix. For instance this allows to serve the webapp via a reverse-proxy/ingress controller under a path prefix/sub path such as e.g. `/localai/` while still being able to use the regular LocalAI routes/paths without prefix when directly connecting to the LocalAI server. Changes: * Add new `StripPathPrefix` middleware to strip the path prefix (provided with the `X-Forwarded-Prefix` HTTP request header) from the request path prior to matching the HTTP route. * Add a `BaseURL` utility function to build the base URL, honouring the `X-Forwarded-Prefix` HTTP request header. * Generate the derived base URL into the HTML (`head.html` template) as `<base/>` tag. * Make all webapp-internal URLs (within HTML+JS) relative in order to make the browser resolve them against the `<base/>` URL specified within each HTML page's header. * Make font URLs within the CSS files relative to the CSS file. * Use the new `BaseURL` function to generate absolute URLs within gallery JSON responses. Closes mudler#3095 TL;DR: The header-based approach allows to move the path prefix configuration concern completely to the reverse-proxy/ingress as opposed to having to align the path prefix configuration between LocalAI, the reverse-proxy and potentially other internal LocalAI clients. The gofiber swagger handler already supports path prefixes this way, see https://github.com/gofiber/swagger/blob/e2d9e9916d8809e8b23c4365f8acfbbd8a71c4cd/swagger.go#L79 Signed-off-by: Max Goltzsche <[email protected]>

Makes the web app honour the `X-Forwarded-Prefix` HTTP request header that may be sent by a reverse-proxy in order to inform the app that its public routes contain a path prefix. For instance this allows to serve the webapp via a reverse-proxy/ingress controller under a path prefix/sub path such as e.g. `/localai/` while still being able to use the regular LocalAI routes/paths without prefix when directly connecting to the LocalAI server. Changes: * Add new `StripPathPrefix` middleware to strip the path prefix (provided with the `X-Forwarded-Prefix` HTTP request header) from the request path prior to matching the HTTP route. * Add a `BaseURL` utility function to build the base URL, honouring the `X-Forwarded-Prefix` HTTP request header. * Generate the derived base URL into the HTML (`head.html` template) as `<base/>` tag. * Make all webapp-internal URLs (within HTML+JS) relative in order to make the browser resolve them against the `<base/>` URL specified within each HTML page's header. * Make font URLs within the CSS files relative to the CSS file. * Generate redirect location URLs using the new `BaseURL` function. * Use the new `BaseURL` function to generate absolute URLs within gallery JSON responses. Closes mudler#3095 TL;DR: The header-based approach allows to move the path prefix configuration concern completely to the reverse-proxy/ingress as opposed to having to align the path prefix configuration between LocalAI, the reverse-proxy and potentially other internal LocalAI clients. The gofiber swagger handler already supports path prefixes this way, see https://github.com/gofiber/swagger/blob/e2d9e9916d8809e8b23c4365f8acfbbd8a71c4cd/swagger.go#L79 Signed-off-by: Max Goltzsche <[email protected]>

senpro-ingwersenk added the enhancement New feature or request label Jul 31, 2024

mudler added the roadmap label Jul 31, 2024

mgoltzsche linked a pull request Dec 25, 2024 that will close this issue

feat(ui): path prefix support via HTTP header #4497

Open

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Set url sub-path (Reverse Proxy) #3095

Set url sub-path (Reverse Proxy) #3095

senpro-ingwersenk commented Jul 31, 2024

mudler commented Jul 31, 2024 •

edited

Loading

senpro-ingwersenk commented Aug 1, 2024

senpro-ingwersenk commented Aug 1, 2024

mgoltzsche commented Dec 25, 2024 •

edited

Loading

Set url sub-path (Reverse Proxy) #3095

Set url sub-path (Reverse Proxy) #3095

Comments

senpro-ingwersenk commented Jul 31, 2024

mudler commented Jul 31, 2024 • edited Loading

senpro-ingwersenk commented Aug 1, 2024

senpro-ingwersenk commented Aug 1, 2024

mgoltzsche commented Dec 25, 2024 • edited Loading

mudler commented Jul 31, 2024 •

edited

Loading

mgoltzsche commented Dec 25, 2024 •

edited

Loading