LibreChat Details

To view the publicly accessible instance, visit https://use.your.ip/. See our instructions to bypass the HTTPS warning for self-signed SSL/TLS certificates if a Commercial or Let's Encrypt SSL/TLS certificate is not going to be installed (instructions for both options are below).

Configuration and Administration

Once the instance has finished booting and installing the required software, authentication can be further configured and new account registration enabled or disabled by connecting to the server via console or SSH as the root user. To simply create an account for the web UI of this instance with an email address, open https://use.your.ip/register and fill out the form.

Authentication can be handled via OAuth2 and OpenID Connect providers, after appropriate values are set in the /home/librechat/LibreChat/.env configuration file and the application has been restarted: systemctl restart librechat.service.

If no further accounts are necessary, it is possible to disable new account registrations via email addresses and social media accounts with a script provided by Vultr. To disable all new account registrations, run the script with the appropriate arguments:
# librechat-registration email disable
This will stop and restart the application upon completion.

Upgrade LibreChat

A script has been installed that can be used to update to the latest version of LibreChat:
# librechat-update

HTTPS: SSL/TLS Certificates

To access the server with a domain name, instead of use.your.ip, it is possible to register a domain name from a domain registrar, and either follow the registrar's documentation on updating DNS records, or utilize Vultr's DNS.

Once DNS has finished propagating, and the registered domain name resolves to use.your.ip, connect to the server via console or SSH as the root user.

Let's Encrypt via Certbot

Certbot is installed by default on Vultr's LibreChat Marketplace app. If you need to update or reinstall, please see the recommended installation steps at eff.org.

Requesting a Certificate

The below example shows installing multi-domain certificate for the bare or root domain of example.com as well as the fully-qualified domain name (FQDN) of www.example.com. The email provided is used for registering an account with Let's Encrypt and is not sent to Vultr:
# certbot --nginx --redirect -d www.example.com -d example.com -m admin@example.com --agree-tos --no-eff-email
Upon successfully requesting certificates, a message should be shown that includes text similar to the following:

Successfully deployed certificate for www.example.com to /etc/nginx/conf.d/librechat.conf
Congratulations! You have successfully enabled HTTPS on https://www.example.com

Revoking a Certificate

In case a certificate issued by Let's Encrypt via certbot is to be revoked, or otherwise needs to be uninstalled, these steps should be followed:
1. Back up current web server configuration files:
# cp -r /etc/nginx /root/nginx
2. Revoke the certificate:
# certbot delete
3. Restore default web server configuration:
# /opt/vultr/fix-vhost.sh

Commercial SSL/TLS Certificate

If a commercial certificate is desired instead of the free Let's Encrypt certificate, install the public certificate as /etc/nginx/ssl/server.crt and the private key as /etc/nginx/ssl/server.key. Refer to the certificate vendor's documentation for any further details. Once these files are in place, reboot the server to ensure all services are using the correct certificate: # reboot