浏览代码

Merge remote-tracking branch 'origin/master' into release-0.9.0

Blake Blackshear 3 年之前
父节点
当前提交
5a209caed3
共有 3 个文件被更改,包括 36 次插入9 次删除
  1. 20 0
      .github/ISSUE_TEMPLATE/feature_request.md
  2. 1 0
      docs/docs/configuration/optimizing.md
  3. 15 9
      docs/docs/usage/home-assistant.md

+ 20 - 0
.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Describe what you are trying to accomplish and why in non technical terms**
+I want to be able to ... so that I can ... 
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

+ 1 - 0
docs/docs/configuration/optimizing.md

@@ -14,6 +14,7 @@ title: Optimizing performance
 Frigate works on Raspberry Pi 3b/4 and x86 machines. It is recommended to update your configuration to enable hardware accelerated decoding in ffmpeg. Depending on your system, these parameters may not be compatible.
 
 Raspberry Pi 3/4 (32-bit OS)
+Ensure you increase the allocated RAM for your GPU to at least 128 (raspi-config > Performance Options > GPU Memory).
 **NOTICE**: If you are using the addon, ensure you turn off `Protection mode` for hardware acceleration.
 
 ```yaml

+ 15 - 9
docs/docs/usage/home-assistant.md

@@ -8,18 +8,18 @@ The best way to integrate with Home Assistant is to use the [official integratio
 
 ## Installation
 
-Available via HACS as a [custom repository](https://hacs.xyz/docs/faq/custom_repositories). To install:
+### Preparation
 
-- Add the custom repository:
+The Frigate integration requires the `mqtt` integration to be installed and
+manually configured first.
 
-```
-Home Assistant > HACS > Integrations > [...] > Custom Repositories
-```
+See the [MQTT integration
+documentation](https://www.home-assistant.io/integrations/mqtt/) for more
+details.
+
+### Integration installation
 
-| Key            | Value                                                       |
-| -------------- | ----------------------------------------------------------- |
-| Repository URL | https://github.com/blakeblackshear/frigate-hass-integration |
-| Category       | Integration                                                 |
+Available via HACS as a default repository. To install:
 
 - Use [HACS](https://hacs.xyz/) to install the integration:
 
@@ -38,6 +38,12 @@ Note: You will also need
 [media_source](https://www.home-assistant.io/integrations/media_source/) enabled
 in your Home Assistant configuration for the Media Browser to appear.
 
+### (Optional) Lovelace Card Installation
+
+To install the optional companion Lovelace card, please see the [separate
+installation instructions](https://github.com/dermotduffy/frigate-hass-card) for
+that card.
+
 ## Configuration
 
 When configuring the integration, you will be asked for the following parameters: