使用Docker部署网页版简易笔记flatnotes汉化优化版

秦曱凧

镜像是我(汉化)制作的，欢迎关注我B站账号 秦曱凧 (读作 qín yuē zhēng)
后面有新的项目，会在B站先发，欢迎关注。
有什么需要制作docker镜像或汉化的项目，也可以B站私信

项目介绍

一个自托管、无数据库的笔记网络应用程序，利用平面文件夹中的 Markdown 文件进行存储。

原项目没有中文，我做了汉化，和中文搜索的支持。
中文搜索，参考的另一个汉化项目 https://github.com/jettzhan/flatnotes-zh

• 原项目地址
  • GitHub仓库 https://github.com/Dullage/flatnotes
• 我汉化和构建docker镜像的
  • GitHub仓库 https://github.com/Firfr/flatnotes-zh-cn
  • Gitee仓库 https://gitee.com/firfe/flatnotes-zh-cn

欢迎start

有需要帮忙部署这个项目的朋友,一杯奶茶,即可程远程帮你部署，需要可联系。
微信号 E-0_0-
闲鱼搜索用户 明月人间
或者邮箱 firfe163@163.com

视频教程

使用

镜像

镜像位于国内，在华为云或阿里云，方便拉取。
(镜像没有上传在DockerHub上面)

端口号 8080

镜像地址

swr.cn-north-4.myhuaweicloud.com/firfe/flatnotes_zh-cn:5.5.3

compose 文件部署

services:
  flatnotes:
    container_name: flatnotes
    image: swr.cn-north-4.myhuaweicloud.com/firfe/flatnotes_zh-cn:5.5.3
    network_mode: bridge
    restart: unless-stopped
    cpus: 1
    mem_limit: 512m
    logging:
      options:
        max-size: "1m"
        max-file: "3"
    environment:
      PUID: 1000
      PGID: 1000
      FLATNOTES_AUTH_TYPE: password
      FLATNOTES_SECRET_KEY: flatnotes
      FLATNOTES_USERNAME: 用户名
      FLATNOTES_PASSWORD: 密码
      TZ: Asia/Shanghai
    volumes:
      - 数据路径:/data
    ports:
      - 端口:8080

高阶配置

高阶配置通过环境变量来设置

• 环境变量

  • FLATNOTES_PORT 监听端口，默认8080

  • FLATNOTES_AUTH_TYPE 登录类型

    • none 无身份验证
    • read_only 同上，但禁用了注释的创建、修改和删除。
    • password 访问 flatnotes 需要用户名和密码。通过环境变量 FLATNOTES_USERNAME 和 FLATNOTES_PASSWORD指定用户名密码
    • totp 除了用户名和密码外，访问 flatnotes 还需要基于时间的一次性密码。

  • FLATNOTES_USERNAME 和 FLATNOTES_PASSWORD 指定用户名密码

  • FLATNOTES_TOTP_KEY 用于生成 totp 代码的密钥。更改此设置将使 totp 配置失效。

    • 建议使用密码生成器来生成随机的 32 个字符的字符串。
    • 当 FLATNOTES_AUTH_TYPE 为 totp 时是必需的。不适用于其他身份验证类型。

  • FLATNOTES_SECRET_KEY 用于生成访问令牌的密钥。更改此设置将使所有现有访问令牌失效。

    • 我建议使用密码生成器来生成随机的 32 个字符的字符串。
    • 当 FLATNOTES_AUTH_TYPE 设置为 password 或 totp 时是必需的。当 FLATNOTES_AUTH_TYPE 设置为 none 或 read_only 时不适用。

  • FLATNOTES_SESSION_EXPIRY_DAYS 定义访问令牌的有效期天数（在需要用户名、密码和（可能）totp 代码才能再次登录之前）。

    • 如果未提供，则默认为 30。

  • FLATNOTES_PATH_PREFIX 子路径

    • 值必须以 / 开头，但不能以 1 结尾，例如 /flatnotes。如果未提供，则没有。

  • FLATNOTES_QUICK_ACCESS_HIDE 如果设置为 true，则隐藏主页上的快速访问说明。默认为 false 。

  • FLATNOTES_QUICK_ACCESS_TITLE 快速访问注释部分的标题。默认为 RECENTLY MODIFIED。

  • FLATNOTES_QUICK_ACCESS_TERM 定义要在快速访问注释部分中显示的注释的搜索词。

    • 一个很好的示例是将此设置为 #pinned 以仅显示包含 “#pinned” 标签或 NOT tags：work 的注释，以排除带有 “#work” 标记的注释。默认为 *。

  • FLATNOTES_QUICK_ACCESS_SORT 用于对快速访问注释部分进行排序的字段。值必须是 score， title， lastModified(默认) 之一。

  • FLATNOTES_QUICK_ACCESS_LIMIT 要在快速访问注释部分中显示的最大注释数。默认为 4。

  • FLATNOTES_PORT 仅适用于 Docker 镜像。定义 flatnotes 将在容器内绑定到的端口。如果未提供，则默认为 8080。

  • PUID & PGID 仅适用于 Docker 镜像。两者都默认为 1000。指定 flatnotes 将在 Docker 容器内运行的用户和组。这对于避免从主机挂载目录时出现权限问题非常有用。

效果图