https://github.com/wictorwilen/ring-timelapse
A Docker container that periodically takes snapshots from your Ring cameras and then creates timelapse videos of the snapshots.
https://github.com/wictorwilen/ring-timelapse
docker ring timelapse video
Last synced: 7 months ago
JSON representation
A Docker container that periodically takes snapshots from your Ring cameras and then creates timelapse videos of the snapshots.
- Host: GitHub
- URL: https://github.com/wictorwilen/ring-timelapse
- Owner: wictorwilen
- License: mit
- Created: 2021-05-04T06:18:02.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-25T04:18:37.000Z (about 1 year ago)
- Last Synced: 2024-10-12T08:29:40.869Z (about 1 year ago)
- Topics: docker, ring, timelapse, video
- Language: TypeScript
- Homepage:
- Size: 72.3 KB
- Stars: 26
- Watchers: 6
- Forks: 14
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Ring Timelapse generator
A Docker container that periodically takes snapshots from your [Ring](https://www.ring.com) cameras and then creates timelapse videos of the snapshots.
[](https://hub.docker.com/repository/docker/wictorwilen/ring-timelapse)
[](https://github.com/wictorwilen/ring-timelapse/blob/main/LICENSE.md)
## 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:
``` bash
npx -p ring-client-api ring-auth-cli
```
Use the following to pull the Docker container from Docker hub.
``` bash
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:
``` bash
cd /media
mkdir timelapse
```
Start the container by running:
``` bash
docker run \
-d \
-e TOKEN="" \
-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](https://linuxhandbook.com/crontab/). Default: `*/15 * * * *`
`CRON_SCHEDULE_TIMELAPSE` - Schedule for generating the timelapse video. Default: `0 7 * * *`
## Authors
- [@wictorwilen](https://www.github.com/wictorwilen)
## License
[MIT](https://choosealicense.com/licenses/mit/)