1
0
Fork 0
mirror of synced 2024-05-30 13:51:11 -04:00
yadm/README.md

176 lines
7.3 KiB
Markdown
Raw Normal View History

# yadm - Yet Another Dotfiles Manager [![Build Status](https://travis-ci.org/TheLocehiliosan/yadm.svg?branch=master)](https://travis-ci.org/TheLocehiliosan/yadm)
_A house that does not have one warm, comfy chair in it is soulless._—May Sarton
2015-07-17 17:27:50 -04:00
When you live in a command line, configurations are a deeply personal thing. They are often crafted over years of experience, battles lost, lessons learned, advice followed, and ingenuity rewarded. When you are away from your own configurations, you are an orphaned refugee in unfamiliar and hostile surroundings. You feel clumsy and out of sorts. You are filled with a sense of longing to be back in a place you know. A place you built. A place where all the short-cuts have been worn bare by your own travels. A place you proudly call... `$HOME`.
2015-07-17 17:27:50 -04:00
## Introduction
_Home is an invention on which no one has yet improved._—Ann Douglas
2015-07-17 17:27:50 -04:00
As so many others, I started out with a repository of dotfiles and a few scripts to symbolically link them around my home directory. This quickly became inadequate and I looked for solutions elsewhere. I've used two excellent tools; [homeschick](https://github.com/andsens/homeshick), and [vcsh](https://github.com/RichiH/vcsh). These tools are great, and you should check them out to understand their strengths. However, I didn't find all of the features I personally wished for in a single tool. **yadm** was written with the following goals:
2015-07-17 17:27:50 -04:00
- Use a single repository
- Few dependencies
- Ability to use alternate files based on OS or host
- Ability to encrypt and track confidential files
- Stay out of the way and let Git do what it's good at
2015-07-20 17:29:51 -04:00
## Installation
_Seek home for rest, for home is best._—Thomas Tusser
2015-07-20 17:29:51 -04:00
#### OSX
2015-07-20 17:29:51 -04:00
**yadm** can be installed using [Homebrew](https://github.com/Homebrew/homebrew).
brew install yadm
2015-07-20 17:29:51 -04:00
#### Fedora/Redhat/CentOS YUM/RPM
Several yum repositories are on Copr. Follow this link for [repositories and installation instructions](https://copr.fedorainfracloud.org/coprs/thelocehiliosan/yadm/).
#### Arch Linux
**yadm** is available in the Arch User Repos and can be installed with AUR helper or Makepkg
yaourt -S yadm
2016-04-23 12:30:37 -04:00
#### Gentoo Linux
**yadm** is available in the main gentoo portage tree, simply use `emerge` to
install it
2016-04-23 12:30:37 -04:00
emerge -atv app-admin/yadm
#### Other
You *can* simply download the **yadm** script and put it into your `$PATH`. Something like this:
2015-09-08 08:47:38 -04:00
curl -fLo /usr/local/bin/yadm https://github.com/TheLocehiliosan/yadm/raw/master/yadm && chmod a+x /usr/local/bin/yadm
2015-07-20 17:29:51 -04:00
2015-07-17 17:27:50 -04:00
## Getting Started
_I would not change my blest estate for all the world calls good or great._—Isaac Watts
2015-07-17 17:27:50 -04:00
2015-07-19 14:01:52 -04:00
If you know how to use Git, then you already know how to use **yadm**.
See the [man page](yadm.md) for a comprehensive explanation of commands and options.
2015-07-17 17:27:50 -04:00
#### If you don't currently have a repository
Start out with an empty local repository
yadm init
yadm add <important file>
yadm commit
Eventually you will want to push the local repo to a remote.
yadm remote add origin <url>
yadm push -u origin master
#### If you have an existing remote repository
This `clone` will attempt to merge your existing repository, but if it fails, it will do a reset instead and you'll have to decide best on how resolve the differences.
yadm clone <url>
yadm status
## Strategies for alternate files on different systems
_To feel at home, stay at home._—Clifton Fadiman
2015-07-17 17:27:50 -04:00
Where possible, you should try to use the same file on every system. Here are a few examples:
2015-07-19 14:01:52 -04:00
### .vimrc
2015-07-17 17:27:50 -04:00
let OS=substitute(system('uname -s'),"\n","","")
if (OS == "Darwin")
" do something that only makes sense on a Mac
endif
2015-07-19 14:01:52 -04:00
### .tmux.conf
2015-07-17 17:27:50 -04:00
# use reattach-to-user-namespace as the default command on OSX
if-shell "test -f /usr/local/bin/reattach-to-user-namespace" 'set -g default-command "reattach-to-user-namespace -l bash"'
2015-07-19 14:01:52 -04:00
### .bash_profile
2015-07-17 17:27:50 -04:00
system_type=$(uname -s)
if [ "$system_type" = "Darwin" ]; then
eval $(gdircolors $HOME/.dir_colors)
else
eval $(dircolors -b $HOME/.dir_colors)
fi
However, sometimes the type of file you are using doesn't allow for this type of logic. If a configuration can do an "include", you can include a specific alternate version using **yadm**. Consider these three files:
2015-07-19 14:01:52 -04:00
### .gitconfig
2015-07-17 17:27:50 -04:00
#---- .gitconfig -----------------
[log]
decorate = short
abbrevCommit = true
[include]
path = .gitconfig.local
#---- .gitconfig.local##Darwin ---
[user]
name = Tim Byrne
email = tim@personal.email.org
#---- .gitconfig.local##Linux ----
[user]
name = Dr. Tim Byrne
email = dr.byrne@work.email.com
Configuring Git this way includes `.gitconfig.local` in the standard `.gitconfig`. **yadm** will automatically link the correct version based on the operation system. The bulk of your configurations can go in a single file, and you just put the exceptions in OS-specific files.
2015-07-19 14:01:52 -04:00
Of course, you can use **yadm** to manage completely separate files for different systems as well.
### .signature
#---- .signature##
- Tim
#---- .signature##Darwin.host1
Sent from my MacBook
- Tim
#---- .signature##Linux.host2
Sincerely,
Dr. Tim Byrne
**yadm** will link the appropriate version for the current host, or use the default `##` version.
2015-07-21 09:46:53 -04:00
## Example of managing SSH configurations
_We shape our dwellings, and afterwards our dwellings shape us._—Winston Churchill
2015-07-21 09:46:53 -04:00
Below is an example of how **yadm** can be used to manage SSH configurations. The example demonstrates **yadm** directly managing the `config` file, managing a host-specific `authorized_keys` file, and storing the private SSH key as part of its encrypted files. This example assumes a typical working SSH configuration exists, and walks through the steps to bring it under **yadm**'s management.
yadm add ~/.ssh/config
mv ~/.ssh/authorized_keys ~/.ssh/authorized_keys##Linux.myhost
yadm add ~/.ssh/authorized_keys##Linux.myhost
echo '.ssh/id_rsa' >> ~/.yadm/encrypt
yadm add ~/.yadm/encrypt
yadm encrypt
------
yadm status
2015-07-21 09:46:53 -04:00
Changes to be committed:
(use "git rm --cached <file>..." to unstage)
new file: .ssh/authorized_keys##Linux.myhost
new file: .ssh/config
new file: .yadm/encrypt
new file: .yadm/files.gpg
------
ls ~/.ssh
authorized_keys -> ~/.ssh/authorized_keys##Linux.myhost
authorized_keys##Linux.myhost
config
rsa_id
First, the `config` file is simply added. This will cause the same `config` file to be used on other **yadm** managed hosts. The `authorized_keys` file needs to be host specific, so rename the file using the OS and hostname. After adding the renamed `authorized_keys##Linux.myhost`, **yadm** will automatically create the symlink for it. Last, the private key should be maintained in **yadm**'s encrypted files. Add a pattern to the `.yadm/encrypt` file which matches the private key. Then instruct **yadm** to encrypt all files matching the patterns found in `.yadm/encrypt`. Notice that the **yadm** repository is not tracking the private key directly, rather it tracks the collection of encrypted files `.yadm/files.gpg`. When these changes are brought onto another host, using the `yadm decrypt` command will extract the files stored.
2015-07-17 17:27:50 -04:00
<!-- vim: set spell lbr : -->