Suggestion - Migration Announcements

[BrutalBirdie]

Hello LibreChat contributors / maintainers

Firstly, thanks for reading my issue / suggestion and for this awesome software.

Background

I'm from the Cloudron Forum 👋🏻 😊

Cloudron has packaged your awesome software for easy deployment, so people can use your software with a few clicks.

We got a report after the latest app update to version 0.8.0.
User @p44 wrote in his topic that After update all prompts disappeared.

After reproduction, I've noticed that the prompts still existed in the MongoDB.
So I started searching what happened.
In the release notes of version 0.8.0 I read:

🔐 Granular Permissions System

Complete overhaul of permission system with fine-grained access control, Entra ID group discovery, and ACL-based (Access Control List) resource permissions with permission bits for agents, prompts, files, and conversations.

Permission overhaul? This needs some changes in the DB, right?
More digging.

Release notes of version 0.8.0-rc3 states:

🔎 feat: Add Prompt and Agent Permissions Migration Checks by @danny-avila in #9063

Okay, so there are "Migrations Checks", do they run on startup of the LibreChat application?
Hmm, more research.
Found something in the docs about Migration Required (v0.8.0-rc3+)

Ah, okay, so it is needed to run these migrations manually, but for agents?
Oh, there is a Note:

The same migration process applies to prompts. If you also have existing prompts, run the prompt permissions migration using the same commands but replace agent with prompt in the command names.

Got it. This also fixed the issue. Awesome!

Suggestion

I am aware that all versions of LibreChat are still considered Pre-Release, so any version could bring mayor changes.

Having these migration details in the docs is great, thanks for that!
Problem is, if you search in the docs for Migration you find the guide for agents and only after the whole guide it is mentioned that this also applies for prompts.
I have ADHD and tend to skip everything that is just an information in guides, especially if in a footnote 😅

Also, having this only as an information footnote makes it less searchable for users, thus increasing tickets and support workload which could be spent otherwise improving the product.
Furthermore, because this is only a footnote of the guide for agent migration, this information is somewhat "hidden" in the librechat.ai/docs/features/agents path which is unintuitive when you search specifically for information about prompts.

Solution?

My proposed solutions would be:

• have a clear warning in the release notes that manual migrations are need to be applied with a link to the docs / ticket / etc.
• in the future make the doc more explicit so its better searchable (Yes, I am aware I could create a PR for that 😉 regarding this specific issue)

---

Thanks again for reading, a wonderful week and health to y'all 👋🏻
Cheers
~ BrutalBirdie

[michnovka]

I would simply not allow UI to launch if the migrations are not executed. Then people go check the logs immediately and such situations do not occur.