appstore-1panel/apps/siyuan/README.md
2024-04-10 16:22:47 +08:00

2.6 KiB
Raw Blame History

使用说明

安装方法

请根据安装时的表单填写以下内容:

表单填写项 内容解释
工作空间文件夹路径WORKSPACE_PATH 主机上的工作空间文件夹路径
容器中的文件夹路径WORKSPACE_DIR_CONTAINER 工作空间文件夹在容器中的路径,与指定的参数 --workspace 相同
访问授权码ACCESS_AUTH_CODE 访问授权码,请务必填写,且需要足够复杂。否则任何人都可以读写您的数据
端口SIYUAN_PORT 指定思源端口号默认为6806

勾选【端口外部访问】选项。安装完毕后您可以通过【IP/域名:端口】这种形式服务。例:http://127.0.0.1:6806

安装好后,我的笔记数据在哪?

在您设置的工作空间文件夹WORKSPACE_PATH下。为了防止您更新/删除思源笔记导致的数据丢失问题,默认笔记数据将放置在主机的文件夹 /opt/siyuan/ 下,以确保在卸载时不会将其删除。

我该如何修改访问授权码?

请您在【应用商店】内【已安装】选项卡中找到思源笔记,然后点击参数,选择编辑且修改访问授权码,保存即可。

网页版和客户端有什么区别?

网页版和客户端相比,局限性在于:

  1. 不支持桌面和移动应用程序连接,仅支持在浏览器上使用
  2. 不支持导出为 PDF、HTML 和 Word 格式
  3. 不支持导入 Markdown 文件

以上内容来自Docker Siyuan,如果你需要以上部分或全部内容,请使用客户端。

如何隐藏端口

首先先关闭思源笔记的【端口外部访问】功能然后在左侧【网站】选项卡内找到【创建网站】选择【反向代理】功能最后填写上主域名和代理地址HTTP保存即可。

其中主域名是您可以正常访问的域名siyuan.mydomain.com。 代理地址中的端口是您在前面配置的思源端口号127.0.0.1:6806。

如果您使用 NGINX 进行反向代理,您可能还需要手动配置下 WebSocket 反代 /ws 域名。你可以参考以下配置:

location /ws {
    proxy_pass http://127.0.0.1:6806;
    proxy_read_timeout 60s;
    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection 'Upgrade';
}