How to Deploy LibreChat with xCloud(One Click Apps)

LibreChat is an open-source chat application that allows users to interact with AI models in a flexible and customizable environment. It provides a platform to deploy, manage, and run AI-powered chat interfaces, making it suitable for both experimentation and production use. 

Follow the steps below so you can quickly get LibreChat running on a cloud server with full functionality, whether for testing purposes or a live application. Once it is running, you can update LibreChat to the latest version from the same dashboard.

Step 1: Create a Docker+ NGINX Server

First, you need to create a Docker server to deploy LibreChat. Click the ‘New Server’ button on the dashboard and enter all the necessary credentials to connect your server. You can deploy LibreChat either on your own server or on an xCloud server.

Next, choose your server provider to deploy LibreChat with xCloud. You can either use an xCloud Managed Server or select your preferred provider. In this guide, we’ll use the xCloud Managed Server.

Afterward, enter the ‘Server Name’, set the ‘App Type’ to LibreChat, and add any relevant ‘Tags’ to help identify your server later. 

Next, choose between the ‘General’ and ‘Premium’ options based on your requirements. Then, select a plan that best fits your needs.

Next, choose the ‘Region’ and ‘Ubuntu Version for your server. You can also enable or disable the Backup option as needed.

Next, you can see the ‘Docker + NGINX’ stack is already selected, which is mandatory for deploying the LibreChat application.  Then click on the ‘Create’ button to proceed.

Once the server is created, you will be able to deploy your LibreChat Application in this server.

After creating a server, it may take a while to become fully operational. Wait a few minutes before deploying your applications to ensure everything starts correctly.

How to Install LibreChat on a Cloud Server 

Learn how to install LibreChat on a cloud server. It walks you through creating a server, configuring the environment, and launching your LibreChat application easily.

Step 2: Access the One Click Apps Dashboard

Begin by logging into your xCloud account. Once logged in, navigate to your dashboard and click on the ‘New Site’ button.

 Then choose your ‘Server’ from your dropdown and click on the ‘Next’ button to proceed. 

This will take you to the site creation interface. From here, select your Server, then navigate to the One-Click Apps section. You will see ‘LibreChat’, click on it to proceed with the deployment of this application

Step 3: Set Up the LibreChat Application

In the site setup screen, you will be prompted to enter basic site information. Provide a ‘Site Title’ and add relevant ‘Tags’ to help organize your deployment.

At this point, you can choose between two deployment modes: ‘Go Live’ for a production-ready deployment or ‘Demo Site’ for testing purposes. Selecting ‘Go Live’ will immediately create a live environment, while choosing ‘Demo Site’ allows you to experiment in a staging environment before promoting it to production.

Step 4: Configure Domain Settings

If you select the ‘Demo Site’ option, xCloud will assign a temporary subdomain for your LibreChat application. You can adjust the ‘Site User’ according to your preferences, or leave it as the default.

Next, click the toggle on the ‘Enable Ollama’ button, then choose the AI models and click ‘Next’ to proceed. Enabling this option is not mandatory. If you do not enable it, we will display three default AI models. You can also add your preferred models later within the application environment.

However, if you enable Ollama, you will be able to access all available models from here, choose them, and install them at the same time.

Step 4: Visit the LibreChat Application 

With LibreChat set up with xCloud, you should be able to log in and confirm that it’s working. From the dashboard, click on the ‘Visit Site’ app.

Environment Editor for LibreChat

The Environment section in xCloud allows you to customize configuration settings for your LibreChat instance. Just go to the ‘Environment’ option from the sidebar and adjust as you need, then click on the ‘Save’ button.

Manage LibreChat  Models

Later, you can manage your LibreChat application. Go to the ‘LibreChat’ → ‘Management’. Next, click on the ‘Add New Model’ to install more AI models. Also, you can click on the ‘Delete Icon’ to delete the AI models of this application. 

Note: You will get access to management only if you enable Ollama

How to Update LibreChat to the Latest Version

To update LibreChat on xCloud, open your LibreChat site, go to ‘LibreChat’ → ‘Updates’ and click ‘Update LibreChat’. xCloud pulls the latest LibreChat Docker image and restarts the app. Your users, conversations, uploads, avatars and chat images are kept.

LibreChat ships new versions often, with new AI models, endpoints and fixes. You do not need SSH or Docker commands to upgrade it: the whole update runs from the xCloud dashboard.

Step 1: Open LibreChat Updates

From your LibreChat site, go to ‘LibreChat’ → ‘Updates’ in the left sidebar. You see the ‘Update LibreChat’ card and, after your first update, the ‘Recent Updates’ list.

Note: You only see the ‘Updates’ option if you have permission to manage updates on this site.

Step 2: Start the LibreChat Update

Click the ‘Update LibreChat’ button, then click ‘Update LibreChat’ again in the confirmation box.

xCloud downloads the latest LibreChat image while your site keeps running, then restarts the LibreChat containers on the new version. LibreChat is unavailable for a minute or two while it restarts.

Step 3: Check the Update Status

The update appears under ‘Recent Updates’ with its date and status. When LibreChat answers again, the status changes to ‘finished’ and xCloud shows ‘LibreChat has been updated.’

What Happens to Your LibreChat Data During an Update

• Your data is kept. Users, conversations, presets, uploads, avatars and chat images stay in place.
• Only one update runs at a time. If you click the button while an update is running, xCloud tells you that a LibreChat update is already running.
• A failed update does not leave your site down. If something fails before the new containers start, xCloud starts LibreChat again as it was. The update shows as failed, and the ‘Events’ page shows what went wrong.
• Older LibreChat sites are fixed during the update. On some older sites, avatar and chat image uploads fail, or images are stored only inside the container. The update copies any existing images to the site folder and fixes uploads, so images are kept from then on.

Update LibreChat with the xCloud API or MCP

You can also upgrade LibreChat from a script, a CI job or an AI agent through the xCloud Public API or xCloud MCP. Send this request with a token that has the write:sites ability:

curl -X POST "https://app.xcloud.host/api/v1/sites/YOUR_SITE_UUID/librechat/update" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

xCloud answers 202 Accepted with a task_uuid. Poll the site’s events with that task_uuid to see when the update finishes. In xCloud MCP, the same action is the sites_librechat_update tool.

How to Change the Domain of a LibreChat Site

You can move LibreChat to a new domain the same way as any other site. Follow how to change the primary domain of a site. LibreChat keeps your users, conversations, avatars and chat images on the new domain, and its containers start on the new domain automatically.

Frequently Asked Questions

How do I update LibreChat to the latest version on xCloud?

Open your LibreChat site in xCloud, go to LibreChat → Updates and click Update LibreChat. xCloud pulls the latest LibreChat image and restarts the app in a minute or two.

Will updating LibreChat delete my conversations or images?

No. Your users, conversations, uploads, avatars and chat images are kept. LibreChat is unavailable for a minute or two while its containers restart.

What happens if the LibreChat update fails?

If the update fails before the new containers start, xCloud starts LibreChat again as it was. The update shows as failed under Recent Updates, and the Events page shows what went wrong.

Can I update LibreChat through the xCloud API?

Yes. Send POST /api/v1/sites/{site}/librechat/update with a token that has the write:sites ability. The response returns a task_uuid that you can poll to see when the update finishes.

This is how you can deploy LibreChat with xCloud and set up a fully functional AI chat environment. By following the steps in this guide, you can create a Docker + NGINX server, configure your site using One-Click Apps, choose between a live or demo environment, manage your AI models, and keep LibreChat up to date. You also have full control over domain settings, environment configurations, and user access. 

Once deployed, LibreChat can be customized, scaled, and maintained to meet your specific requirements, providing a reliable platform for AI-powered chat applications. If you encounter any issues, xCloud support is available to assist you in keeping your LibreChat instance running smoothly.

Want to Deploy Different Self-Hosted AI Models?

If you are looking to deploy other self-hosted AI applications, check out the following documentation:

✔️Deploy OLLAMA application

✔️Deploy OpenWebUI application

If you encounter any issues or have questions during deployment, please contact our support team for assistance.