it my dotfield files

These dotfiles are managed by Chezmoi. Why Chezmoi? Chezmoi was chosen because of its multiplatform support, flexibility, easy of use and its encryption support.

The dotfiles in this repo are not the end all, be all of configuration. Quite the opposite, as great care was taken to include the least amount of configuration. This was done to empower individuals to make it their own. Please feel free to improve upon the starter. Just keep in mind that its purpose is to lower the barrier to entry.

mkdir -p ~/.local/share
ssh-add
git clone [email protected]:mkearns87/dotfiles.git ~/.local/share/chezmoi
cd ~/.local/share/chezmoi
# checkout your own branch if you have one, before running this
./scripts/bootstrap/macos.sh

cd ~/.local/share/chezmoi
git checkout -B u/$USER
git push origin HEAD

The image below illustrates the overall workflow for adding and editing dotfiles via Chezmoi. That is followed by examples.

Feel free to read Chezmoi's Quick start or follow along.

chezmoi add ~/.config/git
chezmoi cd
git add .
git commit
git push origin HEAD

Installing:

brew install zoxide
chezmoi cd
git add .
git commit
git push origin HEAD

Uninstalling pkg:

brew uninstall zoxide
chezmoi cd
git add .
git commit
git push origin HEAD

Syncing an uninstall from origin:

chezmoi update
brew clean -C

chezmoi edit ~/.config/zsh/.zshrc
chezmoi diff
chezmoi -v apply
# saving changes to upstream
chezmoi cd
git add .
git commit -m "Updating zshrc"
git push origin HEAD

chezmoi rm ~/.config/git
chezmoi cd
git add .
git commit -m "Deleting git config"

chezmoi update

Sensitive information such as the CPE configuration scrpit should not be made publicly available. If you go through the process of Open sourcing your version of these files, please ensure sensitive data is encrypted.

Under no circumstances should you include encrypted access keys or ssh ids in your dotfiles. A better alternative would be to use a Yubikey as a Smart Card for storing authentication keys to use with ssh. Additionally, it is worth investigating Chezmoi's support of third-party password managers.

Please refer to Chezmoi extensive documentation on the matter. Another method would be to use a tool independent of Chezmoi such as git-crypt.

Let's walk-through encrypting one of the sensitive scripts within this repo.

For clarifications on the steps, feel free to consult the [docs][gitcrpyt-docs].

brew install git-crypt
cd ~/.local/share/chezmoi
git crypt init

This will create a special key, it is recommended you safe keep it in a security focus secrets manager such as LastPass or 1Password to name a few.

git-crypt export-key ~/Documents/special-git-encryption.key

Let's encrypt some sensitive data:

mkdir sensitive
cat <<EOF >> .gitattributes
sensitive/** filter=git-crypt diff=git-crypt
EOF
awk '!/^{{.*}}$/{print}' \
  .chezmoiscripts/run_after_20-macos-cpe.sh.tmpl >| sensitive/notsosecret.dat
cat <<EOF >| .chezmoiscripts/run_once_after_20-macos-secrets.sh.tmpl
{{ joinPath .chezmoi.sourceDir "sensitive/notsosecret.dat" | include }}
EOF
rm .chezmoiscripts/run_after_20-macos-cpe.sh.tmpl
git add
git commit -m "Adding some sensitive data"

Verify encryption.

git crypt lock
file sensitive/*

File type should be data and to ASCII/text.