https://github.com/flintsh/flare
A modern, lightning-fast file sharing platform built for self-hosting. Created with support for ShareX, Flameshot, and easy to set up.
https://github.com/flintsh/flare
docker file-management file-sharing flameshot nextjs nextjs15 react self-hosted server sharex
Last synced: about 1 month ago
JSON representation
A modern, lightning-fast file sharing platform built for self-hosting. Created with support for ShareX, Flameshot, and easy to set up.
- Host: GitHub
- URL: https://github.com/flintsh/flare
- Owner: FlintSH
- License: mit
- Created: 2025-02-17T06:29:47.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-04-03T04:59:45.000Z (about 2 months ago)
- Last Synced: 2025-04-07T10:50:07.424Z (about 2 months ago)
- Topics: docker, file-management, file-sharing, flameshot, nextjs, nextjs15, react, self-hosted, server, sharex
- Language: TypeScript
- Homepage:
- Size: 1.5 MB
- Stars: 30
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
Icon designed by xNefas
### A modern, lightning-fast file sharing platform built for self-hosting
[](https://github.com/FlintSH/flare/releases)
[](https://github.com/FlintSH/flare/commits/main)
[](https://github.com/FlintSH/flare/stargazers)
[](https://discord.gg/mwVAjKwPus)
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.
[](https://railway.com/template/JVT41u?referralCode=R5s8WT)
### Docker Deployment (Self-Hosted)
1. Set up a PostgreSQL server and create a database for Flare.
2. Create a `.env` file with the following required variables:
```bash
DATABASE_URL=postgresql://user:pass@host:5432/dbname # (replace with your PostgreSQL connection string)
NEXTAUTH_SECRET=your-secure-secret-key # (generate with `openssl rand -base64 32`)
NEXTAUTH_URL=http://localhost:3000 # (or wherever you deploy Flare)
```
3. Run Flare using the pre-built Docker image:
```bash
docker run -d \
--name flare \
-p 3000:3000 \
--env-file .env \
-v ./uploads:/app/uploads \
flintsh/flare:latest
```
4. Open http://localhost:3000 to complete the setup and create your admin account.
The official Docker image is available on Docker Hub and GitHub Container Registry as `flintsh/flare`.
## 💬 Support
Need help with your instance? Join my [Discord](https://discord.gg/mwVAjKwPus) for support, discussions, and updates!
## 📝 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](https://flare.fl1nt.dev) (coming soon).
## 📜 License
Flare is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.