Environment variables

As is usual with LibreChat, an instance is configured through an environment file. The delivery includes a commented template from which the installer creates the actual configuration on the first run.

The configuration file stays on the server

It holds all credentials of the instance. It never belongs in a repository, never in a ticket and never in a support request.

What you set yourself

By far the largest part of the template is preset so that an instance starts. Essentially three things you have to provide yourself:

• the domain the instance is reachable at. As long as the default stays in place, invitation links only work on the server itself.
• the access key of the model provider. Without it the instance does start, but every model request fails.
• optionally the credentials for mail delivery. Without them there are no verification and invitation mails, and an invitation then only produces a link to copy.

Secrets

The cryptographic secrets of an instance are generated by the installer on the first run and stored protected. You do not have to do anything for them.

When migrating to a new server

The existing configuration has to be taken over. If it is generated anew instead, credentials stored encrypted before can no longer be read and all users have to set up their connector connections again. The bundled backup tool therefore takes the configuration along.

Complete reference

Which entries exist in detail, what they do and which of them a particular deployment stage needs is described in the operating documentation included with the delivery. Customers receive it together with their access. The template itself is commented as well.

For everything that is standard LibreChat, the documentation there applies in addition: www.librechat.ai/docs.

Related pages

• Configuration describes what is set in the librechat.yaml and what in the admin panel instead.
• Troubleshooting collects the common symptoms.