Skip to content

TechSquidTV/Cliparr

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

121 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Cliparr

Cliparr Logo

Instant media clipper for your personal media server.

Plex Support Jellyfin Support License


Cliparr is a streamlined media clipper that allows you to quickly create and download clips from the media currently playing on your Plex or Jellyfin server.

Firefox.mp4

Features

  • Instant Session Discovery: Automatically loads your media player's currently playing file.
  • Intuitive Timeline Editor: Familiar UI based on common video editing interfaces.
  • Local Transcoding: Powered by Mediabunny, video is transcoded in your browser.
  • Rich Metadata Tagging: Clips are exported with full EXIF data, including Season, Episode numbers, and timing metadata.
  • Native Plex & Jellyfin Support: Seamless integration with the most popular media server platforms.

Getting Started

Quick Start with Docker

The fastest way to get Cliparr running is via the GitHub Container Registry.

docker run -d \
  --name cliparr \
  -p 3000:3000 \
  -e APP_URL=http://localhost:3000 \
  -e APP_KEY="your-stable-random-secret" \
  -v cliparr-data:/data \
  ghcr.io/techsquidtv/cliparr:latest

Important

Stable APP_KEY Required: Cliparr uses APP_KEY to encrypt your provider credentials at rest. You must use a stable, random secret. If you change this key later, you will need to re-authenticate your media servers.

Using Docker Compose

For a persistent setup, we recommend using Docker Compose:

services:
  cliparr:
    image: ghcr.io/techsquidtv/cliparr:latest
    container_name: cliparr
    ports:
      - "3000:3000"
    environment:
      - APP_URL=http://localhost:3000
      - APP_KEY=replace-this-with-a-secure-random-string
    volumes:
      - cliparr-data:/data
    restart: unless-stopped

volumes:
  cliparr-data:

Configuration

Variable Description Default
APP_URL Public base URL for auth callbacks. http://localhost:3000
APP_KEY Required secret for credential encryption. -
PORT Internal port for the Express server. 3000
CLIPARR_DATA_DIR Directory for SQLite storage. /data
CLIPARR_ALLOW_LOOPBACK_JELLYFIN_URLS Allow Jellyfin URLs that resolve to localhost/loopback. Use only for trusted self-hosted setups. false

Development

We welcome contributions! To get started with a local development environment:

  1. Clone: git clone https://github.com/techsquidtv/cliparr.git
  2. Setup: cp .env.example .env (and fill in APP_KEY)
  3. Install: pnpm install
  4. Run: pnpm dev

See CONTRIBUTING.md for more detailed guidance.

License

Cliparr is released under the MIT License.