charlesrocket.essential.dotfiles role – Deploys dotfiles

Note

This role is part of the charlesrocket.essential collection (version 1.5.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it use: ansible-galaxy collection install charlesrocket.essential.

To use it in a playbook, specify: charlesrocket.essential.dotfiles.

Entry point main – Deploys dotfiles

Synopsis

  • Deploy dotfiles from git repositories to a specified target location. Supports dfs.

Parameters

Parameter

Comments

dotfiles_dfs

boolean

Use dfs to deply dotfiles.

Choices:

  • false ← (default)

  • true

dotfiles_dfs_config

string

dfs config file URL.

dotfiles_files

list / elements=string

Files to track.

dotfiles_home

string

Local dotfiles deployment target.

Default: "~"

dotfiles_repo

string

URL of the target repository to deploy from.

dotfiles_repo_accept_newhostkey

boolean

Ensure “-o StrictHostKeyChecking=accept-new” is present as an SSH option.

Choices:

  • false ← (default)

  • true

dotfiles_repo_force

boolean

Force git clone to override local modifications.

Choices:

  • false ← (default)

  • true

dotfiles_repo_local_destination

string

Local dotfiles repository target.

Default: "~/src/dotfiles"

dotfiles_repo_version

string

Branch to track.

Authors

  • charlesrocket