{"id":13456179,"url":"https://github.com/soulteary/docker-flare","last_synced_at":"2025-05-15T20:04:46.141Z","repository":{"id":40594555,"uuid":"449562407","full_name":"soulteary/docker-flare","owner":"soulteary","description":"Flare ✨ Lightweight, high performance and fast self-hosted navigation pages, resource utilization rate is \u003c1% CPU, MEM \u003c30 M, Docker Image \u003c 10M","archived":false,"fork":false,"pushed_at":"2024-01-06T03:32:47.000Z","size":1974,"stargazers_count":1949,"open_issues_count":104,"forks_count":163,"subscribers_count":21,"default_branch":"main","last_synced_at":"2025-04-10T02:18:53.704Z","etag":null,"topics":["bookmark","bookmarks-manager","navigation","self-hosted","start-page"],"latest_commit_sha":null,"homepage":"https://soulteary.com/2022/02/23/building-a-personal-bookmark-navigation-app-from-scratch-flare.html","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/soulteary.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2022-01-19T05:42:58.000Z","updated_at":"2025-04-09T16:47:47.000Z","dependencies_parsed_at":"2024-02-17T08:44:26.931Z","dependency_job_id":null,"html_url":"https://github.com/soulteary/docker-flare","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soulteary%2Fdocker-flare","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soulteary%2Fdocker-flare/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soulteary%2Fdocker-flare/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soulteary%2Fdocker-flare/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/soulteary","download_url":"https://codeload.github.com/soulteary/docker-flare/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254414499,"owners_count":22067272,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bookmark","bookmarks-manager","navigation","self-hosted","start-page"],"created_at":"2024-07-31T08:01:17.358Z","updated_at":"2025-05-15T20:04:39.438Z","avatar_url":"https://github.com/soulteary.png","language":null,"funding_links":[],"categories":["miscellaneous","置顶","Others"],"sub_categories":["9、效率工具集合"],"readme":"# Flare ✨\n\n[![CodeQL](https://github.com/soulteary/flare/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/soulteary/flare/actions/workflows/codeql-analysis.yml) [![Security Scan](https://github.com/soulteary/flare/actions/workflows/scan.yml/badge.svg)](https://github.com/soulteary/flare/actions/workflows/scan.yml) [![Release](https://github.com/soulteary/flare/actions/workflows/release.yml/badge.svg)](https://github.com/soulteary/flare/actions/workflows/release.yml) ![Go Report Card](https://goreportcard.com/badge/github.com/soulteary/flare) [![Docker Image](https://img.shields.io/docker/pulls/soulteary/flare.svg)](https://hub.docker.com/r/soulteary/flare)\n\n\n如果你觉得这个项目有帮到你，欢迎点赞✨（star）给予鼓励；如果你希望收到这个项目的更新推送，可以点击关注 👀（watch）并选择适合自己的关注模式（推荐 release）。\n\n---\n\n轻量、快速、美观的个人导航页面，适用于 HomeLab 或其他注重私密的场景。\n\n无任何数据库依赖，应用数据完全开放透明，100% 属于用户自己。\n\n支持在线编辑，内置 Material Design Icons 6k+ 图标，目前累计下载过万，期待你的反馈 :)\n\n支持 x86 以及常见的 ARM (ARM32v6、ARM32v7、ARM64v8)设备，应用资源消耗非常低：\n\n- CPU: \u003c 1%\n- MEM: \u003c 30M\n- Docker Image: \u003c 10M\n\n\u003cimg src=\"screenshots/docker-pulls.png\" width=\"90%\"/\u003e\n\u003cimg src=\"screenshots/docker-image-size.png\" width=\"90%\"/\u003e\n\n## 快速上手\n\n快速上手 Flare，需要两步：**下载**包含示例的代码、**启动**程序访问浏览器。\n\n### 下载包含示例的代码\n\n你可以使用 `git clone` 或者选择使用 “Download ZIP” 的方式，下载包含了基础的配置示例（书签和应用）的代码：\n\n```bash\ngit clone https://github.com/soulteary/docker-flare.git\ncd docker-flare\n```\n\n`app/*yml` 目录中包含了你的书签和应用数据，你可以根据你的需求对其进行调整。如果目录中没有配置文件，应用将在首次运行的时候，进行自动创建。\n\n### 启动程序访问浏览器\n\n启动应用非常简单，如果你习惯使用 Docker，可以执行：\n\n```bash\n# 可以使用最新镜像\ndocker pull soulteary/flare\ndocker run --rm -it -p 5005:5005 -v `pwd`/app:/app soulteary/flare\n# 也可以追求明确，使用固定版本\ndocker pull soulteary/flare:0.5.1\ndocker run --rm -it -p 5005:5005 -v `pwd`/app:/app soulteary/flare:0.5.1\n```\n\n如果你习惯使用 docker-compose，只需要执行：\n\n```bash\ndocker-compose up -d\n```\n\n如果你是 Traefik 用户，可以参考 `docker-compose.traefik.yml` 配置文件来使用。\n\n不论是哪一种方式，在命令执行完毕之后，默认情况下，我们访问浏览器的 `5005` 端口，就能看到下面的界面啦：\n\n![Flare Web UI](./screenshots/ui.png)\n\n### 程序使用向导\n\n为了方便你的使用，我制作了一个简单的向导程序，在 flare 启动之后，你可以随时访问 `/guide`，获取 flare 基础界面功能的介绍。\n\n![Flare Guide](./screenshots/flare-guide.png)\n\n\n## 程序在线编辑页面\n\n为了满足随时随地编辑的需求，程序新增了“在线编辑”的页面。\n\n![Flare Editor](./screenshots/editor-beta.png)\n\n工具页面地址：`/editor`\n\n## 程序帮助页面\n\n为了减少不必要的地址记忆负担，程序新增了一个“帮助页面”，默认展示所有的程序内的工具页面。\n\n![Flare Help](./screenshots/flare-help.png)\n\n工具页面地址：`/help`\n\n## 程序性能\n\n“快”作为 Flare 对主要优势而言，自然是需要“满分”来加持。\n\n![Flare Lighthouse Scores](./screenshots/lighthouse.png)\n\n如果你好奇这是如何实现的，可以阅读这篇文章：[《Flare 制作记录：应用前后端性能优化》](https://soulteary.com/2022/01/19/flare-production-record-application-frontend-and-backend-performance-optimization.html)。\n\n## 进阶文档\n\n- [自定义启动参数](./docs/advanced-startup.md)\n- [关闭免登陆模式后，如何设置用户账号](./docs/application-account.md)\n- [如何挑选和使用图标](./docs/material-design-icons.md)\n- [如何和 Traefik 一起使用](https://github.com/soulteary/traefik-example)\n\n## 相比较 Flame\n\n- 服务资源消耗极低，可以跑在任何规格的机器上，甚至是一台搭载2015年S805芯片的ARM盒子。\n- 程序页面性能非常好，渲染速度更快，支持同时渲染大量（数千）书签，而不必担心风扇起飞。\n- 使用声明的配置来进行导航内容的管理，无需担心数据迁移问题。\n- 简化了天气数据的获取方式，不再需要申请天气网站的 `API_KEY` ，避免了不必要的成本开销。\n- 简化了 Flame 中的K8S、Docker 集成等不必要的功能。\n- 内置了大量风格统一、高质量的矢量图标，减少选择困难症，确保界面长期“耐看”。\n- 默认使用免登陆模式，避免 HomeLab、本地使用的用户有额外的登陆操作。\n\n## 关于内置图标\n\n程序内置了目前 [materialdesignicons.com](https://materialdesignicons.com/) 中所有的 Material Design Icons，你可以让你的每一个书签都拥有风格统一、高质量的矢量图标。\n\n![](./screenshots/icon-cheat-sheets.png)\n\n更多信息，可以参考 [如何挑选和使用图标](./docs/material-design-icons.md)。\n\n## TODO\n\n- [ ] 持续完善程序定制化功能\n- [ ] 支持使用 API 进行内容管理\n- [ ] 支持自定义主题配色\n\n## Thanks\n\nInspired by https://github.com/pawelmalak/flame\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoulteary%2Fdocker-flare","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsoulteary%2Fdocker-flare","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoulteary%2Fdocker-flare/lists"}