structurizr/lite

Structurizr Lite Docker镜像文档

1. 镜像概述和主要用途

本镜像为Structurizr Lite的预构建Docker镜像。Structurizr Lite是一款轻量级软件架构设计工具，基于C4模型（Context、Container、Component、Code），提供简单的Web界面用于创建和可视化软件架构图。该镜像旨在简化Structurizr Lite的部署流程，用户可通过Docker快速启动服务，无需手动配置依赖环境。

2. 核心功能和特性

• C4模型支持：原生支持C4软件架构模型，可创建上下文图、容器图、组件图和代码图。
• 实时预览：编辑架构定义文件（如.diagram）时，Web界面实时更新预览效果。
• 本地文件存储：架构文件存储在本地文件系统，支持通过Docker数据卷持久化。
• 轻量级Web界面：简洁的浏览器界面，无需复杂配置即可上手使用。
• 跨平台兼容：基于Docker容器，可在Linux、macOS、Windows等支持Docker的环境运行。
• 零外部依赖：无需数据库或外部服务，仅需本地文件系统即可运行。

3. 使用场景和适用范围

适用场景

• 个人开发者快速设计软件架构图。
• 小型团队协作进行架构原型设计。
• 教学或培训中演示C4模型实践。
• 本地环境中离线编辑和预览架构文件。
• 作为架构设计工具链的轻量化前置环节。

适用范围

• 适合个人或3人以下小型团队使用。
• 适合架构设计初期的快速迭代和原型验证。
• 不建议用于大型团队复杂架构的协同管理（此类场景推荐使用Structurizr Cloud或Enterprise版本）。

4. 详细使用方法和配置说明

4.1 基本使用（Docker Run）

通过docker run命令快速启动Structurizr Lite服务：

bash
docker run -d \
  --name structurizr-lite \
  -p 8080:8080 \
  -v $(pwd)/structurizr-data:/data \
  structurizr/lite

参数说明：

• -d：后台运行容器。
• --name structurizr-lite：指定容器名称。
• -p 8080:8080：映射容器端口8080到主机端口8080（默认Web服务端口）。
• -v $(pwd)/structurizr-data:/data：挂载主机目录（当前目录下的structurizr-data）到容器内/data目录，用于持久化架构文件。

4.2 Docker Compose配置

创建docker-compose.yml文件简化部署：

yaml
version: '3.8'

services:
  structurizr-lite:
    image: structurizr/lite
    container_name: structurizr-lite
    restart: unless-stopped
    ports:
      - "8080:8080"  # Web服务端口
    volumes:
      - ./structurizr-data:/data  # 持久化架构文件
    environment:
      - TZ=Asia/Shanghai  # 设置时区（可选）

启动服务：

bash
docker-compose up -d

4.3 数据持久化

Structurizr Lite的所有架构文件（如.diagram、.json）默认存储在容器内/data目录。为避免容器删除后数据丢失，需通过数据卷挂载将该目录映射到主机：

bash
# 主机目录./structurizr-data将持久化存储架构文件
-v /path/to/host/directory:/data

4.4 端口配置

默认情况下，Structurizr Lite使用8080端口提供Web服务。如需修改端口，可通过端口映射调整主机端口：

bash
# 将容器8080端口映射到主机8888端口
-p 8888:8080

5. 配置参数与环境变量

目前Structurizr Lite Docker镜像未提供官方环境变量配置，主要通过文件挂载和端口映射自定义行为。以下为关键配置说明：

6. 访问与使用Web界面

1. 启动服务后，通过浏览器访问：
   http://<主机IP>:<映射端口>（如http://localhost:8080）。

2. 创建/编辑架构文件：
   在Web界面左侧文件浏览器中，通过New按钮创建.diagram文件，使用Structurizr DSL语法定义架构。

3. 实时预览：
   编辑文件时，右侧面板实时显示架构图效果，支持缩放、拖拽和导出（PNG/SVG格式）。

7. 注意事项

• 文件权限：挂载主机目录时，确保目录权限允许Docker容器读写（可设置权限为777临时测试，生产环境建议按最小权限原则配置）。
• 版本更新：如需使用特定版本的Structurizr Lite，可在镜像标签中指定（如structurizr/lite:1.23.0），默认使用latest标签。
• 备份策略：定期备份挂载的主机目录（/path/to/host/directory），防止数据丢失。