Note limitation about Lunr in production

Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2023-01-05 14:32:26 +01:00
parent 5e8cd3c72c
commit c2f1041c15
1 changed files with 5 additions and 0 deletions
@@ -34,6 +34,11 @@ const searchEngine = new LunrSearchEngine({ logger: env.logger });
 const indexBuilder = new IndexBuilder({ logger: env.logger, searchEngine });
 ```

+> Note: Lunr is appropriate as a zero-config search engine when developing
+> other parts of Backstage locally, however its use is highly discouraged when
+> running Backstage in production. When deploying Backstage, use one of the
+> other search engines instead.
+
 ## Postgres

 The Postgres based search engine only requires that postgres being configured as