【Docker】Linux系统以及威联通QNAP部署思源笔记的通用教程原创

1. 部署容器

1.1. 在威联通container-station3上部署

这个版本是我从2024年年初一直用到现在的版本，没遇到过任何问题，个人感觉没有必要升级。如果你想部署其他版本，可以修改冒号右侧的版本号。
b3log/siyuan:v2.11.4
拉取镜像后，创建容器。这里我使用的是最新的container station 3。 
先配置容器的端口，主机端口设置为一个未被使用的端口即可，重启策略改成始终重启。 
添加存储映射，在nas上新建一个文件夹来存放思源笔记的数据。冒号左侧是你的qnap上的共享文件夹路径，必须新建一个文件夹作为宿主机路径进行映射。 
/Public/docker/data/synote/data:/home/siyuan/sy
然后是修改启动命令，在命令中选择覆盖，然后键入如下内容。如果你的docker需要外网访问，则一定要把accessAuthCode密码设置的复杂一些！ 
--workspace=/home/siyuan/sy --lang=zh_CN --accessAuthCode=你的密码
然后创建容器就可以了。 
创建完毕容器一定要去检查日志，看工作空间有没有问题。如下所示，日志的路径中提到了/home/siyuan/sy，即代表当前使用的就是我们设置好的路径，那就是没有问题的。 
包括检查本地的映射路径中是否有对应的文件，如果没有下面的这些文件，一定要去确认你的docker路径映射有没有问题！ 
最终访问本地IP:端口，显示下面的内容，就是部署成功了。 
1.2. 使用docker-cli命令部署
 
使用docker命令部署参考如下设置，最新版本3.1.0也是一样的命令，我已经测试过了，修改镜像的tag就可以了。其中你可以修改的是-v选项冒号左侧的宿主机目录，以及-p选项后冒号左侧的宿主机端口号。 
sudo docker run -d \
    --name siyuan \
    -v 你需要绑定的宿主机目录:/home/siyuan/sy \
    -p 你需要绑定的宿主机端口:6806 \
    --restart=always \
    b3log/siyuan:v2.11.4 \
    --workspace=/home/siyuan/sy \
    --lang=zh_CN \
    --accessAuthCode=123456
部署完毕后，一定要检查你绑定的宿主机目录下是否有文件！没有文件是有问题的！比如我使用-v /home/wsl/synote/data:/home/siyuan/sy命令创建了思源容器，此时ls -l查看宿主机该路径下会有如下文件，这才是正常情况。 
❯ ls -l /home/wsl/synote/data
total 12K
drwxr-xr-x  3 wsl wsl 4.0K May 25 18:23 conf
drwxr-xr-x 11 wsl wsl 4.0K May 25 18:23 data
drwxr-xr-x  4 wsl wsl 4.0K May 25 18:21 temp
1.3. 使用docker-compose部署
 
在威联通container-station-3中支持docker-compose，就是界面中的应用程序这一栏。真的得吐槽一下qnap的国内翻译组，一股机翻的味道，你还不如不翻译，直接用stack或者docker-compose还更好让人理解一些，最开始我都不知道应用程序是嘛玩意，还以为container-station从2变成3后不支持docker-compose了。 
这里给出qnap可以使用的docker-compose.yml，其实也是所有Linux通用的。 
该yml文件的注意事项在注释里面提到了。其中volumes的配置一定要注意，我们在container-station-3里面可以选择我们的文件夹，但是这些我们创建的共享文件夹的绝对路径都是在/share下的，比如我的共享文件夹名称为Public，那么最终需要在docker-compose里面写的绝对路径就是/share/Public。如果你不注意这一点，直接从/Public开始写，就会发现无论如何配置，思源容器都无法启动，会提示权限不够。说白了还是宿主机目录映射错位置了。 
version: '3'
services:
  siyuan_compose:
    image: b3log/siyuan:v2.11.4
    container_name: siyuan-compose
    restart: unless-stopped
    environment:
      PGID: 1000
      PUID: 1000
      TZ: "Asia/Shanghai"
    ports:
      # 本地端口改冒号左边的。
      - "20000:6806"
    volumes:
	  # 本地映射路径改冒号左边的。
      # 注意qnap的docker-compose采用绝对路径，需要在前面加上/share才是共享文件夹！
      - /share/Public/docker/data/synote/data:/home/siyuan/sy 
    # 登录密码改最后一个accessAuthCode命令等号之后的，其他的别改。
    command: ["--workspace=/home/siyuan/sy","--lang=zh_CN","--accessAuthCode=123456"]
    stdin_open: true  ## 相当于 -i
    tty: true         ## 相当于 -t
写进去后点击创建，即可创建思源容器。 
请进入容器日志检查是否成功启动，以及进入本地映射的目录检查是否有文件！一定要检查一定要检查，不要等你到时候容器出问题了发现本地目录没有文件！ 
比如日志中不应该出现报错，工作空间路径和我们配置的一致，以及/share/Public/docker/data/synote/data路径下应该出现conf、data、temp等文件夹。 
如果是其他Linux主机，将上述内容修改成你的配置之后，在你的linux主机上将上述内容写入一个docker-compose.yml文件，然后使用如下方式启动思源容器 
sudo docker-compose up -d
如果提示docker-compose命令不存在，可以试试docker compose命令，如果还是提示不存在，则需要去安装docker-compose，本站有相关博客。 
2. 如何设置镜像源？
 
 PS: 因为一些原因，各大服务商提供的公开docker镜像源都下架了，您可以尝试自建镜像源或百度一下目前仍然可用的免费公开镜像源。注意，目前可用的公开镜像源大多是互联网用户主动提供的，可能会存在安全风险！ 
2.1. contianer station3如何添加镜像源？
 
默认情况下dockerhub的连通性并不是很好，可能没有办法pull镜像，所以需要设置docker的镜像源。 
设置方法如下。 
点击添加存储库，提供商选择其他，然后URL是填镜像源的名称。 
推荐使用南京大学的镜像https://docker.nju.edu.cn，速度不错。 
填好了之后点击测试链接，成功就OK了，点击应用。 
设置了之后，在映像中就可以使用这个镜像源来pull容器了。 
不过没有办法通过镜像源来搜容器，自带的搜索只能使用dockerhub来pull镜像。每次需要镜像的时候，都得去找容器的镜像名字是什么，还是有点不方便。 
2.2. docker命令行如何添加镜像源？
 
docker的命令行需要修改系统的配置来设置镜像源，对应的文件是/etc/docker/daemon.json。修改这个文件之前，建议先备份一份（如果原本有这个文件的话） 
sudo cp /etc/docker/daemon.json ./docker-daemon.json.bak
然后使用nano或vim编辑器修改这个文件 
sudo vim /etc/docker/daemon.json
往文件中复制粘贴如下内容 
 	"registry-mirrors": ["https://docker.nju.edu.cn"]
随后重启docker服务就可以了，如果无法重启docker服务，也可以直接重启整个主机。 
sudo systemctl restart docker
3. 部署思源后可能遇到的问题
 
3.1. 工作空间不一致问题
 
在下面的这个命令中，我们将使用-v命令映射的容器内的目录（冒号右侧）和--workspace的选项都设置为了/home/siyuan/sy。在部署的时候一定要确认二者的设置是一致的，否则思源会因为找不到容器内的目录，而采用默认的工作空间。相当于路径映射失败。 
docker run -d \
    --name siyuan \
    -v 你需要绑定的宿主机目录:/home/siyuan/sy \
    -p 你需要绑定的宿主机端口:6806 \
    --restart=always \
    b3log/siyuan:v2.11.4 \
    --workspace=/home/siyuan/sy \
    --lang=zh_CN \
    --accessAuthCode=123456
对于不太了解docker机制的用户而言，此时删除了该容器，你的数据就很难找回来了！！这也是为什么前文一直强调，创建了容器后，要去检查自己的本地路径中是否有对应的文件。 
比如你使用了如下映射，那么在创建容器后，一定、一定、一定要去宿主机本地的/home/mu/synote路径下检查是否多出了思源创建的文件！！！！验证方法很简单，你可以给思源单独创建一个新的文件夹，当思源容器启动后，这个文件夹里面多出了repo、data、temp等目录，那么就是映射成功了。 
-v /home/mu/synote:/home/siyuan/sy
如果没有出现新的目录，那就需要去检查思源容器日志，看看工作空间是否正常，以及宿主机目录是否有权限问题导致容器内无法访问。 
3.2. 权限问题
 
思源容器是使用1000用户来创建和访问文件的，所以如果你映射的宿主机路径无法被1000用户或用户组访问，此时日志中就会出现Permission Deny字眼，代表思源缺少权限，没有办法在你映射的工作空间中创建和访问文件。 
你可以通过docker logs命令查看容器的日志。 
docker logs 思源容器名字
下面是一个思源的日志，来源于社区帖子。在这个日志中出现了[lstat /root/document/fllsynote: permission denied]的输出，代表当前思源没有办法访问/root/document/fllsynote这个路径，因为它是一个root用户的路径，权限组不是1000，无法被思源容器的1000用户组访问。 
然后日志中的第二行输出的意思是，思源发现你提供的工作路径/root/document/fllsynote压根没有办法访问，不是个路径（因为思源没有权限访问），所以它会去使用默认的工作路径/home/siyuan/SiYuan。这个时候问题就来了，如果你没有去检查容器日志和本地文件，你会发现思源是正常启动且可以使用的，但它把你的笔记都写入了容器内部，如果后续你的docker出现问题或者你想升级思源镜像版本的时候，把当前容器删除了，数据就丢了！ 
fllsiyuan | W 2024/07/24 19:23:09 file.go:210: determines whether [/root/document/fllsynote] is a directory failed: [lstat /root/document/fllsynote: permission denied]
fllsiyuan | W 2024/07/24 19:23:09 working.go:258: use the default workspace [/home/siyuan/SiYuan] since the specified workspace [/root/document/fllsynote] is not a dir
考虑到真的有很多很多很多人压根没有备份的习惯（即便思源提供了非常方便的导出DATA备份方式），本文再三强调了检查本地映射路径是否有文件的重要性。 
解决这个权限问题的办法有几种： 
不要使用root用户来操作docker命令，而是使用一个子用户+sudo的方式操作docker命令，因为子用户创建出来的文件夹权限是ok的。
手动使用chown和chgrp命令将创建出来的宿主机文件夹用户组改成1000（推荐）。
对于qnap来说，第一个注册的非admin用户就是1000用户，你可以用第一个注册的用户来配置这里的docker容器，并设置映射到qnap的文件夹目录的可读可写权限。理论上也只有第一个注册的用户是默认的管理员，能使用container-station； 
针对第二点做个说明，chown命令是修改文件夹的所属用户，chgrp命令是修改文件夹的所属组。-R选项代表同时修改这个文件夹内部的子文件夹权限。 
sudo chown -R 1000 文件夹
sudo chgrp -R 1000 文件夹
比如我使用了-v /root/siyuan:/home/siyuan/sy进行映射，此时我映射的宿主机目录是在root用户下，大概率是没有办法被容器内直接访问的。此时思源日志中就会出现Permission Deny错误 
这样操作了之后，这个文件夹就可以被容器内访问了，不过你还是需要去检查日志或该文件夹判断是否成功。 
还是那句话，创建了容器后，一定要去检查自己的本地路径中是否有对应的文件！ 
4. 写在最后
 
不管你采用什么方式部署的容器，请一定要确认你映射的本地路径中有对应的文件！数据无价哦！ 
                                    code-server 是一款在线代码编写编辑器，用户可以直接在浏览器中直接使用 VS Code 的功能，无需安装本地 IDE‌。在本地用 docker 安装部署 code-server 以及结合路由侠内网穿透实现外网访问本地部署的 code-server。
                                    本教程基于绿联的NAS设备DX4600 Pro的docker功能进行搭建。思源笔记是一款开源的跨平台云笔记应用，由国内开发者 Vanry 发起和维护。Markdown 支持：思源笔记提供了对 Markdown 格式的强大支持，用户可以使用 Markdown 语法进行高效的文本编辑和格式化。多端同步：支持多平台使用，包括 Windows、macOS、Linux 等，所有设备上的笔记可以实时同步，方便在不同设备间切换使用。文档结构视图：提供了对文档结构的可视化展示，方便用户快速理解和导航文档结构。富文本编辑。
                                    注意上传替换时需要停止docker，否则这个.lock锁定文件会影响笔记的访问。docker容器命名为siyuan，映射的目录为/opt/siyuan。注意如果自己已经有很多本地部署的思源笔记了，只需要整个笔记文件夹压缩。运行之后，访问笔记的网址为：[服务器公网地址]:6806。设置的访问密码是password 端口为6806。然后打包上传到云服务器的映射文件夹中替换就行。我一般在opt的文件夹下创建。
                                    通过 NGINX 反向代理，你可以隐藏后端服务的默认端口（如思源笔记的 6806 端口），只暴露 NGINX 监听的端口（如 80 或 443）。这可以提高安全性，因为直接暴露后端服务的端口可能会带来安全风险。如果你需要以特定用户运行容器，但又不想在容器内创建用户组，可以在 Docker Compose 文件中使用。这需要确保宿主机上的用户组 ID 与容器内使用的用户组 ID 一致。如果一切正常，你应该能够看到思源笔记的界面。在文件夹下创建conf文件（，用于存储思源笔记的数据。，在启动容器时需要带参数。
SSH 登录QTS
ssh 182.168.1.112:22 具体地址得用自己的，和访问QTS的web ip地址一致，使用22端口登录QTS系统
QTS，一个基于linux内核的自定义系统。
哦，我用的是finalshell，如果你在windows下，可以尝试这个工具，很棒~
登录QTS
找到docker
这不是常用linux，常用的docker路径没有