From 5b5159f4dddefd121262eddb78d174fc733a8146 Mon Sep 17 00:00:00 2001 From: Blake Blackshear Date: Sun, 20 Dec 2020 07:33:13 -0600 Subject: [PATCH] docs and issue template --- .github/ISSUE_TEMPLATE/bug_report.md | 17 +++++++++-------- README.md | 3 +++ 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index ac6fd3671..886b844d8 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,6 +1,6 @@ --- -name: Bug report -about: Create a report to help us improve +name: Bug report or Support request +about: '' title: '' labels: '' assignees: '' @@ -8,10 +8,10 @@ assignees: '' --- **Describe the bug** -A clear and concise description of what the bug is. +A clear and concise description of what your issue is. **Version of frigate** -What version are you using? +Output from `/version` **Config file** Include your full config file wrapped in triple back ticks. @@ -19,14 +19,14 @@ Include your full config file wrapped in triple back ticks. config here ``` -**Logs** +**Frigate container logs** ``` Include relevant log output here ``` -**Frigate debug stats** -``` -Output from frigate's /debug/stats endpoint +**Frigate stats** +```json +Output from frigate's /stats endpoint ``` **FFprobe from your camera** @@ -41,6 +41,7 @@ If applicable, add screenshots to help explain your problem. **Computer Hardware** - OS: [e.g. Ubuntu, Windows] + - Install method: [e.g. Addon, Docker Compose, Docker Command] - Virtualization: [e.g. Proxmox, Virtualbox] - Coral Version: [e.g. USB, PCIe, None] - Network Setup: [e.g. Wired, WiFi] diff --git a/README.md b/README.md index 844248848..25ec961bb 100644 --- a/README.md +++ b/README.md @@ -845,6 +845,9 @@ Sample response: ### `/config` A json representation of your configuration +### `/version` +Version info + ### `/events` Events from the database. Accepts the following query string parameters: |param|Type|Description|