dumbwareio/dumbpad

DumbPad

一个极其简单、无需认证（除非需要！）的现代记事本应用，具备自动保存功能和暗黑模式支持。

!https://github.com/user-attachments/assets/c7138bc4-3a9f-456a-a049-67a03a2f45a5

目录

• 核心功能
• 快速开始
  • 前提条件
  • 方式一：Docker 快速运行
  • 方式二：Docker Compose 自定义部署
  • 方式三：本地运行（开发者）
• 配置说明
• 安全特性
• 技术细节
• 使用方法
• 链接

核心功能

• 简洁清晰的界面
• 自动保存功能
• 暗黑模式支持
• 响应式设计（适配移动端）
• Docker 支持
• 可选 PIN 保护（4-10位数字）
• 文件存储模式
• 跨更新数据持久化
• Markdown 格式化
• 模糊搜索（按文件名和内容）
• PWA 支持（渐进式Web应用）

快速开始

前提条件

• Docker（推荐）
• Node.js >=20.0.0（本地开发用）

方式一：Docker 快速运行（适合新手）

bash
# 拉取并运行镜像（一行命令）
docker run -p 3000:3000 \
  -v ./data:/app/data \
  dumbwareio/dumbpad:latest

1. 访问 http://localhost:3000
2. 开始输入内容 - 笔记会自动保存
3. 体验极致简单的笔记记录流程

方式二：Docker Compose 自定义部署（适合喜欢定制的用户）

创建 docker-compose.yml 文件：

yaml
services:
  dumbpad:
    image: dumbwareio/dumbpad:latest
    container_name: dumbpad
    restart: unless-stopped
    ports:
      - ${DUMBPAD_PORT:-3000}:3000
    volumes:
      - ${DUMBPAD_DATA_PATH:-./data}:/app/data
    environment:
      # 网页界面显示的标题
      SITE_TITLE: ${DUMBPAD_SITE_TITLE:-DumbPad}
      # 可选 PIN 保护（留空则禁用）
      DUMBPAD_PIN: ${DUMBPAD_PIN:-}
      # 应用的基础 URL
      BASE_URL: ${DUMBPAD_BASE_URL:-http://localhost:3000} # 使用下方的 ALLOWED_ORIGINS 限制跨域请求来源
      # （可选配置）
      # 用法：逗号分隔的 URL 列表，例如：http://localhost:端口,http://内网IP:端口,https://代理域名,https://认证域名
      # ALLOWED_ORIGINS: ${DUMBPAD_ALLOWED_ORIGINS:-http://localhost:3000} # 取消注释以限制跨域来源（默认允许所有来源*）
      # LOCKOUT_TIME: ${DUMBPAD_LOCK_TIME:-15} # 自定义 PIN 锁定时间（留空默认15分钟）
      # MAX_ATTEMPTS: ${DUMBPAD_MAX_ATTEMPTS:-5} # 自定义 PIN 最大尝试次数（留空默认5次）
      # COOKIE_MAX_AGE: ${DUMBPAD_COOKIE_MAX_AGE:-24} # 自定义认证 Cookie 最大有效期（默认24小时）
      # PAGE_HISTORY_COOKIE_AGE: ${DUMBPAD_PAGE_HISTORY_COOKIE_AGE:-365} # 自定义上次打开记事本的 Cookie 有效期（默认365天，最大400天）- 过期后加载默认记事本

然后运行：

bash
docker compose up -d

1. 访问 http://localhost:3000
2. 开始输入内容 - 笔记会自动保存
3. 享受简单笔记管理的便捷

方式三：本地运行（适合开发者）

1. 安装依赖：

bash
npm install

2. 在 .env 文件中设置环境变量（或复制 .env.example 为 .env）：

bash
PORT=3000                  # 服务器运行端口
DUMBPAD_PIN=1234          # 可选 PIN 保护
SITE_TITLE=DumbPad        # 自定义网站标题
BASE_URL=http://localhost:3000  # 应用基础 URL

3. 启动服务器：

bash
npm start

Windows 用户注意

若使用 Windows PowerShell 运行 Docker，路径格式需调整为：

powershell
docker run -p 3000:3000 -v "${PWD}\data:/app/data" dumbwareio/dumbpad:latest

配置说明

环境变量

安全特性

安全功能

• 可变长度 PIN 支持（4-10位）
• 恒定时间 PIN 比较（防时序***）
• 暴力破解防护：
  • 最大5次尝试机会
  • 尝试失败后15分钟锁定
  • 基于 IP 地址跟踪
• 安全 Cookie 处理
• 客户端不存储 PIN
• 请求频率限制
• 协作编辑支持
• 可选跨域来源限制（CORS）

技术细节

技术栈

• 后端：Node.js (>=20.0.0) + Express
• 前端：原生 JavaScript (ES6+)
• 容器化：Docker 多阶段构建
• 安全：Express 安全中间件
• 存储：基于文件的自动保存系统
• 主题：动态暗黑/亮色模式（支持系统偏好）

依赖项

• express：Web 框架
• cors：跨域资源共享
• dotenv：环境变量配置
• cookie-parser：Cookie 处理
• express-rate-limit：请求频率限制
• marked：Markdown 格式化
• fuse.js：模糊搜索

data 目录包含：

• notepads.json：所有记事本列表
• 每个记事本对应的 .txt 内容文件
• 可直接放入 .txt 文件导入笔记（需刷新页面）

⚠️ 重要：更新镜像时切勿删除 data 目录！这是存储所有笔记的位置。

使用方法

• 直接开始输入即可！笔记会自动保存
• 点击右上角主题切换按钮可切换亮色/暗黑模式
• 按 Ctrl+S（Mac 按 Cmd+S）可强制保存
• 输入时每10秒自动保存一次
• 点击 "+" 按钮创建新记事本
• 可将记事本下载为 .txt 或 .md 文件
• 悬停在记事本控制按钮上可查看键盘快捷键提示
• 按 Ctrl+K（Mac 按 Cmd+K）打开模糊搜索
• 若启用 PIN 保护，访问应用时需先输入 PIN

链接

• GitHub：https://github.com/dumbwareio/dumbpad
• Docker Hub：https://hub.docker.com/r/dumbwareio/dumbpad