<img src="https://raw.githubusercontent.com/shaneisrael/fireshare/HEAD/app/client/src/assets/logo.png" alt="Logo" width="120" height="160">

Fireshare

Share your game clips, videos, or other media via unique links.
<br /><br />
<a href="https://github.com/shaneisrael/fireshare/actions">
  <img alt="Docker Build" src="https://github.com/shaneisrael/fireshare/actions/workflows/docker-publish-main.yml/badge.svg" />
</a>
<a href="https://hub.docker.com/r/shaneisrael/fireshare">
  <img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/shaneisrael/fireshare?label=docker%20pulls">
</a>
<a href="https://hub.docker.com/r/shaneisrael/fireshare/tags?page=1&ordering=last_updated">
  <img alt="GitHub tag (latest SemVer)" src="https://img.shields.io/github/v/tag/shaneisrael/fireshare?label=version">
</a>
<a href="https://github.com/shaneisrael/fireshare/stargazers">
  <img alt="GitHub stars" src="https://img.shields.io/github/stars/shaneisrael/fireshare">
</a>
<br /><br />
<a href="https://www.buymeacoffee.com/shaneisrael">
  <img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" height="41" width="174" />
</a>
<br /><br />
<a href="https://demo.fireshare.net">Live Demo</a>
 · 
<a href="https://github.com/ShaneIsrael/fireshare/issues">Report a Bug</a>

Key Features

• Share videos through unique links
• Public / private feeds (private is link-only)
• Video transcoding with CPU or GPU
• Password protected videos
• Game-based organization with cover art
• Folder sharing
• Mobile device support
• Uploads (optional, can be restricted)
• Video view counting
• Video cropping
• Video tags for improved search and categorization
• Open Graph metadata for rich link previews
• Notifications to Discord and others
• RSS feed for new public videos
• LDAP support

Supported Video Formats

Navigation

• Installation
• Configuration
• Local Development
• Contributing
• Troubleshooting

Dashboard

Automatic Game Organization

Video Details

Public / Private Uploading

Installation

Docker Compose

services:
  fireshare:
    container_name: fireshare
    image: shaneisrael/fireshare:latest-lite
    ports:
      - "8080:80"
    volumes:
      - /path/to/data:/data
      - /path/to/processed:/processed
      - /path/to/videos:/videos
      - /path/to/images:/images
    environment:
      - ADMIN_USERNAME=your-admin-username
      - ADMIN_PASSWORD=your-admin-password
      - SECRET_KEY=replace_with_random_string_can_be_anything
      # The domain your instance is hosted at. e.x: demo.fireshare.net
      # this is required for opengraph to work correctly for shared links.
      - DOMAIN=
      # PUID/PGID: the user/group ID the container runs as. Files written to your
      # volumes (data, processed, videos, images) will be owned by this user. Set these to
      # match the owner of your host directories to avoid permission errors.
      # Run `id` on your host to find your UID and GID.
      - PUID=1000
      - PGID=1000
      # The port the web server (nginx) listens on inside the container (default: 80).
      # Leave this alone and change the host-side "ports" mapping above unless you run
      # with network_mode: host, where "ports" is ignored and this becomes the host port.
      # - FIRESHARE_PORT=80

docker-compose up -d

Docker Run

docker run --name fireshare \
  -v $(pwd)/fireshare/data:/data:rw \
  -v $(pwd)/fireshare/processed:/processed:rw \
  -v /path/to/my/videos:/videos:rw \
  -v /path/to/my/images:/images:rw \
  -p 8080:80 \
  -e ADMIN_USERNAME=your-admin-username \
  -e ADMIN_PASSWORD=your-admin-password \
  -e PUID=user-id-with-read-write-permissions \
  -e PGID=group-id-with-read-write-permissions \
  -d shaneisrael/fireshare:latest

Fireshare Lite

Note: Setting TRANSCODE_GPU=true has no effect in the lite image. GPU transcoding is permanently disabled regardless of environment variables.

Configuration

LDAP

Transcoding (Optional)

ENABLE_TRANSCODING=true
TRANSCODE_GPU=true   # optional, NVIDIA only

Unraid Setup

1. Install the "NVIDIA Driver" plugin from Apps / Community Applications.
2. Add to the Fireshare container environment:

```
ENABLE_TRANSCODING=true
TRANSCODE_GPU=true
NVIDIA_DRIVER_CAPABILITIES=all
```

1. Add --gpus=all to "Extra Parameters".

Encoder Selection

Docker Environment Variables

Local Development

1. Clone the repo:

```sh
git clone https://github.com/ShaneIsrael/fireshare.git
```

1. Start backend services from the project root:

```sh
./run_local.sh
```

1. Start the frontend:

```sh
cd app/client
npm install
npm start
```

1. Open http://localhost:3000 and sign in with admin / admin.

Contributing

1. Know how to code! I DO NOT WANT VIBE CODERS SUBMITTING PRs

AI assisted coding is fine if you can read, understand, and validate AI code.
_Asking AI to review itself doesn't count as reading, understanding, and validating AI code._

1. Fork the repository
2. Create a branch from develop
3. Commit your changes
4. Rebase on latest develop
5. Open a pull request to develop

Database Changes

Troubleshooting

Star History

<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/chart?repos=shaneisrael/fireshare&type=date&theme=dark&legend=top-left" />
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/chart?repos=shaneisrael/fireshare&type=date&legend=top-left" />
<img alt="Star History Chart" src="https://api.star-history.com/chart?repos=shaneisrael/fireshare&type=date&legend=top-left" />