From bbac17462abf4caecf0b0c1b5dfec67ac0266da8 Mon Sep 17 00:00:00 2001 From: Quentin BEY Date: Wed, 5 Nov 2025 11:42:38 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D(doc)=20add=20small=20how-to=20for?= =?UTF-8?q?=20local=20run?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This could help new developpers to run the stack locally. --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index 4df72f8..9cc23fb 100644 --- a/README.md +++ b/README.md @@ -115,6 +115,31 @@ To start all the services, except the frontend container, you can use the follow $ make run-backend ``` +**Setup a basic LLM call** + +To be able to use Conversations, you need to configure at least one Large Language Model (LLM) provider. +You can do so by setting the appropriate environment variables in the `env.d/development/common` file: + +```ini +AI_BASE_URL=http://host.docker.internal:12434/v1/ +AI_MODEL=gemma3:4b +AI_API_KEY=XXX +``` + +for a local ollama, or by running a local LLM with docker-compose: + +```shellscript +$ make create-compose-with-models +``` + +which will create a `compose.override.yml` file to start a local models `ai/smollm2` +which can be changed later by editing the `compose.override.yml` file. + +You will need to call `make run` after changing the `env.d/development/common` +or `compose.override.yml` file. + +You can find more information about configuring LLM providers in the [LLM Configuration](docs/llm-configuration.md) documentation. + **Adding content** You can create a basic demo site by running this command: