siyuan

概述

在服务器上服务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)