forked from hacs/documentation
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
45 changed files
with
2,112 additions
and
2,112 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| --- | ||
| id: data | ||
| title: Data | ||
| description: "HACS Data stores" | ||
| --- | ||
|
|
||
| --- | ||
| id: data | ||
| title: Data | ||
| description: "HACS Data stores" | ||
| --- | ||
|
|
||
| All data it handles are saved to `hacs.*` files that is located under `.storage` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,16 +1,16 @@ | ||
| --- | ||
| id: logs | ||
| title: Logs | ||
| description: "Logs" | ||
| --- | ||
|
|
||
| Like any other integration this logs to the `home-assistant.log` file. | ||
|
|
||
| To enable `debug` logging, add this to your `configuration.yaml`: | ||
|
|
||
| ```yaml | ||
| logger: | ||
| default: info | ||
| logs: | ||
| hacs: debug | ||
| ``` | ||
| --- | ||
| id: logs | ||
| title: Logs | ||
| description: "Logs" | ||
| --- | ||
|
|
||
| Like any other integration this logs to the `home-assistant.log` file. | ||
|
|
||
| To enable `debug` logging, add this to your `configuration.yaml`: | ||
|
|
||
| ```yaml | ||
| logger: | ||
| default: info | ||
| logs: | ||
| hacs: debug | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,27 +1,27 @@ | ||
| --- | ||
| id: updates | ||
| title: Updates | ||
| description: "Data updates" | ||
| --- | ||
|
|
||
| ## Installed elements | ||
|
|
||
| HACS will check for updates to installed elements: | ||
|
|
||
| - At startup. | ||
| - Every 30 minutes after HA startup. | ||
|
|
||
| ## Everything else | ||
|
|
||
| HACS will check for updates to every element: | ||
|
|
||
| - At startup | ||
| - Every 800 minutes after HA startup. | ||
|
|
||
| ## Manually trigger updates | ||
|
|
||
| You can also force a check by clicking the "RELOAD DATA" button under the "SETTINGS" tab _(This will force a reload of everything.)_ | ||
|
|
||
| Under the "SETTINGS" tab there is also a reload icon to the left of every custom repository you have added, clicking that will reload info for it. | ||
|
|
||
| --- | ||
| id: updates | ||
| title: Updates | ||
| description: "Data updates" | ||
| --- | ||
|
|
||
| ## Installed elements | ||
|
|
||
| HACS will check for updates to installed elements: | ||
|
|
||
| - At startup. | ||
| - Every 30 minutes after HA startup. | ||
|
|
||
| ## Everything else | ||
|
|
||
| HACS will check for updates to every element: | ||
|
|
||
| - At startup | ||
| - Every 800 minutes after HA startup. | ||
|
|
||
| ## Manually trigger updates | ||
|
|
||
| You can also force a check by clicking the "RELOAD DATA" button under the "SETTINGS" tab _(This will force a reload of everything.)_ | ||
|
|
||
| Under the "SETTINGS" tab there is also a reload icon to the left of every custom repository you have added, clicking that will reload info for it. | ||
|
|
||
| On each RepositoryView (the page with details about the element) there is a reload icon at the top-right corner, clicking that will reload it. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,44 +1,44 @@ | ||
| --- | ||
| id: basic | ||
| title: Initial Configuration | ||
| description: "Basic configuration" | ||
| --- | ||
|
|
||
| _This page assume that you have already finished the [installation](/docs/installation/prerequisites)_ | ||
|
|
||
| ## In your Home Assistant UI go to "Configuration", then click "Integrations". | ||
|
|
||
|  | ||
|
|
||
| ## Clear your browser cache | ||
|
|
||
| Before HACS can show up in the list you need to clear your browser cache. | ||
|
|
||
| ## Click the "+" button in the bottom right corner | ||
|
|
||
|  | ||
|
|
||
| ## Search for or scroll down to find "HACS (Home Assistant Community Store)" and select it. | ||
|
|
||
|  | ||
|
|
||
| ## Add your configuration | ||
|
|
||
|  | ||
|
|
||
| - `GitHub Personal Access Token`: The token you got when you finished [_this guide_](/docs/configuration/pat) | ||
| - `Side panel title`: The name/title you want to display for HACS in the sidebar. | ||
| - `Side panel icon`: The icon you want to display for HACS in the sidebar. | ||
| - `Enable AppDaemon apps discovery & tracking`: Enables [AppDaemon](/docs/categories/appdaemon_apps) | ||
| - `Enable python_scripts discovery & tracking`: [DEPRECATED!] Enables [Python Scripts](/docs/categories/python_scripts) | ||
| - `Enable Themes discovery & tracking`: [DEPRECATED!] Enables [Themes](/docs/categories/themes) | ||
|
|
||
| ## Click submit and wait for confirmation. | ||
|
|
||
|  | ||
|
|
||
| _If something failed, you will be taken back to the [Add your configuration step](#add-your-configuration)_ | ||
|
|
||
| ## Changing the configuration | ||
|
|
||
| --- | ||
| id: basic | ||
| title: Initial Configuration | ||
| description: "Basic configuration" | ||
| --- | ||
|
|
||
| _This page assume that you have already finished the [installation](/docs/installation/prerequisites)_ | ||
|
|
||
| ## In your Home Assistant UI go to "Configuration", then click "Integrations". | ||
|
|
||
|  | ||
|
|
||
| ## Clear your browser cache | ||
|
|
||
| Before HACS can show up in the list you need to clear your browser cache. | ||
|
|
||
| ## Click the "+" button in the bottom right corner | ||
|
|
||
|  | ||
|
|
||
| ## Search for or scroll down to find "HACS (Home Assistant Community Store)" and select it. | ||
|
|
||
|  | ||
|
|
||
| ## Add your configuration | ||
|
|
||
|  | ||
|
|
||
| - `GitHub Personal Access Token`: The token you got when you finished [_this guide_](/docs/configuration/pat) | ||
| - `Side panel title`: The name/title you want to display for HACS in the sidebar. | ||
| - `Side panel icon`: The icon you want to display for HACS in the sidebar. | ||
| - `Enable AppDaemon apps discovery & tracking`: Enables [AppDaemon](/docs/categories/appdaemon_apps) | ||
| - `Enable python_scripts discovery & tracking`: [DEPRECATED!] Enables [Python Scripts](/docs/categories/python_scripts) | ||
| - `Enable Themes discovery & tracking`: [DEPRECATED!] Enables [Themes](/docs/categories/themes) | ||
|
|
||
| ## Click submit and wait for confirmation. | ||
|
|
||
|  | ||
|
|
||
| _If something failed, you will be taken back to the [Add your configuration step](#add-your-configuration)_ | ||
|
|
||
| ## Changing the configuration | ||
|
|
||
| If you need to change the configuration, you first need to delete the integration from the integrations list, then you need to add it back again. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,40 +1,40 @@ | ||
| --- | ||
| id: legacy | ||
| title: Configure HACS with YAML | ||
| sidebar_label: YAML (legacy) | ||
| description: "Configure HACS with YAML (legacy)" | ||
| --- | ||
|
|
||
| _This page assume that you have already finished the [installation](/docs/installation/prerequisites)_ | ||
|
|
||
| ## Example configuration | ||
|
|
||
| ```yaml | ||
| hacs: | ||
| token: d73jds8f73jkr9d8sufv2br8sd9fy92nr9f80u23r97fhse (Don't copy+paste this token, create your own) | ||
| ``` | ||
|
|
||
| key | optional | default | description | ||
| -- | -- | -- | -- | ||
| `token` | False | | [A Github Personal Access Token](/docs/configuration/pat) | ||
| `sidepanel_title` | True | Community | The name used for the sidepanel link. | ||
| `sidepanel_icon` | True | "mdi:alpha-c-box" | The icon used for the sidepanel link. | ||
| `appdaemon` | True | `False` | Enable tracking of AppDaemon apps. | ||
| `python_script` | True | `False` | [DEPRECATED!] Enable tracking of python scripts. | ||
| `theme` | True | `False` | [DEPRECATED!] Enable tracking of themes. | ||
| `options` | True | | A map of options. | ||
|
|
||
| ### Options (map) | ||
|
|
||
| ```yaml | ||
| hacs: | ||
| ... | ||
| options: | ||
| ... | ||
| ``` | ||
|
|
||
| option | description | ||
| -- | -- | ||
| `country` | Set a filter based on your [A2(ISO) country code](https://www.worldatlas.com/aatlas/ctycodes.htm). | ||
| `release_limit` | Number of releases to show in the version selector. (Defaults to 5) | ||
| `experimental` | Boolean to enable experimental features (defaults to False). | ||
| --- | ||
| id: legacy | ||
| title: Configure HACS with YAML | ||
| sidebar_label: YAML (legacy) | ||
| description: "Configure HACS with YAML (legacy)" | ||
| --- | ||
|
|
||
| _This page assume that you have already finished the [installation](/docs/installation/prerequisites)_ | ||
|
|
||
| ## Example configuration | ||
|
|
||
| ```yaml | ||
| hacs: | ||
| token: d73jds8f73jkr9d8sufv2br8sd9fy92nr9f80u23r97fhse (Don't copy+paste this token, create your own) | ||
| ``` | ||
|
|
||
| key | optional | default | description | ||
| -- | -- | -- | -- | ||
| `token` | False | | [A Github Personal Access Token](/docs/configuration/pat) | ||
| `sidepanel_title` | True | Community | The name used for the sidepanel link. | ||
| `sidepanel_icon` | True | "mdi:alpha-c-box" | The icon used for the sidepanel link. | ||
| `appdaemon` | True | `False` | Enable tracking of AppDaemon apps. | ||
| `python_script` | True | `False` | [DEPRECATED!] Enable tracking of python scripts. | ||
| `theme` | True | `False` | [DEPRECATED!] Enable tracking of themes. | ||
| `options` | True | | A map of options. | ||
|
|
||
| ### Options (map) | ||
|
|
||
| ```yaml | ||
| hacs: | ||
| ... | ||
| options: | ||
| ... | ||
| ``` | ||
|
|
||
| option | description | ||
| -- | -- | ||
| `country` | Set a filter based on your [A2(ISO) country code](https://www.worldatlas.com/aatlas/ctycodes.htm). | ||
| `release_limit` | Number of releases to show in the version selector. (Defaults to 5) | ||
| `experimental` | Boolean to enable experimental features (defaults to False). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,35 +1,35 @@ | ||
| --- | ||
| id: options | ||
| title: Configuration options | ||
| description: "Configuration options" | ||
| --- | ||
|
|
||
| _This page assumes that you have already finished the [initial configuration](/docs/configuration/basic)_ | ||
|
|
||
| **This does _not_ apply if you configured HACS with YAML(legacy)** | ||
|
|
||
| ## In your Home Assistant UI go to "Configuration", then click "Integrations". | ||
|
|
||
|  | ||
|
|
||
| ## Select "HACS (Home Assistant Community Store)" | ||
|
|
||
|  | ||
|
|
||
| ## Click the cogwheel icon in the top right corner | ||
|
|
||
|  | ||
|
|
||
| ## Options | ||
|
|
||
|  | ||
|
|
||
| - `Filter with country code`: Only show repositories for your country (if the repository has information about that) | ||
| - `Number of releases to show`: Number of releases to show in the dropdown. | ||
| - `Enable experimental features`: This enables experimental features in HACS. | ||
|
|
||
| ## Click submit and wait for confirmation. | ||
|
|
||
| _This will reload HACS and your changes will be reflected when you see the confirmation._ | ||
|
|
||
|  | ||
| --- | ||
| id: options | ||
| title: Configuration options | ||
| description: "Configuration options" | ||
| --- | ||
|
|
||
| _This page assumes that you have already finished the [initial configuration](/docs/configuration/basic)_ | ||
|
|
||
| **This does _not_ apply if you configured HACS with YAML(legacy)** | ||
|
|
||
| ## In your Home Assistant UI go to "Configuration", then click "Integrations". | ||
|
|
||
|  | ||
|
|
||
| ## Select "HACS (Home Assistant Community Store)" | ||
|
|
||
|  | ||
|
|
||
| ## Click the cogwheel icon in the top right corner | ||
|
|
||
|  | ||
|
|
||
| ## Options | ||
|
|
||
|  | ||
|
|
||
| - `Filter with country code`: Only show repositories for your country (if the repository has information about that) | ||
| - `Number of releases to show`: Number of releases to show in the dropdown. | ||
| - `Enable experimental features`: This enables experimental features in HACS. | ||
|
|
||
| ## Click submit and wait for confirmation. | ||
|
|
||
| _This will reload HACS and your changes will be reflected when you see the confirmation._ | ||
|
|
||
|  |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,9 @@ | ||
| --- | ||
| id: start | ||
| title: Configuration | ||
| description: "Configuration" | ||
| --- | ||
|
|
||
| _This page assumes you have already completed the [installation](/docs/installation/prerequisites)_ | ||
|
|
||
| Before you start with the configuration, you will need to go to GitHub to get a [Personal Access Token.](/docs/configuration/pat) | ||
| --- | ||
| id: start | ||
| title: Configuration | ||
| description: "Configuration" | ||
| --- | ||
|
|
||
| _This page assumes you have already completed the [installation](/docs/installation/prerequisites)_ | ||
|
|
||
| Before you start with the configuration, you will need to go to GitHub to get a [Personal Access Token.](/docs/configuration/pat) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,11 @@ | ||
| --- | ||
| id: backend | ||
| title: Backend | ||
| description: "Backend development" | ||
| --- | ||
|
|
||
| This page should contain: | ||
|
|
||
| - How to get started. | ||
| - What branch to target. | ||
| --- | ||
| id: backend | ||
| title: Backend | ||
| description: "Backend development" | ||
| --- | ||
|
|
||
| This page should contain: | ||
|
|
||
| - How to get started. | ||
| - What branch to target. | ||
| - How to test locally. |
Oops, something went wrong.