Fireshare

Share your game clips, videos, or other media via unique links.





Live Demo  ·  Report a Bug

If Fireshare is useful to you, GitHub Sponsors is the best way to support development. It keeps the demo server running and helps me carve out time on weekends for new features and updates.

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
• 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

Supported encodings: H.264 (AVC), H.265 (HEVC), AV1, VP9.

Files must be in a supported format because the original file is always served directly to the viewer. Transcoding (when enabled) only generates additional lower-quality versions for adaptive streaming; the original is never modified.

Navigation

• Installation
• Configuration
• Local Development
• Contributing
• Troubleshooting

Dashboard

Automatic Game Organization

Video Details

Public / Private Uploading

Installation

Fireshare is designed to run in Docker.

Required volume mounts:

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: v.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

Update the volume paths and credentials, then run:

docker-compose up -d

Open http://localhost:8080.

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

Open http://localhost:8080.

Fireshare Lite

The fireshare:latest-lite image is a smaller alternative that uses the system-provided FFmpeg instead of the CUDA-enabled build included in the standard image. It is a good fit for most users who do not need GPU transcoding.

Use the lite image by appending -lite to your tag:

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

Configuration

LDAP

See LDAP.md for setup instructions.

Transcoding (Optional)

When enabled, Fireshare will create lower quality versions of your original supported file type videos. Your viewers can then choose to play your videos at lower qualities that their internet can handle. Fireshare will also attempt to automatically downgrade the quality of a viewer who is constantly buffering.

Transcoding is off by default. To enable it, set the following environment variables:

ENABLE_TRANSCODING=true
TRANSCODE_GPU=true   # optional, NVIDIA only

CPU transcoding works out of the box. For NVIDIA GPU transcoding, you only need an NVIDIA GPU on the host. The image handles drivers and toolkit.

GPU requirements: NVIDIA GPU with NVENC support.

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

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

Encoder Selection

Fireshare automatically selects the best available encoder.

GPU mode (TRANSCODE_GPU=true):

CPU mode (TRANSCODE_GPU=false):

Docker Environment Variables

See EnvironmentVariables.md for the full list of available environment variables.

Local Development

Requirements: Python 3, Node.js, and npm.

1. Clone the repo:

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

2. Start backend services from the project root:

   ./run_local.sh

3. Start the frontend:

   cd app/client
   npm install
   npm start

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

Contributing

Contributions are welcome. For larger changes, open an issue first to align on scope.

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.
2. Fork the repository
3. Create a branch from develop
4. Commit your changes
5. Rebase on latest develop
6. Open a pull request to develop

For issues and feature requests, visit the issue tracker.

Please DO NOT open a pull request for a feature or addition that was not previously discussed with me. Pull requests that do this will be automatically closed.

Database Changes

If you update models, create a migration and review it before opening a pull request.

Troubleshooting

See TROUBLESHOOTING.md for a full guide covering installation issues, playback problems, permission errors, transcoding, LDAP, and more.

Star History

If you like the project, consider giving it a star. It helps increase visibility and supports continued development.