siyuan
1.0.0
重构你的思维
中文 | 日本语
siyuan是一个隐私优先的个人知识管理系统，支持细粒度的块级引用和Markdown所见即所得。
欢迎来到siyuan英语讨论论坛了解更多信息。
大多数功能都是免费的，即使用于商业用途也是如此。
siyuan ://部分功能仅供付费会员使用，更多详情请参阅定价。
| 项目 | 描述 | 叉子 | 星星 |
|---|---|---|---|
| 琵琶 | 编辑器引擎 | ||
| 铬合金 | Chrome/Edge 扩展 | ||
| 市场 | 社区市场 | ||
| 似曾相识 | 数据仓库 | ||
| 花瓣 | 插件API | ||
| 安卓 | 安卓应用程序 | ||
| IOS | iOS应用程序 | ||
| 即兴演奏 | 间隔重复 |
建议桌面端和移动端优先通过应用市场安装，方便日后一键升级版本。
移动的：
桌面：
在服务器上提供siyuan最简单的方法是通过 Docker 进行部署。
b3log/ siyuan整体程序位于/opt/ siyuan /下，基本上就是Electron安装包的resources文件夹下的结构：
入口点在构建 Docker 镜像时设置： ENTRYPOINT ["/opt/ siyuan /entrypoint.sh"] 。此脚本允许更改将在容器内运行的用户的PUID和PGID 。这对于解决从主机挂载目录时的权限问题尤其重要。 PUID （用户ID）和PGID （组ID）可以作为环境变量传递，从而在访问主机安装的目录时更容易确保正确的权限。
使用docker run b3log/ siyuan运行容器时使用以下参数：
--workspace ：指定工作空间文件夹路径，通过主机上的-v挂载到容器--accessAuthCode : 指定访问授权码可以使用--help找到更多参数。以下是使用新环境变量的启动命令的示例：
docker run -d
-v workspace_dir_host:workspace_dir_container
-p 6806:6806
-e PUID=1001 -e PGID=1002
b3log/ siyuan
--workspace=workspace_dir_container
--accessAuthCode=xxxPUID ：自定义用户 ID（可选，如果未提供则默认为1000 ）PGID ：自定义组ID（可选，如果不提供则默认为1000 ）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
-e PUID=1001 -e PGID=1002
b3log/ siyuan
--workspace=/ siyuan /workspace/
--accessAuthCode=xxx对于使用 Docker Compose 运行siyuan的用户，可以传递环境变量PUID和PGID来自定义用户和组 ID。以下是 Docker Compose 配置的示例：
version : " 3.9 "
services :
main :
image : b3log/ siyuan
command : ['--workspace=/ siyuan /workspace/', '--accessAuthCode=${AuthCode}']
ports :
- 6806:6806
volumes :
- / siyuan /workspace:/ siyuan /workspace
restart : unless-stopped
environment :
# A list of time zone identifiers can be found at https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
- TZ=${YOUR_TIME_ZONE}
- PUID=${YOUR_USER_PUID} # Customize user ID
- PGID=${YOUR_USER_PGID} # Customize group ID在此设置中：
PUID和PGID动态设置并传递给容器1000通过在环境中指定PUID和PGID ，您无需在 compose 文件中显式设置user指令 ( user: '1000:1000' )。容器在启动时会根据这些环境变量动态调整用户和组。
在该映像中， entrypoint.sh脚本确保使用指定的PUID和PGID创建siyuan用户和组。因此，当主机创建工作区文件夹时，请注意设置该文件夹的用户和组所有权，以匹配您计划使用的PUID和PGID 。例如：
chown -R 1001:1002 / siyuan /workspace如果您使用自定义PUID和PGID值，入口点脚本将确保在容器内创建正确的用户和组，并且已安装卷的所有权将相应调整。无需在docker run或docker-compose中手动传递-u ，因为环境变量将处理自定义。
使用NGINX反向代理隐藏6806端口，请注意：
/ws PUID和PGID环境变量是否与主机系统上已安装目录的所有权相匹配注意：首先在终端运行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=******(Access authorization code)
我们在重大更新之前发布了 Insider 预览版，请访问 https://github.com/siyuan-note/insider。
参见开发指南。
数据保存在工作区文件夹中，在工作区数据文件夹中：
assets用于保存所有插入的资源emojis用于保存表情符号图像snippets用于保存代码片段storage用于保存查询条件、布局和抽认卡等。templates用于保存模板片段widgets用于保存小部件plugins用于保存插件public用于保存公共数据.sy的文件用于保存文档数据，数据格式为JSON不支持通过第三方同步盘进行数据同步，否则可能导致数据损坏。
虽然不支持第三方同步盘，但支持连接第三方云存储（会员特权）。
另外，还可以考虑手动导出和导入数据，实现数据同步：
siyuan完全开源，欢迎贡献：
更多详情请参考开发指南。
您可以在设置-关于-当前版本中查看更新，或者关注官方下载或 GitHub Releases 获取新版本。
列表项下的第一个子块是省略的块图标。您可以将光标移动到该块并使用Ctrl+/触发其块菜单。
如果之前在多个设备上正确初始化了数据存储库密钥，则该密钥在所有设备上都是相同的，可以在“设置” - “关于” - “数据存储库密钥” -“复制密钥字符串检索”中设置
如果之前没有正确配置（例如多台设备上的密钥不一致）或者所有设备都不可用而无法获取密钥串，您可以按照以下步骤重置密钥：
大多数功能都是免费的，即使用于商业用途也是如此。
会员权益需付款后才能使用，请参阅定价。
siyuan的诞生离不开众多开源项目和贡献者，请参考项目源码kernel/go.mod、app/package.json以及项目主页。
siyuan的成长离不开用户的反馈和推广，感谢大家对siyuan的帮助❤️
欢迎加入我们，共同为siyuan贡献代码。
