Polyfin documentation
These pages explain how to run Polyfin and what it does for the people who use it. New here? Start with Installation, then Getting started.
Set up
| Page | What it covers |
|---|---|
| Installation | Choosing between Docker and the desktop version, Docker Compose, Unraid, the health check and monitoring, and giving the container a GPU |
| Desktop version | Polyfin Desktop on Windows, macOS and Linux: installing it, the menu, starting with the computer, its folders, the secret key, updates, and moving to Docker and back |
| Getting started | The first run, the administrator, users, Quick Connect, and the language of generated names |
| Configuration | Environment variables and the Compose .env file |
| Reverse proxy | Serving Polyfin over HTTPS behind a proxy: the headers to pass, WebSockets, known proxies, and an example with Traefik |
| Backups | Daily database backups, how many are kept, and restoring one |
Content
| Page | What it covers |
|---|---|
| Addons and libraries | Stremio and music addons, libraries, song lyrics, catalog limits, collections, people, similar titles, artwork, and editing items |
| Live TV | Channels from addons, programme guides (Native EPG and XMLTV), and recordings |
| IPTV | M3U and Xtream Codes sources, the line-up page, Replay of the providers' archives, and IPTV movies and series |
| Torrents | Playing the torrents addons list over a network interface, a SOCKS5 proxy or a WireGuard tunnel alone: the kill switch, the limits, the permission, and Docker |
| Local folders | Your own video files from folders mounted in the container or from SMB and WebDAV shares: permissions, network shares, naming, matching, scanning, watching for changes, unmatched files and versions |
Watching
| Page | What it covers |
|---|---|
| Playback | How a title plays, versions, chapters, preparing playback ahead, choosing a version, watching together, and thumbnails |
| Transcoding | When Polyfin converts, GPUs, HDR tone mapping, and the conversion settings |
| Subtitles | Addon subtitles, text tracks inside files, ASS styles and fonts, and image subtitles |
| Skip segments | Skipping intros, recaps, credits and previews: the sources, their order, and their keys |
| DLNA | Sharing the libraries with TVs and players that have no Jellyfin app: devices and their users, profiles, Docker networking, and limits |
| Tracking | Sending what you watch to Trakt, Simkl, MDBList and PublicMetaDB, and the songs you play to Last.fm and ListenBrainz, and importing what you watched there |
Users and administration
| Page | What it covers |
|---|---|
| Users | Watch state, moving from Jellyfin, parental control, per-user limits, quality groups, and the security settings |
| Administration | The admin app (home, search, system pages, settings), the check for new versions, API keys and metrics for Prometheus |
| Statistics | The playback history, the Statistics page, each user's own figures, the CSV export and their API |
| Notifications | Webhook, Discord, ntfy, email, Telegram, Gotify and Pushover targets for new episodes, recordings, Health problems, new versions and playbacks, and the webhook event's JSON |
| Web client | The built-in jellyfin-web, single sign-on to the admin app, and custom CSS and JavaScript |
| Jellyfin compatibility | Compatible apps, what apps get, and the Jellyfin features Polyfin does without |
Contributing
| Page | What it covers |
|---|---|
| Development | Building, running and testing Polyfin, and its website |