├── .dockerignore ├── .env ├── .gitattributes ├── .gitignore ├── Dockerfile ├── LICENSE ├── README.md ├── docker-compose.yml └── rootfs └── app ├── LICENSE.txt ├── captures └── .keep ├── config └── .keep ├── ctbrec-server-5.3.0-final.jar ├── ctbrec.py ├── defaults └── server.json ├── dopp.sh ├── healthcheck.sh ├── init.sh ├── note2txt.sh ├── plcheck.sh ├── reclaim.py ├── reclean.py ├── send2discord.sh ├── send2email.sh ├── send2http.sh ├── send2ntfy.sh ├── send2telegram.sh └── start.sh /.dockerignore: -------------------------------------------------------------------------------- 1 | config\* 2 | media\* 3 | alt\* 4 | .git\* 5 | .github\* 6 | .dockerignore 7 | .env 8 | .gitattributes 9 | .gitignore 10 | build-push.ps1 11 | Dockerfile* 12 | docker-compose.yml 13 | LICENSE 14 | README.md 15 | -------------------------------------------------------------------------------- /.env: -------------------------------------------------------------------------------- 1 | # Where the config files for CTBRec are kept 2 | CONFIG=./ 3 | # Where CTBRec records to 4 | MEDIA=./media 5 | 6 | # Your TZ setting, only used inside Docker container 7 | TZ=Australia/Sydney 8 | 9 | # UID/GID to run the server as 10 | PUID=1000 11 | PGID=1000 12 | 13 | # Variables below are used for the reclean.py and reclaim.py scripts 14 | # Don't change the SRVURL unless you don't use TLS and/or have changed the 15 | # container port. 16 | # SRVURL=https://127.0.0.1:8443 17 | 18 | # User/Pass for the WebUI (defaults below) 19 | # SRVUSR=ctbrec 20 | # SRVPSS=sucks 21 | 22 | # Following variable is for reclaim.py, it specifies how much space to recover 23 | # when a 'Out of Drive Space' event occurs. 24 | # NOTE: DO NOT MAKE THIS VALUE LARGER THAN AVAILABLE SPACE!!!! 25 | # The value is in **bytes** - eg. below is 100GB 26 | RECOVER=100000000000 27 | 28 | # The following variable is for using the optional Discord notification script 29 | # DISCORDHOOK= 30 | 31 | # The following variables are for using the optional Telegram notification script 32 | # CHAT_ID= 33 | # TOKEN= 34 | 35 | # The following variables are for using the optional email notification script 36 | #MAILSERVER=smtps://smtp.gmail.com:465 37 | #MAILFROM=my_really_cool_email@gmail.com 38 | #MAILTO=woohoo_another_capture@gmail.com 39 | #MAILPASS=my_really_super_secret_p4ssw0rd 40 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .git/* 2 | .github/* 3 | build-push.ps1 -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | # 2 | # ctbrec-debian Dockerfile 3 | # 4 | # https://github.com/jafea7/ctbrec-debian 5 | # 6 | 7 | FROM debian:bookworm-slim AS builder 8 | 9 | ARG TARGETPLATFORM 10 | 11 | # Install curl & tar to get ffmpeg static 12 | RUN apt-get update && \ 13 | apt-get install -y --no-install-recommends curl xz-utils && \ 14 | rm -rf /var/lib/apt/lists/* 15 | 16 | # Copy the rootfs layout including files 17 | COPY rootfs/ / 18 | 19 | # Install ffmpeg static build, set permissions 20 | RUN useradd -u 1000 -U -G users -d /app -s /bin/false ctbrec && \ 21 | mkdir -p /app/captures /app/config /app/ffmpeg && \ 22 | if [ "$TARGETPLATFORM" = "linux/amd64" ]; then curl -k -v --http1.1 https://www.johnvansickle.com/ffmpeg/old-releases/ffmpeg-5.1.1-amd64-static.tar.xz | tar --strip-components=1 -C /app/ffmpeg -xvJ --wildcards "ffmpeg-*/ffmpeg"; fi && \ 23 | if [ "$TARGETPLATFORM" = "linux/arm/v7" ]; then curl -k -v --http1.1 https://www.johnvansickle.com/ffmpeg/old-releases/ffmpeg-5.1.1-armhf-static.tar.xz | tar --strip-components=1 -C /app/ffmpeg -xvJ --wildcards "ffmpeg-*/ffmpeg"; fi && \ 24 | if [ "$TARGETPLATFORM" = "linux/arm64" ]; then curl -k -v --http1.1 https://www.johnvansickle.com/ffmpeg/old-releases/ffmpeg-5.1.1-arm64-static.tar.xz | tar --strip-components=1 -C /app/ffmpeg -xvJ --wildcards "ffmpeg-*/ffmpeg"; fi && \ 25 | chmod -R a+rwX /app/ && \ 26 | chmod a+x /app/*.sh /app/*.py /app/ffmpeg/ffmpeg 27 | 28 | # Pull base image. 29 | FROM eclipse-temurin:21-jre 30 | 31 | # Copy app folder with ffmpeg from builder 32 | COPY --from=builder /app /app 33 | RUN apt-get update && \ 34 | apt-get install -y --no-install-recommends less inetutils-ping python3 python3-pip && \ 35 | pip3 install urllib3 requests && \ 36 | apt-get -y remove python3-pip && \ 37 | apt-get -y autoremove && \ 38 | rm -rf /var/lib/apt/lists/* 39 | 40 | ARG CTBVER 41 | ENV CTBVER=${CTBVER} 42 | 43 | # Expose server non-SSL and SSL ports 44 | EXPOSE 8080 8443 45 | 46 | # Initialise 47 | ENTRYPOINT ["/app/init.sh"] 48 | 49 | HEALTHCHECK --interval=20s --retries=3 --timeout=3s \ 50 | CMD curl -f http://localhost:8080 || exit 1 51 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | This is free and unencumbered software released into the public domain. 2 | 3 | Anyone is free to copy, modify, publish, use, compile, sell, or 4 | distribute this software, either in source code form or as a compiled 5 | binary, for any purpose, commercial or non-commercial, and by any 6 | means. 7 | 8 | In jurisdictions that recognize copyright laws, the author or authors 9 | of this software dedicate any and all copyright interest in the 10 | software to the public domain. We make this dedication for the benefit 11 | of the public at large and to the detriment of our heirs and 12 | successors. We intend this dedication to be an overt act of 13 | relinquishment in perpetuity of all present and future rights to this 14 | software under copyright law. 15 | 16 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 17 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 18 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 19 | IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR 20 | OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 21 | ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 22 | OTHER DEALINGS IN THE SOFTWARE. 23 | 24 | For more information, please refer to 25 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Docker container for CTBRec server 2 | 3 | --- 4 | 5 | CTBRec is a streaming media recorder. 6 | 7 | **NOTE: Recommend you create a new container using the info below.** 8 | 9 | --- 10 | 11 | ## Table of Content 12 | 13 | * [Docker container for CTBRec server](#docker-container-for-ctbrec-server) 14 | * [Table of Content](#table-of-content) 15 | * [Quick Start](#quick-start) 16 | * [Usage](#usage) 17 | * [Environment Variables](#environment-variables) 18 | * [Data Volumes](#data-volumes) 19 | * [Ports](#ports) 20 | * [Changing Parameters of a Running Container](#changing-parameters-of-a-running-container) 21 | * [Docker Compose File](#docker-compose-file) 22 | * [QNap Installs](#qnap-installs) 23 | * [Docker Image Update](#docker-image-update) 24 | * [Synology](#synology) 25 | * [unRAID](#unraid) 26 | * [Accessing the GUI](#accessing-the-gui) 27 | * [Shell Access](#shell-access) 28 | * [Default Web Interface Access](#default-web-interface-access) 29 | * [Logging](#logging) 30 | * [Extras](#extras) 31 | * [Ancillary Scripts](#ancillary-scripts) 32 | * [Send2 Scripts](#send2-scripts) 33 | 34 | ## Quick Start 35 | 36 | **NOTE**: The Docker command provided in this quick start is given as an example 37 | and parameters should be adjusted to your need. 38 | 39 | Launch the CTBRec server docker container with the following command: 40 | 41 | ```text 42 | docker run -d \ 43 | --name=ctbrec-debian \ 44 | -p 8080:8080 \ 45 | -p 8443:8443 \ 46 | -v /home/ctbrec/media:/app/captures:rw \ 47 | -v /home/ctbrec/.config/ctbrec:/app/config:rw \ 48 | -e TZ=Australia/Sydney \ 49 | -e PGID=1000 \ 50 | -e PUID=1000 \ 51 | jafea7/ctbrec-debian 52 | ``` 53 | 54 | Where: 55 | 56 | * `/home/ctbrec/.config/ctbrec`: This is where the application stores its configuration and any files needing persistency. 57 | * `/home/ctbrec/media`: This is where the application stores recordings. 58 | * `TZ`: The timezone you want the application to use, files created will be referenced to this. 59 | * `PGID`: The Group ID that CTBRec will run under. 60 | * `PUID`: The User ID that CTBRec will run under. 61 | 62 | Browse to `http://your-host-ip:8080` to access the CTBRec web interface, (or `https://your-host-ip:8443` if TLS is enabled). 63 | 64 | **NOTE**: If it's your initial use of this image then a default config is copied that already has the web interface enabled along with TLS. 65 | 66 | ## Usage 67 | 68 | ```text 69 | docker run [-d] \ 70 | --name=ctbrec-debian \ 71 | [-e =]... \ 72 | [-v :[:PERMISSIONS]]... \ 73 | [-p :]... \ 74 | jafea7/ctbrec-debian 75 | ``` 76 | 77 | | Parameter | Description | 78 | |-----------|-------------| 79 | | -d | Run the container in the background. If not set, the container runs in the foreground. | 80 | | -e | Pass an environment variable to the container. See the [Environment Variables](#environment-variables) section for more details. | 81 | | -v | Set a volume mapping (allows to share a folder/file between the host and the container). See the [Data Volumes](#data-volumes) section for more details. | 82 | | -p | Set a network port mapping (exposes an internal container port to the host). See the [Ports](#ports) section for more details. | 83 | 84 | ### Environment Variables 85 | 86 | To customize some properties of the container, the following environment 87 | variables can be passed via the `-e` parameter (one for each variable). Value 88 | of this parameter has the format `=`. 89 | 90 | | Variable | Description | Default | 91 | |----------------|----------------------------------------------|---------| 92 | |`TZ`| [TimeZone] of the container. Timezone can also be set by mapping `/etc/localtime` between the host and the container. | `UTC` | 93 | |`PGID`| Group ID that will be used to run CTBRec within the container. | `1000` | 94 | |`PUID`| User ID that will be used to run CTBRec within the container. | `1000` | 95 | 96 | ### Data Volumes 97 | 98 | The following table describes data volumes used by the container. The mappings 99 | are set via the `-v` parameter. Each mapping is specified with the following 100 | format: `:[:PERMISSIONS]`. 101 | 102 | | Container path | Permissions | Description | 103 | |-----------------|-------------|-------------| 104 | |`/app/config`| rw | This is where the application stores its configuration and any files needing persistency. | 105 | |`/app/captures`| rw | This is where the application stores recordings. | 106 | 107 | ### Ports 108 | 109 | Here is the list of ports used by the container. They can be mapped to the host 110 | via the `-p` parameter (one per port mapping). Each mapping is defined in the 111 | following format: `:`. The port number inside the 112 | container cannot be changed, but you are free to use any port on the host side. 113 | 114 | | Port | Mapping to host | Description | 115 | |------|-----------------|-------------| 116 | | 8080 | Mandatory | Port used to serve HTTP requests. | 117 | | 8443 | Mandatory | Port used to serve HTTPs requests. | 118 | 119 | ### Changing Parameters of a Running Container 120 | 121 | As seen, environment variables, volume mappings and port mappings are specified 122 | while creating the container. 123 | 124 | The following steps describe the method used to add, remove or update 125 | parameter(s) of an existing container. The generic idea is to destroy and 126 | re-create the container: 127 | 128 | 1. Stop the container (if it is running): 129 | 130 | ```text 131 | docker stop ctbrec-debian 132 | ``` 133 | 134 | 2. Remove the container: 135 | 136 | ```text 137 | docker rm ctbrec-debian 138 | ``` 139 | 140 | 3. Create/start the container using the `docker run` command, by adjusting parameters as needed. 141 | 142 | **NOTE**: Since all application's data is saved under the `/app/config` and 143 | `/app/captures` container folders, destroying and re-creating 144 | a container is not a problem: nothing is lost and the application comes back 145 | with the same state (as long as the mapping of the `/app/config` and 146 | `/app/captures` are the same as previously used). 147 | 148 | ## Docker Compose File 149 | 150 | Here is an example of a `docker-compose.yml` file that can be used with 151 | [Docker Compose](https://docs.docker.com/compose/overview/). 152 | 153 | Make sure to adjust according to your needs. Note that only mandatory network 154 | ports are part of the example. 155 | 156 | ```yaml 157 | version: '2.1' 158 | services: 159 | ctbrec-debian: 160 | image: jafea7/ctbrec-debian 161 | container_name: "CTBRec-Debian" 162 | environment: 163 | - TZ=Australia/Sydney 164 | - PGID=1000 165 | - PUID=1000 166 | ports: 167 | - "8080:8080" 168 | - "8443:8443" 169 | volumes: 170 | - "/home/ctbrec/.config/ctbrec:/app/config:rw" 171 | - "/home/ctbrec/media:/app/captures:rw" 172 | restart: "unless-stopped" 173 | ``` 174 | 175 | ## QNap Installs 176 | 177 | When you create the container using Container Station specify the PUID and PGID environment variables, (you can't do this later). 178 | 179 | You may need to set `PGID = 0` and `PUID = 0`, ie. CTBRec runs as root within the container. 180 | 181 | ## Docker Image Update 182 | 183 | If the system on which the container runs doesn't provide a way to easily update 184 | the Docker image, the following steps can be followed: 185 | 186 | 1. Fetch the latest image: 187 | 188 | ```text 189 | docker pull jafea7/ctbrec-debian 190 | ``` 191 | 192 | 2. Stop the container: 193 | 194 | ```text 195 | docker stop jafea7/ctbrec-debian 196 | ``` 197 | 198 | 3. Remove the container: 199 | 200 | ```text 201 | docker rm jafea7/ctbrec-debian 202 | ``` 203 | 204 | 4. Start the container using the `docker run` command. 205 | 206 | **Updating using docker-compose:** 207 | 208 | ```text 209 | docker-compose pull && docker-compose up -d 210 | ``` 211 | 212 | ### Synology 213 | 214 | For owners of a Synology NAS, the following steps can be used to update a 215 | container image. 216 | 217 | 1. Open the *Docker* application. 218 | 2. Click on *Registry* in the left pane. 219 | 3. In the search bar, type the name of the container (`jafea7/ctbrec-debian`). 220 | 4. Select the image, click *Download* and then choose the `latest` tag. 221 | 5. Wait for the download to complete. A notification will appear once done. 222 | 6. Click on *Container* in the left pane. 223 | 7. Select your CTBRec server container. 224 | 8. Stop it by clicking *Action*->*Stop*. 225 | 9. Clear the container by clicking *Action*->*Clear*. This removes the 226 | container while keeping its configuration. 227 | 10. Start the container again by clicking *Action*->*Start*. 228 | 229 | **NOTE**: The container may temporarily disappear from the list while it is re-created. 230 | 231 | --- 232 | 233 | ### unRAID 234 | 235 | For unRAID, a container image can be updated by following these steps: 236 | 237 | 1. Select the *Docker* tab. 238 | 2. Click the *Check for Updates* button at the bottom of the page. 239 | 3. Click the *update ready* link of the container to be updated. 240 | 241 | ## Accessing the GUI 242 | 243 | Assuming that container's ports are mapped to the same host's ports, the 244 | interface of the application can be accessed with a web browser at: 245 | 246 | ```text 247 | http://:8080 248 | ``` 249 | 250 | Or if TLS is enabled: 251 | 252 | ```text 253 | https://:8443 254 | ``` 255 | 256 | ## Shell Access 257 | 258 | To get shell access to the running container, execute the following command: 259 | 260 | ```text 261 | docker exec -ti CONTAINER sh 262 | ``` 263 | 264 | Where `CONTAINER` is the ID or the name of the container used during its 265 | creation (e.g. `ctbrec-debian`). 266 | 267 | ## Default Web Interface Access 268 | 269 | After a fresh install and the web interface is enabled, the default login is: 270 | 271 | * Username: `ctbrec` 272 | * Password: `sucks` 273 | 274 | Change the username/password via the WebUI, you will need to log into it again after saving. 275 | 276 | **NOTE**: A fresh start of the image will include a current default server.json, (if it doesn't exist already), with the following options set: 277 | 278 | * `"deleteOrphanedRecordingMetadata" : true,` 279 | * `"downloadFilename": "$sanitize(${modelName})_$sanitize(${siteName})_$format(${localDateTime},yyyyMMdd-hhmmss).${fileSuffix}"` 280 | * `"recordingsDirStructure": "ONE_PER_MODEL"` 281 | * `"totalModelCountInTitle": true` 282 | * `"transportLayerSecurity": true` 283 | * `"webinterface": true` 284 | 285 | These post-processing steps will be set in the default config: 286 | 287 | * Run external script `dopp.sh` to check the existence of the flag file to enable or disable post-processing, (see [Ancillary Scripts](#ancillary-scripts)); 288 | * Run external script `plcheck.sh` which checks the `playlist.m3u8` generated by CTBRec is terminated correctly, (see [Ancillary Scripts](#ancillary-scripts)); 289 | * Remux/Transcode to a matroska container; 290 | * (v3/4) Rename to the following: `"${modelSantizedName})_${siteSanitizedName})_${localDateTime(yyyyMMdd-HHmmss)}.${fileSuffix}"`; 291 | * (v5+) Rename to the following: `"$sanitize(${modelName})_$sanitize(${siteName})_$format(${localDateTime},yyyyMMdd-hhmmss).${fileSuffix}"`; 292 | * Create contact sheet: 8x7 images, 2560px wide, timecodes enabled, same file name format as the Rename step. 293 | 294 | ## Logging 295 | 296 | All logging is to the standard Docker logs, *no log file is created either external or internal to the container*. 297 | 298 | If you want a log file then use the `docker logs` command, see [Docker Logging](https://docs.docker.com/config/containers/logging/) and [Docker Compose Logs](https://docs.docker.com/engine/reference/commandline/compose_logs/). 299 | 300 | ## Extras 301 | 302 | ### Ancillary Scripts 303 | 304 | #### dopp.sh 305 | 306 | This script controls post-processing by checking the existence of a `flag` file. 307 | 308 | Why does this script exist? 309 | 310 | In case you're running the server on low powered hardware, (or some other reason), it gives you a way to defer post-processing to a time of your choosing without having to: 311 | 312 | * stop the server; 313 | * remove post-processing steps; 314 | * start the server; 315 | * wait for all your recordings to finish; 316 | * stop the server; 317 | * add the post-processing steps back; 318 | * start the server; 319 | * and finally `Re-run post-processing` from the client. 320 | 321 | If the file `dopp` exists in the mapped `/app/config` directory then post-processing will continue as normal. 322 | 323 | If the file does not exist then post-processing will be aborted and the recording marked as `FAILED` in the interface. To run post-processing on the recording, create the dopp file and `Re-run post-processing` via the context menu in the client. 324 | 325 | The relevant entry for post-processing is: 326 | 327 | ```json 328 | { 329 | "type": "ctbrec.recorder.postprocessing.Script", 330 | "config": { 331 | "script.params": "", 332 | "script.executable": "/app/dopp.sh" 333 | } 334 | } 335 | ``` 336 | 337 | **NOTE:** By default this script is the **first step** in post-processing and the `dopp` file will be created whenever the container is started so that post-processing works as normal. 338 | 339 | #### plcheck.sh 340 | 341 | A simple script that will check if `playlist.m3u8` is terminated correctly, only useful if you don't record as a single file. 342 | 343 | If the container is terminated without existing captures being finished correctly the `playlist.m3u8` file won't be terminated with `#EXT-X-ENDLIST` which will cause ffmpeg to truncate the recording and take excessive time to process. 344 | 345 | By default this step happens before any following remux, (obviously), in post-processing, if `playlist.m3u8` doesn't exist, (in the case of `Record Single File` being enabled), or is correctly terminated it will exit otherwise it will append `#EXT-X-ENDLIST` to the file which will allow post-processing to be re-run without causing problems. 346 | 347 | The relevant entry for post-processing is: 348 | 349 | ```json 350 | { 351 | "type": "ctbrec.recorder.postprocessing.Script", 352 | "config": { 353 | "script.params": "${absolutePath}", 354 | "script.executable": "/app/plcheck.sh" 355 | } 356 | } 357 | ``` 358 | 359 | **NOTE: The following Python scripts use the server API Python script that was created by *Scooter* and require three environment variables to be able to run.** 360 | 361 | You can specify them in a `docker run` command, `docker-compose.yml`, or `.env` file. 362 | 363 | The defaults are: 364 | | Variable | Required | Meaning | 365 | |----------|----------|---------| 366 | | SRVURL | Mandatory | URL of the WebUI, default is `https://127.0.0.1:8443` | 367 | | SRVUSR | Mandatory | WebUI username, default is `ctbrec` | 368 | | SRVPSS | Mandatory | WebUI password, default is `sucks` | 369 | 370 | Examples: 371 | 372 | ```text 373 | docker run -d \ 374 | --name=ctbrec-debian \ 375 | -p 8080:8080 \ 376 | -p 8443:8443 \ 377 | -v /home/ctbrec/media:/app/captures:rw \ 378 | -v /home/ctbrec/.config/ctbrec:/app/config:rw \ 379 | -e TZ=Australia/Sydney \ 380 | -e PGID=1000 \ 381 | -e PUID=1000 \ 382 | -e SRVURL=https://127.0.0.1:8443 383 | -e SRVUSR=ctbrec 384 | -e SRVPSS=sucks 385 | jafea7/ctbrec-debian 386 | ``` 387 | 388 | ```yaml 389 | version: '2.1' 390 | services: 391 | ctbrec-debian: 392 | image: jafea7/ctbrec-debian 393 | container_name: "CTBRec-Debian" 394 | environment: 395 | - TZ=Australia/Sydney 396 | - PGID=1000 397 | - PUID=1000 398 | - SRVURL=https://127.0.0.1:8443 399 | - SRVUSR=ctbrec 400 | - SRVPSS=sucks 401 | ports: 402 | - "8080:8080" 403 | - "8443:8443" 404 | volumes: 405 | - "/home/ctbrec/.config/ctbrec:/app/config:rw" 406 | - "/home/ctbrec/media:/app/captures:rw" 407 | restart: "unless-stopped" 408 | ``` 409 | 410 | #### reclean.py 411 | 412 | Automatically removes orphaned JSON files from the `/recordings` directory left there by the removal of the media file. 413 | 414 | This step should be the last in post-processing and the factors required for a JSON file to be removed are: 415 | 416 | * the media file does not exist; 417 | * the status of the recording was `FINISHED`. 418 | 419 | The relevant entry for post-processing is: 420 | 421 | ```json 422 | { 423 | "type": "ctbrec.recorder.postprocessing.Script", 424 | "config": { 425 | "script.params": "", 426 | "script.executable": "/app/reclean.py" 427 | } 428 | } 429 | ``` 430 | 431 | #### reclaim.py 432 | 433 | `reclaim.py` recovers drive space by **automatically deleting the oldest non-pinned captures** until the required amount of drive space is free. 434 | 435 | Besides the above three environment variables it requires one more to specify the minimum amount of space to recover, it can be specified in `docker run` command, `docker-compose.yml`, or `.env` file. 436 | 437 | | Variable | Required | Description | 438 | -----------|----------|-------------| 439 | | RECOVER | Mandatory | Specifies the minimum amount of space to recover in bytes | 440 | 441 | **NOTE:** **Do NOT** set the value so that the resultant required free space is larger than the available drive space. 442 | 443 | This script should be used by adding to the `Events & Actions` section of the settings. 444 | 445 | For example: 446 | 447 | ```json 448 | "eventHandlers": [ 449 | { 450 | "actions": [ 451 | { 452 | "configuration": { 453 | "file": "/app/reclaim.py" 454 | }, 455 | "name": "execute reclaim.py", 456 | "type": "ctbrec.event.ExecuteProgram" 457 | } 458 | ], 459 | "event": "NO_SPACE_LEFT", 460 | "id": "5a1beebb-32dd-43cd-9848-b894121374fe", 461 | "name": "Delete oldest video", 462 | "predicates": [ 463 | { 464 | "configuration": {}, 465 | "name": "no space left", 466 | "type": "ctbrec.event.MatchAllPredicate" 467 | } 468 | ] 469 | } 470 | ], 471 | ``` 472 | 473 | ### Send2 Scripts 474 | 475 | Included are four scripts that will send a contact sheet created by post-processing to a designated Discord, Telegram channel, email address, or POST to HTTP site. 476 | 477 | The scripts are called `send2discord.sh`, `send2telegram.sh`, `send2email.sh`, and `send2http.sh` respectively, they reside in the `/app` directory, they are designed to be called after creation of the contact sheet, (no point calling them before a contact sheet is created). 478 | 479 | The relevant entries for post-processing are, for example: 480 | 481 | ```json 482 | { 483 | "type": "ctbrec.recorder.postprocessing.Script", 484 | "config": { 485 | "script.params": "${absolutePath} ${modelDisplayName} $format(${localDateTime},yyyyMMdd-hhmmss)}", 486 | "script.executable": "/app/send2discord.sh" 487 | } 488 | } 489 | ``` 490 | 491 | ```json 492 | { 493 | "type": "ctbrec.recorder.postprocessing.Script", 494 | "config": { 495 | "script.params": "${absolutePath} ${modelDisplayName} $sanitize(${siteName}) $format(${localDateTime},yyyyMMdd-hhmmss)}", 496 | "script.executable": "/app/send2telegram.sh" 497 | } 498 | } 499 | ``` 500 | 501 | ```json 502 | { 503 | "type": "ctbrec.recorder.postprocessing.Script", 504 | "config": { 505 | "script.params": "${absolutePath} ${modelDisplayName} $sanitize(${siteName}) $format(${localDateTime},yyyyMMdd-hhmmss)}", 506 | "script.executable": "/app/send2email.sh" 507 | } 508 | } 509 | ``` 510 | 511 | ```json 512 | { 513 | "type": "ctbrec.recorder.postprocessing.Script", 514 | "config": { 515 | "script.params": "${absolutePath} ${modelDisplayName} $sanitize(${siteName}) $format(${localDateTime},yyyyMMdd-hhmmss)}", 516 | "script.executable": "/app/send2http.sh" 517 | } 518 | } 519 | ``` 520 | 521 | The first variable needs to be `${absolutePath}`, (needed to determine the contact sheet path/name), the following arguments can be anything and any number, (within reason), they will be concatenated with ` - ` and used as the subject. 522 | 523 | The duration of the video will be concatenated at the end as `: hh:mm:ss`. 524 | 525 | To designate the Discord channel it is to be sent to, create an environment variable called `DISCORDHOOK` with the Discord Webhook. 526 | 527 | See [here](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) for how to get it. 528 | 529 | For example: 530 | 531 | ```text 532 | docker run -d \ 533 | --name=ctbrec-debian \ 534 | -p 8080:8080 \ 535 | -p 8443:8443 \ 536 | -v /home/ctbrec/media:/app/captures:rw \ 537 | -v /home/ctbrec/.config/ctbrec:/app/config:rw \ 538 | -e TZ=Australia/Sydney \ 539 | -e PGID=1000 \ 540 | -e PUID=1000 \ 541 | -e DISCORDHOOK=https://discordapp.com/api/webhooks// \ 542 | jafea7/ctbrec-debian 543 | ``` 544 | 545 | ```yaml 546 | version: '2.1' 547 | services: 548 | ctbrec-debian: 549 | image: jafea7/ctbrec-debian 550 | container_name: "CTBRec-Debian" 551 | environment: 552 | - TZ=Australia/Sydney 553 | - PGID=1000 554 | - PUID=1000 555 | - DISCORDHOOK=https://discordapp.com/api/webhooks// 556 | ports: 557 | - "8080:8080" 558 | - "8443:8443" 559 | volumes: 560 | - "/home/ctbrec/.config/ctbrec:/app/config:rw" 561 | - "/home/ctbrec/media:/app/captures:rw" 562 | restart: "unless-stopped" 563 | ``` 564 | 565 | To designate the Telegram channel you need to set two environment variables, `CHAT_ID` and `TOKEN`. 566 | 567 | See [here](https://www.shellhacks.com/telegram-api-send-message-personal-notification-bot/) on how to get both. 568 | 569 | For example: 570 | 571 | ```text 572 | docker run -d \ 573 | --name=ctbrec-debian \ 574 | -p 8080:8080 \ 575 | -p 8443:8443 \ 576 | -v /home/ctbrec/media:/app/captures:rw \ 577 | -v /home/ctbrec/.config/ctbrec:/app/config:rw \ 578 | -e TZ=Australia/Sydney \ 579 | -e PGID=1000 \ 580 | -e PUID=1000 \ 581 | -e CHAT_ID= \ 582 | -e TOKEN= \ 583 | jafea7/ctbrec-debian 584 | ``` 585 | 586 | ```yaml 587 | version: '2.1' 588 | services: 589 | ctbrec-debian: 590 | image: jafea7/ctbrec-debian 591 | container_name: "CTBRec-Debian" 592 | environment: 593 | - TZ=Australia/Sydney 594 | - PGID=1000 595 | - PUID=1000 596 | - CHAT_ID= 597 | - TOKEN= 598 | ports: 599 | - "8080:8080" 600 | - "8443:8443" 601 | volumes: 602 | - "/home/ctbrec/.config/ctbrec:/app/config:rw" 603 | - "/home/ctbrec/media:/app/captures:rw" 604 | restart: "unless-stopped" 605 | ``` 606 | 607 | To send to an email address you need to set four environment variables, `MAILSERVER`, `MAILFROM`, `MAILTO`, and `MAILPASS`. 608 | 609 | | Variable | Required | Meaning | 610 | |----------|----------|---------| 611 | | MAILSERVER | Mandatory | Address of the mail server in the form: `smtps://smtp.:` | 612 | | MAILFROM | Mandatory | Email address the emails are sent from. | 613 | | MAILTO | Mandatory | Email address to send the emails to. | 614 | | MAILPASS | Mandatory | Password for email account sending the emails. | 615 | 616 | For example: 617 | 618 | ```text 619 | docker run -d \ 620 | --name=ctbrec-debian \ 621 | -p 8080:8080 \ 622 | -p 8443:8443 \ 623 | -v /home/ctbrec/media:/app/captures:rw \ 624 | -v /home/ctbrec/.config/ctbrec:/app/config:rw \ 625 | -e TZ=Australia/Sydney \ 626 | -e PGID=1000 \ 627 | -e PUID=1000 \ 628 | -e MAILSERVER=smtps://smtp.gmail.com:465 \ 629 | -e MAILFROM=my_really_cool_email@gmail.com \ 630 | -e MAILTO=woohoo_another_capture@gmail.com \ 631 | -e MAILPASS=my_really_super_secret_p4ssw0rd \ 632 | jafea7/ctbrec-debian 633 | ``` 634 | 635 | ```yaml 636 | version: '2.1' 637 | services: 638 | ctbrec-debian: 639 | image: jafea7/ctbrec-debian 640 | container_name: "CTBRec-Debian" 641 | environment: 642 | - TZ=Australia/Sydney 643 | - PGID=1000 644 | - PUID=1000 645 | - MAILSERVER=smtps://smtp.gmail.com:465 646 | - MAILFROM=my_really_cool_email@gmail.com 647 | - MAILTO=woohoo_another_capture@gmail.com 648 | - MAILPASS=my_really_super_secret_p4ssw0rd 649 | ports: 650 | - "8080:8080" 651 | - "8443:8443" 652 | volumes: 653 | - "/home/ctbrec/.config/ctbrec:/app/config:rw" 654 | - "/home/ctbrec/media:/app/captures:rw" 655 | restart: "unless-stopped" 656 | ``` 657 | 658 | **NOTE: The following was a request by someone to add to the image and was written by them. I have no way to test it so I don't know if it works or not.** 659 | 660 | Send a POST request to an URL with postprocessing parameters. 661 | 662 | Data will be sent as `multipart/form-data`. 663 | 664 | | Form Field | Description | 665 | |------------|-------------| 666 | | file | relative path of the recording | 667 | | sheet | the contact sheet file | 668 | | duration | recording file length, format: `hh:mm:ss` | 669 | | argv | `script.params` string set in server.json, base64encoded | 670 | 671 | You need three environment Variables: `HTTP_URL`, `CURL_ARGS`, and `CURL_GET`. 672 | 673 | | Variable | Required | Meaning | 674 | |----------|----------|---------| 675 | | HTTP_URL | Mandatory | the url will send the http request to | 676 | | CURL_ARGS | Optional | extra CURL arguments | 677 | | CURL_GET | Optional | Send GET requests instead, no contact sheet | 678 | 679 | For example: 680 | 681 | ```text 682 | docker run -d \ 683 | --name=ctbrec-debian \ 684 | -p 8080:8080 \ 685 | -p 8443:8443 \ 686 | -v /home/ctbrec/media:/app/captures:rw \ 687 | -v /home/ctbrec/.config/ctbrec:/app/config:rw \ 688 | -e TZ=Australia/Sydney \ 689 | -e PGID=1000 \ 690 | -e PUID=1000 \ 691 | -e HTTP_URL=http://some.url.org \ 692 | -e CURL_ARGS=some_args \ 693 | -e CURL_GET=true \ 694 | jafea7/ctbrec-debian 695 | ``` 696 | 697 | ```yaml 698 | version: '2.1' 699 | services: 700 | ctbrec-debian: 701 | image: jafea7/ctbrec-debian 702 | container_name: "CTBRec-Debian" 703 | environment: 704 | - TZ=Australia/Sydney 705 | - PGID=1000 706 | - PUID=1000 707 | - HTTP_URL=http://some.url.org 708 | - CURL_ARGS=some_args 709 | - CURL_GET=true 710 | ports: 711 | - "8080:8080" 712 | - "8443:8443" 713 | volumes: 714 | - "/home/ctbrec/.config/ctbrec:/app/config:rw" 715 | - "/home/ctbrec/media:/app/captures:rw" 716 | restart: "unless-stopped" 717 | ``` 718 | 719 | For `docker-compose` you can also add the variables to the `.env` file and reference them from within the `docker-compose.yml` file. 720 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: '2.1' 2 | services: 3 | # CTBRec streaming recorder 4 | ctbrec-debian: 5 | image: "jafea7/ctbrec-debian" 6 | container_name: "ctbrec-debian" 7 | environment: 8 | - TZ=${TZ} 9 | - PGID=${PGID} 10 | - PUID=${PUID} 11 | # The following variables are used by reclean.py & reclaim.py 12 | # - SRVURL=${SRVURL} 13 | # - SRVUSR=${SRVUSR} 14 | # - SRVPSS=${SRVPSS} 15 | # The following variable is used for reclaim.py, the value is in bytes 16 | # - RECOVER=${RECOVER} 17 | # The following variable is for using the optional Discord notification script 18 | # - DISCORD=${DISCORD} 19 | # The following variables are for using the optional Telegram notification script 20 | # - CHAT_ID=${CHAT_ID} 21 | # - TOKEN=${TOKEN} 22 | # The following variables are for using the optional email notification script 23 | # - MAILSERVER=${MAILSERVER} 24 | # - MAILFROM=${MAILFROM} 25 | # - MAILTO=${MAILTO} 26 | # - MAILPASS=${MAILPASS} 27 | volumes: 28 | - "${CONFIG}/ctbrec:/app/config" 29 | - "${MEDIA}:/app/captures" 30 | ports: 31 | - 8080:8080 32 | - 8443:8443 33 | restart: "unless-stopped" 34 | -------------------------------------------------------------------------------- /rootfs/app/LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /rootfs/app/captures/.keep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Jafea7/ctbrec-debian/8068700a4a21d5b75144f493d74714829f9ad0e2/rootfs/app/captures/.keep -------------------------------------------------------------------------------- /rootfs/app/config/.keep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Jafea7/ctbrec-debian/8068700a4a21d5b75144f493d74714829f9ad0e2/rootfs/app/config/.keep -------------------------------------------------------------------------------- /rootfs/app/ctbrec-server-5.3.0-final.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Jafea7/ctbrec-debian/8068700a4a21d5b75144f493d74714829f9ad0e2/rootfs/app/ctbrec-server-5.3.0-final.jar -------------------------------------------------------------------------------- /rootfs/app/ctbrec.py: -------------------------------------------------------------------------------- 1 | """ Simple python client for programmatic interaction with the CTBREC server 2 | 3 | ################################################################################### 4 | WARNING - Make a backup of your server.json file before using the CtbRec class !!!! 5 | ################################################################################### 6 | 7 | CTBREC server functionality that is exposed includes: 8 | * querying server state 9 | * updating server settings 10 | * getting/adding/modifying/deleting models 11 | * getting/adding/modifying/deleting model-groups 12 | * getting/deleting/post-processing recordings 13 | 14 | Tested with ctbrec-server version 4.7.4, and Python version 3.9 15 | """ 16 | 17 | import json 18 | from datetime import datetime 19 | from enum import Enum 20 | from typing import Union, Mapping, Optional 21 | import uuid 22 | import re 23 | import hmac 24 | import hashlib 25 | import warnings 26 | 27 | from urllib3.exceptions import InsecureRequestWarning 28 | import requests 29 | 30 | 31 | class CtbRecRequestFailed(Exception): 32 | """ Exception to be raised if ctbrec server returns status=='fail' """ 33 | pass 34 | 35 | 36 | class CtbRecInvalidModelDefinition(Exception): 37 | """ Exception to be raised model definition doesn't conform to recognised pattern """ 38 | pass 39 | 40 | 41 | class CtbRecNotFound(Exception): 42 | """ Exception to be raised if an attempt to match a model or group on the server fails """ 43 | pass 44 | 45 | 46 | class CtbRecAlreadyExists(Exception): 47 | """ Exception to be raised if an attempt is made to create a model-group that already exists""" 48 | pass 49 | 50 | 51 | class CtbRec: 52 | """ 53 | Simple Python interface to the awesome ctbrec-server 54 | """ 55 | 56 | # basic regular expressions for model strings/urls 57 | regex = { 58 | 'url': re.compile('https?://'), 59 | 'site_name': re.compile(r'[A-Z]\w+:[\w-]+'), 60 | 'domain_name': re.compile(r'https?://([\w-]+\.)*([\w-]+\.[\w-]+)/([\w-]+/)*(.*)/?$'), 61 | 'model_type': re.compile(r'ctbrec\.sites\.[\w]+\.([\w]+)Model') 62 | } 63 | 64 | class ModelType(Enum): 65 | """ used for identifying model input type """ 66 | url = 1 67 | site_name = 2 68 | model_dict = 3 69 | 70 | def __init__(self, server_url: str, username: str = None, password: str = None, verify: Union[bool, str] = False): 71 | """ 72 | Initialise server connection 73 | 74 | Args: 75 | server_url: url of the ctbrec server, eg https://localhost:8443 76 | username: optional ctbrec server username Default is None 77 | password: optional ctbrec server password Default is None 78 | verify: Passed through to requests.Session for server ssl certificate handling. Default is False. 79 | """ 80 | # ignore insecure request warnings when tls is being used 81 | warnings.simplefilter(action='ignore', category=InsecureRequestWarning) 82 | # initialise connection parameters 83 | self.server_url = server_url.strip("/") 84 | self.session = requests.Session() 85 | if username is not None or password is not None: 86 | self.session.auth = (username, password) 87 | self.session.verify = verify 88 | self.session.headers.update({'X-Requested-With': 'XMLHttpRequest'}) 89 | # get hmac key 90 | hmac_req = self.session.get(self.server_url+'/secured/hmac') 91 | if hmac_req.status_code == 200 and len(hmac_req.text) > 0: 92 | self.hmac_key = json.loads(hmac_req.text)['hmac'].encode('utf-8') 93 | else: 94 | self.hmac_key = b'' 95 | # keep copy of initial server config 96 | self.initial_config = self.get_settings() 97 | self.initial_models = self.get_models() 98 | self.initial_model_groups = self.get_model_groups() 99 | 100 | # ----------------------------------------- model methods --------------------------------------------------------- 101 | def get_models(self, online: bool = False) -> Mapping[str, dict]: 102 | """ 103 | Get a list of all models on the server 104 | 105 | Args: 106 | online: if True then only retrieve online models else return all models. Default is False. 107 | Returns: 108 | dict of models where key is Site:ModelName 109 | Raises: 110 | CtbRecRequestFailed 111 | """ 112 | ml = self.send_request(url='/rec', data={'action': 'listOnline' if online else 'list'})['models'] 113 | return {self.model_id(m): m for m in ml} 114 | 115 | def get_model_status(self) -> Mapping[str, str]: 116 | """ 117 | Get status code for all models 118 | 119 | Returns: dict with status for each Site:Model. Status can be one of 120 | ["recording", "online", "offline", "paused", "later"] 121 | Raises: 122 | CtbRecRequestFailed 123 | """ 124 | m = self.get_models() 125 | o = self.get_models(online=True) 126 | r = self.get_recordings() 127 | result = dict.fromkeys(m.keys(), 'offline') 128 | result.update(dict.fromkeys(o.keys(), 'online')) 129 | result.update(dict.fromkeys({self.model_id(i['model']) for i in r if i['status'] == 'RECORDING'}, 'recording')) 130 | result.update(dict.fromkeys({k for k, v in m.items() if v['bookmarked']}, 'later')) 131 | result.update(dict.fromkeys({k for k, v in m.items() if v['suspended']}, 'paused')) 132 | return result 133 | 134 | def add_model(self, model: Union[str, dict], props: dict = None) -> dict: 135 | """ 136 | Add a model to the server 137 | 138 | Args: 139 | model: one of [url[str], Site:Name[str], ModelDict[dict]] 140 | props: optional dict of one or more model definition items to update in model. These can include; 141 | 'priority' (integer), 'bookmarked' (True|False), 'suspended' (True|False), 142 | 'recordUntil' (int), 'recordUntilSubsequentAction' (string). 143 | Returns: 144 | The model dict if successfully added 145 | Raises: 146 | CtbRecInvalidModelDefinition 147 | CtbRecNotFound 148 | CtbRecRequestFailed 149 | """ 150 | if props: 151 | props = self.parse_model_props(props) 152 | 153 | # determine model specification type 154 | mt = self.parse_model_type(model) 155 | if mt == self.ModelType.model_dict: 156 | model = self.parse_model_props(model) 157 | if props: 158 | model.update(props) 159 | data = {'action': 'start', 'model': model} 160 | elif mt == self.ModelType.site_name: 161 | data = {'action': 'startByName', 'model': {"type": None, "name": "", "url": model}} 162 | elif mt == self.ModelType.url: 163 | data = {'action': 'startByUrl', 'model': {"type": None, "name": "", "url": model}} 164 | else: 165 | data = {} # should never reach here because parse_model_type will raise an exception 166 | # query the server 167 | self.send_request("/rec", data=data) 168 | # retrieve model back from server 169 | m = self.find_model(model) 170 | # update model dict with optional additional properties 171 | if props and mt != self.ModelType.model_dict: 172 | m = self.update_model(m, props) 173 | return m 174 | 175 | def add_models(self, models: list[Union[str, dict]], props: dict = None) -> list: 176 | """ 177 | suspended=False, later=False, stop_action = 'PAUSE', 178 | 179 | Add a list of models to the server, catching any exceptions 180 | 181 | Args: 182 | models: a list of model definitions - one of [url[str], Site:Name[str], ModelDict[dict]] 183 | props: optional dict of one or more model definition items that will be applied to all models. 184 | These can include; 185 | 'priority' (int), 'bookmarked' (bool), 'suspended' (bool), 186 | 'recordUntil' (int|datetime), 'recordUntilSubsequentAction' (str). 187 | Returns: 188 | A list of any models successfully added 189 | """ 190 | models_added = [] 191 | for m in models: 192 | try: 193 | models_added.append(self.add_model(m, props)) 194 | except (CtbRecRequestFailed, CtbRecInvalidModelDefinition) as error: 195 | warnings.warn(f'Unable to add {m} to server: {error}') 196 | except CtbRecNotFound: 197 | warnings.warn(f'{m} added but could not be matched on server') 198 | return models_added 199 | 200 | def update_model(self, model: Union[str, dict], props: dict) -> dict: 201 | """ Update properties for an existing model on the server 202 | 203 | Args: 204 | model: one of [url[str], Site:Name[str], ModelDict[dict]] 205 | props: dict of one or more model definition items to update in model. These can include; 206 | 'priority' (int), 'bookmarked' (bool), 'suspended' (bool), 207 | 'recordUntil' (int|datetime), 'recordUntilSubsequentAction' (str). 208 | Returns: 209 | The updated model dict 210 | Raises: 211 | CtbRecInvalidModelDefinition 212 | CtbRecNotFound 213 | CtbRecRequestFailed 214 | """ 215 | props = self.parse_model_props(props) 216 | mt = self.parse_model_type(model) 217 | m = model if mt == self.ModelType.model_dict else self.find_model(model) 218 | invalid_keys = [k for k in props if k not in m] 219 | if invalid_keys: 220 | warnings.warn(f'Invalid properties {",".join(invalid_keys)} will be ignored.') 221 | p = {k: v for k, v in props.items() if k in m} 222 | if m and p: 223 | m.update(p) 224 | self.send_request("/rec", data={"action": "start", "model": m}) 225 | return self.find_model(m) 226 | warnings.warn("Failed to update model properties") 227 | return dict() 228 | 229 | def remove_model(self, model: Union[str, dict]): 230 | """ Delete a model from recording list on the server 231 | 232 | Args: 233 | model: one of [url[str], Site:Name[str], ModelDict[dict]] 234 | Raises: 235 | CtbRecInvalidModelDefinition 236 | CtbRecNotFound 237 | CtbRecRequestFailed 238 | """ 239 | self.send_request(url='/rec', data={"action": "stop", "model": self.find_model(model)}) 240 | 241 | def remove_models(self, models: list[Union[str, dict]]) -> list[Union[str, dict]]: 242 | """ Delete a list of models from the server, catching any exceptions 243 | 244 | Args: 245 | models: list of models where elements must be one of [url[str], Site:Name[str], ModelDict[dict]] 246 | Returns: 247 | a list of any input models that failed to be removed 248 | """ 249 | failed = [] 250 | for m in models: 251 | try: 252 | self.remove_model(m) 253 | except (CtbRecRequestFailed, CtbRecInvalidModelDefinition, CtbRecNotFound) as error: 254 | failed.append(m) 255 | warnings.warn(f'Unable to remove {m} from server: {error}') 256 | return failed 257 | 258 | def find_model(self, model: Union[str, dict]) -> dict: 259 | """ get an existing model on the server by matching model input 260 | 261 | Args: 262 | model: string|dict - a ctbrec model definition 263 | Returns: 264 | model dict if model found on server 265 | Raises: 266 | CtbRecInvalidModelDefinition 267 | CtbRecNotFound 268 | CtbRecRequestFailed 269 | """ 270 | models = self.get_models() 271 | mt = self.parse_model_type(model) 272 | if mt == self.ModelType.model_dict: 273 | match = [m for m in models.values() if m['type'] == model['type'] and m['name'] == model['name']] 274 | elif mt == self.ModelType.url: 275 | match = [m for m in models.values() if self.url_match(m['url'], model)] 276 | elif mt == self.ModelType.site_name and model in models: 277 | match = [models[model]] 278 | else: 279 | match = [] 280 | if match: 281 | return match[0] 282 | raise CtbRecNotFound("Requested model could not be found on server.") 283 | 284 | # ----------------------------------------- model group methods ---------------------------------------------------- 285 | def get_model_groups(self) -> Mapping[str, dict]: 286 | """ 287 | Get a dict of all model groups currently on the server 288 | 289 | Returns: 290 | dict keyed by group-name, containing all model group dicts on the server. Model groups contain keys 291 | ["name", "modelUrls", "id"] 292 | """ 293 | g = self.send_request(url='/rec', data={'action': 'listModelGroups'})['groups'] 294 | return {v['name']: v for v in g} 295 | 296 | def delete_model_group(self, group: Union[dict, str]): 297 | """ 298 | Delete a model group from the server 299 | 300 | Args: 301 | group: a group dict, or group name identifying the group to be deleted 302 | Raises: 303 | CtbRecNotFound 304 | CtbRecRequestFailed 305 | """ 306 | if isinstance(group, str): 307 | g = self.find_model_group(group) 308 | else: 309 | g = group 310 | self.send_request(url='/rec', data={'action': 'deleteModelGroup', 'modelGroup': g}) 311 | 312 | def save_model_group(self, group: dict): 313 | """ 314 | Save a model group to the server. This will overwrite any existing information in the group. 315 | 316 | Args: 317 | group: the group dict to be saved 318 | Raises: 319 | CtbRecRequestFailed 320 | """ 321 | self.send_request(url='/rec', data={'action': 'saveModelGroup', 'modelGroup': group}) 322 | 323 | def add_models_to_group(self, group: Union[dict, str], model_list: list[Union[dict, str]]) -> dict: 324 | """ 325 | Add models to an existing model group. 326 | 327 | Args: 328 | group: either a group name or a group dict, specifying an existing model group that is to be updated. 329 | model_list: a list of models where list items can be either au url string, or a model dict. 330 | Returns: 331 | The updated model group retrieved back from the server 332 | Raises: 333 | CtbRecNotFound 334 | CtbRecRequestFailed 335 | """ 336 | if isinstance(group, str): 337 | group = self.find_model_group(group) 338 | ml = {m if isinstance(m, str) else m['url'] for m in model_list} 339 | group['modelUrls'].extend(list(ml)) 340 | self.save_model_group(group) 341 | return self.get_model_groups()[group['name']] 342 | 343 | def remove_models_from_group(self, group: Union[dict, str], model_list: list[Union[dict, str]]): 344 | """ 345 | Remove models from an existing model group. 346 | 347 | Args: 348 | group: either a group name or a group dict, specifying an existing model group that is to be updated. 349 | model_list: a list of models where list items can be either an url string, or a model dict. 350 | Returns: 351 | The updated model group retrieved back from the server 352 | Raises: 353 | CtbRecNotFound 354 | CtbRecRequestFailed 355 | """ 356 | if isinstance(group, str): 357 | group = self.find_model_group(group) 358 | ml = {m if isinstance(m, str) else m['url'] for m in model_list} 359 | group['modelUrls'] = [m for m in group['modelUrls'] if m not in ml] 360 | self.save_model_group(group) 361 | return self.get_model_groups()[group['name']] 362 | 363 | def create_model_group(self, name: str, model_list: list) -> dict: 364 | """ 365 | Create a new model group on the server 366 | 367 | Args: 368 | name: a string specifying name of the new group. Must be unique. 369 | model_list: a list of models where list items can be either an url string, or a model dict 370 | Returns: 371 | dict containing keys 'status' ('success' or 'fail') and 'msg' 372 | Raises: 373 | CtbRecAlreadyExists 374 | CtbRecRequestFailed 375 | CtbRecNotFound 376 | """ 377 | groups = self.get_model_groups() 378 | if name in groups: 379 | raise CtbRecAlreadyExists(f'Model group {name} already exists') 380 | ml = {m if isinstance(m, str) else m['url'] for m in model_list} # use set to reduce to unique urls 381 | self.save_model_group({"name": name, 'modelUrls': list(ml), 'id': uuid.uuid4().__str__()}) 382 | return self.get_model_groups()[name] 383 | 384 | def find_model_group(self, name: str) -> dict: 385 | """ 386 | Retrieve an existing model group from the server by name 387 | 388 | Args: 389 | name: a string specifying name of the new group. 390 | Returns: 391 | Model-group dict 392 | Raises: 393 | CtbRecNotFound 394 | CtbRecRequestFailed 395 | """ 396 | groups = self.get_model_groups() 397 | if name in groups: 398 | return groups[name] 399 | raise CtbRecNotFound(f'Model group {name} could not be found on the server') 400 | 401 | # --------------------------------------- recording methods ------------------------------------------------------- 402 | def get_recordings(self) -> list[dict]: 403 | """ 404 | Get a list of all recordings from the server 405 | 406 | Returns: 407 | list of recording dicts 408 | Raises: 409 | CtbRecRequestFailed 410 | """ 411 | return self.send_request(url='/rec', data={'action': 'recordings'})['recordings'] 412 | 413 | def delete_recording(self, recording: dict): 414 | """ 415 | **Permanently** delete a recoding on server 416 | 417 | Raises: 418 | CtbRecRequestFailed 419 | """ 420 | self.send_request(url='/rec', data={'action': 'delete', 'recording': recording}) 421 | 422 | def pin_recording(self, recording: dict): 423 | """ 424 | Pin a recoding on the server 425 | 426 | Raises: 427 | CtbRecRequestFailed 428 | """ 429 | self.send_request(url='/rec', data={'action': 'pin', 'recording': recording}) 430 | 431 | def unpin_recording(self, recording: dict): 432 | """ 433 | Unpin a recoding on the server 434 | 435 | Raises: 436 | CtbRecRequestFailed 437 | """ 438 | self.send_request(url='/rec', data={'action': 'unpin', 'recording': recording}) 439 | 440 | def annotate_recording(self, recording: dict, note: str): 441 | """ 442 | Add a note to a recoding on the server 443 | 444 | Raises: 445 | CtbRecRequestFailed 446 | """ 447 | recording['note'] = note 448 | self.send_request(url='/rec', data={'action': 'setNote', 'recording': recording}) 449 | 450 | def rerun_post_process(self, recording: dict): 451 | """ 452 | Rerun post-processing for a recording 453 | 454 | Raises: 455 | CtbRecRequestFailed 456 | """ 457 | self.send_request(url='/rec', data={'action': 'rerunPostProcessing', 'recording': recording}) 458 | 459 | # --------------------------------------- general server methods --------------------------------------------------- 460 | def get_settings(self) -> list: 461 | """ Get current server settings 462 | 463 | Returns: 464 | list of current server settings 465 | Raises: 466 | CtbRecRequestFailed 467 | """ 468 | return self.send_request(url='/config') 469 | 470 | def update_settings(self, settings: Union[dict, list]) -> list: 471 | """ Update server config settings 472 | 473 | Args: 474 | settings: either a dict of key-value pairs where keys must be valid ctbrec setting keys and values must 475 | conform to expected type, or a list of ctbrec settings. 476 | Returns: 477 | list of server settings after updates have been applied 478 | Raises: 479 | CtbRecRequestFailed 480 | """ 481 | if isinstance(settings, dict): 482 | data = {s['key']: s for s in self.get_settings()} 483 | for k in settings: 484 | if k not in data.keys(): 485 | warnings.warn(f'{k} is not a valid settings key and will be ignored') 486 | data[k]['value'] = settings[k] 487 | data = list(data.values()) 488 | else: 489 | data = settings 490 | self.send_request(url='/config', data=data) 491 | return self.get_settings() 492 | 493 | def get_space(self) -> dict: 494 | """ Get drive space statistics from server 495 | 496 | Returns: 497 | dict of drive space statistics 498 | Raises: 499 | CtbRecRequestFailed 500 | """ 501 | return self.send_request(url='/rec', data={'action': 'space'}) 502 | 503 | def get_summary(self) -> dict: 504 | """ Get summary of server activity 505 | 506 | Returns: 507 | dict of drive space statistics 508 | Raises: 509 | CtbRecRequestFailed 510 | """ 511 | models = self.get_models() 512 | paused = len([m for m in models.values() if m['suspended']]) 513 | later = len([m for m in models.values() if m['bookmarked']]) 514 | online = len(self.get_models(online=True)) 515 | recordings = self.get_recordings() 516 | recording = len([r for r in recordings if r['status'] == 'RECORDING']) 517 | post_process = len([r for r in recordings if r['status'] == 'POST_PROCESSING']) 518 | space = self.get_space() 519 | return {"total_models": len(models), "models_recording": recording, "models_online": online, 520 | "models_paused": paused, "models_bookmarked": later, "total_recordings": len(recordings), 521 | "post_processing": post_process, 522 | "space_used": f"{round((space['spaceTotal']-space['spaceFree'])/1e9,3)} GB", 523 | "space_free": f"{round(space['spaceFree']/1e9,3)} GB"} 524 | 525 | def pause_recording(self): 526 | """ Suspend all recoding on the server 527 | 528 | Raises: 529 | CtbRecRequestFailed 530 | """ 531 | self.send_request(url='/rec', data={'action': 'pauseRecorder'}) 532 | 533 | def resume_recording(self): 534 | """ Resume all recoding on the server 535 | 536 | Raises: 537 | CtbRecRequestFailed 538 | """ 539 | self.send_request(url='/rec', data={'action': 'resumeRecorder'}) 540 | 541 | 542 | # ------------------------------------------- internal methods ----------------------------------------------------- 543 | def type_to_site(self, model_type: str) -> str: 544 | """ 545 | Get ctbrec site code from ctbrec site class name 546 | 547 | Args: 548 | model_type: str containing ctbrec model type code 549 | """ 550 | return re.findall(self.regex['model_type'], model_type)[0] 551 | 552 | def parse_model_props(self, props: dict) -> dict: 553 | """ 554 | Process model properties. At the moment this only adjusts 'recordUntil' if it is specified as a datetime or 555 | in hours. 556 | 557 | Args: 558 | props: dict containing model properties 559 | Returns: 560 | model dict after converting recordUntil to a timestamp 561 | """ 562 | p = props 563 | if p and 'recordUntil' in p: 564 | record_until = p['recordUntil'] 565 | if isinstance(record_until, datetime): 566 | p['recordUntil'] = round(record_until.timestamp()*1000) 567 | elif isinstance(record_until, int) and record_until < 10000: # assume it is specified in hours 568 | p['recordUntil'] = round(datetime.now().timestamp()*1000 + record_until*3600000) 569 | return p 570 | 571 | def model_id(self, model: dict) -> str: 572 | """ 573 | Get model id from model dict. Id is Site:ModelName 574 | 575 | Args: 576 | model: ctbrec model dict 577 | """ 578 | return re.findall(self.regex['model_type'], model['type'])[0] + ':' + model['name'] 579 | 580 | def url_match(self, url1: str, url2: str) -> bool: 581 | """ Check if two urls match, either exact match or by top level domain and name 582 | 583 | This makes the assumption that model name is the last string in the url, which seems to be the case at the 584 | moment, may not always be true in the future 585 | """ 586 | u1 = url1.strip().rstrip('/') 587 | u2 = url2.strip().rstrip('/') 588 | if u1 == u2: 589 | return True 590 | u1g = re.findall(self.regex['domain_name'], u1)[0] 591 | u2g = re.findall(self.regex['domain_name'], u2)[0] 592 | return u1g[1] == u2g[1] and u1g[3] == u2g[3] 593 | 594 | def parse_model_type(self, model: Union[str, dict]) -> ModelType: 595 | """ Determine model request type from model input """ 596 | if isinstance(model, dict) and all(k in model for k in ['type', 'name', 'url']): 597 | return self.ModelType.model_dict 598 | elif isinstance(model, str) and re.match(self.regex['url'], model): 599 | return self.ModelType.url 600 | elif isinstance(model, str) and re.match(self.regex['site_name'], model): 601 | return self.ModelType.site_name 602 | raise CtbRecInvalidModelDefinition("Model must be one of [url[str], Site:Name[str], ModelDict[dict]]") 603 | 604 | def send_request(self, url: str, data: Optional[Union[dict, list]] = None) -> Union[dict, list]: 605 | """ Send a request to the ctbrec server 606 | 607 | Args: 608 | url: string - relative url for the request, eg. '/rec' 609 | data: dict - payload to send to server. If None then GET will be used rather than POST 610 | Return: 611 | server result data structure 612 | Raises: 613 | CtbRecRequestFailed 614 | """ 615 | data_str = '' if data is None else json.dumps(data) 616 | data_hmac = hmac.new(self.hmac_key, data_str.encode('utf-8'), hashlib.sha256).hexdigest() 617 | self.session.headers.update({'CTBREC-HMAC': data_hmac}) 618 | if data is None: 619 | result = self.session.get(self.server_url + url) 620 | else: 621 | result = self.session.post(self.server_url+url, data=data_str) 622 | if result.status_code == 200: 623 | result_json = json.loads(result.text) 624 | if isinstance(result_json, dict) and result_json['status'] != "success": 625 | raise CtbRecRequestFailed(f"Request failed: {result_json['msg']}") 626 | else: 627 | return result_json 628 | else: 629 | raise CtbRecRequestFailed(f'HTTP error: {result.status_code} : {result.reason} : {result.text}') 630 | -------------------------------------------------------------------------------- /rootfs/app/defaults/server.json: -------------------------------------------------------------------------------- 1 | { 2 | "amateurTvUsername" : "", 3 | "amateurTvPassword" : "", 4 | "bongacamsBaseUrl" : "https://bongacams.com", 5 | "bongaPassword" : "", 6 | "bongaUsername" : "", 7 | "cam4Password" : "", 8 | "cam4Username" : "", 9 | "camsodaPassword" : "", 10 | "camsodaUsername" : "", 11 | "chaturbatePassword" : "", 12 | "chaturbateUsername" : "", 13 | "chaturbateBaseUrl" : "https://chaturbate.com", 14 | "chaturbateMsBetweenRequests" : 1000, 15 | "cherryTvPassword" : "", 16 | "cherryTvUsername" : "", 17 | "chooseStreamQuality" : false, 18 | "colorAccent" : "#FFFFFF", 19 | "colorBase" : "#FFFFFF", 20 | "concurrentRecordings" : 0, 21 | "confirmationForDangerousActions" : false, 22 | "contactsheetTimestampLook" : "font=sans-serif:fontcolor=white:fontsize=60:box=1:boxcolor=black@0.5:boxborderw=5", 23 | "dateTimeFormat" : "", 24 | "defaultPriority" : 50, 25 | "deleteOrphanedRecordingMetadata" : true, 26 | "determineResolution" : false, 27 | "disabledSites" : [ ], 28 | "downloadFilename" : "$sanitize(${modelName})_$sanitize(${siteName})_$format(${localDateTime},yyyyMMdd-HHmmss)", 29 | "eventHandlers" : [ ], 30 | "eventsSuspended" : false, 31 | "fastScrollSpeed" : true, 32 | "fc2livePassword" : "", 33 | "fc2liveUsername" : "", 34 | "ffmpegMergedDownloadArgs" : "-c:v copy -c:a copy -movflags faststart -y -f mpegts", 35 | "ffmpegFileSuffix" : "ts", 36 | "flirt4freePassword" : null, 37 | "flirt4freeUsername" : null, 38 | "fontFamily" : "Sans-Serif", 39 | "fontSize" : 14, 40 | "hlsdlExecutable" : "", 41 | "httpPort" : 8080, 42 | "httpSecurePort" : 8443, 43 | "httpServer" : "0.0.0.0", 44 | "httpTimeout" : 10000, 45 | "httpUserAgent" : "Mozilla/5.0 (X11; Linux i686; rv:109.0) Gecko/20100101 Firefox/121.0", 46 | "httpUserAgentMobile" : "Mozilla/5.0 (Android 14; Mobile; rv:109.0) Gecko/121.0 Firefox/121.0", 47 | "key" : null, 48 | "ignoredModels" : [ ], 49 | "lastDownloadDir" : "", 50 | "livejasminBaseUrl" : "https://www.livejasmin.com", 51 | "livejasminBetaAcknowledged" : true, 52 | "livejasminPassword" : "", 53 | "livejasminUsername" : "", 54 | "livePreviews" : false, 55 | "localRecording" : true, 56 | "logFFmpegOutput" : false, 57 | "loghlsdlOutput" : false, 58 | "logMissedSegments" : true, 59 | "minimumResolution" : 0, 60 | "maximumResolution" : 8640, 61 | "maximumResolutionPlayer" : 0, 62 | "mediaPlayer" : "/usr/bin/mpv", 63 | "mediaPlayerParams" : "", 64 | "browserOverride" : "", 65 | "browserParams" : "", 66 | "forceBrowserOverride" : false, 67 | "mfcBaseUrl" : "https://www.myfreecams.com", 68 | "mfcDisabledModelsTableColumns" : [ ], 69 | "mfcModelsTableColumnIds" : [ ], 70 | "mfcModelsTableColumnWidths" : [ ], 71 | "mfcModelsTableFilter" : "", 72 | "mfcModelsTableSortColumn" : "", 73 | "mfcModelsTableSortType" : "", 74 | "mfcPassword" : "", 75 | "mfcUsername" : "", 76 | "minimizeToTray" : false, 77 | "minimumLengthInSeconds" : 0, 78 | "minimumSpaceLeftInBytes" : 0, 79 | "models" : [ ], 80 | "modelGroups" : [ ], 81 | "modelNotes" : { }, 82 | "modelPortraits" : { }, 83 | "modelsIgnored" : [ ], 84 | "monitorClipboard" : false, 85 | "onlineCheckIntervalInSecs" : 60, 86 | "onlineCheckSkipsPausedModels" : true, 87 | "overviewUpdateIntervalInSecs" : 60, 88 | "password" : "", 89 | "postProcessing" : "", 90 | "playlistRequestTimeout" : 2000, 91 | "postProcessingThreads" : 1, 92 | "postProcessors" : [ { 93 | "type" : "ctbrec.recorder.postprocessing.Script", 94 | "enabled" : true, 95 | "config" : { 96 | "script.params" : "", 97 | "script.executable" : "/app/dopp.sh" 98 | } 99 | }, { 100 | "type" : "ctbrec.recorder.postprocessing.Script", 101 | "enabled" : true, 102 | "config" : { 103 | "script.params" : "${absolutePath}", 104 | "script.executable" : "/app/plcheck.sh" 105 | } 106 | }, { 107 | "type" : "ctbrec.recorder.postprocessing.Remux", 108 | "enabled" : true, 109 | "config" : { 110 | "ffmpeg.args" : "-c:v copy -c:a copy -y -f matroska", 111 | "file.ext" : "mkv" 112 | } 113 | }, { 114 | "type" : "ctbrec.recorder.postprocessing.Rename", 115 | "enabled" : true, 116 | "config" : { 117 | "filename.template" : "$sanitize(${modelName})_$sanitize(${siteName})_$format(${localDateTime},yyyyMMdd-HHmmss).${fileSuffix}" 118 | } 119 | }, { 120 | "type" : "ctbrec.recorder.postprocessing.CreateContactSheet", 121 | "enabled" : true, 122 | "config" : { 123 | "padding" : "2", 124 | "burn_in_timestamp" : "true", 125 | "filename" : "$sanitize(${modelName})_$sanitize(${siteName})_$format(${localDateTime},yyyyMMdd-HHmmss).jpg", 126 | "columns" : "8", 127 | "background" : "0x333333", 128 | "total_size" : "2560", 129 | "rows" : "7" 130 | } 131 | } ], 132 | "proxyHost" : null, 133 | "proxyPassword" : null, 134 | "proxyPort" : null, 135 | "proxyType" : "DIRECT", 136 | "proxyUser" : null, 137 | "recentlyWatched" : true, 138 | "recordLaterTableColumnOrder" : [ ], 139 | "recordLaterTableColumnVisibility" : { }, 140 | "recordLaterTableColumnWidth" : { }, 141 | "recordLaterTableSortColumn" : "", 142 | "recordLaterTableSortType" : "", 143 | "recordedModelsTableColumnOrder" : [ ], 144 | "recordedModelsTableColumnVisibility" : { }, 145 | "recordedModelsTableColumnWidth" : { }, 146 | "recordedModelsTableSortColumn" : "", 147 | "recordedModelsPerSite" : false, 148 | "recordedModelsTableSortType" : "", 149 | "recordingsTableColumnOrder" : [ ], 150 | "recordingsTableColumnVisibility" : { }, 151 | "recordingsTableColumnWidth" : { }, 152 | "recordingsTableSortColumn" : "", 153 | "recordingsTableSortType" : "", 154 | "recordingsDir" : "/app/captures", 155 | "recordingsDirStructure" : "ONE_PER_MODEL", 156 | "recordLater" : [ ], 157 | "recordSingleFile" : false, 158 | "recordUntilDefaultDurationInMinutes" : 1440, 159 | "removeRecordingAfterPostProcessing" : false, 160 | "requireAuthentication" : false, 161 | "segmentErrorMeasurePeriodInSecs" : 20, 162 | "segmentErrorThresholdToStopRecording" : 5, 163 | "servletContext" : "", 164 | "showActiveRecordingsInTray" : true, 165 | "showActiveRecordingsInTrayColor" : "#FFFFFF", 166 | "showActiveRecordingsInTrayFont" : "SansSerif", 167 | "showActiveRecordingsInTrayFontSize" : 48, 168 | "showGridLinesInTables" : true, 169 | "showPlayerStarting" : false, 170 | "showupUsername" : "", 171 | "showupPassword" : "", 172 | "singlePlayer" : true, 173 | "splitRecordings" : 0, 174 | "splitStrategy" : "DONT", 175 | "splitRecordingsAfterSecs" : 0, 176 | "splitRecordingsBiggerThanBytes" : 0, 177 | "startTab" : "Settings", 178 | "startMinimized" : false, 179 | "streamatePassword" : "", 180 | "streamateUsername" : "", 181 | "stripchatUsername" : "", 182 | "stripchatPassword" : "", 183 | "stripchatUseXhamster" : false, 184 | "tabOrder" : [ "Amateur.tv", "BongaCams", "Cam4", "CamSoda", "Chaturbate", "CherryTV", "DreamCam", "FC2Live", "Flirt4Free", "LiveJasmin", "MV Live", "MyFreeCams", "SecretFriends", "Showup.tv", "Streamate", "Stripchat", "Streamray", "WinkTv", "XloveCam", "Recording", "Recordings", "Settings", "News", "Donate", "Help", "Logging" ], 185 | "tabsSortable" : true, 186 | "timeoutRecordingStartingAt" : "00:00:00", 187 | "timeoutRecordingEndingAt" : "00:00:00", 188 | "totalModelCountInTitle" : false, 189 | "transportLayerSecurity" : true, 190 | "thumbWidth" : 180, 191 | "updateThumbnails" : false, 192 | "useHlsdl" : false, 193 | "username" : "", 194 | "windowHeight" : 800, 195 | "windowMaximized" : false, 196 | "windowWidth" : 1340, 197 | "windowX" : 0, 198 | "windowY" : 0, 199 | "webinterface" : true, 200 | "webinterfaceUsername" : "ctbrec", 201 | "webinterfacePassword" : "sucks", 202 | "xlovecamUsername" : "", 203 | "xlovecamPassword" : "", 204 | "stripchatVR" : false, 205 | "streamrayRecordGoalShows" : false, 206 | "checkForUpdates" : true, 207 | "thumbCacheSize" : 16, 208 | "dreamcamVR" : true, 209 | "filterBlacklist" : "", 210 | "filterWhitelist" : "", 211 | "checkResolutionByMinSide" : false, 212 | "restrictBitrate" : 0 213 | } -------------------------------------------------------------------------------- /rootfs/app/dopp.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # dopp.sh 3 | # Defers post-processing if file /app/config/dopp does not exist by failing 4 | 5 | [[ -f "/app/config/dopp" ]] || exit 1 6 | -------------------------------------------------------------------------------- /rootfs/app/healthcheck.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | port=`grep -Po '"httpPort":\s(\d+)' "/app/config/${CTBVER}/server.json" | grep -Po '(\d+)$'` 3 | 4 | curl -f http://localhost:$port || exit 1 5 | -------------------------------------------------------------------------------- /rootfs/app/init.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh -e 2 | # Added updates by @tigobitties 3 | 4 | echo "`date '+%T.%3N'` [Start]" 5 | # Grab passed env variables or set defaults 6 | PUID="${PUID:-1000}" 7 | PGID="${PGID:-1000}" 8 | TZ="${TZ:-UTC}" 9 | 10 | # Set the home directory 11 | export HOME=/app 12 | 13 | echo "`date '+%T.%3N'` [Group]" 14 | # Use existing group if GID exists, create ctbrec if not 15 | if [ $(getent group ${PGID} | cut -d: -f3) ]; then 16 | grp="$(getent group ${PGID} | cut -d: -f1)" 17 | else 18 | addgroup --gid "${PGID}" --system ctbrec 19 | grp="ctbrec" 20 | fi 21 | 22 | echo "`date '+%T.%3N'` [User]" 23 | # Use existing user if UID exists, create ctbrec if not 24 | if [ $(getent passwd ${PUID} | cut -d: -f1) ]; then 25 | usr="$(getent passwd ${PUID} | cut -d: -f1)" 26 | else 27 | adduser --disabled-password --gecos "" --no-create-home --home "${HOME}" --ingroup "${grp}" --uid "${PUID}" ctbrec 28 | usr="ctbrec" 29 | fi 30 | 31 | echo "`date '+%T.%3N'` [Directories]" 32 | # Set the owner/permissions of the home directory 33 | if ! chown -R $PUID:$PGID "$HOME" 2>/dev/null; then 34 | echo - unable to change ownership of $HOME 35 | fi 36 | su -p $usr -c "chmod -R a+rwx,g+s $HOME" || true 37 | 38 | # Loop while an internet connection is not available 39 | echo "`date '+%T.%3N'` [Internet]" 40 | while ! ping -qc1 -W5 dns.google >/dev/null 2>&1 41 | do 42 | echo "`date '+%T.%3N'` [Internet failed]: Waiting 30 seconds ..." 43 | sleep 30 44 | done 45 | 46 | echo "`date '+%T.%3N'` [CTBRec]" 47 | # Start CTBRec as the user 48 | su -p -c "${HOME}/start.sh" ${usr} 49 | -------------------------------------------------------------------------------- /rootfs/app/note2txt.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # note2txt.sh ${absolutePath} ${modelName} ${siteName} ${modelNotes} [${recordingNotes}|"Misc text"] 3 | txtfile="${1%.*}.txt" 4 | model=$2 5 | site=$3 6 | modnote=$4 7 | recnote=$5 8 | 9 | { 10 | echo "Model: $model Site: $site" 11 | echo "Model notes:" 12 | [ -n "$modnote" ] && echo "$modnote" || echo "None" 13 | echo "Other notes:" 14 | [ -n "$recnote" ] && echo "$recnote" || echo "None" 15 | } > "$txtfile" 16 | -------------------------------------------------------------------------------- /rootfs/app/plcheck.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # Server non-single file use only. 3 | # plcheck.sh ${absolutePath} 4 | 5 | [[ -d "${1}" ]] && [[ -f "${1%/}/playlist.m3u8" ]] && echo "#EXT-X-ENDLIST" >> "${1%/}/playlist.m3u8" || exit 0 6 | -------------------------------------------------------------------------------- /rootfs/app/reclaim.py: -------------------------------------------------------------------------------- 1 | #!/bin/python3 2 | 3 | from ctbrec import CtbRec 4 | import os 5 | import time 6 | 7 | srv_url=os.environ.get('SRVURL') 8 | srv_usr=os.environ.get('SRVUSR') 9 | srv_pss=os.environ.get('SRVPSS') 10 | recover=int(os.environ.get('RECOVER')) 11 | 12 | # Create CTBRec Python client instance 13 | ctb = CtbRec(server_url=srv_url, username=srv_usr, password=srv_pss) 14 | 15 | # Get disk space 16 | space=ctb.get_space() 17 | minspace=(space['spaceFree'] + recover) 18 | print('reclaim.py\nFree: ' + space['spaceFree'] + '\nRequired: ' + minspace) 19 | 20 | # Get recordings 21 | recordings = ctb.get_recordings() 22 | if recordings: 23 | index = 0 24 | for record in recordings: 25 | if not record['pinned'] and (record['status'] == 'FINISHED'): 26 | if ((ctb.get_space())['spaceFree'] < minspace): 27 | ctb.delete_recording(recordings[index]) 28 | print(record['metaDataFile'] + " - Deleted") 29 | time.sleep(2) 30 | index += 1 31 | -------------------------------------------------------------------------------- /rootfs/app/reclean.py: -------------------------------------------------------------------------------- 1 | #!/bin/python3 2 | import os 3 | from ctbrec import CtbRec 4 | 5 | srv_url=os.environ.get('SRVURL') 6 | srv_usr=os.environ.get('SRVUSR') 7 | srv_pss=os.environ.get('SRVPSS') 8 | # create CtbRec python client instance 9 | ctb = CtbRec(server_url=srv_url, username=srv_usr, password=srv_pss) 10 | 11 | # get recordings 12 | recordings = ctb.get_recordings() 13 | if recordings: 14 | print("Number of recordings:", len(recordings)) 15 | index = 0 16 | for record in recordings: 17 | if not os.path.exists(record['absoluteFile']): 18 | print(record['absoluteFile'] + " - " + record['status']) 19 | if record['status'] == 'FINISHED': 20 | ctb.delete_recording(recordings[index]) 21 | print(record['metaDataFile'] + " - Deleted") 22 | index += 1 23 | -------------------------------------------------------------------------------- /rootfs/app/send2discord.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # send2discord.sh ${absolutePath} [${modelDisplayName} ${localDateTime(yyyyMMdd-HHmmss)} ...] 4 | 5 | file="$1" 6 | sheet="${file%.*}.jpg" 7 | length=`/app/ffmpeg/ffmpeg -i "$file" 2>&1 | grep "Duration" | cut -d ' ' -f 4 | sed s/,// | sed 's@\..*@@g'` 8 | shift 9 | 10 | if [ -z "$1" ]; then 11 | content="Contact sheet" 12 | else 13 | content="$1" 14 | shift 15 | for i in $@ 16 | do 17 | content=`echo "${content} - ${i}"` 18 | done 19 | fi 20 | content=`echo "${content}: ${length}"` 21 | 22 | curl -F 'payload_json={"username": "CTBRec", "content":"'"$content"'"}' -F "file1=@$sheet" $DISCORDHOOK 23 | -------------------------------------------------------------------------------- /rootfs/app/send2email.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # send2email.sh ${absolutePath} [${modelDisplayName} ${localDateTime(yyyyMMdd-HHmmss)} ...] 4 | 5 | file="$1" 6 | sheet="${file%.*}.jpg" 7 | length=`/app/ffmpeg/ffmpeg -i "$file" 2>&1 | grep "Duration" | cut -d ' ' -f 4 | sed s/,// | sed 's@\..*@@g'` 8 | name=`basename $sheet` 9 | shift 10 | 11 | if [ -z "$1" ]; then 12 | content="Contact sheet" 13 | else 14 | content="$1" 15 | shift 16 | for i in $@ 17 | do 18 | content=`echo "${content} - ${i}"` 19 | done 20 | fi 21 | content=`echo "${content}: ${length}"` 22 | 23 | encoded=`base64 $sheet` 24 | 25 | echo -e "MIME-Version: 1.0\nSubject: $content\nContent-Type: multipart/mixed;\n boundary=\"Delimiter\"\n\n--Delimiter\nContent-Type: image/jpeg;\n name=$name\nContent-Disposition: attachment;\n filename=$name\nContent-Transfer-Encoding: base64\n\n$encoded\n--Delimiter--\n" > /app/captures/temp.txt 26 | 27 | curl --url "$MAILSERVER" --ssl-reqd --mail-from "$MAILFROM" --mail-rcpt "$MAILTO" --upload-file '/app/captures/temp.txt' --user "$MAILFROM:$MAILPASS" 28 | 29 | rm /app/captures/temp.txt -------------------------------------------------------------------------------- /rootfs/app/send2http.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # send2http.sh ${absolutePath} [${modelName} ${localDateTime(YYYYMMDD-HHmmss)} ...] 4 | 5 | file="$1" 6 | rel=`echo ${file} | cut -c 15-` 7 | sheet="${file%.*}.jpg" 8 | 9 | length=`/app/ffmpeg/ffmpeg -i "$file" 2>&1 | grep "Duration" | cut -d ' ' -f 4 | sed s/,// | sed 's@\..*@@g'` 10 | shift 11 | 12 | args=`echo $@ | base64` 13 | 14 | if [ -z ${CURL_GET} ]; then 15 | args="-F file=${rel} -F sheet=@$sheet -F duration=${length} -F argv=${args}" 16 | else 17 | args="-G --data-urlencode file=${rel} --data-urlencode duration=${length} --data-urlencode argv=${args}" 18 | fi 19 | 20 | curl ${args} ${CURL_ARGS} "${HTTP_URL}" -------------------------------------------------------------------------------- /rootfs/app/send2ntfy.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # send2ntfy.sh ${absolutePath} [${modelDisplayName} ${localDateTime(yyyyMMdd-HHmmss)} ...] 4 | 5 | file="$1" 6 | sheet="${file%.*}.jpg" 7 | length=`/app/ffmpeg/ffmpeg -i "$file" 2>&1 | grep "Duration" | cut -d ' ' -f 4 | sed s/,// | sed 's@\..*@@g'` 8 | shift 9 | 10 | if [ -z "$1" ]; then 11 | content="Contact sheet" 12 | else 13 | content="$1" 14 | shift 15 | for i in $@ 16 | do 17 | content=`echo "${content} - ${i}"` 18 | done 19 | fi 20 | content=`echo "${content}: ${length}"` 21 | 22 | curl -F 'payload_json={"username": "CTBRec", "content":"'"$content"'"}' -F "file1=@$sheet" $DISCORDHOOK 23 | -------------------------------------------------------------------------------- /rootfs/app/send2telegram.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # send2telegram.sh ${absolutePath} [${modelName} ${localDateTime(YYYYMMDD-HHmmss)} ...] 4 | 5 | file="$1" 6 | sheet="${file%.*}.jpg" 7 | length=`/app/ffmpeg/ffmpeg -i "$file" 2>&1 | grep "Duration" | cut -d ' ' -f 4 | sed s/,// | sed 's@\..*@@g'` 8 | shift 9 | 10 | if [ -z "$1" ]; then 11 | content="Contact sheet" 12 | else 13 | content="$1" 14 | shift 15 | for i in $@ 16 | do 17 | content=`echo "${content} - ${i}"` 18 | done 19 | fi 20 | content=`echo "${content}: ${length}"` 21 | 22 | curl --form photo=@$sheet --form caption="${content}" --form-string chat_id=$CHAT_ID "https://api.telegram.org/bot${TOKEN}/sendPhoto" 23 | -------------------------------------------------------------------------------- /rootfs/app/start.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh -e 2 | # Added updates by @tigobitties 3 | 4 | cd ${HOME} 5 | JAVA_HOME="/opt/java/openjdk" 6 | JAVA="/opt/java/openjdk/bin/java" 7 | 8 | # Copy default settings if it doesn't exist 9 | echo "`date '+%T.%3N'` [Defaults]" 10 | cp --verbose --no-clobber "/app/defaults/server.json" "/app/config/" 11 | chmod 666 /app/config/server.json 12 | 13 | # Enable post-processing by default 14 | [ ! -f "/app/config/dopp" ] && touch "/app/config/dopp" 15 | 16 | $JAVA -Xms256m -Xmx768m -cp ctbrec-server-$CTBVER-final.jar -Dfile.encoding=utf-8 -Dctbrec.config.dir=/app/config -Dctbrec.config=server.json ctbrec.recorder.server.HttpServer 17 | --------------------------------------------------------------------------------