Thanks to visit codestin.com
Credit goes to github.com

Skip to content

allow overrides for each snapshot domain #916

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 4, 2025
Merged

allow overrides for each snapshot domain #916

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
32c648e
allow overrides for each snapshot domain
roflcoopter Feb 26, 2025
ae4066b
add more docs on snapshot retention rules
roflcoopter Feb 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/docs/documentation/configuration/recordings.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ This will enable continuous recordings for all cameras. If you want to disable c

### Setting retention rules for a specific camera

You can set retention rules for a specific camera by adding the `events`, `continuous` or `storage` key to the `recorder` camera config.
You can set retention rules for a specific camera by adding the `events`, `continuous` or `storage` key to the camera config.

Example configuration to set retention rules for a specific camera:

Expand Down
28 changes: 26 additions & 2 deletions docs/docs/documentation/configuration/snapshots.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ Size based retention rules are calculated **per camera**, meaning that if you ha
### Setting retention rules per domain

You can set specific retention rules for each domain by following the example below.
The example stores 1 GB of face recognition snapshots, and 7 days if license plate recognition snapshots.
The example stores 1 GB of face recognition snapshots, and 14 days of license plate recognition snapshots.

```yaml /config/config.yaml
storage:
Expand All @@ -134,7 +134,31 @@ storage:
tiers:
- path: / # Files will be stored in the /snapshots/license_plate_recognition directory
max_age:
days: 7
days: 14
```

### Setting retention rules for a specific camera

You can set retention rules for a specific camera by adding the `storage` key to the camera config.
The example stores 1gb of face recognition snapshots for `camera_one`, while other cameras and types of snapshots will be stored based on the global retention rules (defaults to 7 days).

```yaml /config/config.yaml
ffmpeg: # or any other camera component
camera:
camera_one:
name: Camera 1
host: !secret camera_one_host
path: /Streaming/Channels/101/
username: !secret camera_one_username
password: !secret camera_one_password
// highlight-start
snapshots:
face_recognition:
tiers:
- path: / # Files will be stored in the /snapshots/face_recognition directory
max_size:
gb: 1
// highlight-end
```

## Downloading snapshots
Expand Down
51 changes: 28 additions & 23 deletions docs/src/pages/components-explorer/components/ffmpeg/config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@
"name": "minutes",
"description": "Minutes between checks for files to move/delete.",
"optional": true,
"default": 1
"default": 0
},
{
"type": "integer",
Expand All @@ -261,7 +261,9 @@
"name": "check_interval",
"description": "How often to check for files to move to the next tier.",
"optional": true,
"default": null
"default": {
"minutes": 1
}
},
{
"type": "map",
Expand Down Expand Up @@ -512,9 +514,9 @@
}
],
"name": "recorder",
"description": "Configuration for recordings.",
"description": "Recorder config.",
"optional": true,
"default": {}
"default": null
},
{
"type": "map",
Expand Down Expand Up @@ -675,7 +677,7 @@
"name": "minutes",
"description": "Minutes between checks for files to move/delete.",
"optional": true,
"default": 1
"default": 0
},
{
"type": "integer",
Expand All @@ -689,22 +691,17 @@
"name": "check_interval",
"description": "How often to check for files to move to the next tier.",
"optional": true,
"default": null
"default": {
"minutes": 1
}
}
]
],
"lengthMin": 1,
"name": "tiers",
"description": "Default tiers for all domains, unless overridden in the domain configuration.<br>Tiers are used to move files between different storage locations. When a file reaches the max age or max size of a tier, it will be moved to the next tier. If the file is already in the last tier, it will be deleted. ",
"optional": true,
"default": [
{
"path": "/",
"max_age": {
"days": 7
}
}
]
"default": null
},
{
"type": "map",
Expand Down Expand Up @@ -865,7 +862,7 @@
"name": "minutes",
"description": "Minutes between checks for files to move/delete.",
"optional": true,
"default": 1
"default": 0
},
{
"type": "integer",
Expand All @@ -879,7 +876,9 @@
"name": "check_interval",
"description": "How often to check for files to move to the next tier.",
"optional": true,
"default": null
"default": {
"minutes": 1
}
}
]
],
Expand Down Expand Up @@ -1054,7 +1053,7 @@
"name": "minutes",
"description": "Minutes between checks for files to move/delete.",
"optional": true,
"default": 1
"default": 0
},
{
"type": "integer",
Expand All @@ -1068,7 +1067,9 @@
"name": "check_interval",
"description": "How often to check for files to move to the next tier.",
"optional": true,
"default": null
"default": {
"minutes": 1
}
}
]
],
Expand Down Expand Up @@ -1243,7 +1244,7 @@
"name": "minutes",
"description": "Minutes between checks for files to move/delete.",
"optional": true,
"default": 1
"default": 0
},
{
"type": "integer",
Expand All @@ -1257,7 +1258,9 @@
"name": "check_interval",
"description": "How often to check for files to move to the next tier.",
"optional": true,
"default": null
"default": {
"minutes": 1
}
}
]
],
Expand Down Expand Up @@ -1432,7 +1435,7 @@
"name": "minutes",
"description": "Minutes between checks for files to move/delete.",
"optional": true,
"default": 1
"default": 0
},
{
"type": "integer",
Expand All @@ -1446,7 +1449,9 @@
"name": "check_interval",
"description": "How often to check for files to move to the next tier.",
"optional": true,
"default": null
"default": {
"minutes": 1
}
}
]
],
Expand All @@ -1466,7 +1471,7 @@
"name": "snapshots",
"description": "Snapshots are images taken when events are triggered or post processors finds anything. Snapshots will be taken for object detection, motion detection, and any post processor that scans the image, for example face and license plate recognition.",
"optional": true,
"default": {}
"default": null
}
],
"name": "storage",
Expand Down
51 changes: 28 additions & 23 deletions docs/src/pages/components-explorer/components/gstreamer/config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@
"name": "minutes",
"description": "Minutes between checks for files to move/delete.",
"optional": true,
"default": 1
"default": 0
},
{
"type": "integer",
Expand All @@ -261,7 +261,9 @@
"name": "check_interval",
"description": "How often to check for files to move to the next tier.",
"optional": true,
"default": null
"default": {
"minutes": 1
}
},
{
"type": "map",
Expand Down Expand Up @@ -512,9 +514,9 @@
}
],
"name": "recorder",
"description": "Configuration for recordings.",
"description": "Recorder config.",
"optional": true,
"default": {}
"default": null
},
{
"type": "map",
Expand Down Expand Up @@ -675,7 +677,7 @@
"name": "minutes",
"description": "Minutes between checks for files to move/delete.",
"optional": true,
"default": 1
"default": 0
},
{
"type": "integer",
Expand All @@ -689,22 +691,17 @@
"name": "check_interval",
"description": "How often to check for files to move to the next tier.",
"optional": true,
"default": null
"default": {
"minutes": 1
}
}
]
],
"lengthMin": 1,
"name": "tiers",
"description": "Default tiers for all domains, unless overridden in the domain configuration.<br>Tiers are used to move files between different storage locations. When a file reaches the max age or max size of a tier, it will be moved to the next tier. If the file is already in the last tier, it will be deleted. ",
"optional": true,
"default": [
{
"path": "/",
"max_age": {
"days": 7
}
}
]
"default": null
},
{
"type": "map",
Expand Down Expand Up @@ -865,7 +862,7 @@
"name": "minutes",
"description": "Minutes between checks for files to move/delete.",
"optional": true,
"default": 1
"default": 0
},
{
"type": "integer",
Expand All @@ -879,7 +876,9 @@
"name": "check_interval",
"description": "How often to check for files to move to the next tier.",
"optional": true,
"default": null
"default": {
"minutes": 1
}
}
]
],
Expand Down Expand Up @@ -1054,7 +1053,7 @@
"name": "minutes",
"description": "Minutes between checks for files to move/delete.",
"optional": true,
"default": 1
"default": 0
},
{
"type": "integer",
Expand All @@ -1068,7 +1067,9 @@
"name": "check_interval",
"description": "How often to check for files to move to the next tier.",
"optional": true,
"default": null
"default": {
"minutes": 1
}
}
]
],
Expand Down Expand Up @@ -1243,7 +1244,7 @@
"name": "minutes",
"description": "Minutes between checks for files to move/delete.",
"optional": true,
"default": 1
"default": 0
},
{
"type": "integer",
Expand All @@ -1257,7 +1258,9 @@
"name": "check_interval",
"description": "How often to check for files to move to the next tier.",
"optional": true,
"default": null
"default": {
"minutes": 1
}
}
]
],
Expand Down Expand Up @@ -1432,7 +1435,7 @@
"name": "minutes",
"description": "Minutes between checks for files to move/delete.",
"optional": true,
"default": 1
"default": 0
},
{
"type": "integer",
Expand All @@ -1446,7 +1449,9 @@
"name": "check_interval",
"description": "How often to check for files to move to the next tier.",
"optional": true,
"default": null
"default": {
"minutes": 1
}
}
]
],
Expand All @@ -1466,7 +1471,7 @@
"name": "snapshots",
"description": "Snapshots are images taken when events are triggered or post processors finds anything. Snapshots will be taken for object detection, motion detection, and any post processor that scans the image, for example face and license plate recognition.",
"optional": true,
"default": {}
"default": null
}
],
"name": "storage",
Expand Down
Loading