more documentation for end users (and more FIXMEs), including README.admin in the...
[monkeysphere.git] / doc / README
1 Monkeysphere User README
2 ========================
3
4 As a regular user on a system where the monkeysphere package is
5 installed, you probably want to do a few things:
6
7 Keeping your keyring up-to-date
8 -------------------------------
9
10 Regularly refresh your GnuPG keyring from the keyservers.  This can be
11 done with a simple cronjob.
12
13 FIXME: give an example of a useful cronjob
14
15
16 Keeping your known_hosts file in sync with your keyring
17 -------------------------------------------------------
18
19 With your keyring updated, you want to make sure that openssh can
20 still see the most recent trusted information about who the various
21 hosts are:
22
23 $ monkeysphere update-known_hosts
24
25
26 Using monkeysphere-ssh-proxycommand(1)
27 --------------------------------------
28
29 FIXME: make a suggestion about how to integrate this in daily use.
30
31
32 Setting up an OpenPGP authentication key
33 ----------------------------------------
34
35 First things first: you'll need to create a new subkey for your
36 current key, if you don't already have one.  If your OpenPGP key is
37 keyid $GPGID, you can set up such a subkey relatively easily with:
38
39 $ monkeysphere gen-subkey $GPGID
40
41 Using your OpenPGP authentication key for SSH
42 ---------------------------------------------
43
44 FIXME: Sending the key to the ssh-agent?
45
46 FIXME: using the key with a single session?
47
48 NOTE: the current version of openpgp2ssh does *not* deal well with
49 encrypted keys (as of 2008-07-26)
50
51 Miscellaneous
52 -------------
53
54 For a user to update their monkeysphere authorized_keys file:
55
56 $ monkeysphere update-authorized_keys
57
58 FIXME: where is this file located?  What does this command do?