flintsh/flare

Flare 文件分享平台

概述

Flare 是一个现代化的自托管文件分享平台，旨在与 ShareX、Flameshot 等流行截图和分享工具无缝协作。基于 Next.js 构建，以简洁设计为核心，提供完整的文件分享解决方案，同时注重性能、可定制性和用户体验。

核心功能与特性

• 🚀 通用截图工具集成
  • 支持 ShareX、Flameshot 和 Bash 脚本
  • 一键下载配置文件
• 🔒 安全与隐私 - 基于角色的权限控制、私有文件和密码保护
• 💾 灵活存储 - 支持本地文件系统和 S3 兼容存储
• 🖼️ 通用预览 - 预览图片、视频、PDF 及代码（含语法高亮）
• 🔍 智能搜索 - 按文件名、OCR 内容和日期搜索，支持筛选
• 📱 现代化界面 - 基于 shadcn/ui 构建的简洁响应式界面，易于定制
• ⚙️ 高度可配置
  • 用户存储配额、注册控制和实例设置
  • 通过 CSS 变量和自定义颜色进行主题定制
  • 支持自定义 CSS 和 HTML 注入的高级设置
• 📊 管理员仪表盘 - 使用指标、用户管理和系统配置
• 👥 用户管理 - 角色分配、存储配额和内容审核
• 🔗 URL 短链接 - 自定义域名下的短链接，含点击跟踪
• 📝 代码粘贴板 - 支持语法高亮的代码和文本分享
• 🤖 OCR 处理 - 自动从上传图片中提取文本
• 🔌 丰富嵌入 - 内容可在各类社交媒体平台自然嵌入

适用场景

• 个人用户自托管文件分享系统
• 团队内部快速截图与文件交换
• 需要自定义存储和权限管理的私有文件服务
• 集成截图工具实现一键分享工作流

快速开始

Flare 部署简单，仅需 PostgreSQL 服务器和 Docker。选择以下部署方式：

Railway 一键部署

点击下方按钮在 Railway 上部署 Flare。部署完成后，设置认证密钥并创建管理员账户。

![Deploy on Railway]([***]

Docker 自托管部署

1. 克隆仓库并进入项目目录：

   bash
   git clone https://github.com/FlintSH/flare.git
   cd flare
   

2. 复制示例环境文件：

   bash
   cp .env.example .env
   

3. 更新环境变量（如 NEXTAUTH_SECRET 和 DATABASE_URL），指向您的 PostgreSQL 服务器，并设置安全密钥保护实例。

4. 启动 Flare（包含 PostgreSQL）：

   bash
   docker compose up -d
   

5. 打开 http://localhost:3000%EF%BC%88%E6%88%96%E6%82%A8%E7%9A%84%E9%83%A8%E7%BD%B2%E5%9C%B0%E5%9D%80%EF%BC%89%E5%AE%8C%E6%88%90%E8%AE%BE%E7%BD%AE%E5%B9%B6%E5%88%9B%E5%BB%BA%E7%AE%A1%E7%90%86%E5%91%98%E8%B4%A6%E6%88%B7%E3%80%82

预构建 Docker 镜像可在 Docker Hub 和 GitHub 上获取，镜像名为 flintsh/flare。

配置说明

Flare 具备高度可配置性，可通过访问 /dashboard/settings 调整以下设置：

• 用户存储配额和文件大小限制
• 上传规则与限制定义
• 注册选项和用户权限配置
• 网站外观与品牌定制
• 高级设置（如自定义 CSS 和 HTML 注入）

有关各设置的详细说明，请访问 文档（即将推出）。

许可证

Flare 采用 MIT 许可证授权 - 详见 LICENSE 文件。