From 8f968d03419949753d8b6be963e0b24612c77238 Mon Sep 17 00:00:00 2001 From: Ettore Di Giacinto Date: Tue, 25 Jun 2024 19:18:43 +0200 Subject: [PATCH] Update quickstart.md Signed-off-by: Ettore Di Giacinto --- docs/content/docs/getting-started/quickstart.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/content/docs/getting-started/quickstart.md b/docs/content/docs/getting-started/quickstart.md index 6f14d242..207adbfa 100644 --- a/docs/content/docs/getting-started/quickstart.md +++ b/docs/content/docs/getting-started/quickstart.md @@ -8,6 +8,16 @@ icon = "rocket_launch" **LocalAI** is a free, open-source alternative to OpenAI (Anthropic, etc.), functioning as a drop-in replacement REST API for local inferencing. It allows you to run [LLMs]({{% relref "docs/features/text-generation" %}}), generate images, and produce audio, all locally or on-premises with consumer-grade hardware, supporting multiple model families and architectures. +{{% alert icon="💡" %}} + +**Security considerations** + +If you are exposing LocalAI remotely, make sure you protect the API endpoints adeguately with a mechanism which allows to protect from the incoming traffic or alternatively, run LocalAI with `API_KEY` to gate the access with an API key. The API key guarantees a total access to the features (there is no role separation), and it is to be considered as likely as an admin role. + +To access the WebUI with an API_KEY, browser extensions such as [Requestly](https://requestly.com/) can be used (see also https://github.com/mudler/LocalAI/issues/2227#issuecomment-2093333752). + +{{% /alert %}} + ## Using the Bash Installer Install LocalAI easily using the bash installer with the following command: