🌐 feat: Add support to SubDirectory hosting

[jpsfs]

🌐 feat: Add support to SubDirectory hosting

Summary

The changes in this Pull Request implement the Enhancement Request described in #1701.
With this changes LibreChat can now be hosted in a subdirectory or path.

I've implemented this change reusing the DOMAIN_CLIENT and DOMAIN_SERVER environment variables, which I assume was the original idea of the author. Thus I've not made any documentation change. If DOMAIN_CLIENT is set with a URL that includes a path, then the system will adapt itself to it.

Change Type

Please delete any irrelevant options.

• New feature (non-breaking change which adds functionality)

Testing

I've setup a reverse proxy in front of the LibreChat image, redirecting the traffic of "/mycustomaddress" to port 3080. The setup was made using the strip-prefix middleware, to ensure the requests reach port 3080 already without the "/mycustomaddress" part of the URL.

Test Configuration:

LibreChat relevant env vars:

DOMAIN_CLIENT=http://{{yourpublicdomain:port}}/mycustomdomain
DOMAIN_SERVER=http://{{yourpublicdomain:port}}/mycustomdomain

Traefik configuration file:

http:
  routers:
    my-host-app:
      rule: "PathPrefix(`/mycustomdomain`)"
      entryPoints:
        - web
      service: librechat
      middlewares:
        - strip-path

  services:
    librechat:
      loadBalancer:
        servers:
          - url: "http://host.docker.internal:3080"

  middlewares:
    strip-path:
      stripPrefix:
        prefixes:
          - "/mycustomdomain"

Checklist

• My code adheres to this project's style guidelines
• I have performed a self-review of my own code
• I have commented in any complex areas of my code
• My changes do not introduce new warnings
• Local unit tests pass with my changes

[dacosta444]

Great work! This is a must to have LibreChat behind a reverse proxy!

[jpsfs]

@danny-avila updated, test fixed and linting issues reviewed 🙏🏼

[digas111]

I tested this on my side and it solves my use case:
#8919

[jpsfs]

@danny-avila Merge conflict resolved.

[jpsfs]

Hi @danny-avila, is there anything I can do to help streamline the process?

[danny-avila]

@jpsfs I missed this, it looks this PR created the issue highlighted here: #9300

No worries, though, this is why we have the dev branch now to help catch issues.

[danny-avila]

This fixes it:

danny:~/LibreChat$ git diff dev -- packages/data-provider/src/api-endpoints.ts
diff --git a/packages/data-provider/src/api-endpoints.ts b/packages/data-provider/src/api-endpoints.ts
index 59ede0905..8b6be0f5a 100644
--- a/packages/data-provider/src/api-endpoints.ts
+++ b/packages/data-provider/src/api-endpoints.ts
@@ -58,7 +58,7 @@ export const messages = (params: q.MessagesListParams) => {
     return `${messagesRoot}/${conversationId}`;
   }
 
-  return `${messagesRoot}{buildQuery(rest)}`;
+  return `${messagesRoot}${buildQuery(rest)}`;
 };
 
 export const messagesArtifacts = (messageId: string) => `${messagesRoot}/artifacts/${messageId}`;

[jpsfs]

Damn... Thank you for the quick fix!