soulteary/flare

Flare ✨

如果你觉得这个项目有帮到你，欢迎点赞✨（star）给予鼓励；如果你希望收到这个项目的更新推送，可以点击关注 👀（watch）并选择适合自己的关注模式（推荐 release）。

镜像概述和主要用途

轻量、快速、美观的个人导航页面，适用于 HomeLab 或其他注重私密的场景。无任何数据库依赖，应用数据完全开放透明，100% 属于用户自己。支持 x86 以及常见的 ARM 设备，应用资源消耗极低。

核心功能和特性

• 资源消耗极低：
  • CPU: < 1%
  • 内存: < 30M
  • Docker 镜像: < 10M
• 无数据库依赖：应用数据以文件形式存储，完全开放透明，100% 归属用户
• 多架构支持：兼容 x86 及常见 ARM 设备
• 内置高质量图标：集成 Material Design Icons 所有图标，确保界面风格统一
• 免登陆模式：默认无需登录，适合 HomeLab 或本地使用场景
• 高性能：页面渲染速度快，支持同时展示数千个书签

!https://github.com/soulteary/docker-flare/blob/main/screenshots/docker-image-size.png?raw=true

使用场景和适用范围

• HomeLab 个人导航页面
• 本地私密导航场景
• 需要轻量级导航解决方案的环境
• 对资源消耗敏感的设备（如低配置 ARM 设备）

详细使用方法和配置说明

快速上手

快速使用 Flare 仅需两步：下载示例代码和启动程序。

下载包含示例的代码

可通过 git clone 或 "Download ZIP" 方式获取包含基础配置示例（书签和应用）的代码：

bash
git clone https://github.com/soulteary/docker-flare.git
cd docker-flare

app/*yml 目录包含书签和应用数据，可根据需求调整。若目录中无配置文件，应用首次运行时将自动创建。

启动程序访问浏览器

使用 Docker 启动

bash
docker run --rm -it -p 5005:5005 -v `pwd`/app:/app soulteary/flare:0.2.7

使用 docker-compose 启动

bash
docker-compose up -d

Traefik 用户配置

可参考 docker-compose.traefik.yml 配置文件使用。

启动后，默认访问浏览器 5005 端口即可看到界面：

!https://github.com/soulteary/docker-flare/blob/main/screenshots/ui.png?raw=true

应用使用向导

应用启动后，访问 /guide 可获取基础界面功能介绍：

!https://github.com/soulteary/docker-flare/blob/main/screenshots/flare-guide.png?raw=true

应用性能

"快"是 Flare 的核心优势，其性能表现优异：

!https://github.com/soulteary/docker-flare/blob/main/screenshots/***.png?raw=true

性能优化细节可参考文章：《Flare 制作记录：应用前后端性能优化》

进阶文档

• 自定义启动参数
• 关闭免登陆模式后，如何设置用户账号
• 如何挑选和使用图标
• https://github.com/soulteary/traefik-example

与 Flame 比较

• 资源消耗更低：可运行在任何规格机器，包括老旧 ARM 设备（如2015年S805芯片设备）
• 页面性能更优：渲染速度快，支持数千书签同时渲染
• 配置管理简单：使用声明式配置管理导航内容，无数据迁移问题
• 天气数据获取简化：无需申请天气网站 API_KEY，降低使用成本
• 功能精简：去除 K8S、Docker 集成等非必要功能
• 图标统一：内置大量风格统一的高质量矢量图标
• 免登陆默认：适合 HomeLab 及本地使用，减少额外操作

关于内置图标

程序内置 materialdesignicons.com 所有 Material Design Icons，可让每个书签拥有风格统一的高质量矢量图标。

更多信息参考 如何挑选和使用图标。

TODO

• 持续完善程序定制化功能
• 支持使用 API 进行内容管理
• 支持自定义主题配色

Thanks

Inspired by https://github.com/pawelmalak/flame