Installation

The setup is carried out in a guided manner on the basis of the delivery package. In the course of it the configuration and the secrets of the instance are created, then the application starts. The prerequisite is a prepared server, see Prepare the server.

What the setup takes care of

• It checks the prerequisites on the machine and aborts if something fundamental is missing.
• It creates the configuration of the instance and sets all secrets to freshly generated random values. Every instance receives its own values, and these are readable only for the operation of the instance.
• It sets up the storage areas of the instance with the necessary permissions and starts the application.
• It reports at the end which values still have to be entered by hand. Only the names of the values are reported, never their contents.

Secure the generated secrets

Some of the generated values decrypt what is stored encrypted in the database. If these values are lost, or regenerated during a migration instead of carried over, the affected data is irretrievably unreadable, and every person would have to rebuild their connections. The regular backup covers the configuration and therefore these values, see Backup and migration.

The only mandatory value

For a standard installation you enter exactly one value yourself: the key of the inference provider with EU processing. The setup explicitly points this out at the end. Everything else is optional: a second option for models, the connectors, e-mail delivery and code execution.

What remains manual

• Set the DNS records and choose the TLS variant, see Domain and certificate.
• Set the domain lock for registration, see Configuration.
• Define role permissions and model cards in the admin panel.
• Deliberately grant access for each connector in the panel instead of leaving it open.
• Set up the backup, see Backup and migration.

After the first start

1. Open the chat. At the address under which the instance was set up.

2. Create the first account. Register in the chat. The first account of an instance receives the administration rights.

3. Check the admin panel. Access requires an account with administration rights.

4. Close off access. Set the domain lock so that only people from your e-mail domain can register.

5. Create a second admin account. Not only the personal one, otherwise you lock yourself out when it matters.

6. Set up the backup. Back up once by hand and then schedule the backup.

Detailed instructions in the operations manual

The exact sequence and the complete list of configuration values are in the operations manual that comes with the delivery package. Customers receive it together with their access.

Next

ConfigurationThe three levels: environment, librechat.yaml and the overrides in the admin panel.

Domain and certificatePublic certificate, an internal CA on the LAN or operation behind an existing WAF.