Skip to content

Commit 74cf665

Browse files
committed
Update readme
1 parent 6197dd9 commit 74cf665

File tree

1 file changed

+42
-1
lines changed

1 file changed

+42
-1
lines changed

README.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,39 @@ letting stow create a bunch of symbolic links but it allows greater control
99
and ease-of-use for managing differences across systems and dealing with
1010
secrets.
1111

12+
## usage
13+
14+
### setup
15+
16+
You must have the GPG key used for decrypting the vault (more information
17+
below) available before running the setup step below. If you're using using a
18+
yubikey to store the key material you're done as the setup script automatically
19+
loads the public keys necessary for it to work.
20+
21+
If you're keeping the private key material on the machine then you need to copy
22+
the private key to the new machine and then run the following steps:
23+
24+
```shell
25+
gpg --import ./path/to/key.asc
26+
```
27+
28+
Then you need to edit the key to give it `ultimate` trust:
29+
30+
```shell
31+
gpg --edit-key 36FDA306
32+
```
33+
34+
Then enter `trust` and `5` to `ultimate`ly trust the key, and then `save` to
35+
exit.
36+
37+
You can verify success with
38+
39+
```shell
40+
gpg --list-keys
41+
```
42+
43+
### first run
44+
1245
Get up and running by either cloning this repository and running, `run.bash`,
1346
or all-in-one:
1447

@@ -23,7 +56,15 @@ unlocked (`ssh-add ~/.ssh/key`).
2356
The initial installation will install the dotfiles into `$HOME/.dotfiles` and
2457
afterwards everything can be updated with `git pull` and `./run.bash`.
2558

26-
## vault
59+
### post-setup
60+
61+
Some roles only install basic configuration but other steps are necessary.
62+
For example to activate `atuin` (in the `zsh` role) you must run the `command`.
63+
More information is available in the `zsh` role README.
64+
65+
## notes
66+
67+
### vault
2768

2869
Sensitive files are encrypted with ansible-vault. The vault password was
2970
initialized like so:

0 commit comments

Comments
 (0)