major overhaul of rhesus:
[monkeysphere.git] / doc / README
1 Monkeysphere README
2 -------------------
3
4 Default file locations:
5
6 MS_HOME=~/.config/monkeysphere
7 STAGING_AREA=$MS_HOME
8 GNUPGHOME=~/.gnupg
9 $MS_HOME/monkeysphere.conf
10 $MS_HOME/auth_host_ids
11 $MS_HOME/auth_user_ids
12 $STAGING_AREA/host_keys/KEYHASH
13 $STAGING_AREA/known_hosts
14 $STAGING_AREA/user_keys/KEYHASH
15 $STAGING_AREA/authorized_keys
16
17 For a user to update their ms known_hosts file:
18
19 $ rhesus --known_hosts
20
21 For a user to update their ms authorized_keys file:
22
23 $ rhesus --authorized_keys
24
25 A system can maintain ms authorized_keys files for it's users.  Some
26 different variables need to be defined to help manage this.  The way
27 this is done is by first defining a new MS_HOME:
28
29 MS_HOME=/etc/monkeysphere
30
31 This directory would then have a monkeysphere.conf which defines the
32 following variables:
33
34 AUTH_USER_FILE="$MS_HOME"/auth_user_ids/"$USER"
35 STAGING_AREA=/var/lib/monkeysphere/stage/$USER
36 GNUPGHOME=$MS_HOME/gnupg
37
38 To update the ms authorized_keys file for user "foo", the system would
39 then run the following:
40
41 # USER=foo MS_HOME=/etc/monkeysphere rhesus --authorized_keys
42
43 To update the ms authorized_keys file for all users on the the system:
44
45 MS_HOME=/etc/monkeysphere
46 for USER in $(ls -1 /etc/monkeysphere/auth_user_ids) ; do
47     rhesus --authorized_keys
48 done