Run nano locally or deploy it via Docker in minutes

nano is designed to be running in minutes regardless of your setup. Pick the path that fits your workflow — Docker if you want a zero-fuss deployment, or local development if you want to customise the source or contribute. Both paths produce a fully working instance at the end.

Docker (no coding needed)
Local development

Docker is the fastest way to get nano up and running. The pre-built image on the GitHub Container Registry is ready to go — no Node.js, no package managers, no build step required.

Pull the latest image

Pull the official nano image from the GitHub Container Registry:

docker pull ghcr.io/mohameodo/nano:latest

Run the container

Start nano on port 3000. You can pass any environment variable with -e to customise the instance at launch:

docker run -p 3000:3000 -e SITE_NAME="my nano site" ghcr.io/mohameodo/nano:latest

To pass a full configuration file instead of individual flags, mount a .env file:

docker run -p 3000:3000 --env-file .env ghcr.io/mohameodo/nano:latest

Open nano in your browser

Navigate to http://localhost:3000. You should see the nano home screen with live TMDB search ready to use.

(Optional) Customise with environment variables

Nano is fully configured through environment variables. Copy .env.example from the repository as a starting point, edit the values you want to change, and re-run the container with --env-file .env.See the Configuration reference for every available option.

Running nano locally gives you hot-reload, full access to the source, and the ability to add or write custom .rink plugins.

Clone the repository

git clone https://github.com/mohameodo/nano.git && cd nano

Install dependencies

nano supports both pnpm and bun as package managers.

pnpm install

Configure the application

Run the setup script. It checks whether a .env file already exists; if not, it copies .env.example to .env automatically. It then prints a brief config summary (site name, theme mode, background style, and default server) and reminds you to edit .env before starting the server:

node setup.js

Open .env in your editor and adjust any values you want to change — all fields are optional and have sensible defaults.

Add stream sources

nano resolves streams through .rink plugin files. Use the shiopa CLI to install the default set of sources:

npx shiopa add --all

Or, if you prefer to use your local package manager:

pnpm shiopa add --all

You can also add individual sources by name: npx shiopa add <source-id>.

Start the development server

pnpm dev

Astro will compile the project and start a local server with hot-module replacement enabled.

Open nano in your browser

Navigate to http://localhost:4321 — the default Astro dev server port. The nano home screen should load immediately with live search and streaming ready to use.

TMDB API key is optional. nano ships with a built-in TMDB API key fallback, so search and metadata work out of the box without any configuration. If you hit rate limits or want full control, register for a free key at themoviedb.org and set TMDB_API_KEY in your .env.

The steps above get you running with sensible defaults. For a full list of every environment variable — theming, auth, video player options, ghost companion settings, and more — see the Configuration reference.

Get Started

Deployment

Features

CLI

Run nano locally or deploy it via Docker in minutes

Build docs developers (and LLMs) love

Get Started

Deployment

Features

CLI

Documentation Index

Build docs developers (and LLMs) love