Git pull for Home Assistant (app)

About

Git pull is an app that updates the local Home Assistant configuration from a Git repository. It can run either a pull, which keeps local changes to tracked files, or a hard reset, which overwrites them with the remote version. Options cover the remote name, branch, pruning of deleted remote branches, and an optional restart of Home Assistant when the configuration has changed and is valid. Files and directories can be excluded from triggering that restart. The app can poll the repository at a set interval in seconds, and it authenticates with a username and password or a private SSH key. It requires Home Assistant OS, runs on aarch64 and amd64, and is configured through the app's configuration section.

Automatic summary of the docs and configuration of home-assistant/apps. Something wrong, or are you the maintainer and want your own text here? Get in touch

Supports

Updated with Home Assistant Ships and updates with every Home Assistant release.

Setting it up

Install it under Settings, Apps, then start it.

Permissions

Supervisor APICan talk to the Supervisor, which manages apps and the system.

Configuration

RepositoryGit URL to your repository.
Git BranchBranch name of the Git repo. If left empty, the currently checked out branch will be updated. Leave this as 'master' if you are unsure.
Git RemoteName of the tracked repository. Leave this as origin if you are unsure.
Auto restartRestart Home Assistant when the configuration has changed (and is valid).
Restart IgnoreWhen auto_restart is enabled, changes to these files will not make HA restart. Full directories to ignore can be specified.
Git CommandCommand to run. Leave this as pull if you are unsure.
Git PruneIf enabled, the app will clean-up branches that are deleted on the remote repository, but still have cached entries on the local machine. Leave this as false if you are unsure.
Deployment KeyA private SSH key that will be used for communication during Git operations.
Deployment UserUsername to use when authenticating to a repository with a username and password.
Deployment PasswordPassword to use when authenticating to a repository. Ignored if deployment_user is not set.
Deployment Key ProtocolThe key protocol
PollingConfigure the Git pull app to poll the repository for updates periodically automatically.