Flare v1.0.0

Original documentation published with v1.0.0 on 2025-02-18. This release predates the handbook. Commands and external services reflect that release.

Icon designed by xNefas

Flare is a modern, self-hostable file sharing platform designed to work seamlessly with popular screenshot and sharing tools like ShareX and Flameshot. Built with Next.js and designed with simplicity in mind, it offers a complete solution for all your file sharing needs with a strong focus on performance, customizability, and user experience.

✨ Features

🚀 Universal Screenshot Integration
- ShareX, Flameshot, and Bash Script support
- One-click configuration downloads
🔒 Secure & Private - Role-based permissions, private files, and password protection
💾 Flexible Storage - Local filesystem and S3-compatible storage support
🖼️ Universal Preview - Preview images, videos, PDFs, and code with syntax highlighting
🔍 Smart Search - Search by filename, OCR content, and date with filters
📱 Modern UI - Clean, responsive interface built with shadcn/ui - easily customizable
⚙️ Configurable
- User storage quotas, registration controls, and instance settings
- Theme customization with CSS variables and custom colors
- Advanced settings for custom CSS and HTML injection
📊 Admin Dashboard - Usage metrics, user management, and system configuration
👥 User Management - Role assignment, storage quotas, and content moderation
🔗 URL Shortener - Custom short URLs under your domain with click tracking
📝 Pastebin - Code and text sharing with syntax highlighting
🤖 OCR Processing - Automatic text extraction from images uploaded
🔌 Rich Embeds - Content embeds naturally on all your social media platforms.

🚀 Quick Start

Flare is quick to deploy—you only need a PostgreSQL server and Docker. Choose one of these options:

Railway (One-Click)

Click the button below to deploy Flare on Railway. Once deployed, just set your authentication secret and create your admin account.

Docker Deployment (Self-Hosted)

Clone the repository and enter the project directory:

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

Copy the sample environment file:
```
cp .env.example .env
```
Update environment variables (e.g. NEXTAUTH_SECRET and DATABASE_URL) to point to your Postgres server and secure your instance with a secret key.
Launch Flare (which runs PostgreSQL) with:
```
docker compose up -d
```
Open http://localhost:3000 (or wherever you deployed Flare) to complete the setup and create your admin account.

Pre-built Docker images are available on both Docker Hub and GitHub under flintsh/flare.

📝 Configuration

Flare is built to be really configurable. Head to /dashboard/settings to tweak different settings like:

Setting storage quotas and file size limits for users
Defining upload rules and restrictions
Configuring registration options and user permissions
Customizing the site’s appearance and branding
Managing advanced settings like custom CSS and HTML

For more details on each setting, visit the Docs (coming soon).

📜 License

Flare is licensed under the MIT License - see the LICENSE file for details.