GitHub - maury91/miauflix

GitHub

3 min read Original article ↗

Miauflix

The self-hosted streaming service that meows!

License: PolyForm Noncommercial CI Status Docker

Miauflix home screen

Miauflix is a streaming service you run yourself. Browse movies and TV shows with rich artwork and press Watch Now. The server downloads the media through BitTorrent and streams it to your browser or TV, with no media library to manage.

  • ⚡ Prepares playback ahead: background preloading and media inspection reduce waiting; startup depends on the source, connection, and conversion needed
  • 🔎 Finds sources for you: searches multiple providers and chooses a source for your device
  • 📺 Made for the couch: full remote-control navigation, and sign in on a TV by scanning a QR code
  • 🔐 Account and privacy controls: administrator-created accounts, VPN checks, and downloads stored so the disk does not show what they are: encrypted with a key per download, random file and folder names, padded file sizes
  • 🔗 Personal viewing: watchlists, ratings, Continue watching, and optional Trakt watchlist and playback sync
  • 🐳 One command to run: prebuilt images for amd64 and arm64, configured from the browser

See the Feature Guide for grouped explanations, requirements, and current limitations.

Screenshots

Quick start

You need Docker and a free TMDB access token.

1. Download the Compose file

curl -fsSLO https://raw.githubusercontent.com/maury91/miauflix/main/docker-compose.yml

2. Start Miauflix

3. Open http://localhost:3000, create your admin account and paste your TMDB token. That's it. 🎉

Note

Until you create the admin account, anyone who can reach Miauflix could create it instead, so the quick start only accepts connections from this computer. Once your account exists, open it to your local network to watch from your TV or phone.

Important

Miauflix streams over BitTorrent, so it won't search for sources until it detects a VPN: without one, peers see your real IP. Add NordVPN (a must on a server), or opt out if you accept the risk.

Next steps

Planned improvements

TV season and episode navigation, subtitles, and Jackett/Prowlarr integration are implemented. The current task list includes:

  • A quality picker beside Watch Now
  • Correct handling of multiple episodes combined in one video
  • Interface translations and language preferences
  • Subtitle translation and language-learning tools
  • VPN diagnostics and exit-server controls in Settings
  • Keeping the database that links downloads to torrents on an external server (such as AWS RDS), so a copy of the server's disk cannot be read on its own

See the Feature Guide for how these plans differ from available features. The task list does not promise delivery dates.

Contributing

Contributions are welcome! Read CONTRIBUTING.md to get a development environment running.

Disclaimer

Miauflix doesn't host or distribute any content. It's a tool for streaming media that you are entitled to access, and you are responsible for complying with the laws of your country.

License

This project is source available under the PolyForm Noncommercial License 1.0.0. You may use, modify, and share it for permitted noncommercial purposes. Commercial use requires separate permission from the relevant rights holders. See the license for its full terms, including permitted organizational uses.

This license applies to project-owned code and original materials. Third-party libraries, assets, and catalog artwork retain their own licenses and rights. It does not revoke licenses already granted for earlier versions, including earlier MIT-licensed copies.

Built with 😻 by the Miauflix team