docu

.gitignore

@@ -14,7 +14,7 @@ target/
 .classpath
 
 # ignore docker deployments
+docker/.env
 docker/deployments/
 docker/keys
-
 docker/docker-compose-imixs.yaml

README.md

@@ -11,10 +11,36 @@ This repository contains the source code as also build scripts to setup an Dynam
 
 ## Build & Run
 
+The dev environment is defined by the 'docker compose' file `docker-compose-dev.yaml`
+
+The Environment contains the following components:
+
+- Imixs-Office-Workflow - application instance based on Wildfly 29.x
+- PostgreSQL Server - postgres:9.6.1 - local database
+- Apache Tika - apache/tika:3.2.0.0-full for OCR
+- Apache Cassandra - cassandra:5.0.4 local vector database
+- Collabora - collabora/code:25.04.6.2.1 for local office documents
+- Imixs-Admin - imixs/imixs-admin Imixs Admin Client
+- Prometheus - prom/prometheus:latest for logging metrics
+- Grafana - grafana/grafana:10.4.0 - for metric monitoring
+
+### AI / LLM
+
+The system expects a LLM Server endpoint based on Open AI API. The default LLM server endpoint is defined by the environment variables `LLM_SERVICE_ENDPOINT` and `LLM_API_KEY`. You can define both variables in the file `./docker/.env`
+
+```
+LLM_API_ENDPOINT=https://my.llama.cpp.foo.com/
+LLM_API_KEY=your-api-key-here
+```
+
+### Build / Setup
+
 To build and run the project you can use the build script `devi.sh` and run:
 
     $ ./devi setup
 
+This wild bild the project with 'maven' and build the local docker image.
+
 You can access the application from our Web browser
 
     http://localhost:8080
@@ -22,3 +48,5 @@ You can access the application from our Web browser
 (Default user `admin' - default passwort `adminadmin`)
 
 ## SSO KeyCloak
+
+t.b.d.

doc/AAIF.md

@@ -0,0 +1,3 @@
+# AAIF.io
+
+https://aaif.io/

docker/docker-compose-dev.yaml

@@ -46,10 +46,8 @@ services:
 
       # Imixs-AI
       # Optional configured via imixs.properties
-      LLM_SERVICE_ENDPOINT: "https://api.llama.cpp.imixs.com/"
-      # LLM_SERVICE_ENDPOINT_USER: "admin"
-      # LLM_SERVICE_ENDPOINT_PASSWORD: "imixs4.null"
-      LLM_SERVICE_ENDPOINT_APIKEY: "7fdb663fa87ea16731c1e0ece8ad3214e358423eabf2403188110c731ce07321"
+      LLM_SERVICE_ENDPOINT: ${LLM_API_ENDPOINT}
+      LLM_SERVICE_ENDPOINT_APIKEY: ${LLM_API_KEY}
 
       # Cassandra Embeddings
       EMBEDDINGS_CLUSTER_CONTACTPOINTS: "cassandra"