Siyuan:隐私优先的自托管个人知识管理软件
Siyuan是一款隐私优先、自托管、完全开源的个人知识管理软件,用TypeScript和Golang编写,是一款国产的知识管理和笔记软件。
支持特性
- 双向链接:支持在笔记之间建立双向链接,方便知识的关联和整理。
- Markdown编辑:采用Markdown作为主要的编辑语言,所见即所得,提高了编辑效率。
- 块引用:支持对笔记内容进行精细化的引用和管理,方便用户进行知识整理和构建知识体系。
- 图谱视图:提供图谱视图,帮助用户直观地查看笔记之间的关系。
技术特点
- 本地优先:思源笔记的数据存储在用户的硬盘中,用户可以直接访问和管理自己的笔记数据。
- 细粒度块级引用:支持对笔记内容进行精细化的引用和管理。
- Markdown所见即所得:采用Markdown作为主要的编辑语言,用户可以直接看到编辑后的效果。
同步方式
由于采用了新的技术路线,思源笔记的新版本暂时不支持官方的同步功能。但用户可以通过第三方的数据同步方案来同步自己的笔记数据。
易用性
在思源笔记中,用户可以通过多种方式新建文档,如点击文件树、输入双链符号、按下快捷键、新建日记等,操作简便易上手。
如需了解更多信息,可以访问其官方网站或查阅相关的技术文档。
官方GitHub: https://github.com/siyuan-note/siyuan?tab=readme-ov-file
官方网站: https://b3log.org/siyuan/
Docker镜像: https://hub.docker.com/r/b3log/siyuan
安装教程
Siyuan支持跨平台,可以直接下载安装包使用,同时也支持Docker部署。以下是以Ubuntu为例的操作步骤:安装Docker、创建环境文件.env.docker、创建docker-compose.yml、启动容器运行镜像。
第一步:安装Docker
sudo apt update
sudo apt install -y docker.io docker-compose
第二步:创建docker-compose.yml
在Home目录创建docker-compose.yml
,编写以下配置并保存:
version: "3"
services:
main:
image: b3log/siyuan
command: ['--workspace=/siyuan/workspace/', '--accessAuthCode=aaabbbccc']
user: '1000:1000'
ports:
- 6806:6806
volumes:
- /siyuan/workspace:/siyuan/workspace
restart: unless-stopped
environment:
- TZ='Asia/Shanghai'
accessAuthCode
是访问授权码,请务必修改,否则任何人都可以读写你的数据。
镜像中siyuan默认创建的普通用户(uid 1000/gid 1000)用于启动内核进程,因此宿主机创建工作区文件夹时,请注意设置文件夹的用户组:
sudo chown -R 1000:1000 /siyuan/workspace
第三步:启动容器运行镜像
sudo docker-compose up -d
快速搭建
除了使用docker-compose部署之外,还可使用Docker指令快速搭建:
sudo docker run -d \
-v /siyuan/workspace:/siyuan/workspace \
-p 6806:6806 -u 1000:1000 \
b3log/siyuan \
--workspace=/siyuan/workspace/ \
--accessAuthCode=aaabbbccc
上述指令执行完成后,在浏览器访问 IP:6806
即可。
使用自托管的功能限制
- 不支持桌面和移动应用程序连接,仅支持在浏览器上使用。
- 不支持导出为 PDF、HTML 和 Word 格式。
- 不支持导入 Markdown 文件。