# Cliparr

> Self-hosted video clipper for Plex, Jellyfin, and local files.

Cliparr is an open-source application for making short clips from personal media. Use this file as orientation: the notes below establish the product's boundaries and terminology, while the linked documentation is authoritative for detailed behavior and setup.

Key facts:

- Cliparr can discover media currently playing on connected Plex and Jellyfin servers. It can also open a browser-local video file or a direct HTTP, HTTPS, or HLS media URL.
- Editing and export processing happen in the user's browser. Video exports use Mediabunny, and GIF exports use @techsquidtv/gifenc. Cliparr does not invoke FFmpeg for exports.
- The self-hosted server manages provider authentication, encrypted provider records, active-session discovery, and proxy access to remote media. It does not render exported video.
- Local files are read directly by the browser and are not uploaded to the Cliparr server. Provider and URL sources may pass through the server's media proxy for playback and export.
- Supported outputs include MP4, WebM, MOV, MKV, and GIF. Capabilities vary with the browser and the source codecs.
- Text subtitle tracks can be burned into exports. Image-based subtitle formats such as PGS and VobSub are not currently burn-in sources.
- Cliparr requires a stable APP_KEY of at least 32 characters to encrypt stored provider credentials. Changing it requires reconnecting providers.
- Cliparr has no full app-level account, role, or permission system. Keep an instance on a trusted network or place authentication in front of it.
- WebCodecs and related editor features require HTTPS in production; localhost and 127.0.0.1 are valid secure contexts for local use.
- Cliparr Convert is a separate hosted, browser-based whole-file converter. It is not the self-hosted timeline editor and does not connect to Plex or Jellyfin.

Terminology: a provider is a configured Plex or Jellyfin connection; a source is the selected provider item, local file, or direct URL; export means browser-side processing and download of the selected timeline range.

## Start here

- [Product overview](https://cliparr.dev/index.md): Capabilities, architecture summary, answers to common questions, and Docker quick start.
- [Getting started](https://cliparr.dev/docs/getting-started.md): Run the container, persist its data, provide APP_KEY, and connect the first source.
- [Providers](https://cliparr.dev/docs/providers.md): Plex and Jellyfin authentication, session discovery, permissions, and metadata behavior.
- [Export settings](https://cliparr.dev/docs/export-settings.md): Formats, quality, resolution, source selection, audio, filenames, estimates, and metadata controls.

## Install & operate

- [Configuration](https://cliparr.dev/docs/configuration.md): Environment variables, credential encryption, persistent data, and reverse proxy notes.
- [Access control](https://cliparr.dev/docs/access-control.md): Protect Cliparr with a trusted network or an authenticated reverse proxy.
- [Browser support](https://cliparr.dev/docs/browser-support.md): Which browsers work best for editing, export, and mobile installs.
- [Logging](https://cliparr.dev/docs/logging.md): Choose server log formats, levels, file rotation, and safe sharing defaults.

## Sources

- [Local videos](https://cliparr.dev/docs/local-videos.md): Open browser-local files or direct media URLs.

## Editing & export

- [Subtitle burn-in](https://cliparr.dev/docs/subtitle-burn-in.md): Choose supported text subtitles and style how they render into exported clips.
- [Export metadata](https://cliparr.dev/docs/export-metadata.md): Review the provider metadata Cliparr can embed into exported clips.
- [Editor shortcuts](https://cliparr.dev/docs/editor-shortcuts.md): Keyboard and pointer shortcuts for playback, marking, seeking, frame stepping, timeline zoom, and editable timecodes.

## Contributing

- [Development](https://cliparr.dev/docs/development.md): Set up the local workspace and run the checks before opening a pull request.


## Optional

- [GitHub repository](https://github.com/TechSquidTV/Cliparr): Source code, issues, contribution history, and MIT license.
- [Releases](https://cliparr.dev/changelog.md): Versioned release notes generated from published GitHub releases.
- [Blog](https://cliparr.dev/blog.md): Project announcements and longer technical notes.
- [Cliparr Convert](https://cliparr.dev/convert.md): Separate hosted tool for browser-based whole-file conversion.

Last generated from the site's canonical content at https://cliparr.dev.