Floke/Brancheneinstufung2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[30388f42] docs: Streamline root README and move technical details to infrastructure doc

Browse Source
This commit is contained in:
Floke
2026-03-08 12:36:28 +00:00
parent c33dca4a09
commit f7dff7e445
2 changed files with 51 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
docs/INFRASTRUCTURE.md
View File

@@ -33,4 +33,36 @@ Um eine stabile Erreichbarkeit der Dienste auch bei wechselnden IPs (DynDNS) zu
* **Funktion:** Aktualisiert die Domain `floke-ai.duckdns.org` alle 5 Minuten mit der aktuellen öffentlichen IP. * **Funktion:** Aktualisiert die Domain `floke-ai.duckdns.org` alle 5 Minuten mit der aktuellen öffentlichen IP.
* **Monitoring:** Ein Sidecar-Container `dns-monitor` prüft die Auflösung und warnt bei Fehlern. * **Monitoring:** Ein Sidecar-Container `dns-monitor` prüft die Auflösung und warnt bei Fehlern.
---
## 📂 Daten-Persistenz (Volumes)
Um Datenverlust zu vermeiden und Dateisystem-Berechtigungskonflikte zu umgehen, nutzen alle Dienste **benannte Docker-Volumes**.
| Volume Name | Dienst / Inhalt |
| :--- | :--- |
| `explorer_db_data` | Company Explorer (SQLite Datenbank) |
| `connector_db_data` | Connector Queue (Eingehende CRM Events) |
| `lead_engine_data` | Lead Engine (State & Persistence) |
| `gtm_architect_data` | GTM Strategien (Projekte) |
| `b2b_marketing_data` | B2B Marketing Assistant Analysen |
| `content_engine_data` | Content Engine Projekt-Entwürfe |
| `market_intel_data` | Market Intelligence Projekte |
| `competitor_analysis_data` | Competitor Analysis Berichte |
| `transcription_uploads` | Meeting Assistant (Audio-Uploads) |
---
## 🛠️ Port-Mapping (Übersicht)
Die Dienste kommunizieren intern über den Standard-Port des jeweiligen Frameworks (meist 8000, 3000 oder 3005).
| Host-Port | Ziel-Dienst | Routing |
| :--- | :--- | :--- |
| **8090** | `gateway_proxy` | `/` |
| **8000** | `company-explorer` | `/ce/` |
| **8501** | `lead-engine` | `/lead/` |
| **3005** | `gtm-architect` | `/gtm/` |
| **...** | ... | ... |
Siehe auch: [DuckDNS Setup](./duckdns_setup.md) (falls vorhanden). Siehe auch: [DuckDNS Setup](./duckdns_setup.md) (falls vorhanden).

50
readme.md
View File

@@ -24,44 +24,32 @@ Alle Dienste sind über Port **8090** (oder `https://floke-ai.duckdns.org` bei e
| Modul | Icon | Pfad | Beschreibung | Doku | | Modul | Icon | Pfad | Beschreibung | Doku |
| :--- | :---: | :--- | :--- | :--- | | :--- | :---: | :--- | :--- | :--- |
| **Dashboard** | 🏠 | `/` | Zentrale Landingpage mit Links zu allen Tools. | - | | **Dashboard** | 🏠 | `/` | Zentrale Einstiegsseite. | - |
| **GTM Architect** | 🏛️ | `/gtm/` | **"The Brain"**. Strategie-Entwicklung und Architektur für Go-to-Market. | [README](./gtm-architect/README.md) | | **GTM Architect** | 🏛️ | `/gtm/` | **"The Brain"**. Go-to-Market Strategie & Architektur. | [README](./gtm-architect/README.md) |
| **Company Explorer** | 🤖 | `/ce/` | **"The Data Core"**. CRM-Data-Mining, Import & Deduplizierung. | [README](./company-explorer/README.md) | | **Company Explorer** | 🤖 | `/ce/` | **"The Data Core"**. CRM-Data-Mining & Enrichment. | [README](./company-explorer/README.md) |
| **Lead Engine** | 📈 | `/lead/` | **"Trading Twins"**. Lead-Management und Kalender-Integration. | [README](./lead-engine/README.md) | | **Lead Engine** | 📈 | `/lead/` | **"Trading Twins"**. Lead-Management & Kalender. | [README](./lead-engine/README.md) |
| **Content Engine** | ✍️ | `/content/` | **"The Mouth"**. Generiert SEO-Websites und Sales-Content. | [README](./content-engine/README.md) | | **Content Engine** | ✍️ | `/content/` | **"The Mouth"**. SEO- & Sales-Content Generierung. | [README](./content-engine/README.md) |
| **B2B Marketing Assistant** | 🚀 | `/b2b/` | KI-Analyse von Webseiten für Personas & Pain-Points. | [README](./b2b-marketing-assistant/README.md) | | **B2B Assistant** | 🚀 | `/b2b/` | Persona- & Pain-Point-Analyse. | [README](./b2b-marketing-assistant/README.md) |
| **Market Intelligence** | 📊 | `/market/` | Tiefe Marktanalyse und Recherche-Tool. | [README](./general-market-intelligence/README.md) | | **Market Intel** | 📊 | `/market/` | Marktanalyse & Recherche-Agent. | [README](./general-market-intelligence/README.md) |
| **Competitor Analysis** | ⚔️ | `/competitor/` | Wettbewerber-Analyse, Battlecards & Silver Bullets. | [README](./competitor-analysis-app/README.md) | | **Competitor Analysis** | ⚔️ | `/competitor/` | Wettbewerber-Analyse & Battlecards. | [README](./competitor-analysis-app/README.md) |
| **SuperOffice Connector** | 🔌 | `/connector/` | **"The Muscle"**. Synchronisation mit SuperOffice CRM (Webhook-Empfänger). | [README](./connector-superoffice/README.md) | | **Connector** | 🔌 | `/connector/` | **"The Muscle"**. SuperOffice CRM Synchronisation. | [README](./connector-superoffice/README.md) |
| **Transcription Tool** | 🎙️ | `/tr/` | Meeting-Transkription (MP3/WAV) mit Gemini 2.0. | [README](./transcription-tool/README.md) | | **Meeting Assistant** | 🎙️ | `/tr/` | Meeting-Transkription via Gemini 2.0. | [README](./transcription-tool/README.md) |
| **Heatmap Tool** | 🗺️ | `/heatmap/` | Visualisierung von Excel-Daten (PLZ) auf einer Karte. | [README](./heatmap-tool/README.md) | | **Heatmap Tool** | 🗺️ | `/heatmap/` | Visualisierung von Excel-Daten auf PLZ-Karte. | [README](./heatmap-tool/README.md) |
--- ---
## 🛠️ Technische Spezifikationen ## 🛠️ Technische Spezifikationen
### Docker Stack & Ports ### Architektur & Ports
Die Orchestrierung erfolgt über `docker-compose.yml`. Detaillierte Architektur-Infos finden Sie in der [➡️ Infrastruktur-Dokumentation](./docs/INFRASTRUCTURE.md). Die GTM Engine basiert auf einer Microservice-Architektur, orchestriert via `docker-compose.yml`. Detaillierte Informationen zu Ports, Volumes und Routing finden Sie in der [➡️ Infrastruktur-Dokumentation](./docs/INFRASTRUCTURE.md).
* **Gateway (Nginx):** Port `8090` (extern). * **Zentraler Zugang:** Port `8090` (extern).
* **Interne Kommunikation:** Alle Dienste kommunizieren im `default` Docker-Netzwerk über ihre Service-Namen (z.B. `http://company-explorer:8000`). * **Sicherheit:** Einheitliche Authentifizierung via Nginx-Gateway.
* **WebHooks:** Öffentliche Webhooks (SuperOffice, n8n) müssen explizit in der Firewall freigegeben werden (siehe `RELOCATION.md`). * **Connectivity:** Automatisches DNS-Update via DuckDNS.
### Daten-Persistenz (Volumes) ### Persistenz & Environment
**WICHTIG:** Datenbanken werden niemals direkt gemountet, sondern nutzen benannte Volumes, um Berechtigungsprobleme (insb. auf Synology/NFS) zu vermeiden. * **Volumes:** Alle kritischen Daten werden in benannten Docker-Volumes gespeichert.
* **Secrets:** Konfiguration erfolgt ausschließlich über eine zentrale `.env` Datei. Hardcoded Credentials sind nicht zulässig.
* `explorer_db_data`: Company Explorer (SQLite)
* `connector_db_data`: Connector Queue (SQLite)
* `lead_engine_data`: Lead Engine State (SQLite)
* `gtm_architect_data`: GTM Strategien (SQLite)
* `b2b_marketing_data`: B2B Analysen
* `content_engine_data`: Content Drafts
* `market_intel_data`: Market Intelligence Projekte
* `competitor_analysis_data`: Competitor Reports
* `transcription_uploads`: Audio-Uploads
### Umgebungsvariablen (`.env`)
Alle API-Schlüssel (`GEMINI_API_KEY`, `SERP_API`, `SO_CLIENT_ID` etc.) werden zentral in der `.env` Datei verwaltet und in die Container injiziert. Es gibt keine Hardcoded Credentials im Code.
--- ---