# 217heidai/grass-desktop-node architecture

> Architecture diagram of the GitHub repository 217heidai/grass-desktop-node, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/217heidai/grass-desktop-node
- Repository: https://github.com/217heidai/grass-desktop-node

## Overview

##### Main Components

a) Container Layer:
- Docker Container (primary boundary)
- Volume Mount (/config)
- Network Interface (host network or port mapping)

b) Application Components:
- Grass Desktop Node Application
- Web Interface (port 5800)
- Configuration Storage

c) External Interactions:
- Grass Network Connection
- User's Browser Access
- Host System Resources

**[External Layer]**
- User's Browser
- Grass Network

**[Container Layer]**
- Docker Container Configuration
- Network Modes (host/bridged)

**[Application Layer]**
- Grass Desktop Node
- Web Interface
- Persistent Storage

##### Key Elements to Highlight

- Two alternative network configurations:
- Host network mode (--network host)
- Port mapping mode (-p 5800:5800)
- Web interface connection on port 5800
- Environment variables (USER_ID, GROUP_ID, WEB_LISTENING_PORT)

##### Connection Flows

- User browser → Web Interface (port 5800)
- Container → Grass Network
- Container → Volume Mount
- Environment Variables → Container Configuration

##### Additional Details

- Container configuration options
- Network mode differences
- Volume mount purpose
- Environment variables

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph External
        Browser["User's Browser"]
        GrassNetwork["Grass Network"]
    end

    subgraph Container["Docker Container Environment"]
        direction TB
        DockerConfig["Docker Configuration"]:::docker
        NetworkConfig{"Network Mode"}:::docker
        EnvVars["Environment Variables<br/>USER_ID<br/>GROUP_ID<br/>WEB_PORT"]:::docker
        StartScript["Startup Script"]:::script
        
        subgraph AppLayer["Application Layer"]
            direction TB
            GrassNode["Grass Desktop Node"]:::app
            WebUI["Web Interface<br/>(Port 5800)"]:::ui
            WindowConfig["Window Interface<br/>Configuration"]:::config
        end
        
        Volume[(Config Volume<br/>/config)]:::storage
    end

    Browser -->|"Access via<br/>Port 5800"| WebUI
    GrassNode -->|"Bandwidth<br/>Sharing"| GrassNetwork
    DockerConfig --> NetworkConfig
    NetworkConfig -->|"Host Mode"| GrassNode
    NetworkConfig -->|"Bridge Mode"| GrassNode
    EnvVars --> DockerConfig
    Volume --> GrassNode
    StartScript --> GrassNode
    WindowConfig --> WebUI

    classDef docker fill:#1a73e8,color:white
    classDef app fill:#34a853,color:white
    classDef ui fill:#fbbc04,color:black
    classDef storage fill:#4285f4,color:white
    classDef script fill:#ea4335,color:white
    classDef config fill:#673ab7,color:white

    click DockerConfig "https://github.com/217heidai/grass-desktop-node/tree/main/Dockerfile"
    click StartScript "https://github.com/217heidai/grass-desktop-node/blob/main/startapp.sh"
    click WindowConfig "https://github.com/217heidai/grass-desktop-node/blob/main/main-window-selection.jwmrc"
    click Container "https://github.com/217heidai/grass-desktop-node/blob/main/.github/workflows/docker-image-builder.yml"
    click GrassNode "https://github.com/217heidai/grass-desktop-node/blob/main/README.md"
```
