使用unraid的docker部署SiYuan笔记,简单记录
- 笔记说明
Siyuan笔记是一款基于markdown语法的笔记工具,具有活跃的社区和多设备支持。大部分功能都是免费,源代码开源,支持插件安装,具有很不错的使用体验。
Docker地址:https://hub.docker.com/r/b3log/siyuan
界面:
- docker部署
官方docker指令为:
docker run -d -v /siyuan/workspace:/siyuan/workspace -p 6806:6806 -u 1000:1000 b3log/siyuan --workspace=/siyuan/workspace/ --accessAuthCode=xxx
其中,需要自己设定/siyuan/workspace路径,用于存放笔记的配置文件和数据文件。另外,设置accessAuthCode密码,在网页登录的时候需要输入密码。最后,由于该docker需要读写文件,需要对文件夹赋予权限,这里设置了1000:1000的PUID和PGID,需要对应设置路径的权限为1000:1000用户可访问。具体指令为:
chown 1000:1000 /siyuan/workspace
- unraid安装
1) 创建文件夹放置siyuan笔记的数据,并使用chown给予用于权限。
2)将workspace和accessAuthCode添加到发布参数,实际为命令。
3) 最后设置的内容如下,分别为基础设置,以及高级测试。
4)上述由于没有设置语言,打开后是英文的,需要进行语言设置。
- 官方docker参数介绍
--workspace
用于指定工作空间文件夹路径,不指定时的默认值是 ~/SiYuan/
。
--wd
内核工作目录路径,不指定时按内核可执行文件入口自动获取。
--readonly
使用 --readonly=true
指定后内核将以只读模式运行,所有写入操作将被禁止。
--accessAuthCode
用于指定浏览器访问((20210104090909-20f2hvi “鉴权密码”)),设置后会覆盖 conf.json 中的 authCode。
--ssl
使用 --ssl=true
后将使用 https 和 wss 协议进行伺服。
--lang
使用 --lang=zh_CN
后将使用简体中文初始化外观语言,默认 en_US
。目前可选值:zh_CN
、zh_CHT
、en_US
和 fr_FR
。
--mode
使用 --mode=dev
后将使用开发模式运行,使用 --mode=prod
将使用生产模式运行,默认 prod
。
开发模式和生产模式的主要区别开发模式会使用 工作目录/appearance/
作为外观文件夹,而生产模式使用的是 工作空间/conf/appearance/
。
--port
用于指定监听端口,不指定时:
- 桌面端使用随机端口
- Docker/移动端使用
6806