Metadata-Version: 2.5
Name: cctv-stack
Version: 0.7.0
Summary: A packaging-first self-hosted CCTV stack built on Frigate.
Project-URL: Homepage, https://github.com/aravindmyd/cctv-stack
Project-URL: Repository, https://github.com/aravindmyd/cctv-stack
Project-URL: Issues, https://github.com/aravindmyd/cctv-stack/issues
Author: Jothika Raja
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright 2026 Jothika Raja
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
License-File: LICENSE
Keywords: backblaze-b2,cctv,frigate,nvr,self-hosted,video-surveillance
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Multimedia :: Video
Classifier: Topic :: System :: Systems Administration
Requires-Python: >=3.12
Requires-Dist: pyyaml>=6.0
Requires-Dist: tzdata>=2024.1
Provides-Extra: dev
Requires-Dist: mkdocs-material>=9.6; extra == 'dev'
Requires-Dist: mkdocs<2,>=1.6; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: ruff>=0.6; extra == 'dev'
Provides-Extra: mqtt
Requires-Dist: paho-mqtt>=2.1; extra == 'mqtt'
Provides-Extra: storage
Requires-Dist: boto3>=1.34; extra == 'storage'
Description-Content-Type: text/markdown

# cctv-stack

[![PyPI](https://img.shields.io/pypi/v/cctv-stack.svg)](https://pypi.org/project/cctv-stack/)
[![Python versions](https://img.shields.io/pypi/pyversions/cctv-stack.svg)](https://pypi.org/project/cctv-stack/)
[![CI](https://github.com/aravindmyd/cctv-stack/actions/workflows/ci.yml/badge.svg)](https://github.com/aravindmyd/cctv-stack/actions/workflows/ci.yml)

`cctv-stack` is a Python toolkit and container image for a self-hosted CCTV pipeline built
on **[Frigate](https://github.com/blakeblackshear/frigate)**.

Frigate does camera ingest, detection, recording and review segmentation. `cctv-stack`
adds the four pieces it leaves to the operator:

1. **Canonical clips** — one deterministic file per review item.
2. **Durable backup** — clips are uploaded to Backblaze B2 exactly once.
3. **Upload-aware retention** — local cleanup never deletes a clip that is not safely
   uploaded.
4. **Health surfaces** — the uploader and cleanup expose `/health` and `/metrics`.

It is not a replacement for Frigate. It is the missing layer around it.

**Current release: `0.7.0`.** Clips, B2 upload, upload-aware local retention, the aggregate
status page with Gatus/ntfy alerting, a guided one-command installer, `./scripts/doctor.sh`
diagnosis, encrypted backups, `./update.sh` upgrades, and two days of continuous footage kept
locally. Cloud retention is not — see [`CONTRIBUTING.md`](CONTRIBUTING.md) for the exact state
and roadmap.

---

## Install

The shortest path is one command, from a checkout:

```bash
git clone https://github.com/aravindmyd/cctv-stack.git
cd cctv-stack
./install.sh
```

It asks for the location, timezone, cameras and optional B2 credentials, validates the
result through the same loader the services use, detects the host, starts the stack, and
waits for Frigate. See [`docs/install.md`](docs/install.md) for the released-image path
and the by-hand alternative.

The Python package is usable on its own for the parts that read Frigate's API:

```bash
pip install cctv-stack
```

Requires **Python 3.12+**. The distribution is `cctv-stack`; the import package is `cctv`.

Optional extras:

| Extra | Adds | Needed by |
|---|---|---|
| `mqtt` | `paho-mqtt` | `cctv-clip-worker` when subscribing to `frigate/reviews` |
| `storage` | `boto3` | `cctv-uploader` for B2/S3 |
| `dev` | pytest, ruff | Contributors |

```bash
pip install "cctv-stack[mqtt,storage]"
```

### Container image

```bash
docker pull ghcr.io/aravindmyd/cctv-stack:0.7.0
```

Tags published per release: `:0.7.0`, `:0.7`, and the commit tag `:sha-<short>`.
A moving `:edge` tag follows `master`. If the registry package is private, run
`docker login ghcr.io` first. The image includes `ffmpeg`/`ffprobe`.

## Commands

| Command | What it does |
|---|---|
| `cctv-config validate --cameras cameras.yml` | Validate the camera configuration. Exits 78 (`EX_CONFIG`) on an invalid config |
| `cctv-config generate --cameras cameras.yml --out frigate.yml` | Generate Frigate's configuration from `cameras.yml` |
| `cctv-clip-worker` | Turn completed Frigate reviews into canonical clips |
| `cctv-uploader` | Upload clips to B2 through the persisted retry state machine |
| `cctv-cleanup` | Enforce local retention after a successful upload |
| `cctv-status` | Serve the aggregate status page (`:8084/status`), health and metrics |
| `cctv-host` | Detect this machine's host profile and Frigate's `shm_size` |
| `cctv-init` | Answer the install questions and write `cameras.yml` and `.env` |
| `cctv-doctor` | Diagnose a whole installation, read-only (`./scripts/doctor.sh`) |
| `cctv-backup` | Encrypted config bundle, online database backup, verification |
| `cctv-migrate` | Apply pending migrations between stopping and starting services |

The four services are long-running and configuration-driven; they take no command-line
arguments. Run them under systemd, Docker, or Compose.

With Compose, the answer to *is my CCTV working?* is at
`http://<host>:8084/status`; the dashboard and history are at `http://<host>:3001` (Gatus),
and alerts arrive through ntfy at `http://<host>:8085`.

## Quick start

The only required input is a `cameras.yml`. This minimal file is valid; `${VAR}` values
are read from the environment and an unset variable is a hard error.

```yaml
site:
  location: home
  timezone: UTC

cameras:
  front-door:
    display_name: Front Door
    rtsp:
      main: ${CAMERA_FRONT_DOOR_RTSP}
      sub: ${CAMERA_FRONT_DOOR_SUB}
```

Validate it and generate Frigate's config:

```bash
export CAMERA_FRONT_DOOR_RTSP='rtsp://user:pass@192.168.1.10:554/stream1'
export CAMERA_FRONT_DOOR_SUB='rtsp://user:pass@192.168.1.10:554/stream2'

cctv-config validate --cameras cameras.yml
cctv-config generate --cameras cameras.yml --out frigate.yml
```

`validate` checks the camera model and the environment substitution. `generate` writes a
Frigate config with a `GENERATED FILE — DO NOT EDIT` header.

### Running the services

```bash
export CCTV_CONFIG_DIR="$PWD"
export CCTV_DATA_DIR="$PWD/data"
export CCTV_FRIGATE_URL="http://127.0.0.1:5000"

cctv-clip-worker
```

Run each service in its own process. `cctv-clip-worker` works without MQTT (sweep-only);
set `CCTV_MQTT_HOST` to receive reviews immediately. `cctv-uploader` reports `DISABLED`
and uploads nothing when `CCTV_STORAGE_BUCKET` is empty; a bucket with no key exits `78`.

> `ffprobe` must be on `PATH` for the clip worker. The container image includes it; a
> `pip install` does not install ffmpeg.

## Configuration

There are two kinds of configuration, and they must not be mixed:

| File | Holds | Secret? |
|---|---|---|
| `cameras.yml` | Site name, timezone, cameras, clip policy, retention | No — but `${VAR}` values come from the environment |
| environment / `.env` | RTSP URLs, B2 keys, paths, ports, intervals | **Yes** |

The full template is [`.env.example`](.env.example). The settings most consumers need:

| Variable | Default | Meaning |
|---|---|---|
| `CCTV_CONFIG_DIR` | `/config` | Directory containing `cameras.yml` |
| `CCTV_DATA_DIR` | `/data` | Root for `clips/` and the state database |
| `CCTV_DB` | `$CCTV_DATA_DIR/cctv.db` | SQLite state store |
| `CCTV_FRIGATE_URL` | `http://frigate:5000` | Frigate API base URL. Port 5000 must stay on a private network |
| `CCTV_MQTT_HOST` | unset | Unset means sweep-only; no broker required |
| `CCTV_SWEEP_INTERVAL_S` | `60` | Worst-case delay before a missed review is noticed |
| `CCTV_STORAGE_BUCKET` | empty | Empty means cloud backup `DISABLED` |
| `CCTV_STORAGE_KEY_ID` | empty | B2 application key ID |
| `CCTV_STORAGE_APPLICATION_KEY` | empty | B2 application key |
| `CCTV_STORAGE_REGION` | `us-west-004` | B2 region |
| `CCTV_UPLOADER_HEALTH_PORT` | `8082` | Uploader `/health` and `/metrics` |
| `CCTV_CLEANUP_HEALTH_PORT` | `8083` | Cleanup `/health` and `/metrics` |
| `INTERNAL_API_TOKEN` | empty | Enables the uploader admin endpoints when set |

Keep `.env` out of version control. RTSP URLs and B2 keys are credentials.

Camera names must be lowercase kebab-case (`front-door`): they become directory names and
cloud object keys.

## What it produces

```text
$CCTV_DATA_DIR/
├── clips/
│   └── <camera>/YYYY/MM/DD/HH-MM-SS.mp4
│       <camera>/YYYY/MM/DD/HH-MM-SS.mp4.json
└── cctv.db
```

The clips tree is rendered in the **site timezone**. The sidecar records the review id,
event ids, requested boundaries, measured coverage, codecs, size and SHA-256. The cloud
object key is `<location>/clips/<path-inside-clips>`.

A clip appears **after** the visit ends: Frigate keeps the review open until its alert
cutoff passes. There is no partial clip by design.

### Health endpoints

| Service | Endpoint | Notes |
|---|---|---|
| `cctv-uploader` | `http://127.0.0.1:8082/health`, `/metrics` | `DISABLED` without a bucket |
| `cctv-cleanup` | `http://127.0.0.1:8083/health`, `/metrics` | Local retention state |
| Uploader admin | `/admin/queue`, `/admin/retry` | Mounted only when `INTERNAL_API_TOKEN` is set |

Bind these to loopback. Nothing in the package needs an inbound port from the LAN.

## Python API

The supported contract is the CLI, the environment variables, and the HTTP health
endpoints. The importable modules are tested, but pre-1.0 names may change between minor
versions.

```python
from cctv.config import ConfigError, load_cameras_config

try:
    config = load_cameras_config("cameras.yml")
except ConfigError as exc:
    raise SystemExit(f"invalid camera config: {exc}")

print(config.site.location)
for name, camera in config.enabled_cameras().items():
    print(name, camera.display_name, camera.record.mode)
```

Storage is available behind the `storage` extra:

```python
import os
from cctv.storage import S3StorageAdapter

adapter = S3StorageAdapter(
    bucket=os.environ["CCTV_STORAGE_BUCKET"],
    access_key_id=os.environ["CCTV_STORAGE_KEY_ID"],
    secret_access_key=os.environ["CCTV_STORAGE_APPLICATION_KEY"],
    region=os.environ.get("CCTV_STORAGE_REGION", "us-west-004"),
)
```

`cctv.__version__` reports the installed package version.

## Complete installation

For a full CCTV site — Frigate, MQTT, the worker, uploader and cleanup — use the Compose
deployment in this repository:

```bash
git clone https://github.com/aravindmyd/cctv-stack.git
cd cctv-stack
./install.sh
```

The first run creates `.env` and `config/cameras.yml`; edit both and run it again. See
[`docs/install.md`](docs/install.md) for the operator procedure and
[`CONTRIBUTING.md`](CONTRIBUTING.md) for how releases are built and delivered.

## Compatibility

| | |
|---|---|
| Python | 3.12 or newer |
| Frigate | 0.18 API and MQTT contract (verified) |
| Platforms | Linux x86_64/arm64; macOS for development |
| Cloud backup | Backblaze B2 through its S3-compatible endpoint; optional |
| Inbound network | None required |

## Documentation

Full documentation: **https://aravindmyd.github.io/cctv-stack/**

- [Install](docs/install.md) — Docker Compose from the published image, or pip
- [Configure](docs/configure.md) — `cameras.yml`, `.env`, adding a camera
- [Frigate UI login](docs/frigate-ui.md)
- [Health](docs/health.md) — endpoints and what to check first
- [Recover failed uploads](docs/recover-uploads.md)
- [Glossary](docs/glossary.md) — the vocabulary these docs use
- [`CONTRIBUTING.md`](CONTRIBUTING.md) — development, CI and release process

## License

Apache-2.0 — see [`LICENSE`](LICENSE).
