jauderho/excalidraw

Excalidraw Docker 镜像文档

1. 镜像概述和主要用途

1.1 基本信息

• 构建状态：https://github.com/jauderho/dockerfiles/workflows/excalidraw/badge.svg](https://github.com/jauderho/dockerfiles/actions)
• 最新版本：
• 拉取次数：
• 镜像大小：

1.2 主要用途

Excalidraw 是一款虚拟白板工具，专注于绘制手绘风格的图表。本 Docker 镜像封装了 Excalidraw 应用，提供开箱即用的部署方案，支持多平台运行，适用于快速搭建手绘风格绘图环境。

1.3 镜像特性

• 多平台支持：适配多种架构（如 amd64、arm64 等）。
• 时效性：上游 Excalidraw 发布新版本后 1 小时内完成构建，每周至少重建一次，确保镜像与上游同步。

2. 核心功能和特性

2.1 手绘风格渲染

• 线条、形状自动模拟手绘笔触，支持调整粗细、颜色。
• 文本支持手写体字体，增强手绘视觉效果。

2.2 丰富的图形工具

• 基础图形：矩形、圆形、菱形、箭头、折线、自由曲线等。
• 特殊元素：便签、代码块、流程图组件（支持自定义图标）。
• 文本工具：支持多段落、换行、字体大小/颜色调整。

2.3 协作与导出

• 实时协作：通过共享链接支持多人同时编辑（需配合后端服务）。
• 多格式导出：支持导出为 PNG、SVG、PDF 或 Excalidraw 原生格式（.excalidraw）。

2.4 轻量与适配

• 纯前端静态应用，启动快速，资源占用低。
• 支持响应式布局，适配桌面端与平板设备。

3. 使用场景和适用范围

3.1 典型使用场景

• 团队协作：远程团队实时绘制流程图、架构图、头脑风暴记录。
• 个人笔记：快速绘制概念图、学习笔记、草稿。
• 教学演示：教师在线绘制板书、解题步骤、知识点梳理。
• 项目管理：绘制用户旅程图、产品原型、任务看板。

3.2 适用范围

• 用户类型：个人开发者、设计师、教师、学生、小型团队。
• 环境需求：仅需 Docker 运行环境，无需复杂依赖。

4. 使用方法和配置说明

4.1 快速启动（docker run）

bash
# 基本运行（默认端口 80）
docker run -d \
  --name excalidraw \
  -p 8080:80 \  # 主机端口:容器端口（容器内默认监听 80）
  jauderho/excalidraw:latest

启动后访问 http://localhost:8080 即可使用。

4.2 Docker Compose 配置

创建 docker-compose.yml 文件：

yaml
version: "3"
services:
  excalidraw:
    image: jauderho/excalidraw:latest
    container_name: excalidraw
    ports:
      - "8080:80"  # 自定义主机端口（如 80:80）
    restart: unless-stopped  # 自动重启
    # 如需持久化配置（如自定义主题），可挂载配置文件（需参考上游文档）
    # volumes:
    #   - ./config.json:/usr/share/nginx/html/config.json

启动命令：docker-compose up -d

4.3 配置参数说明

环境变量

端口映射

• 容器内默认通过 80 端口提供 HTTP 服务，需通过 -p <主机端口>:80 映射到主机可访问端口。

4.4 高级配置

• 自定义主题：通过挂载配置文件 config.json 修改默认样式（参考 https://github.com/excalidraw/excalidraw/blob/master/src/config.ts%EF%BC%89%E3%80%82
• 反向代理：配合 Nginx/Traefik 等反向代理，添加 HTTPS 支持或路径前缀（如 /excalidraw）。

4.5 注意事项

• 实时协作功能需额外部署 Excalidraw 后端服务（如 excalidraw-room），本镜像仅包含前端应用。
• 数据默认存储在浏览器本地存储，如需跨设备同步，需手动导出/导入文件。