Skip to content

A Docker container that periodically takes snapshots from your Ring cameras and then creates timelapse videos of the snapshots.

License

Notifications You must be signed in to change notification settings

wictorwilen/ring-timelapse

Repository files navigation

Ring Timelapse generator

A Docker container that periodically takes snapshots from your Ring cameras and then creates timelapse videos of the snapshots.

Docker Image Version (tag latest semver) MIT License

Features

  • Takes snapshots of all Ring cameras periodically, default 15 minutes
  • Creates a timelapse video periodically, default every day
  • Runs as a Docker container with minimal footprint

NOTE: Taking snapshots often will drain the battery faster than normal.

Installation

In order to run the Docker container you need a Ring refresh token. To generate the token use the following command:

npx -p ring-client-api ring-auth-cli

Use the following to pull the Docker container from Docker hub.

docker pull wictorwilen/ring-timelapse

Before starting the container, create a directory that will be shared with the container to persist the snapshots and timelapses, for instance:

cd /media
mkdir timelapse

Start the container by running:

docker run \
  -d \
  -e TOKEN="<insert token here>" \
  -v "/media/timelapse:/app/dist/target" \
  --restart unless-stopped \
  wictorwilen/ring-timelapse

NOTE: In the -v argument replace the local path (/media/timelapse) with the directory you created

Environment Variables

The following variables are required:

TOKEN - your generated Ring token, see Installation

The following variables are optional:

CRON_SCHEDULE - Schedule for taking snapshots, in Crontab format. Default: */15 * * * *

CRON_SCHEDULE_TIMELAPSE - Schedule for generating the timelapse video. Default: 0 7 * * *

Authors

License

MIT

About

A Docker container that periodically takes snapshots from your Ring cameras and then creates timelapse videos of the snapshots.

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project