【打工日常】Docker部署一款简单、自托管且加密的Markdown笔记编辑器

一、项目介绍

1.项目简述
mininote，是一个使用Vue3和Express构建的简单、自托管、加密的Markdown笔记应用程序

2.项目功能
mininote提供一个简单个人笔记界面，支持Markdown语法，随时随地的记录你需要的一切；mininote具备高效的分类和标签功能，可以帮助你在不同的场景里面记录工作项目的进展、日常工作的任务列表和以及个人的备忘录；并且它还支持团队协作，可以创建一个工作团队的私密会议内容纪要或者是搭建项目的工作流程，并且你的笔记可以加密存储！

mininote具有的加密功能，即每个笔记的标题和内容都使用Web Crypto API 提供的对称AES-GCM在客户端（即在您的浏览器中）进行加密。但是，笔记本的密码用于派生加密密钥。也就是说，加密的强度取决于您的密码。此外，尽管笔记是加密发送到服务器的，但这不能被认为是真正的端到端加密，因为从技术上讲，服务器有机会在您首先创建新笔记本的那一刻记录您的密码。

3.项目开源地址
https://github.com/muety/mininote

---

二、项目搭建环境

1. 项目测试环境

A.项目搭建在腾讯云centos7.6,外网地址为43.138.153.157
Linux VM-8-12-centos 3.10.0-1160.108.1.el7.x86_64 #1 SMP Thu Jan 25 16:17:31 UTC 2024 x86_64 x86_64 x86_64 GNU/Linux

B.docker版本为26.01，docker-compose版本为v2.26.1
注意：本次实践部署环境为个人腾讯云的测试环境，若是生产环境请谨慎部署；对应开启了容器的端口，在linux下和防火墙下需开放对应端口。

2. 本次项目实施过程

使用docker下载镜像，创建好项目需要挂载的路径，通过docker-cli或者docker compose启动容器，启动容器后查看容器启动状态，查看容器的运行日志是否正常，以上全部正常执行后体验项目功能。

3.注意：docker下载镜像有可能遇到比较慢的情况，参考以下解决措施：

A.docker配置换源，进入/etc/docker的路径，如果没有就创建这个目录
cd /etc/docker/
mkdir -p /etc/docker

B.编辑配置文件
vim daemon.json   ##可以清空里面的内容：%d 然后复制下面的源进去wq保存

{
    "registry-mirrors":[
        "https://286u3d9d.mirror.aliyuncs.com"
    ]
}

C.registry-mirrors：指定了一个镜像仓库的 URL https://286u3d9d.mirror.aliyuncs.com。 这个配置项用于设置 Docker镜像的镜像仓库地址，使得在拉取和推送 Docker 镜像时能够通过该镜像仓库进行加速。这边提供的是广东广州服务器的镜源，建议个人自己去阿里云建一个个人账号，根据实际所在区获取镜源。

D.重新加载源，重启docker服务
sudo systemctl daemon-reload 
sudo systemctl restart docker

---

三、项目搭建前巡检

1. 检查docker是否正常运行
systemctl status docker
or
service docker status
注：我个人测试环境是使用systemctl进行管理，若有使用service管理请使用第二条的命令进行查看。   

[root@VM-8-12-centos ~]# systemctl status docker
● docker.service - Docker Application Container Engine
   Loaded: loaded (/usr/lib/systemd/system/docker.service; enabled; vendor preset: disabled)
   Active: active (running) since Mon 2024-04-22 23:13:57 CST; 4 days ago
     Docs: https://docs.docker.com
 Main PID: 17092 (dockerd)
    Tasks: 158
   Memory: 142.3M
   CGroup: /system.slice/docker.service

若显示docker的Active是active (running)，即表明docker是正常运行的。

2.一般我会使用docker-compose去管理，所以预先需要创建好yaml文件，vim docker-compose.yml,格式如下例子：

version: '3.9'
services:
    nginx:
        image: nginx
        logging:
            options:
                max-size: 1g
        restart: always
        volumes:
            - '/var/run/docker.sock:/tmp/docker.sock:ro'
        ports:
            - '80:80'

---

四、项目实施过程

1.根据开源项目，找到对应的镜像进行pull，若遇到很慢的情况，先检查是否网络问题以及是否已经换源。
docker pull ghcr.io/muety/mininote

[root@VM-8-12-centos ~]# docker pull ghcr.io/muety/mininote
Using default tag: latest
latest: Pulling from muety/mininote
c158987b0551: Pull complete 
ffe47f20beda: Pull complete 
44600e8ec9ae: Pull complete 
69ec3c51c045: Pull complete 
3a9be6a4947d: Pull complete 
2944509d34a5: Pull complete 
367681d9c632: Pull complete 
9a3f778f1f65: Pull complete 
Digest: sha256:1c3546a4ce6aea5b448c18d59a0ac9a23f7c76b8dee704fba95b3ac5f4e0726a
Status: Downloaded newer image for ghcr.io/muety/mininote:latest

2.若已经下载完成显示新的一行，可以输入命令查看是否上一条命令执行成功
echo$?
若返回0，则成功；返回其他则根据实际情况重新下载或者查找原因。

3.docker下载完后，可以查看对应的镜像是否下载成功
docker images |grep mininote

[root@VM-8-12-centos ~]# docker images |grep mininote
ghcr.io/muety/mininote      latest      108c10ab6b97   15 months ago   986MB

4.创建Mininote目录
mkdir -p /opt/mininote

5.生成ssl证书

cd /opt/mininote

openssl genrsa -out mininote.key 2048 
openssl req -new -key mininote.key -out mininote.csr 
openssl x509 -req -in mininote.csr -signkey mininote.key -out mininote.crt
 
6.下载成功后，编辑docker-compose.yml文件

version: '3.9'
services:
  mininote:
    image: 'ghcr.io/muety/mininote:latest'
    environment:
        - HTTPS_KEY=/etc/mininote.key
        - HTTPS_CERT=/etc/mininote.crt
    volumes:
        - '/opt/mininote/mininote.key:/etc/mininote.key:ro'
        - '/opt/mininote/mininote.crt:/etc/mininote.crt:ro'
        - '/opt/mininote:/app/data'
    container_name: mininote
    ports:
        - '3120:3000'

编辑后输入wq进行保存
    
7.为了便捷启动，也可以使用docker-cli启动
    
docker run -d -p 3120:3000 --name mininote   -v /opt/mininote:/app/data -v /opt/mininote/mininote.crt:/etc/mininote.crt:ro     -v /opt/mininote/mininote.key:/etc/mininote.key:ro -e HTTPS_CERT=/etc/mininote.crt -e HTTPS_KEY=/etc/mininote.key ghcr.io/muety/mininote:latest

8.启动docker-compose

docker compose up -d  

9.启动容器后，查看容器的状态是否正常  

docker ps |grep  mininote
    
[root@VM-8-12-centos mininote]# docker ps |grep  mininote
314f808487e3   ghcr.io/muety/mininote:latest   "/bin/sh -c 'yarn st…"   About a minute ago   Up About a minute   0.0.0.0:3120->3000/tcp, :::3120->3000/tcp   mininote

10.启动容器后，查看容器的日志是否正常

docker logs -f mininote

[root@VM-8-12-centos mininote]# docker logs -f mininote
yarn run v1.22.19
$ node index.js
Listening on localhost:3000.

---

五、项目体验

注：云服务器记得放开防火墙3120！
访问地址https://43.138.153.157:3120/,欢迎点击玩一下！
ps：我的测试服务器是乞丐版，所以每次发了大的项目启动后，可能会把前面的项目kill掉，不然会卡爆了，请大家体谅...