From 4a74f295e78fd5276b12a453b72ec657e6ae4921 Mon Sep 17 00:00:00 2001 From: Blake Blackshear Date: Sat, 20 Feb 2021 07:47:25 -0600 Subject: [PATCH] docs updates --- docs/docs/installation.md | 1 + docs/docs/usage/api.md | 29 ++++++++++++++++++++++++++++- 2 files changed, 29 insertions(+), 1 deletion(-) diff --git a/docs/docs/installation.md b/docs/docs/installation.md index 6663f8e26..65f51021f 100644 --- a/docs/docs/installation.md +++ b/docs/docs/installation.md @@ -37,6 +37,7 @@ version: '3.9' services: frigate: container_name: frigate + privileged: true # this may not be necessary for all setups restart: unless-stopped image: blakeblackshear/frigate: devices: diff --git a/docs/docs/usage/api.md b/docs/docs/usage/api.md index af48e1581..b7fb4dbbc 100644 --- a/docs/docs/usage/api.md +++ b/docs/docs/usage/api.md @@ -118,7 +118,34 @@ Sample response: "service": { /* Uptime in seconds */ "uptime": 10, - "version": "0.8.0-8883709" + "version": "0.8.0-8883709", + /* Storage data in MB for important locations */ + "storage": { + "/media/frigate/clips": { + "total": 1000, + "used": 700, + "free": 300, + "mnt_type": "ext4", + }, + "/media/frigate/recordings": { + "total": 1000, + "used": 700, + "free": 300, + "mnt_type": "ext4", + }, + "/tmp/cache": { + "total": 256, + "used": 100, + "free": 156, + "mnt_type": "tmpfs", + }, + "/dev/shm": { + "total": 256, + "used": 100, + "free": 156, + "mnt_type": "tmpfs", + }, + } } } ```