一、FlatNotes介绍

1.1 FlatNotes简介

FlatNotes 是一个自托管的、无数据库的笔记 Web 应用程序,它利用文件夹存储 Markdown 文件,为用户提供简洁高效的笔记管理功能。

1.2 FlatNotes特点

  • 移动响应式 Web 界面,适配多设备使用场景;
  • 支持原始与所见即所得 Markdown 编辑模式
  • 强大的搜索功能,可以快速检索笔记内容;
  • 灵活的“标记”功能,方便分类管理;
  • 支持浅色/深色主题切换
  • 支持多种身份验证方式:包括无验证、只读模式、用户名/密码登录与二次验证(2FA);
  • 提供 RESTful API 接口,可与其他应用集成。

1.3 FlatNotes使用场景

  • 个人知识管理:通过 Markdown 整理学习笔记、技术心得等内容;
  • 团队协作:共享知识库,提高团队沟通和协作效率;
  • 博客创作:以 Markdown 编写文章并发布到博客;
  • 教育和培训:记录教学笔记、课堂内容;
  • 离线优先场景:无网络时仍可通过本地文件访问和编辑笔记。

二、本地环境介绍

2.1 本地环境规划

本次实践为个人测试环境,操作系统版本为 CentOS 7.6。

HostnameIP地址操作系统版本Docker版本
jeven192.168.3.166CentOS 7.620.10.17

2.2 本次实践介绍

  1. 本次实践部署环境为个人测试环境,生产环境请谨慎使用;
  2. Docker 环境下成功部署 FlatNotes 笔记工具

三、本地环境检查

3.1 检查 Docker 服务状态

确保 Docker 服务正常运行,执行以下命令

systemctl status docker

3.2 检查 Docker 版本

确认 Docker 版本符合要求:

docker version

3.3 检查 Docker Compose 版本

确保 Docker Compose 版本为 2.0 或以上:

docker compose version

四、下载 FlatNotes 镜像

从 Docker Hub 下载 FlatNotes 镜像:

docker pull dullage/flatnotes

五、部署 FlatNotes 笔记工具

5.1 创建目录

新建挂载目录并设置权限:

mkdir -p /data/flatnotes/data  
chmod -R 777 /data/flatnotes/

5.2 使用 Docker CLI 部署

运行以下命令快速部署:

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" \
  dullage/flatnotes:latest

5.3 使用 Docker Compose 部署

编辑 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

运行以下命令启动容器:

docker compose up -d

六、访问 FlatNotes

6.1 进入 FlatNotes 登录页

在浏览器中访问:http://192.168.3.166:28880(请根据实际 IP 替换)。

FlatNotes 登录页

6.2 访问 FlatNotes 首页

输入用户名和密码(默认 admin/admin),进入 FlatNotes 首页。

FlatNotes 首页


七、FlatNotes 的基本使用

7.1 新建笔记

点击右上角的 "New" 按钮,新建笔记。

新建笔记

7.2 编辑笔记内容

在编辑器中使用 Markdown 格式撰写内容。

编辑笔记内容

7.3 预览笔记内容

点击右上角的 "Preview" 按钮,预览笔记。

预览笔记

7.4 保存笔记内容

编辑完成后,点击 "Save" 按钮保存。

保存笔记

7.5 查看首页笔记

回到首页,可以看到刚才保存的笔记。

笔记首页展示

7.6 查看文件存储

在挂载目录 /data/flatnotes/data 上,可以看到刚才编辑保存的笔记文件。


八、总结

FlatNotes 是一个轻量、易用且功能强大的自托管笔记工具,适合个人和团队使用:

  • 无数据库:使用文件系统存储笔记,简单高效;
  • Markdown 支持:提供所见即所得和原始模式;
  • 适用广泛:从个人知识管理团队协作均可胜任;
  • 自托管优势:完全掌控数据,保证隐私安全

通过 Docker 快速部署,FlatNotes 成为希望自主管理笔记用户的理想选择!


系列文章

END
cc
最后修改:2024 年 11 月 17 日
如果觉得我的文章对你有用,请随意赞赏