SiYuan 思源笔记 — 一键安装

概述

在服务器上提供思源服务的最简单方法是通过 Docker 部署。

• 镜像名称 b3log/siyuan
• 镜像地址

文件结构

整体程序位于 /opt/siyuan/ 下，基本上是 Electron 安装包 resources 文件夹下的结构：

• appearance: 图标、主题、语言
• guide: 用户指南文档
• stage: 界面和静态资源
• kernel: 内核程序

入口点

构建 Docker 镜像时设置了入口点：ENTRYPOINT ["/opt/siyuan/kernel" ]，使用 docker run b3log/siyuan 带参数启动：

• --workspace: 指定工作空间文件夹路径，通过 -v 在主机上挂载到容器
• --accessAuthCode: 指定访问授权码

更多参数可以参考 --help。以下是一个启动命令示例：

docker run -d -v workspace_dir_host:workspace_dir_container -p 6806:6806 b3log/siyuan --workspace=workspace_dir_container --accessAuthCode=xxx

• workspace_dir_host: 主机上的工作空间文件夹路径
• workspace_dir_container: 容器内工作空间文件夹的路径，与 --workspace 中指定的相同
• accessAuthCode: 访问授权码，请务必修改，否则任何人都可以读写你的数据

为简化起见，建议将工作空间文件夹路径在主机和容器上配置为一致，例如：workspace_dir_host 和 workspace_dir_container 都配置为 /siyuan/workspace，对应的启动命令是：

docker run -d -v /siyuan/workspace:/siyuan/workspace -p 6806:6806 -u 1000:1000 b3log/siyuan --workspace=/siyuan/workspace/ --accessAuthCode=xxx

或者，参考下面的 Docker Compose 文件示例：

version: "3.9"
services:
  main:
    image: b3log/siyuan
    command: ['--workspace=/siyuan/workspace/', '--accessAuthCode=${AuthCode}']
    user: '1000:1000'
    ports:
      - 6806:6806
    volumes:
      - /siyuan/workspace:/siyuan/workspace
    restart: unless-stopped
    environment:
      # 时区标识符列表可在 https://en.wikipedia.org/wiki/List_of_tz_database_time_zones 找到
      - TZ=${TimeZone}

用户权限

在镜像中，默认使用创建的正常用户 siyuan (uid 1000/gid 1000) 来启动内核进程。因此，主机创建工作空间文件夹时，请注意设置文件夹的用户组：chown -R 1000:1000 /siyuan/workspace。启动容器时需要参数 -u 1000:1000。

隐藏端口

使用 NGINX 反向代理隐藏端口 6806，请注意：

• 配置 WebSocket 反向代理 /ws

注意

• 务必确认挂载卷的正确性，否则容器删除后数据会丢失
• 不要使用 URL 重写进行重定向，否则可能会有认证问题，建议配置反向代理

限制

• 不支持桌面端和移动端应用连接，仅支持在浏览器中使用
• 不支持导出为 PDF、HTML 和 Word 格式
• 不支持导入 Markdown 文件

注意：首先在终端中运行 chown -R 1000:1000 /mnt/user/appdata/siyuan

模板参考：

Web UI: 6806
Container Port: 6806
Container Path: /home/siyuan
Host path: /mnt/user/appdata/siyuan
PUID: 1000
PGID: 1000
Publish parameters: --accessAuthCode=******(访问授权码)