switches approach to utilize systemd service templates and environment files

Author: isaric

.gitignore

@@ -0,0 +1,2 @@
+.idea
+*.iml

LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright 2023 Path Variable & Ivan Šarić
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,18 +1,32 @@
-# recording-scripts
+# recording-scripts v2
 This repository holds the scripts and a systemd service template I have used when making my bash-based NVR system. You can find a link to the presentation 
 outlining the project [here](https://bit.ly/3n8DRRl).
 
 The scripts are written in bash.
 
-I will outline their purpose here in short.
+This is version 2 of the scripts. The second version uses the systemd service template concept as well as the environment file concept
+to make deployment of each camera service simpler. All the variable parts of the recording script are stored in an environment file.
+The user will create one environment file per camera. The file should specify the camera properties, the base path for the recordings
+and the path to record.sh.
 
- 1. cleanup.sh - This will remove any video files in X path after the given X days that are specified as a command line argument
- 2. location-room.service - this system service will execute the recording script and make sure it restarts in case of system reboot
- 3. record-location-room.sh - this is the main recording script. it calls ffmpeg and creates an apendable video file for the whole day
- 4. remux.sh - this script will convert the previous days recording into an mp4 file extension
- 5. watchdog.sh - this script serves a watchdog function that will check if the ffmpeg recording has stalled and restart it
+There is only one recording script - record.sh. The user should read it to get familiar with the variables and their role. There is no need
+to modify the recording script.
 
-Another possible approach when recording is to use the built-in segmentation feature of ffmpeg and have it record in smaller chunks with
-a non-appendable format. That way you can still recover from errors and use less space. The drawback is that you will have to concatenate
-these small chunks at one point. The operation is not resource intensive but you need to have additional space available during that time, 
-write a script for it and schedule it with crontab.
+There is only one systemd service file - [email protected]. The user needs to edit the file before copying to the systemd service folder and specify
+the base path to the environment files and the path to the watchdog script.
+
+
+In order to deploy a script (once copied to the systemd folder) the user will execute the following command template:
+
+    sudo systemd daemon-reload
+    sudo systemd start [email protected]
+    sudo systemd enable [email protected]
+
+As a result of this command systemd will look for an environment file named camera.env located in the folder specified in the service file.
+It will load all the variables contained within and run watchdog.sh. Watchdog will then run the recording script and poll for liveness every
+16 seconds.
+
+The recordings will be written in TS format to allow for appending in case of service failure. There will be only one recording per day.
+Each recording will have the format of YYYY_MM_DD.ts
+
+If you have any questions or think you have encountered a bug, please open an issue on [Github](https://github.com/Path-Variable/recording-scripts/issues).

cleanup.sh

@@ -1,7 +1,2 @@
-#/bin/sh
-
-## delete anything older than 7 days
-## assumes folder structure like /base/cameras/location/room
-find /base/cameras/*/*/* -type f -mtime +7 -exec rm -rf {} \;
-
+find /base/path/to/recordings/*/*/*/ -type d -mtime +3 -exec rm -rf {} \; 
 

example.env

@@ -0,0 +1,6 @@
+REC_SCRIPT=/path/to/record.sh
+BASE_PATH=/path/to/your/recordings
+CAMERA_IP=127.0.0.1
+CAMERA_PASSWORD=campass123
+CAMERA_LOCATION=zagreb
+CAMERA_NAME=hallway

record.sh

@@ -0,0 +1,4 @@
+TS_DAY=$(date +%Y_%m_%d)
+mkdir -p -- ${BASE_PATH}/${CAMERA_LOCATION}/${CAMERA_NAME}/
+ffmpeg -rtsp_transport tcp -i rtsp://${CAMERA_IP}/user=admin_password=${CAMERA_PASSWORD}_channel=1_stream=0.sdp -c copy -acodec aac -f mpegts - >>  ${BASE_PATH}/${CAMERA_LOCATION}/${CAMERA_NAME}/${TS_DAY}.ts
+

location-room.service renamed to [email protected]

@@ -4,12 +4,12 @@ After=network.target
 
 [Service]
 Type=simple
-Environment="REC_SCRIPT=/path/to/script/record_location_room.sh"
+EnvironmentFile=path/to/env_files/%i.env
 Restart=always
 RestartSec=3
 User=your-user
 Group=your-group
-ExecStart=/bin/bash /path/to/script/watchdog.sh
+ExecStart=/bin/bash /path/to/watchdog.sh
 TimeoutStartSec=0
 WatchdogSec=16
 NotifyAccess=all