Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/mohameodo/nano/llms.txt

Use this file to discover all available pages before exploring further.

nano is a minimalist, self-hosted front-end for streaming movies and TV shows. It connects to TMDB for metadata, uses an encrypted plugin system to resolve streams, and ships a capable video player — all configurable entirely through environment variables, with no code changes required.

Quickstart

Run nano locally or in Docker in under five minutes.

Configuration

Customize every aspect of nano via environment variables.

Deployment

Deploy to Docker, Vercel, Railway, Render, or Cloudflare Workers.

API Reference

Explore the built-in REST endpoints for search, details, and streaming.

​
What nano does

nano gives you a clean, fast search UI backed by TMDB. When you open a movie or show, it routes the request through a scraper plugin — a small encrypted .rink file — which resolves a playable stream URL. The proxy layer handles CORS, HLS playlist rewriting, and range requests so playback works in any modern browser without additional infrastructure.

Instant Search

Live TMDB search with fallback results when the API is unavailable.

Plugin System

Encrypted .rink scraper plugins. Add, remove, or swap sources with one CLI command.

Built-in Player

HLS-capable HTML5 player with optional Vidstack controls, subtitles, and quality switching.

Proxy & CORS

Server-side proxy rewrites M3U8 playlists and handles all cross-origin stream requests.

16 Languages

Full UI translation for English, Spanish, French, German, Portuguese, and more.

Flexible Theming

Dark/light mode, accent hue picker, animated shaders, and custom backgrounds — all runtime-configurable.

​
Get started

1

Pull the Docker image

docker pull ghcr.io/mohameodo/nano:latest
2

Run with your settings

docker run -p 3000:3000 \
  -e SITE_NAME="my nano" \
  -e THEME_HUE=200 \
  ghcr.io/mohameodo/nano:latest
3

Open in your browser

Navigate to http://localhost:3000. Search for any movie or TV show.
4

Add scraper sources

Install the shiopa CLI and add stream sources with shiopa add --all. See the CLI guide for details.
nano does not host or serve any media files. It resolves stream URLs from third-party sources via scraper plugins. You are responsible for complying with the terms of any streaming services you configure.

Build docs developers (and LLMs) love

Get started for freeTalk to us