jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-25 18:26:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update git_pull documentation for v4.8 of addon (#5667)

Browse Source 
* Update git_pull documentation for v4.8 of addon

Update to documentation following merge of PR350 in hassio-addons.

https://github.com/home-assistant/hassio-addons/pull/350

* ✏️ Tweaks
This commit is contained in:
Matt White 2018-07-08 11:44:47 +01:00 committed by Franck Nijhof
parent d0d819b400
commit 5558f14cb9
1 changed files with 18 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
source/_addons/git_pull.markdown
View File

@ -1,6 +1,6 @@
--- ---
layout: page layout: page
title: "GIT pull" title: "Git pull"
description: "Load and update configuration files for Home Assistant from a GIT repository." description: "Load and update configuration files for Home Assistant from a GIT repository."
date: 2017-09-25 14:00 date: 2017-09-25 14:00
sidebar: true sidebar: true
@ -15,6 +15,9 @@ Load and update configuration files for Home Assistant from a GIT repository.
{ {
"repository": "https://example.com/my_configs.git", "repository": "https://example.com/my_configs.git",
"auto_restart": false, "auto_restart": false,
"git_branch": "master",
"git_command": "pull",
"git_remote": "origin",
"repeat": { "repeat": {
"active": false, "active": false,
"interval": 300 "interval": 300
@ -32,9 +35,20 @@ Load and update configuration files for Home Assistant from a GIT repository.
} }
``` ```
- **repository** (*Required*): GIT url to your repository. You have to add .git to your GITHub-Repository-URL (see example Config) - **repository** (*Required*): Git URL to your repository (make sure to use double quotes). You have to add .git to your GitHub repository URL (see example config)
- **auto_restart** (*Optional*): Make a restart of Home-Assistant if the config have change and is valid. - **git_branch** (*Required*): Branch name of the git repo, leave this as 'master' if you are unsure.
- **repeat/active** (*Optional*): Pull periodic for GIT updates. - **git_remote** (*Required*): Name of the tracked repository, leave this as 'origin' if you are unsure.
- **git_command** (*Required*): Must be either 'pull' or 'reset', leave this as 'pull' if you are unsure.
* **pull**: Incorporates changes from a remote repository into the current branch. Will preserve any local changes to tracked files.
* **reset**: Will execute ```git reset --hard``` and overwrite any local changes to tracked files and update from the remote repository.
<p class='note warning'>
Using the <b>reset</b> option will overwrite changes to tracked files. Tracked files are those visible in the Github repository or those given by the output on this command: ```git ls-tree -r master --name-only```
</p>
- **auto_restart** (*Optional*): Restart Home Assistant when the configuration has changed (and is valid).
- **repeat/active** (*Optional*): Pull periodic for git updates.
- **repeat/interval** (*Optional*): Pull all x seconds and look for changes. - **repeat/interval** (*Optional*): Pull all x seconds and look for changes.
- **deployment_user** (*Optional*): Username to use when authenticating to a repo with a username and password. - **deployment_user** (*Optional*): Username to use when authenticating to a repo with a username and password.
- **deployment_password** (*Optional*): Password to use when authenticating to a repo. Ignored if deployment_user is not set. - **deployment_password** (*Optional*): Password to use when authenticating to a repo. Ignored if deployment_user is not set.