mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-24 09:46:59 +00:00
Update git_pull documentation for v4.8 of addon (#5667)
* 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:
parent
d0d819b400
commit
5558f14cb9
@ -1,6 +1,6 @@
|
||||
---
|
||||
layout: page
|
||||
title: "GIT pull"
|
||||
title: "Git pull"
|
||||
description: "Load and update configuration files for Home Assistant from a GIT repository."
|
||||
date: 2017-09-25 14:00
|
||||
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",
|
||||
"auto_restart": false,
|
||||
"git_branch": "master",
|
||||
"git_command": "pull",
|
||||
"git_remote": "origin",
|
||||
"repeat": {
|
||||
"active": false,
|
||||
"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)
|
||||
- **auto_restart** (*Optional*): Make a restart of Home-Assistant if the config have change and is valid.
|
||||
- **repeat/active** (*Optional*): Pull periodic for GIT updates.
|
||||
- **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)
|
||||
- **git_branch** (*Required*): Branch name of the git repo, leave this as 'master' if you are unsure.
|
||||
- **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.
|
||||
- **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.
|
||||
|
Loading…
x
Reference in New Issue
Block a user