README.md

Comet Documentation

This documentation covers the full Comet project, with two reading paths:

• Beginner path: for first-time self-hosters who want guided, step-by-step setup.
• Advanced path: for operators who want runtime internals, tuning, and operational details.

CometNet remains documented in a dedicated section because its setup and operations are significantly more complex than the base Comet deployment.

Beginner Path

1. Get Started with Docker
2. Configure and Install in Stremio
3. Use the Admin Dashboard
4. Set Up Kodi

If you plan to use Stremio from another device/network, complete the reverse-proxy + HTTPS step in the Docker beginner guide before installing the add-on.

Advanced Path

1. Runtime and Architecture
2. Configuration Model and Environment Variables
3. Streaming, Playback, and Debrid Flow
4. Scrapers, Background Scraper, and DMM
5. Database and Operations
6. HTTP API Reference
7. Prometheus and Grafana Observability

Dedicated CometNet Docs

• CometNet Documentation Index
• CometNet Quick Start
• CometNet Full Reference
• CometNet Docker Deployment

Integrations

• Torznab clients: Prowlarr, Sonarr, Radarr, and Jackett

Troubleshooting

• Troubleshooting Guide

Documentation Rules Used Here

• Runtime behavior and defaults are documented from the actual code paths (especially comet/core/models.py and endpoint/service implementations).
• .env-sample is treated as a user-facing template, but behavior is confirmed against runtime code.