Flatnotes 打造极简高效的 Markdown 笔记体验

1156 字

6 分钟

Flatnotes 打造极简高效的 Markdown 笔记体验

2024-09-27

Docker

Flatnotes

/

Docker

项目地址

Flatnotes 笔记应用部署指南#

本指南介绍如何使用 Docker Compose 部署 Flatnotes 笔记应用程序，并解释设计理念和功能特性。

设计理念

Flatnotes 的设计核心是提供一个无干扰的笔记记录体验，将笔记内容置于首位。这意味着：

简洁干净的用户界面：减少视觉干扰，突出笔记内容。
无文件夹、笔记本：所有笔记显示在一个列表中，通过强大的搜索和标签功能进行管理。
快捷搜索：通过键盘快捷键 ( / ) 随时进行全文搜索。
笔记自由：Flatnotes 不会“劫持”你的笔记。你的笔记仅仅是 Markdown 文件，没有数据库、专有格式、复杂的文件夹结构等。你随时可以移动文件到其他应用中使用。
实时同步：Flatnotes 仅缓存搜索索引，并在每次搜索和启动时进行增量同步。你可以在 Flatnotes 运行期间，即使在编辑和删除 Markdown 文件，数据仍然保持同步。

功能特性

移动响应式 Web 界面：在各种设备上提供良好的显示效果。
原始 Markdown / WYSIWYG 编辑模式：提供灵活的编辑方式。
高级搜索功能：快速查找需要的内容。
笔记标签功能：方便对笔记进行分类和管理。
可定制主页：根据个人喜好定制主页显示内容。
Wiki 链接支持：轻松链接到其他笔记 (例如： [[我的其他笔记]] )。
浅色/深色主题：根据个人偏好选择合适的显示主题。
多种认证选项：无认证、只读权限、用户名密码认证、双因素认证 (2FA)。
RESTful API：提供 API 接口，方便进行集成和扩展。

部署步骤

创建目录

1
新建一个名为 `flatnotes` 的目录。

创建 Docker Compose 文件

在flatnotes目录中新建一个名为docker-compose.yml的文件，并将以下内容复制到文件中。 务必根据你的实际需求修改以下配置。

1
version: "3"
2
services:
3
  flatnotes:
4
    container_name: flatnotes  # 容器名称，可自行更改
5
    image: dullage/flatnotes:latest  # 使用的镜像版本，"latest"为最新版本，也可指定具体版本
6
    environment:
7
      PUID: 1000  # 用户ID，可以根据需要修改为宿主机的用户ID
8
      PGID: 1000  # 用户组ID，可以根据需要修改为宿主机的用户组ID
9
      FLATNOTES_AUTH_TYPE: "password"  # 认证类型，"password"表示使用密码认证
10
      FLATNOTES_USERNAME: "admin"  # 用户名，可自定义
11
      FLATNOTES_PASSWORD: "password"  # 密码，建议更改为强密码
12
      FLATNOTES_SECRET_KEY: "RandomSeriesOfCharacters"  # 用于安全的密钥，建议修改为随机字符
13
    volumes:
14
      - "/flatnotes/data:/data"  # 数据卷映射，左侧为宿主机路径，右侧为容器内路径，可自定义宿主机路径
15
    ports:
16
      - "56315:8080"  # 映射端口，左侧为宿主机端口，右侧为容器内服务端口，可根据需要修改宿主机端口
17
    restart: unless-stopped  # 重启策略，除非手动停止，否则将始终重启容器

1
**配置解释:**
2

3
*   `version: "3"`: Docker Compose 文件版本。
4
*   `services: flatnotes:`: 定义一个名为 `flatnotes` 的服务。
5
*   `container_name: flatnotes`:  容器名称。
6
*   `image: dullage/flatnotes:latest`: 使用的 Flatnotes 镜像版本。
7
*   `environment`: 设置环境变量:
8
    *   `PUID`:  宿主机用户 ID。
9
    *   `PGID`: 宿主机用户组 ID。
10
    *   `FLATNOTES_AUTH_TYPE: "password"`:  认证方式，设置为 "password" 使用密码认证。
11
    *   `FLATNOTES_USERNAME`: 用户名，建议修改。
12
    *   `FLATNOTES_PASSWORD`: 密码，**务必修改为强密码**。
13
    * `FLATNOTES_SECRET_KEY`: 安全密钥，**务必修改为随机字符，防止恶意攻击**。
14
*   `volumes`:  数据卷映射，将宿主机的 `/flatnotes/data` 目录映射到容器内的 `/data` 目录，用于存储笔记数据。
15
*   `ports`: 将宿主机的 56315 端口映射到容器的 8080 端口。
16
*  `restart: unless-stopped`: 定义了容器的重启策略。如果容器停止，Docker 会尝试自动重启它，除非你手动停止容器。