思源笔记是一款隐私优先的本地知识管理软件。它的部署方式比较灵活,你可以根据场景选择桌面端服务器端

📦 部署方式一:桌面端安装(最推荐)

对于个人日常使用,直接安装桌面端是最简单、体验最完整的方案。

  • 下载渠道:从 GitHub Releases官方下载页获取安装包。
  • 系统支持:提供 Windows、macOS、Linux 版本。Windows 用户也可通过 Microsoft Store 安装,macOS 用户也可通过 App Store 获取。
  • 优势:支持一键升级,开启自动更新后省心省力。

🐳 部署方式二:Docker 自托管(适合服务器/多端访问)

如果你有云服务器,或者希望数据完全由自己掌控,Docker 是首选方案。

1. 基础 Docker 命令
使用官方镜像 b3log/siyuan 即可。注意:自 v3.7.0 起,必须显式传递 serve 子命令。

1
2
3
4
5
6
7
8
9
10
# 请将 /siyuan/workspace 替换为你服务器上的实际路径
docker run -d \
--name siyuan \
-v /siyuan/workspace:/siyuan/workspace \
-p 6806:6806 \
-e PUID=1000 -e PGID=1000 \
b3log/siyuan \
serve \
--workspace=/siyuan/workspace/ \
--accessAuthCode=你的锁屏密码

关键参数说明

  • -v:将主机目录挂载到容器,务必确认路径正确,否则容器删除后数据会丢失
  • PUID/PGID:指定容器运行的用户/组 ID,解决挂载目录的权限问题。
  • --accessAuthCode必须修改,否则任何人都能访问你的笔记数据。

2. Docker Compose(推荐)
对于长期运行的服务,用 Compose 管理更清晰。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
# docker-compose.yml
services:
siyuan:
image: b3log/siyuan
command: ['serve', '--workspace=/siyuan/workspace/', '--accessAuthCode=你的密码']
ports:
- "6806:6806"
volumes:
- /siyuan/workspace:/siyuan/workspace # 修改为你的实际路径
restart: unless-stopped
environment:
- TZ=Asia/Shanghai
- PUID=1000
- PGID=1000

执行 docker compose up -d 即可启动。

🔀 进阶:通过反向代理访问

为了使用域名或隐藏端口,通常会配置反向代理。关键点:必须为 WebSocket 路径 /ws 配置代理,否则客户端会连接失败。

Nginx 配置示例

1
2
3
4
5
6
7
location / {
proxy_pass http://127.0.0.1:6806;
proxy_set_header Host $host;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
}
# 如果你的 Nginx 版本较新,使用 map 指令优化 WebSocket 升级头更规范

⚠️ 重要注意事项

  • 数据存储:所有笔记数据都保存在你挂载的 workspace 目录下。.sy 后缀的文件是 JSON 格式的文档数据。
  • 禁止网盘同步绝对不要用 iCloud、Dropbox 等第三方同步盘直接同步 workspace 目录,否则极易导致数据损坏。
  • CLI 工具:思源内置了命令行工具,可用于脚本自动化。Linux/macOS 下安装后,可通过创建软链接使用 siyuan 命令。

你是打算在个人电脑上直接安装使用,还是准备在服务器上用 Docker 部署?告诉我你的具体场景,我可以帮你把配置细节再梳理一下。