siyuan

其他资源 2025-08-23


重构您的想法








中文| 日本语


目录

  • 介绍
  • ?功能
  • 建筑和生态系统
  • ?星历史
  • ?️路线图
  • 下载设置
    • 应用市场
    • 安装程序包
    • Docker托管
    • 无关托管
    • 内幕预览
  • ?️社区
  • 开发指南
  • ❓常见问题解答
    • siyuan如何存储数据?
    • 它是否通过第三方同步磁盘支持数据同步?
    • siyuan是开源的吗?
    • 如何升级到新版本?
    • 如果某些块(例如列表项目中的段落块)找不到块图标怎么办?
    • 如果丢失数据回购密钥,该怎么办?
    • 我需要付费吗?
  • 致谢
    • 贡献者

介绍

siyuan是一种隐私优先的个人知识管理系统,支持细粒度的块级参考和Markdown Wysiwyg。

欢迎来到siyuan英语讨论论坛,以了解更多信息。

?功能

大多数功能都是免费的,即使用于商业用途。

  • 内容块
    • 块级参考和双向链接
    • 自定义属性
    • SQL查询嵌入
    • 协议siyuan ://
  • 编辑
    • 块式
    • Markdown Wysiwyg
    • 列表大纲
    • 块缩放
    • 数百万个大型文档编辑
    • 数学公式,图表,流程图,甘特图表,计时图表,员工等。
    • 网络剪辑
    • PDF注释链接
  • 出口
    • 裁判和嵌入
    • 资产标准标记
    • pdf,word和html
    • 复制到微信国会议员,Zhihu和Yuque
  • 数据库
    • 表视图
  • 抽认卡间隔重复
  • AI写作和Q/A聊天通过OpenAI API
  • Tesseract OCR
  • 多名,拖放到分屏
  • 模板片段
  • JavaScript/CSS代码
  • Android/iOS/Harmonyos应用程序
  • Docker部署
  • API
  • 社区市场

某些功能仅适用于付费成员,有关更多详细信息,请参考定价。

建筑和生态系统

项目 描述 叉子 星星
琵琶 编辑引擎
铬合金 镀铬/边缘扩展
市场 社区市场
Dejavu 数据存储库
花瓣 插件API
安卓 Android应用
ios iOS应用
和谐 Harmonyos应用程序
即兴 间隔重复

?星历史

siyuan&type = date“>”

?️路线图

  • siyuan发展计划和进步
  • siyuan Changelog

下载设置

建议优先考虑通过桌面和移动设备上的应用程序市场安装,以便将来可以单击一键升级版本。

应用市场

移动的:

  • 应用商店
  • Google Play
  • F-Droid

桌面:

  • Microsoft Store

安装程序包

  • B3log
  • github

Docker托管

Docker部署

概述

在服务器上服务siyuan的最简单方法是通过Docker部署它。

  • 图像名称B3Log/ siyuan
  • 图像URL

文件结构

总体程序位于 /opt / siyuan /下,基本上是电子安装程序包的资源文件夹下的结构:

  • 外观:图标,主题,语言
  • 指南:用户指南文档
  • 阶段:界面和静态资源
  • 内核:内核程序

入口点

当构建Docker映像时,将设置入口点:入口点[“ siyuan ”]。该脚本允许更改将在容器内运行的用户的PUID和PGID。这与从主机安装目录时解决权限问题尤其重要。 PUID(用户ID)和PGID(组ID)可以作为环境变量传递,从而更容易确保在访问主机安装的目录时正确的权限。

使用Docker Run B3Log/ siyuan运行容器时,请使用以下参数:

  • - workspace:指定工作区文件夹路径,安装在主机上的容器上-V
  • - AccessauthCode:指定访问授权代码

使用-HELP可以找到更多参数。这是带有新环境变量的启动命令的示例:

siyuan \ --workspace=workspace_dir_container \ --accessAuthCode=xxx">
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=xxx
  • PUID:自定义用户ID(可选,默认为1000,如果不提供)
  • PGID:自定义组ID(可选,默认为1000,如果不提供)
  • Workspace_dir_host:主机上的工作区文件夹路径
  • workspace_dir_container:workspace中指定的容器中工作区文件夹的路径
    • 另外,可以通过siyuan _WorkSpace_path Env变量设置路径。如果两者都设置
  • accessAuthCode:访问授权代码(请确保修改,否则任何人都可以访问您的数据)
    • 另外,可以通过siyuan _access_auth_code env变量设置验证代码。如果两者都设置
    • 禁用访问授权代码设置ENV变量siyuan _access_auth_code_bypass = true

为了简化事物,建议配置工作区文件夹路径以在主机和容器上保持一致,例如将workspace_dir_host和workspace_dir_container配置为 / siyuan / workspace。相应的启动命令是:

siyuan /workspace \ -p 6806:6806 \ -e PUID=1001 -e PGID=1002 \ b3log/ siyuan \ --workspace=/ siyuan /workspace/ \ --accessAuthCode=xxx">
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组成

对于使用Docker组成的siyuan运行的用户,可以传递环境变量PUID和PGID以自定义用户和组ID。这是Docker组成配置的示例:

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.*wikip*edi*a.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">
 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.*wikip*edi*a.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,您可以避免在组合文件中明确设置用户指令(用户:'1000:1000')。容器将根据启动时的这些环境变量动态调整用户和组。

用户权限

在图像中,entrypoint.sh脚本可确保使用指定的PUID和PGID创建siyuan用户和组。因此,当主机创建一个工作区文件夹时,请注意设置用户和组所有权,以匹配您计划使用的PUID和PGID。例如:

chown -R 1001:1002 / siyuan /workspace

如果使用自定义PUID和PGID值,则入口点脚本将确保在容器内创建正确的用户和组,并且将相应地调整固定量的所有权。由于环境变量将处理自定义,因此无需在Docker Run或Docker -Compose中手动通过-U。

隐藏端口

使用nginx反向代理隐藏端口6806,请注意:

  • 配置Websocket反向代理 /WS

笔记

  • 确保确认已安装卷的正确性,否则将删除容器后丢失数据
  • 请勿使用RURL重写进行重定向,否则身份验证可能存在问题,建议配置反向代理
  • 如果遇到权限问题,请验证PUID和PGID环境变量与主机系统上固定目录的所有权匹配

限制

  • 不支持桌面和移动应用程序连接,仅支持在浏览器上使用
  • 不支持将其导出到PDF,HTML和单词格式
  • 不支持导入降价文件

无关托管

无关的部署

注意:第一次运行Chown -R 1000:1000/mnt/user/appdata/ siyuan在终端中

模板参考:

siyuan Host path: /mnt/user/appdata/ siyuan PUID: 1000 PGID: 1000 Publish parameters: --accessAuthCode=******(Access authorization code)">
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)

内幕预览

我们在重大更新之前发布内幕预览,请访问https://g**it*hub.com/siyuan-note/insider。

?️社区

  • 英语讨论论坛
  • 用户社区摘要
  • 很棒的siyuan

开发指南

请参阅开发指南。

❓常见问题解答

siyuan如何存储数据?

数据保存在工作区文件夹中,在工作区数据文件夹中:

  • 资产用于保存所有插入的资产
  • 表情符号用于保存表情符号图像
  • 摘要用于保存代码片段
  • 存储用于保存查询条件,布局和抽认卡等。
  • 模板用于保存模板片段
  • 小部件用于保存小部件
  • 插件用于保存插件
  • 公众用于保存公共数据
  • 其余的文件夹是由用户创建的笔记本文件夹,使用笔记本文件夹中的带有后缀的文件用于保存文档数据,数据格式是JSON

它是否通过第三方同步磁盘支持数据同步?

不支持通过第三方同步磁盘进行数据同步,否则数据可能会损坏。

尽管它不支持第三方同步磁盘,但它支持与第三方云存储(成员的特权)连接。

此外,您还可以考虑手动导出和导入数据以实现数据同步:

  • 桌面:设置-导出-导出数据/导入数据
  • 手机:右列-关于-导出数据/导入数据

siyuan是开源的吗?

siyuan是完全开源的,欢迎捐款:

  • 用户界面和内核
  • 安卓
  • ios
  • 和谐
  • 镀铬剪辑扩展

有关更多详细信息,请参阅开发指南。

如何升级到新版本?

  • 如果通过App Store安装,请通过App Store更新
  • 如果它是通过桌面上的安装软件包安装的,则可以打开设置的选项 -大约-自动下载更新安装软件包,以便siyuan自动下载最新版本的安装程序包和提示
  • 如果通过手动安装软件包安装,请再次下载安装软件包以安装

您可以检查设置中的更新-关于当前版本,或者注意官方下载或GitHub版本以获取新版本。

如果某些块(例如列表项目中的段落块)找不到块图标怎么办?

列表项下的第一个子块是省略的块图标。您可以将光标移至此块中,并使用CTRL+/触发其块菜单。

如果丢失数据回购密钥,该怎么办?

  • 如果以前在多个设备上正确初始初始初始初始初始初始初始化了该键,则该密钥在所有设备上都是相同的,并且可以在设置中设置 -大约-数据repo键-复制键字符串检索

  • 如果在之前尚未正确配置(例如,多个设备上的密钥不一致)或所有设备都无法获得,并且无法获得键字符串,则可以通过遵循以下步骤来重置密钥:

    1. 手动备份数据,您可以使用导出数据或直接复制文件系统上的工作区/数据/文件夹
    2. 设置-关于-数据rep键-重置数据存储库
    3. 重新初始化数据回购密钥。初始化一台设备上的密钥后,其他设备导入键
    4. 云使用新的同步目录,旧同步目录不再可用,可以删除
    5. 现有的云快照不再可用,可以删除

我需要付费吗?

大多数功能都是免费的,即使用于商业用途。

成员的特权只能在付款后使用,请参考定价。

致谢

siyuan的诞生与许多开源项目和贡献者密不可分,请参阅项目源代码内核/go.mod,app/package.json和Project HomePage。

siyuan的增长与用户反馈和促销密不可分,谢谢大家对siyuan的帮助

贡献者

欢迎加入我们,并一起向siyuan撰写代码。

下载源码

通过命令行克隆项目:

git clone https://github.com/siyuan-note/siyuan.git