FlatNas 功能使用手册

文件传输助手预览

仪表盘与布局

• 网格布局：自由拖拽，支持多尺寸组件。
• 分组管理：创建分组，分类管理应用与书签。
• 响应式设计：桌面与移动端自适应。
• 编辑模式：所见即所得，快速添加/删除/调整。

内置小组件

• 书签组件：支持自定义图标，首次启动自动填充常用站点。
• 时钟与天气：实时显示时间与当地天气。
• 文件传输助手：支持文件图片消息的上传，支持超链接，文本自由选择，图标预览，多选，删除，复制等功能。
• 待办事项：简易任务管理。
• RSS 订阅：获取订阅源最新内容。
• 热搜榜单：聚合热点信息。
• 计算器与音乐播放器：便捷工具与本地音乐播放。

个性化定制

• 图标管理：上传图片，支持 Hex 颜色。
• 背景设置：自定义壁纸。
• 分组卡片背景：统一图片/模糊/遮罩风格。
• 访客统计：页脚显示访问量与在线时长。
• 数据安全：本地存储配置，密码访问保护。
• CGI 扩展与更新提醒：支持脚本扩展与版本检测。

v1.0.41 更新提示

• 添加文字内容可以自由框选
• 增加http://和https://的超链接跳转
• 每日一言关闭手机后依然会在手机端展现
• 添加可调色纯色背景
• 添加返回首页快捷键
• 增加了滚动隔离，升级体验
• 变动了倒计时的编辑按钮的层级
• 添加自定义JS（可与自定义CSS协作）

本地开发与构建

• 本地开发：
  • 克隆并安装依赖：git clone、npm install。
  • 启动：npm start（前端与后端同时启动）。
  • 地址：前端 http://localhost:5173，后端 http://localhost:3000。
• 部署构建：
  • 构建前端：npm run build（产物在 dist）。
  • 运行生产服务：npm run server，通过 http://localhost:3000 访问。

FPK 安装

飞牛私有云 (fnOS)： 飞牛私有云 fnOS 应用中心搜索 FlatNas 即可一键安装。

Docker 部署

docker build -t flatnas .

docker run -d \
    -p 23000:3000 \
    -v $(pwd)/data:/app/server/data \
    -v $(pwd)/music:/app/server/music \
    -v $(pwd)/PC:/app/server/PC \
    -v $(pwd)/APP:/app/server/APP \
    -v $(pwd)/doc:/app/server/doc \
    -v /var/run/docker.sock:/var/run/docker.sock \
    --name flatnas \
    qdnas/flatnas:1.0.41

version: "3.8"

services:
  flatnas:
    image: qdnas/flatnas:1.0.41
    container_name: flatnas
    restart: unless-stopped
    ports:
      - "23000:3000"
    volumes:
      - ./data:/app/server/data #指定路径下新建data
      - ./music:/app/server/music #映射播放器路径
      - ./PC:/app/server/PC #映射背景路径
      - ./APP:/app/server/APP #映射移动端背景路径
      - ./doc:/app/server/doc #映射文件传输助手路径
      - /var/run/docker.sock:/var/run/docker.sock #映射Docker Socket

一键部署 (Debian)

如果您使用 Debian 系统，可以使用我们提供的自动化脚本进行无 Docker 部署。

wget -O deploy.sh https://raw.githubusercontent.com/Garry-QD/FlatNas/main/deploy.sh && sudo bash deploy.sh install

git clone https://github.com/Garry-QD/FlatNas.git
cd FlatNas
chmod +x deploy.sh
sudo ./deploy.sh install

关键路径

• 默认密码：admin，登录后请及时修改。
• 数据文件：server/data/data.json。
• 音乐文件：server/music（支持 MP3）。
• CGI 脚本：server/cgi-bin。
• 背景图片：server/PC（PC 端）、server/APP（移动端）。
• 文件传输助手：server/doc。
• Docker Socket：/var/run/docker.sock（需挂载）。

进入/退出

点击页面右下角的 编辑按钮即可进入编辑模式。再次点击编辑按钮退出。

拖动组件和项目说明

• 进入编辑模式后，按住组件卡片即可拖动到目标位置。
• 支持网格吸附与自动对齐，松开后卡片将自动贴合最近网格。
• 拖动过程中页面支持自动滚动，便于跨区域移动。
• 按住卡片将其拖拽到目标分组区域，分组边框会高亮提示可放置。
• 松开即完成换组，卡片将遵循目标分组的布局与样式。
• 支持批量选择后整体拖动到新分组。

功能概述

壁纸库提供强大的背景管理功能，支持双端独立设置、自动轮播以及第三方 API 接入。

通用开关与全局操作

桌面组件支持精细化的显示控制，您可以一键恢复默认或添加自定义组件。

• 公开： 允许未登录访客查看该组件。
• 启用： 控制组件是否在桌面显示。
• 手机： 独立控制组件在移动端是否显示。
• 自动： 部分组件支持自动行为（如随机音乐的自动播放）。
• 恢复默认组件： 一键重置所有组件至系统初始状态。
• + 自定义组件： 支持添加个性化组件（开发中）。

核心组件清单

高级配置：RSS 订阅管理

RSS 组件支持更深层次的个性化配置，确保信息获取的及时与同步。

• 云端同步： 开启后支持多端订阅源同步（已开启）。
• 管理分类： 对不同的订阅源进行分类整理。
• 新增订阅源： 点击“+ 新增订阅源”即可快速添加 RSS 地址。

订阅源实例推荐

高级配置：搜索引擎设置

自定义您的桌面搜索框，支持多引擎切换与优先级调整。

• 排序与优先级： 拖动引擎左侧的三横线图标可调整显示顺序。
• 默认设置： 一键设置百度、谷歌或 Bing 为您的默认搜索引擎。
• URL 模板： 支持自定义搜索引擎 URL 模板（例如：`.../s?wd={q}`）。
• 记住上次选择： 开启后将自动保留您最近一次使用的引擎。

通用说明

• 可多开： 同一组件可创建多个实例并独立配置。
• 开关： 每个实例都支持“公开/手机/启用”独立控制。
• 删除： 支持单实例删除，不影响其他实例。

万能窗口

万能窗口是基于 iframe 开发的，可以在当前页直接打开其他网站。需要注意的是，部分网站配置了拒绝 iframe 嵌入的策略，这类网站需要安装并启用我们的浏览器插件后才能正常显示。

万能窗口自带 3 个便捷按钮，支持 刷新、视角切换（手机/PC 模式）以及 新窗口打开，方便您快速操作嵌入的网页。

• 外网/默认地址： 组件的默认访问 URL。
• 内网地址： 在局域网环境下优先使用的 URL（内网优先）。
• 嵌入行为： 以窗口形式嵌入网页，少数站点可能因下载、验证码或跨域策略而无法正常嵌入。
• 状态开关： 公开、手机端、启用可分别控制。

倒计时

• 标题： 为倒计时设置描述性标题。
• 目标时间： 选择日期与时间，倒计时将实时显示剩余时间。
• 实例控制： 支持公开/手机/启用独立开关与删除。

宿主机状态组件

• 组件总开关： 顶部开关控制宿主机状态组件的显示。
• 公开访问： 允许访客查看宿主机状态。
• 手机端显示： 控制移动端是否显示。
• 使用模拟数据： 在无数据源或调试时使用内置示例数据。
• 测试连接： 点击进行探针/API 的连通性测试。
• 展示信息： 系统版本、内核、运行时长、设备标识，以及 CPU 温度/占用、RAM 使用、磁盘占用、网络接口速率 等。

Docker 组件列表

• 组件开关： 公开、手机端显示、支持启动/停止/重启、使用模拟数据。
• 内网主机： 配置宿主机地址（如 192.168.1.10），用于容器的内网访问与控制。
• 容器列表： 展示容器名称、镜像、Up 运行时长、暴露端口，以及 CPU/MEM 的实时占用。
• 打开方式： 每个容器支持 内网打开/外网打开，并可 添加外网地址。
• 添加卡片： 将容器以卡片形式添加到桌面，便于快速访问与观察。

容器卡片与操作菜单

• 卡片信息： 显示 CPU/MEM 叠层标识以及 NET/IO 速率指标。
• 右键菜单： 包含 内网访问、外网访问、停止容器、重启容器、编辑卡片、删除卡片 等操作。
• 操作权限： 启停/重启需在探针或后端启用控制权限，通常仅管理员可见与可用。

数据来源与权限控制

• 数据源配置： 可配置本地探针或后端 API 端点以获取宿主机与容器状态。
• 跨域与安全： 如采用远端 API，需确保跨域策略与认证已正确配置。
• 管理员可见： 容器控制相关操作默认仅管理员账号可使用。

备份与恢复

• 导出配置： 将当前所有设置导出为 JSON 文件，便于备份与迁移。
• 导入配置： 上传备份文件以恢复配置，支持覆盖当前设置。
• 设为默认模板： 将当前配置保存为系统默认模板，供初始化或重置时使用。
• 恢复初始化： 将系统恢复到初始状态，谨慎使用（会清空现有配置）。

系统模式

• 当前模式显示： 显示“单用户模式”或“多用户模式”。
• 切换为多用户模式： 启用登录与权限管理，适合多人使用场景。
• 默认管理员： 首次启用多用户模式会提供默认管理员账号与密码（通常为 admin/admin），请立即修改。
• 保存为版本： 为当前配置输入版本名称并保存，形成可回滚的配置快照（保存位置示例：data/config_versions）。

密码与登录

• 修改密码： 输入新密码并点击“修改”，立即生效。
• 退出登录： 立即退出当前管理员会话。
• 公开/私有策略： 私有分组与高级设置仅登录后可见，未登录状态仅显示公开内容。

安全建议

• 首次登录后修改默认密码： 防止未经授权的访问。
• 定期备份： 建议开启版本化保存，出现误操作可快速回滚。
• 忘记密码： 在文件中搜索 "password" 字段。
  • 您会看到一串乱码（如 "$2b$10$..." ），这是加密后的密码。
  • 将其直接修改为您想要的明文密码，例如："password": "123456"。
  • 重启服务器： 保存文件并重新启动服务器。
  • 登录： 使用新密码 123456 登录。系统在首次登录成功后会自动将其加密存储。

数据备份说明

在 "高级设置" 中点击 "导出配置" 即可下载备份文件。恢复时直接上传该文件即可覆盖当前设置。

🎨 自定义 CSS 与 JS

支持注入自定义 CSS 和 JavaScript 代码，实现对页面样式的精细控制和高级功能的扩展。

自定义 CSS

提示：在此处输入的 CSS 将直接应用到页面，可用于微调卡片圆角、颜色等样式。

自定义 JS

提示：JS 代码将在页面加载时执行，可与自定义 CSS 配合实现高级交互功能。

☁️ 天气服务设置

配置您的桌面天气组件数据来源，支持多种国内外主流天气源及自定义接口。

• 天气源选择： 内置 Wttr.in (默认)、高德地图 (AMap) 以及 和风天气 (QWeather)。
• 自定义天气源 URL： 支持输入自定义接口地址，需返回指定的 JSON 格式数据。

🔗 Webhook 设置 (内测中)

支持通过 Webhook 接收外部事件触发，实现与第三方服务的联动自动化。

• Webhook 地址： 系统提供唯一的 Webhook 接收地址，可用于 STUN 穿透等场景。
• 最新状态： 实时展示最近一次 Webhook 触发的状态与数据。

🛠️ 第三方接入

• API 接口： 提供标准 RESTful API，支持第三方应用接入与数据交互。
• 插件系统： 支持开发者编写插件，扩展 FlatNas 的核心功能。

加入交流QQ群

• 群号：613835409
• 加入方式：在 QQ 客户端中搜索群号 613835409；加群时请备注 “FlatNas”。

开源协议

• 本项目采用 GNU AGPLv3 开源协议。
• 如进行二次开发与部署，请遵循协议要求。

官方链接

• 官网：https://flatnas.top/
• 飞牛百科：http://qdnas.icu/
• Demo：http://206.237.2.96/
• 图标库主站：https://nasicon.top/
• 图标库二站：https://2.nasicon.top/
• 图标库三站：https://4.nasicon.top/
• Gitee：https://gitee.com/gjx0808/FlatNas
• GitHub：https://github.com/Garry-QD/FlatNas
• Docker Hub：https://hub.docker.com/r/qdnas/flatnas