Skip to content

ARCHITECTURE.md

Latest commit

 

History

History
41 lines (33 loc) · 1.84 KB

ARCHITECTURE.md

File metadata and controls

41 lines (33 loc) · 1.84 KB

Architecture Overview

DockLog is designed as a lightweight, secure bridge between teams and the Docker daemon.

🏗 High-Level Architecture

graph TD
    User((User)) -->|HTTPS/WS| FE[Vue 3 Frontend]
    FE -->|API/WebSockets| BE[Go Backend]
    BE -->|SQLite| DB[(SQLite DB)]
    BE -->|Unix Socket| DS[Docker Socket]
    DS -->|Logs/Stats| BE
Loading

1. The Backend (Go)

The backend is the core of the application. It handles:

  • Authentication: JWT-based auth with SECRET_KEY signing.
  • RBAC Enforcement: Middleware that validates every request against user permissions stored in SQLite.
  • Docker Interaction: Communicates with the local Docker daemon via the standard Moby SDK.
  • Real-time Streaming: Efficiently tails Docker logs and streams them to the client via WebSockets.

2. The Frontend (Vue 3)

A modern Single Page Application (SPA) that provides:

  • Dashboard: Real-time log viewer and container management.
  • Admin Panel: Interface for managing users, permissions, and viewing audit logs.
  • Security: Enforces password changes and hides unauthorized actions.

3. Data Storage (SQLite)

A local docklog.db file stores:

  • User Accounts: Credentials (hashed) and permission profiles.
  • Audit Logs: Every administrative and container action is recorded for traceability.
  • Container Stats: Historical performance data (CPU/Memory).

🔐 Security Model

DockLog uses a "Defense in Depth" approach:

  1. Transport Security: Should be deployed behind a reverse proxy (like Nginx or Traefik) for TLS.
  2. Authentication: Every request requires a valid JWT.
  3. Authorization: Even with a valid token, the backend re-validates permissions for the specific resource (container) on every request.
  4. Audit Trail: Every action is logged, creating a permanent record of who did what and when.