structurizr/onpremises

Structurizr 本地部署 Docker 镜像文档

镜像概述和主要用途

本Docker镜像是Structurizr的预构建本地部署版本，基于官方Structurizr本地部署文档构建。用户可通过该镜像在自有服务器环境中快速部署Structurizr，实现软件架构图的创建、管理、版本控制及团队协作，数据存储于本地环境，保障数据隐私与安全。

核心功能和特性

• 架构设计与可视化：支持C4模型等主流架构建模方法，可创建系统上下文图、容器图、组件图等软件架构视图
• 文档管理：集成架构文档功能，可将架构决策记录（ADR）与架构图关联管理
• 本地数据存储：数据完全存储在用户自有环境，避免外部数据依赖，提升数据安全性
• 预构建部署：无需手动配置依赖环境，通过Docker快速启动，简化部署流程
• 扩展性：支持与企业内部认证系统（如LDAP）集成，适配企业级部署需求

使用场景和适用范围

• 企业内部架构团队：需要在企业内网环境中进行软件架构设计，对数据隐私和安全有较高要求的团队
• 涉密环境部署：适用于无外部网络访问权限的环境（如隔离网络、涉密项目）
• 定制化需求场景：需要基于Structurizr进行二次开发或定制化配置的组织
• 团队协作场景：小型至中型架构团队在自有服务器上共享和协作管理架构资产

使用方法和配置说明

Docker部署示例

基础运行命令

通过以下命令快速启动Structurizr本地部署实例：

bash
docker run -d \
  -p 8080:8080 \
  -v ./structurizr-data:/var/structurizr \
  --name structurizr-onprem \
  structurizr/onpremises:latest

• -p 8080:8080：将容器内8080端口映射到主机8080端口，用于访问Web界面
• -v ./structurizr-data:/var/structurizr：挂载主机目录./structurizr-data到容器内数据目录，实现数据持久化
• --name structurizr-onprem：指定容器名称为structurizr-onprem

Docker Compose配置

创建docker-compose.yml文件，配置更复杂的部署环境（如集成外部数据库）：

yaml
version: '3'
services:
  structurizr:
    image: structurizr/onpremises:latest
    container_name: structurizr-onprem
    ports:
      - "8080:8080"
    volumes:
      - ./structurizr-data:/var/structurizr
    environment:
      - STRUCTURIZR_ADMIN_USERNAME=admin
      - STRUCTURIZR_ADMIN_PASSWORD=securepassword
    restart: unless-stopped

配置参数说明

环境变量

数据持久化

容器内数据（如架构图、文档、配置）默认存储于/var/structurizr目录，需通过-v参数挂载主机目录实现持久化，避免容器重启后数据丢失。

访问与使用

1. 部署完成后，通过浏览器访问 http://<主机IP>:8080
2. 使用配置的管理员账号（或默认账号）登录系统
3. 参考Structurizr使用文档创建和管理架构图

注意事项

• 生产环境建议配置HTTPS以保障传输安全
• 定期备份挂载的structurizr-data目录，防止数据丢失
• 详细配置与高级功能（如集成认证、数据库配置）请参考官方本地部署文档