Flatnotes开源轻量笔记：基于Ubuntu系统Docker容器化部署实战记录

一、flatnotes介绍

1.1 flatnotes简介

1.2 flatnotes特点

• 移动响应式web界面。
• 原始/所见即所得标记编辑器模式。
• 高级搜索功能。
• 注意“标记”功能。
• 浅色/深色主题。
• 多个身份验证选项（无、只读、用户名/密码、2FA）。
• Restful API。

1.3 flatnotes使用场景

FlatNotes 是一款自托管、无需数据库的 Web 笔记应用，放在下面这些场景里，用起来往往会格外顺手：

1. 个人知识管理：对于喜欢使用Markdown格式记录学习笔记、技术心得、读书感悟等个人知识的用户，FlatNotes提供了一个简洁高效的平台。用户可以轻松地通过文件夹结构来组织和分类自己的笔记，便于日后检索和回顾。
2. 团队项目协作：在小型团队或项目组内部，FlatNotes 可以作为共享知识库使用。团队成员可以共同编辑和查看项目相关的文档、会议纪要、设计规范等，利用Markdown的简洁性和可读性提高沟通效率。自托管特性确保了数据的安全性和私密性。
3. 学术研究与写作：学术研究人员可以利用FlatNotes整理研究资料、撰写论文草稿、记录实验结果。Markdown支持公式、代码高亮等特性，非常适合科技文献的编写。文件夹系统有助于按研究主题或论文章节组织内容。
4. 博客或个人网站内容创作：博主和内容创作者可以利用FlatNotes作为后台编辑器，先在Markdown中撰写文章，然后直接从文件系统发布到网站上。这种方式简化了内容管理和发布的流程，尤其是对于使用静态站点生成器（如Jekyll、Hugo）的用户。
5. 离线优先场景：由于FlatNotes依赖文件系统而非数据库，因此在没有网络连接或者网络不稳定的情况下，用户仍然可以通过本地文件系统访问和编辑笔记，实现离线工作，之后再同步更改。
6. 教育与培训：教师可以使用FlatNotes创建课程大纲、讲义和作业说明，学生则可以用来整理课堂笔记和复习资料。Markdown的易学易用性降低了技术门槛，使得更多人能够专注于内容本身。
7. 开源软件文档维护：开源项目团队可以利用FlatNotes来维护项目文档、开发者指南和贡献者手册。这样不仅便于版本控制，也方便社区成员贡献和编辑文档内容，促进项目的健康发展。

二、本地环境介绍

2.1 本地环境规划

2.2 本次实践介绍

三、本地环境检查

3.1 检查Docker服务状态

[root@jeven ~]# 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 Wed 2023-08-23 23:41:16 CST; 1 weeks 1 days ago
     Docs: https://docs.docker.com
 Main PID: 9562 (dockerd)
    Tasks: 50
   Memory: 1.4G
   CGroup: /system.slice/docker.service

3.2 检查Docker版本

[root@jeven ~]# docker version
Client: Docker Engine - Community
 Version:           20.10.17
 API version:       1.41
 Go version:        go1.17.11
 Git commit:        100c701
 Built:             Mon Jun  6 23:05:12 2022
 OS/Arch:           linux/amd64
 Context:           default
 Experimental:      true

Server: Docker Engine - Community
 Engine:
  Version:          20.10.17
  API version:      1.41 (minimum version 1.12)
  Go version:       go1.17.11
  Git commit:       a89b842
  Built:            Mon Jun  6 23:03:33 2022
  OS/Arch:          linux/amd64
  Experimental:     false
 containerd:
  Version:          1.6.6
  GitCommit:        10c12954828e7c7c9b6e0ea9b0c02b01407d3ae1
 runc:
  Version:          1.1.2
  GitCommit:        v1.1.2-0-ga916309
 docker-init:
  Version:          0.19.0
  GitCommit:        de40ad0

3.3 检查docker compose 版本

[[root@jeven ~]# docker compose version
Docker Compose version v2.19.1

四、下载flatnotes镜像

[root@jeven ~]# docker pull  dullage/flatnotes
Using default tag: latest
latest: Pulling from dullage/flatnotes
1d5252f66ea9: Pull complete
eefb43356e06: Pull complete
c26db0eb1f01: Pull complete
300843d99304: Pull complete
daddf7df59b6: Pull complete
fd5b7d323a9e: Pull complete
956d12ab1aba: Pull complete
3a27da5a148e: Pull complete
9bc9c825c797: Pull complete
4f4fb700ef54: Pull complete
2dff9aeca767: Pull complete
745990a309e1: Pull complete
cf33157fe535: Pull complete
1f4f074b255f: Pull complete
042bd107273a: Pull complete
Digest: sha256:666b237abff5a16d781ee7f06ccdadef9e42951de3ec320a071407a9e85666ef
Status: Downloaded newer image for dullage/flatnotes:latest
docker.io/dullage/flatnotes:latest

五、部署flatnotes笔记工具

5.1 创建目录

mkdir -p /data/flatnotes/data   && cd /data/flatnotes/

 chmod -R 777 /data/flatnotes/

5.2 使用docker-cli部署

• 生成随机KEY

[root@jeven flatnotes]# cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 24 | head -n 1
Nl1rQmfg4gsnJfBfsmkXOo7G

docker run -d 
   --restart unless-stopped 
   --name flatnotes 
   -p "28880:8080" 
   -v "/data/flatnotes/data:/data" 
   -e "FLATNOTES_AUTH_TYPE=password" 
   -e "FLATNOTES_USERNAME=admin" 
   -e "FLATNOTES_PASSWORD=admin" 
   -e "FLATNOTES_SECRET_KEY=Nl1rQmfg4gsnJfBfsmkXOo7G" 
   -e "PORT=8080" 
  dullage/flatnotes:latest

5.3 编辑docker-compose.yaml文件

version: '3'

services:
  flatnotes:
    image: dullage/flatnotes:latest
    container_name: flatnotes
    restart: always
    ports:
      - 28880:8080
    volumes:
      - /data/flatnotes/data:/data
    environment:
      - FLATNOTES_AUTH_TYPE=password
      - FLATNOTES_USERNAME=admin
      - FLATNOTES_PASSWORD=admin
      - FLATNOTES_SECRET_KEY=Nl1rQmfg4gsnJfBfsmkXOo7G
      - PORT=8080

5.4 创建flatnotes容器

[root@jeven flatnotes]# docker compose up -d
[+] Running 2/2
 ⠿ Network flatnotes_default  Created                                                                                                                                     0.1s
 ⠿ Container flatnotes        Started                                                                                                                                     0.4s

5.5 检查flatnotes容器状态

[root@jeven flatnotes]# docker ps
CONTAINER ID   IMAGE                      COMMAND            CREATED          STATUS          PORTS                                         NAMES
23eebd85b174   dullage/flatnotes:latest   "/entrypoint.sh"   13 seconds ago   Up 13 seconds   0.0.0.0:28880->8080/tcp, :::28880->8080/tcp   flatnotes

5.6 检查flatnotes容器日志

[root@jeven flatnotes]# docker logs flatnotes
Setting up user and group...
Adding group `flatnotes' (GID 1000) ...
Done.
Adding user `flatnotes' ...
Adding new user `flatnotes' (1000) with group `flatnotes' ...
Creating home directory `/home/flatnotes' ...
Copying files from `/etc/skel' ...
Setting file permissions...
WARNING: Breaking changes introduced in version 3.x:
  - The port flatnotes uses inside the Docker container has been changed to 8080 (previously 80).
  - To accompany the above change, support for the PORT environment variable has been removed.
  - The note directory inside the Docker container has moved from /app/data to simply /data.
Starting flatnotes...
2023-09-01 10:22:51 [INFO]: Creating new index
INFO:     Started server process [1]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://0.0.0.0:8080 (Press CTRL+C to quit)

六、访问flatnotes

6.1 进入flatnotes登录页

6.2 访问flatnotes首页

七、flatnotes的基本使用

7.1 新建笔记

7.2 编辑笔记内容

7.3 预览笔记内容

7.4 保存笔记内容

7.5 查看首页笔记

7.6 查看文件存储

[root@jeven data]# pwd
/data/flatnotes/data
[root@jeven data]# ls -l
total 8
-rw-r--r--. 1 admin admin 5680 Sep  1 18:52 Linux系统之普通用户sudo提权配置.md

八、总结