# tuliprox

## Docs

- [Authentication](https://mintlify.wiki/euzu/tuliprox/api/authentication.md): How tuliprox authenticates clients across its M3U, Xtream, XMLTV, and management API surfaces.
- [HDHomeRun API](https://mintlify.wiki/euzu/tuliprox/api/hdhomerun.md): HDHomeRun network tuner emulation for Plex, Emby, Jellyfin, and other HDHR-aware clients.
- [M3U API](https://mintlify.wiki/euzu/tuliprox/api/m3u.md): Download M3U playlists and stream live, VOD, and series content via the M3U API.
- [API overview](https://mintlify.wiki/euzu/tuliprox/api/overview.md): All API surfaces exposed by tuliprox — M3U, Xtream Codes, HDHomeRun, XMLTV, and management REST endpoints.
- [Management API (v1)](https://mintlify.wiki/euzu/tuliprox/api/v1.md): REST API for configuration, playlist management, and user administration. Used by the web UI and automation scripts.
- [XMLTV / EPG API](https://mintlify.wiki/euzu/tuliprox/api/xmltv.md): Serve Electronic Programme Guide data in XMLTV format with optional time-shifting and URL rewriting.
- [Xtream Codes API](https://mintlify.wiki/euzu/tuliprox/api/xtream.md): Full Xtream Codes-compatible API for media players. Supports player_api.php, stream URLs, catchup/timeshift, and short EPG.
- [API proxy (api-proxy.yml)](https://mintlify.wiki/euzu/tuliprox/configuration/api-proxy.md): Configure the public server URLs Tuliprox advertises and the user credentials that control access to each target.
- [Main configuration (config.yml)](https://mintlify.wiki/euzu/tuliprox/configuration/main-config.md): Complete reference for all config.yml fields that control the Tuliprox runtime, storage, messaging, metadata, scheduling, Web UI, and more.
- [Mapping and templates](https://mintlify.wiki/euzu/tuliprox/configuration/mapping-and-templates.md): Reusable regex templates and the mapper DSL for renaming, regrouping, and enriching playlist content.
- [Configuration overview](https://mintlify.wiki/euzu/tuliprox/configuration/overview.md): Understand the four configuration files that drive Tuliprox and how they fit together.
- [Scheduled tasks](https://mintlify.wiki/euzu/tuliprox/configuration/schedules.md): Configure cron-based schedules for playlist updates, library scans, and GeoIP database updates.
- [Sources and targets (source.yml)](https://mintlify.wiki/euzu/tuliprox/configuration/sources-and-targets.md): Define upstream inputs, provider options, URL schemes, and the output targets Tuliprox publishes to clients.
- [Binary deployment](https://mintlify.wiki/euzu/tuliprox/deployment/binary.md): Run a pre-built tuliprox static binary directly on Linux, set up a systemd service, and reference all CLI flags.
- [Building from source](https://mintlify.wiki/euzu/tuliprox/deployment/building-from-source.md): Build the tuliprox backend, frontend, and documentation from source, including cross-compilation and Docker image builds.
- [Docker deployment](https://mintlify.wiki/euzu/tuliprox/deployment/docker.md): Run tuliprox with Docker or Docker Compose, including volume mounts, environment variables, healthchecks, and container templates.
- [Local media library](https://mintlify.wiki/euzu/tuliprox/features/local-media-library.md): Scan local directories, enrich metadata via TMDB, probe streams with ffprobe, and expose your media through Xtream or M3U outputs.
- [Monitoring and alerts](https://mintlify.wiki/euzu/tuliprox/features/monitoring-and-alerts.md): Send notifications to Telegram, Discord, Pushover, or any REST endpoint. Track playlist group changes and watch specific groups for real-time alerts.
- [Features overview](https://mintlify.wiki/euzu/tuliprox/features/overview.md): A high-level tour of everything tuliprox can do — from playlist processing to live stream proxying, local media libraries, and operational monitoring.
- [Playlist processing](https://mintlify.wiki/euzu/tuliprox/features/playlist-processing.md): Filter, rename, map, sort, and merge playlists from multiple providers into clean, curated outputs.
- [Streaming and proxy](https://mintlify.wiki/euzu/tuliprox/features/streaming-and-proxy.md): Reverse-proxy live streams with connection management, session reservation, priority-based preemption, and custom fallback videos.
- [Getting started](https://mintlify.wiki/euzu/tuliprox/getting-started.md): Understand tuliprox run modes, CLI arguments, the home directory layout, and the recommended workflow for your first working setup.
- [Examples and recipes](https://mintlify.wiki/euzu/tuliprox/guides/examples-and-recipes.md): Copy-ready configuration examples for common tuliprox setups.
- [Filtering and mapping](https://mintlify.wiki/euzu/tuliprox/guides/filtering-and-mapping.md): Use the filter DSL, template system and mapper DSL to control which channels appear and how they are named.
- [HDHomeRun integration](https://mintlify.wiki/euzu/tuliprox/guides/hdhomerun-integration.md): Emulate an HDHomeRun network tuner device so Plex, Emby, Jellyfin and TVHeadend can discover tuliprox automatically.
- [M3U playlist setup](https://mintlify.wiki/euzu/tuliprox/guides/m3u-setup.md): Configure an M3U provider as an input, integrate EPG, and publish an M3U output.
- [Plex, Jellyfin and Emby](https://mintlify.wiki/euzu/tuliprox/guides/plex-jellyfin-emby.md): Configure tuliprox as a live TV source for Plex, Jellyfin and Emby.
- [Xtream Codes setup](https://mintlify.wiki/euzu/tuliprox/guides/xtream-setup.md): Configure an Xtream Codes provider as an input and expose it to clients.
- [Introduction](https://mintlify.wiki/euzu/tuliprox/introduction.md): tuliprox is a self-hosted IPTV proxy and playlist processor written in Rust. It sits between your IPTV providers and your media clients, giving you complete control over how streams are filtered, reshaped, and delivered.
- [Monitoring](https://mintlify.wiki/euzu/tuliprox/operations/monitoring.md): Track active streams, system resources, and receive notifications when tuliprox events occur.
- [Troubleshooting](https://mintlify.wiki/euzu/tuliprox/operations/troubleshooting.md): Diagnose and resolve common tuliprox problems.
- [Upgrading](https://mintlify.wiki/euzu/tuliprox/operations/upgrading.md): Upgrade tuliprox safely across Docker, binary, and source installations.
- [Quickstart](https://mintlify.wiki/euzu/tuliprox/quickstart.md): Get tuliprox running with Docker in under 5 minutes and serve your first IPTV playlist.