什么是 Note Mark
Note Mark
是一种轻量、快速、简约,基于网络的 Markdown
笔记应用程序。具有时尚且响应迅速的网络用户界面。
安装
在群晖上以 Docker 方式安装。
ghcr.io 镜像下载
官方的镜像没有发布在 docker hub
,而是在 ghcr.io
,所以直接用命令行来安装
镜像分为前端
和后端两个镜像
在 SSH
客户端中依次执行下面的命令
1 2 3 4 5
| docker pull ghcr.io/enchant97/note-mark-frontend:0.6.0-alpha
docker pull ghcr.io/enchant97/note-mark-backend:0.6.0-alpha
|
如果没有科学上网,很可能会拉不动,可以试试 docker
代理网站:https://dockerproxy.com/,但是会多几个步骤
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
|
docker pull ghcr.dockerproxy.com/enchant97/note-mark-frontend:0.6.0-alpha
docker tag ghcr.dockerproxy.com/enchant97/note-mark-frontend:0.6.0-alpha ghcr.io/enchant97/note-mark-frontend:0.6.0-alpha
docker rmi ghcr.dockerproxy.com/enchant97/note-mark-frontend:0.6.0-alpha
docker pull ghcr.dockerproxy.com/enchant97/note-mark-backend:0.6.0-alpha
docker tag ghcr.dockerproxy.com/enchant97/note-mark-backend:0.6.0-alpha ghcr.io/enchant97/note-mark-backend:0.6.0-alpha
docker rmi ghcr.dockerproxy.com/enchant97/note-mark-backend:0.6.0-alpha
|
下载完成后,可以在 映象
中看到
nginx.conf
将下面的内容保存为 nginx.conf
文件
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
| upstream backend { server backend:8000; }
upstream frontend { server frontend:8080; }
server { listen 80; server_name example.com;
location / { proxy_pass http://frontend; }
location /api { proxy_pass http://backend/api; } }
|
docker-compose 安装
将下面的内容保存为 docker-compose.yml
文件
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
| version: "3"
services: backend: image: ghcr.io/enchant97/note-mark-backend:0.6.0-alpha container_name:note-mark-backend restart: unless-stopped volumes: - ./data:/data environment: JWT_SECRET: "mRLxVp/4k8QNLNt2WNuuKBHY5HiYrOtIMqvpM0Wg0wM="
frontend: image: ghcr.io/enchant97/note-mark-frontend:0.6.0-alpha container_name:note-mark-frontend restart: unless-stopped
proxy: image: nginx:alpine container_name:note-mark-web restart: unless-stopped ports: - 8381:80 volumes: - ./nginx.conf:/etc/nginx/conf.d/default.conf:ro
|
JWT_SECRET
:可以用命令 openssl rand -base64 32
来生成
更多的环境变量,可以看官方文档:https://github.com/enchant97/note-mark/blob/main/docs/deploy.md#configuration
然后依次执行下面的命令
1 2 3 4 5 6 7 8 9 10
| mkdir -p /volume2/docker/note-mark/data
cd /volume2/docker/note-mark
docker-compose up -d
|
运行
在浏览器中输入 http://群晖IP:8381
就能看到主界面
点 login
–> need an account?
–> create user
来创建账号
登录后的主界面
先创建笔记本(notebook
)
然后创建笔记( note
)
可通过右上角的 Edit
开关进入编辑状态
或者预览状态
参考文档
enchant97/note-mark: Note Mark is a lighting fast and minimal; web-based Markdown notes app.
地址:https://github.com/enchant97/note-mark