# thevickypedia/rustream architecture

> Architecture diagram of the GitHub repository thevickypedia/rustream, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-12). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/thevickypedia/rustream
- Repository: https://github.com/thevickypedia/rustream

## Overview

##### Project type and purpose
- RuStream is a self-hosted, Rust‐based streaming engine with an embedded web UI. It uses Actix Web for HTTP serving, a custom “Squire” framework for routing, authentication, session management, and server-side templates for rendering HTML.

##### File structure
- Top‐level: Cargo.toml, src/
- src/main.rs: application entry point
- src/lib.rs: library entrypoint exposing `start()`
- src/constant.rs: global constants
- src/routes/*: route handlers (auth, basics/health check, file I/O, media streaming, upload), wired into Actix’s App in startup
- src/squire/*: internal framework modules (startup/bootstrap, settings/config, middleware, authentication, parsing, content‐serving, security, subtitles, ASCII art previews, custom handlers)
- src/templates/*: server‐side HTML templates (landing page, index, listing, upload form, session handling, error pages)

##### Insights from the README
- `actix_rt::main` with `rustream::start()`
- Environment‐driven configuration (authorization map, media_source, ports, SSL, CORS, session duration, payload limits)
- No external database; state is in‐memory session tokens and file system for media
- Optional SSL termination or CDN tunneling via environment variables

a. Main components
- Client (Web Browser / Media Player)
- RuStream HTTP Server (Actix Web)
- Router / Middleware (Squire startup + middleware pipeline)
- Authentication & Session Manager (Squire authenticator, secure sessions)
- Route Handlers (auth.rs, fileio.rs, media.rs, upload.rs, basics.rs)
- Template Engine (src/templates modules)
- Media Processing (subtitles, ASCII art generator, parser modules)
- Filesystem Media Store (media_source directory, uploaded files)
- Configuration Service (environment variables via settings.rs)
- Optional SSL / CORS Layer (key_file, cert_file, websites list)

b. Relationships & interactions
1. Client HTTP request → Actix Web Server
2. Request enters Squire middleware pipeline (CORS, logging, session validation)
3. Router directs to appropriate route handler
– /login, /logout → Authenticator → Session Cookie
– /media/<id> → Media Service → file streaming (byte‐range support)
– /upload → File IO Service → write to filesystem
– / → Template Engine → rendered HTML
4. Handlers consult Configuration Service and Media Store
5. Responses (JSON, HTML, or media byte stream) flow back to Client

c. Architectural patterns and design principles
- Layered architecture (Presentation / Application / Data)
- MVC-style separation: templates = View, routes = Controller, file system = Model
- Dependency injection of config and middleware at startup
- Modular design via “Squire” internal crate for reusability
- In-process state (sessions in cookies) instead of external DB

d. Key technologies/frameworks
- Rust language
- Actix Web (HTTP server, routing, middleware)
- Squire (custom framework for startup, routing, auth, config)
- Environment variables (.env) for configuration
- Server-side templates (Rust modules)
- File system as storage for media and uploads
- Optional SSL/TLS

## Diagram (Mermaid)

```mermaid
flowchart TD
    Client["Client (Browser/Media Player)"]:::external
    CDN["Optional SSL/CDN Layer"]:::external
    Client -->|HTTPS Request| CDN -->|Forward| Server

    subgraph "RuStream Server"
        direction TB

        subgraph "Configuration & Bootstrap"
            direction TB
            Main["Application Entry Point (main.rs)"]:::backend
            Lib["Library Entrypoint (start())"]:::backend
            Const["Global Constants"]:::backend
            Startup["Startup & Bootstrap"]:::backend
            Config["Configuration Service"]:::backend
        end

        subgraph "Actix Web HTTP & Middleware"
            direction TB
            HTTP["Actix Web Server"]:::backend
            Middleware["Middleware Pipeline"]:::backend
        end

        subgraph "Application Logic"
            direction TB
            Router["Router (Squire)"]:::backend

            subgraph "Route Handlers"
                direction TB
                AuthRoute["Authentication Routes"]:::business
                BasicRoute["Basic Routes"]:::business
                FileIORoute["File I/O Routes"]:::business
                MediaRoute["Media Streaming Routes"]:::business
                UploadRoute["Upload Routes"]:::business
            end

            subgraph "Services"
                direction TB
                AuthMgr["Authentication & Session Manager"]:::business
                MediaSrv["Media Processing"]:::business
            end
        end

        subgraph "Presentation Layer"
            direction TB
            Templates["Template Engine"]:::business
        end

        subgraph "Data Layer"
            direction TB
            MediaStore["Filesystem Media Store"]:::data
        end

        %% Connections
        Main --> Startup
        Lib --> Startup
        Const --> Startup
        Startup --> Config
        Startup --> HTTP
        Config --> HTTP
        HTTP --> Middleware
        Middleware --> Router
        Router --> AuthRoute
        Router --> BasicRoute
        Router --> FileIORoute
        Router --> MediaRoute
        Router --> UploadRoute
        AuthRoute --> AuthMgr
        MediaRoute --> MediaSrv
        UploadRoute --> MediaStore
        FileIORoute --> MediaStore
        BasicRoute --> Templates
        AuthRoute --> Templates
        MediaSrv --> MediaStore
        AuthMgr --> MediaStore
        Router --> Templates
        Templates -->|Rendered HTML| HTTP
        MediaSrv -->|Byte Stream| HTTP
        HTTP -->|Response| Client
    end

    click Main "https://github.com/thevickypedia/rustream/blob/main/src/main.rs"
    click Lib "https://github.com/thevickypedia/rustream/blob/main/src/lib.rs"
    click Const "https://github.com/thevickypedia/rustream/blob/main/src/constant.rs"
    click Startup "https://github.com/thevickypedia/rustream/blob/main/src/squire/startup.rs"
    click Config "https://github.com/thevickypedia/rustream/blob/main/src/squire/settings.rs"
    click Middleware "https://github.com/thevickypedia/rustream/blob/main/src/squire/middleware.rs"
    click Router "https://github.com/thevickypedia/rustream/blob/main/src/squire/mod.rs"
    click AuthMgr "https://github.com/thevickypedia/rustream/blob/main/src/squire/authenticator.rs"
    click AuthRoute "https://github.com/thevickypedia/rustream/blob/main/src/routes/auth.rs"
    click BasicRoute "https://github.com/thevickypedia/rustream/blob/main/src/routes/basics.rs"
    click FileIORoute "https://github.com/thevickypedia/rustream/blob/main/src/routes/fileio.rs"
    click MediaRoute "https://github.com/thevickypedia/rustream/blob/main/src/routes/media.rs"
    click UploadRoute "https://github.com/thevickypedia/rustream/blob/main/src/routes/upload.rs"
    click Templates "https://github.com/thevickypedia/rustream/blob/main/src/templates/mod.rs"

    classDef external fill:#dddddd,stroke:#333,stroke-width:1px
    classDef backend fill:#add8e6,stroke:#333,stroke-width:1px
    classDef business fill:#90ee90,stroke:#333,stroke-width:1px
    classDef data fill:#ffa500,stroke:#333,stroke-width:1px
```
