siyuan

环境要求

• Docker 与 Docker Compose 环境（使用 Docker 部署方式时）
• 宿主机需开放 6806 端口用于访问 Web 界面
• 桌面/移动端可直接通过应用市场或安装包安装，无需 Docker
• Linux 下配置 siyuan 命令行需安装好思源桌面版并具备 /usr/local/bin 写权限
• Docker 容器默认以 UID/GID 1000 运行，如需自定义需设置 PUID/PGID

安装与启动步骤

1. 1下载安装客户端

   桌面和移动端建议优先通过应用市场安装，便于后续一键升级版本；也可从 B3log 官网或 GitHub Releases 下载安装包。若用 Docker 自托管可跳过本步。

2. 2编写 Compose 文件

   新建 docker-compose.yml，使用 b3log/siyuan 镜像，映射 6806 端口并把宿主机目录挂载到 /siyuan/workspace 作为工作空间。

   version: "3.9"
   services:
     main:
       image: b3log/siyuan
       command: ['serve', '--workspace=/siyuan/workspace/', '--accessAuthCode=${AuthCode}']
       ports:
         - 6806:6806
       volumes:
         - /siyuan/workspace:/siyuan/workspace
       restart: unless-stopped
       environment:
         - TZ=${YOUR_TIME_ZONE}
         - PUID=${YOUR_USER_PUID}
         - PGID=${YOUR_USER_PGID}

   复制

3. 3替换环境变量

   把 Compose 文件里的 ${AuthCode}、${YOUR_TIME_ZONE}、${YOUR_USER_PUID}、${YOUR_USER_PGID} 换成真实值；PUID/PGID 不填则默认使用 1000。

4. 4启动容器

   在 docker-compose.yml 所在目录执行，后台启动思源服务。首次启动会拉取 b3log/siyuan 镜像，需稍等片刻。

   docker compose up -d

   复制

5. 5访问工作空间

   打开浏览器访问 http://localhost:6806，输入 --accessAuthCode 中设置的授权码即可进入笔记界面。远程服务器部署请把 localhost 换成服务器 IP。

6. 6配置命令行

   macOS 安装后创建软链接即可使用 siyuan 命令；Linux 把 <install-dir> 换成实际安装目录执行同样操作。

   ln -s /Applications/SiYuan.app/Contents/Resources/kernel/SiYuan-Kernel /usr/local/bin/siyuan

   复制

关键配置

如何确认成功

浏览器打开 http://localhost:6806 能正常显示思源界面，输入授权码后成功进入工作空间即部署成功。

常见问题

注意事项

• 笔记数据存放在挂载的 /siyuan/workspace 目录中，请自行做好备份
• Compose 中的 AuthCode 等变量是占位符，直接启动前必须替换为真实值
• PUID/PGID 默认 1000，宿主机目录属主与之一致可避免权限问题
• 项目使用 AGPLv3 许可证，商用或二次分发需注意遵守该协议