diff --git a/README.md b/README.md index 5381de6..0ec6ff1 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,9 @@ This repository contains a containerized Odoo 17 instance pre-configured with a Detailed documentation for the architecture, standards and specific features of this Odoo environment can be found in these directories: -* **[Traceability & Observability Guide](./custom_addons/docs/README.md)**: A complete manual on how Pydantic Logfire is used across the ecosystem, including setup instructions, code instrumentation standards and how to navigate the live dashboard. +- [Perry Webhook Addon](custom_addons/docs/addons/perry-webhook.md) — How messages are intercepted and dispatched. +- [Perry Human-in-the-Loop](custom_addons/docs/addons/perry-human-in-the-loop.md) — Technical details on the staging and confirmation logic. +* **[Traceability & Observability Guide](custom_addons/docs/logfire.md)**: A complete manual on how Pydantic Logfire is used across the ecosystem, including setup instructions, code instrumentation standards and how to navigate the live dashboard. --- @@ -62,7 +64,7 @@ docker network create perry-network ### 2. Odoo setup (`testing-odoo`) Clone this repository, configure your environment variables and launch the ERP: ```bash -git clone https://github.com/your-user/testing-odoo.git +git clone https://github.com/Perry-Multi-LLM/testing-odoo cd testing-odoo ``` Create a `.env` file from the example (ensure `LOGFIRE_TOKEN` is set for observability), then build the containers: @@ -75,7 +77,7 @@ docker-compose up -d --build To complete the system, deploy the orchestrator repository: ```bash cd .. -git clone https://github.com/your-user/ingest-api.git +git https://github.com/Perry-Multi-LLM/ingest-api cd ingest-api docker-compose up -d --build ``` @@ -87,7 +89,34 @@ docker network connect perry-network testing-odoo docker network connect perry-network ingest-api ``` -### 5. Module installation -1. Log into Odoo (Developer Mode must be enabled). -2. Go to **Apps** > **Update Apps List**. -3. Search for `perry` and install the custom modules (`Perry Webhook`, `Perry Human Loop`). +## Initial Odoo Configuration + +Follow these steps to synchronize the ERP environment with the Perry multi-agent system after your containers are running: + +### 1. Database Initialization +The first time you access `http://localhost:8069`, Odoo will prompt you to **create a new database**. +* Fill in the master password, database name,admin credentials, language and country. It is important to set the language to English. +* Wait for the initialization process to complete; this sets up the core PostgreSQL schema. + +### 2. Enable Developer Mode +To manage technical settings and custom module installation, you must activate **Developer Mode**: +* Navigate to **Settings**. +* Scroll to the bottom of the page. +* Click on **Activate the developer mode**. + +### 3. Create the Perry Service User +The AI system identifies itself through a specific user record. You must create this profile to allow the webhook logic to function correctly: +* Go to **Settings > Users & Companies > Users**. +* Click **New** to create a user. +* **Name**: `Perry` +* **Email (Login)**: `perry@perry.com` + +> [!IMPORTANT] +> The email **must** be exactly `perry@perry.com`. The `perry_webhook` logic uses this specific string to filter messages and prevent infinite loops. + +### 4. Custom Addon Activation +The Perry ecosystem relies on external custom addons located in the `custom_addons/` directory. To activate them: +* Navigate to the **Apps** menu. +* Click on **Update Apps List** in the top navigation bar. +* Search for `perry` in the search bar (remove the default "Apps" filter if no results appear). +* Install **Perry Webhook** and **Perry Human Loop**. \ No newline at end of file