NaviDash

轻量、可自托管的个人启动页，用来组织你的日常链接、快速搜索、临时记录和开发者服务入口。
A lightweight, self-hostable start page for your links, searches, notes, and developer services.

中文 | English

在线演示 · 部署说明 · 用户指南 · English

NaviDash 是一个个人用的浏览器起始页。我希望它能把几件每天都会碰到的事放在同一个地方：常用链接、快速搜索、临时便签，以及一些和本地开发、自托管服务有关的小状态。

它不会刻意往完整监控平台、RSS 阅读器或项目管理工具的方向做。那些工具已经有很多成熟选择，NaviDash 更适合做一个轻量的入口页。

为什么做 NaviDash

我最开始想解决的问题很简单：浏览器首页经常要么太空，要么只是一堆书签；如果想放一点待办、便签、天气、项目入口，又很容易变成很重的 dashboard。

NaviDash 想保留一点自由布局和个人化，但核心还是围绕日常使用，不追求把所有组件都塞进来。

• 常用链接和项目入口可以放在一处，不用在书签里来回找。
• 首页可以直接搜索，也可以从已保存链接里快速命中。
• 临时信息可以先记在便签里，不一定每次都打开完整文档工具。
• 支持 Docker 自托管，数据可以放在自己的机器或 NAS 上。
• 功能边界会尽量收住，避免变成另一个很重的全能面板。

适合谁

用户类型	你可能关心	NaviDash 提供
实用效率型	打开快、入口清楚、少配置	链接、搜索、便签、快捷打开
审美展示型	首页好看、有个人风格、适合长期摆放	壁纸、洞洞板布局、主题与可视化配置
技术自托管型	可部署、可控、可扩展、服务状态可见	Docker 部署、数据持久化、面向开发者的组件方向

核心能力

Core：日常入口

• 自由布局的 widget 画布，支持拖拽、重排和尺寸调整
• 桌面与手机双布局，分别编辑排布但共享同一套组件数据
• 内置 Quick Link、Links、Memo、Todo 等高频组件
• 画布级快速打开与搜索，支持命中已保存链接与最近访问记录
• 支持 JSON 导入导出，方便备份和迁移

Theme：个人首页

• 洞洞板风格背景
• 自定义壁纸、模糊和遮罩透明度
• 内置 Clock、Weather、Date、Calendar、Photo Frame
• 适合做成浏览器起始页、个人主页或家用设备首页

Dev Pack：开发者与自托管方向

这些是后续比较想做的技术向扩展。它们更像是“首页上顺手看一眼”的信息，不会一开始就做成完整运维系统。

• 本机 / 局域网 IP、公网 IP 与一键复制
• 服务状态检测，例如 localhost:3000、VPS、API health endpoint
• 端口快捷入口，例如 3000、5432、6379、8080
• 轻量 Docker 服务状态和端口链接

最近更新

当前版本：0.6.0

• 支持桌面与手机分离布局，组件数据共享，移动端适配更完整
• 新增手机布局撤销与恢复能力，降低编辑时的误操作成本
• 新增画布级快速打开与搜索面板，可直接检索已保存链接或走默认搜索
• 主线已吸收 Demo 模式能力，可通过环境变量切换为只读演示站点
• Todo 和 Memo 补充滚动提示阴影，长内容浏览更直观

完整变更记录见 changelog.md。

路线图

下面是目前比较明确的方向，不承诺具体时间。个人项目节奏会按真实使用反馈调整。

阶段	方向
当前主力	链接、搜索、便签、移动端布局、模板体验
接下来	Dev Pack：IP、服务状态、端口快捷入口、轻量 Docker 服务展示
以后考虑	RSS 最近更新、只读 iCal 日历、GitHub 仓库状态
暂不计划	完整监控告警平台、完整 RSS 阅读器、双向日历同步、项目管理系统

快速开始

Docker 部署（推荐）

1. 克隆仓库

git clone https://github.com/wtfllix/navidash.git
cd navidash

2. 准备数据目录

sudo mkdir -p /opt/navidash-data

默认 docker-compose.yml 会把数据挂载到 /opt/navidash-data。推荐把运行数据放在仓库外，避免在升级、替换目录或误删工作区时丢失。

如需自定义路径，可以先设置：

export NAVIDASH_DATA_DIR=/your/data/path

3. 复制环境变量模板

cp .env.example .env

4. 如果需要天气组件，补充天气配置

当前版本天气服务使用和风天气（QWeather）。推荐使用 apikey：

QWEATHER_API_KEY=your_qweather_key
QWEATHER_API_HOST=https://devapi.qweather.com
QWEATHER_AUTH_TYPE=apikey

如果你使用 JWT：

QWEATHER_API_KEY=your_qweather_jwt
QWEATHER_API_HOST=https://devapi.qweather.com
QWEATHER_AUTH_TYPE=jwt

5. 启动容器

docker-compose up -d

6. 打开 http://localhost:3000

升级

git pull
docker-compose pull
docker-compose up -d

只要数据目录仍然挂载在仓库外位置，升级不会清空你的配置。

本地开发

npm install
cp .env.example .env
npm run dev

常用命令：

npm run lint
npm test
npm run build

配置说明

.env.example 中最重要的配置项：

• NEXT_PUBLIC_DEMO_MODE：设为 true 时启用只读演示模式
• DEMO_MODE：设为 true 时在服务端启用 Demo 数据和只读写入保护
• QWEATHER_API_KEY：和风天气（QWeather）使用的 Key 或 JWT
• QWEATHER_API_HOST：可选，自定义和风天气兼容 Host
• QWEATHER_AUTH_TYPE：apikey 或 jwt

当前版本天气请求通过服务端 /api/weather 代理发起，默认对接和风天气（QWeather）。推荐优先把天气相关参数放在环境变量里，而不是写进组件配置。

数据与持久化

运行时数据默认保存在 /app/data，Docker 部署时通过 volume 挂载到宿主机目录。

当前主要持久化文件包括：

• settings.json
• widget-layouts.json
• widget-configs.json

这些文件采用版本化 JSON 包装格式，新版本可以继续兼容迁移；旧格式也保留了读取兼容。

演示模式

NaviDash 支持只读 Demo 模式，适合部署到 Vercel 或作为在线预览站点。

• 前端可以自由拖拽和编辑
• 刷新页面后恢复为预置内容
• 写入接口会返回只读错误，不会持久化数据
• 推荐同时设置 DEMO_MODE=true 和 NEXT_PUBLIC_DEMO_MODE=true

文档

• 部署说明
• 用户指南
• 变更记录
• English README

贡献

欢迎提交 Issue 和 Pull Request。特别欢迎围绕真实使用场景的建议：链接组织、搜索工作流、便签体验、模板和自托管场景。

License

MIT