Home

Nooklet documentation

Nooklet is a self-hosted workspace for discovering, recommending, requesting, downloading, and organizing movies and TV. This Wiki is the operator and contributor handbook; the README remains the short introduction.

New installation? Follow one route: Getting started → Docker installation → First-time setup. Docker Compose is recommended; the Docker setup builder is the easiest path for a new instance.

Prefer a visual introduction? Start with the public Feature guide. For a clean, curated route through setup, daily use, and common recovery, open the User guide. This Wiki remains the canonical source for detailed operator runbooks.

Choose your path

I want to…	Start here
Understand what Nooklet can do	Feature guide
Install Nooklet with the fewest manual steps	Docker setup builder
Install Nooklet manually with Docker	Docker installation
Follow the clean path from setup through daily use	User guide
Reach the first successful request	First-time setup
Fix an “insufficient disk space” message	Storage and path mapping
Connect TMDB, Usenet, Plex, or another service	Service connections
Archive a public YouTube channel or video	YouTube monitoring and downloads
Back up or upgrade safely	Backup, restore, and upgrades
Diagnose an unhealthy container or failed request	Troubleshooting
Understand the system design	Architecture and the engineering dossier
Develop or contribute	Development guide

The shortest path to a request

1. Install with Docker Compose.
2. Create the first administrator with the printed one-time bootstrap token. Nooklet automatically closes /bootstrap as soon as an administrator exists and refuses later bootstrap attempts.
3. Continue in Setup Center: verify TMDB and a Usenet server for the built-in downloader.
4. Verify a Newznab indexer with the right movie or TV categories.
5. Attach a writable media destination and confirm storage capacity in Settings → Storage.

Setup Center reports whether the movie and TV request paths are actually ready. AI recommendations, watch history, and notifications are optional.

Storage rule: engine scratch work, completed-output staging, and the final media library are distinct locations. The built-in downloader checks both DOWNLOAD_ENGINE_WORK_DIR and DOWNLOAD_ENGINE_DIR; the more constrained filesystem limits admission. Docker users must enter container-side paths such as /downloads and /media/movies, never host paths such as F:/Downloads.

Documentation map

Start and configure

• Getting started
• Docker installation
• Native installation
• First-time setup
• Configuration reference
• Storage and path mapping
• Service connections
• Indexers
• Reverse proxy and LAN access

Use and operate

• Discover and recommendations
• Library and requests
• YouTube monitoring and downloads
• Downloads and import
• Watch history
• Automation and notifications
• Health and diagnostics
• Backup, restore, and upgrades
• Account and user administration
• Troubleshooting
• Multi-instance deployments

Engineering

• Architecture
• Data and background jobs
• Security model
• HTTP API
• Architecture decisions
• Development guide
• Testing and CI
• Documentation policy

Support and project status

Nooklet is an actively developed, single-instance application built around separately supervised Next.js web and background-worker processes coordinated through SQLite. It is not designed for horizontal replicas or a shared network database. Review the known operational boundaries before advanced deployments.

• Report reproducible bugs through GitHub Issues.
• Report vulnerabilities through a private security advisory.
• Inspect build status in GitHub Actions.
• Explore source-backed diagrams and quality evidence in the engineering dossier.

---

Installation and first-run documentation last reviewed against main: August 19, 2026.