diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md new file mode 100644 index 0000000..4f7d10f --- /dev/null +++ b/ARCHITECTURE.md @@ -0,0 +1,27 @@ +# APEX OS Architecture + +Last Updated: 2026-07-02 + +## Overview +APEX OS is a self-hosted AI operating system running on Docker. + +## Components +- **Infrastructure**: Docker, Traefik, PostgreSQL, Redis +- **AI Platform**: LiteLLM, Ollama, OpenRouter, Open WebUI +- **Development**: Gitea, Code-Server, n8n, Dockge +- **Monitoring**: Grafana, Prometheus, Loki +- **Security**: Vaultwarden, Docker Socket Proxy + +## Network +All services on apex_apex-net bridge network. +Public access via Traefik reverse proxy with Let's Encrypt SSL. + +## Data Flow +``` +User -> Traefik (SSL/Routing) -> Service Container -> PostgreSQL/Redis +``` + +## Service Dependencies +- All services depend on Docker and Traefik +- AI services depend on LiteLLM as gateway +- Monitoring depends on Prometheus for metrics collection diff --git a/README.md b/README.md index 19c0900..bb39c6c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,11 @@ -# apex-os-docs +# APEX OS Documentation -APEX OS System Documentation \ No newline at end of file +This repository contains all system documentation for APEX OS. + +## Structure +- [ARCHITECTURE.md](ARCHITECTURE.md) - System architecture and design +- [SERVICES.md](SERVICES.md) - Service inventory and configuration +- [API.md](API.md) - API documentation and endpoints +- [WORKFLOWS.md](WORKFLOWS.md) - n8n workflows and automation +- [DEPLOYMENT.md](DEPLOYMENT.md) - Deployment procedures +- [SECURITY.md](SECURITY.md) - Security policies and credentials diff --git a/SERVICES.md b/SERVICES.md new file mode 100644 index 0000000..47f8d61 --- /dev/null +++ b/SERVICES.md @@ -0,0 +1,14 @@ +# APEX OS Service Inventory + +| Service | Port | Domain | Status | +|---------|------|--------|--------| +| Traefik | 80/443 | traefik.apex.unstuck-path.com | Active | +| Open WebUI | 8080 | chat.apex.unstuck-path.com | Active | +| LiteLLM | 4000 | litellm.apex.unstuck-path.com | Active | +| Gitea | 3100 | git.apex.unstuck-path.com | Active | +| n8n | 5678 | n8n.apex.unstuck-path.com | Active | +| Grafana | 3200 | grafana.apex.unstuck-path.com | Active | +| Dockge | 5001 | dockge.apex.unstuck-path.com | Active | +| Vaultwarden | 8081 | vault.apex.unstuck-path.com | Active | +| Code-Server | 8443 | code.apex.unstuck-path.com | Active | +| Ollama | 11434 | (internal) | Active |