Convert most http: links to https:
[wiki.git] / doc / afs-and-you.html
1 [[!meta title="AFS and You"]]
2
3 <div style="float: right; font-size: 0.8em; background-color: #D0D0D0; margin: 1em;">
4         <ol>
5                 <li><a href="#WhatisAFS">What is AFS?</a></li>
6                 <li><a href="#SomeMITAFSterminology">Some MIT/AFS terminology</a></li>
7                 <li><a href="#TheBasics">The Basics</a>
8                         <ol><li><a href="#TheLayoutofaTypicalMITLocker">The Layout of a Typical MIT Locker</a></li>
9                                 <li><a href="#AccessingLockers">Accessing Lockers</a>
10                                         <ol><li><a href="#FromAthena">From Athena</a></li>
11                                                 <li><a href="#FromtheWeb">From the Web</a></li>
12                                         </ol>
13                                 <li><a href="#CheckingQuota">Checking Quota</a></li>
14                         </ol>
15                 <li><a href="#CommonTasks">Common Tasks</a>
16                         <ol><li><a href="#ControllingWhocanAccessFiles">Controlling Who can Access Files</a></li>
17                                 <li><a href="#CreatinganAFSGroup">Creating an AFS Group</a></li>
18                                 <li><a href="#ControllingAccessfromtheWeb">Controlling Access from the Web</a></li>
19                         </ol>
20                 <li><a href="#Troubleshooting">Troubleshooting</a>
21                         <ol>
22                                 <li><a href="#ImtryingtoaccessmyfilesfslasaysIshouldhavepermissionsherebutitstillsays">I'm trying to access my files, <tt>fs listacl</tt> says I should have permissions  &hellip;</a></li>
23                                 <li><a href="#IdreallypreferthatnoteveryonecouldlistmyfileshowshouldIstopthis">I'd really prefer that not everyone could list my files, how should I stop  &hellip;</a></li>
24                                 <li><a href="#Itwasaround6amonaSundaymorningandsuddenlyIcouldntaccessmyfiles">It was around 6am on a Sunday morning and suddenly I couldn't access my  &hellip;</a></li>
25                                 <li><a href="#ItisntSundayandIcantgettomyfiles">It isn't Sunday and I can't get to my files</a></li>
26                         </ol>
27                 <li><a href="#AdvancedTasks">Advanced Tasks</a>
28                         <ol>
29                                 <li><a href="#PuttingSoftwareinaLocker">Putting Software in a Locker</a></li>
30                                 <li><a href="#Acquiringanewlocker">Acquiring a new locker</a></li>
31                                 <li><a href="#Findouttechnicalinformationaboutmylocker">Find out technical 
32                                 information about my locker</h2></li>
33                         </ol>
34                 <li><a href="#SeeAlso">See Also</a></li>
35         </ol>
36 </div>
37
38
39 <p>
40 Mostly written by Donald Guy, <br />
41 drawn from a variety of sources. <br />
42 Credit goes to them, blame goes to him.
43 </p>
44 <h2 id="WhatisAFS">What is AFS?</h2>
45 <p>
46 <strong>AFS</strong> (previously the <strong>Andrew File System</strong> or ) is a distributed network file system invented at <a href="https://www.cmu.edu/index.shtml">Carnegie Mellon University</a> as part of Project Andrew (approximately their equivalent of MIT's Project Athena). More importantly, it is the file system used to store most files on Athena today. This includes your personal home directory, the data and websites of many living groups and student groups on campus, and probably some of the software you run (if you ever use Athena clusters). (Though most user directories were migrated from NFS in the summer of 1992, some files still remain on NFS and, of course, various file systems are used on personal computers and servers.)
47
48 </p>
49 <p>
50 <strong><i>In Short: AFS is probably where some of the files you care about live</i></strong>
51 </p>
52 <p>
53 For the most part, using AFS, particularly at MIT, is well-abstracted; For most tasks, it can be used like any other UNIX file system. For a few, you will need to know a bit more. Let's start by defining some terms.
54 </p>
55 <h2 id="SomeMITAFSterminology">Some MIT/AFS terminology</h2>
56 <dl><dt><strong>locker</strong></dt><dd>
57 For practical purposes, a folder. Probably what you'll care about most of the time. Technically any directory with a hesiod FILSYS entry, regardless of how its stored. Most lockers, however, are stored in AFS and are usually accessed as directories in /mit.
58 </dd></dl>
59 <dl><dt><strong>tokens</strong></dt><dd>
60 Proof to the AFS servers that you are who you say you are, thus allowing you to access files you are supposed to. Technically, a special type of Kerberos ticket. 
61
62 </dd></dl>
63 <dl><dt><strong>cell</strong></dt><dd>
64 AFS concept of an "administrative domain of authority." Each cell has its own set of users, groups, and administrators. Analogous to a Kerberos realm. Each top-level directory in /afs generally corresponds to a cell. The cells you are most likely to care about are <tt>athena.mit.edu</tt> and <tt>sipb.mit.edu</tt>.
65 </dd></dl>
66 <h2 id="TheBasics">The Basics</h2>
67 <h2 id="TheLayoutofaTypicalMITLocker">The Layout of a Typical MIT Locker</h2>
68 <p>
69 Every Athena user has a locker (their home directory), which mounts at <tt>/mit/&lt;username&gt;</tt>. From a technical standpoint, it is (almost always) stored in the volume <tt>user.&lt;username&gt;</tt> which is located at <tt>/afs/athena.mit.edu/user/&lt;first letter&gt;/&lt;second letter&gt;/&lt;user name&gt;</tt>. For example, the user <tt>joeuser</tt> has a home directory that mounts at <tt>/mit/joeuser</tt>, is volume <tt>user.joeuser</tt>, and is accessible at <tt>/afs/athena.mit.edu/user/j/o/joeuser</tt>. Lockers for projects, software, classes, living groups, and student groups are all mounted at <tt>/mit/&lt;lockername&gt;</tt> and stored in various places in AFS.
70
71 </p>
72 <p>
73 Within each locker, there are (by default) 4 special subdirectories you want to care about.
74 </p>
75 <dl><dt><strong><tt>Public</tt></strong></dt><dd>
76 By default, this directory can be read by everyone (and I do mean EVERYONE!), so put files here you want to share with the entire world.
77 </dd><dt><strong><tt>Private</tt></strong></dt><dd>
78 By default, this directory can only be read and can only be <i>listed</i> by you (from AFS, not from web) whereas the files in other directories can (by default) only be read by you, but can be listed by anyone. This means that other people can't see the contents of your files, but they can see the names of the files you have outside of <tt>Private</tt> 
79 </dd><dt><strong><tt>OldFiles</tt></strong></dt><dd>
80
81 This folder is a link to a read-only copy of a backup of your files (created nightly around 3 a.m.). This copy cannot be edited and does not count against the locker's quota. From a technical standpoint, this is a separate volume with .backup appended (e.g. user.&lt;username&gt;.backup ) and is stored only as changes against the current copy.
82 </dd><dt><strong><tt>www</tt></strong></dt><dd>
83 Where you should put a website, if you want one. There is very little special about this directory from an AFS standpoint, but it is world-readable (like Public) and is linked directly to <tt>https://www.mit.edu/~&lt;lockername&gt;</tt> as well as <tt>https://web.mit.edu/&lt;lockername&gt;/www/</tt>.
84 </dd></dl>
85 <h2 id="AccessingLockers">Accessing Lockers</h2>
86 <h3 id="FromAthena">From Athena</h3>
87
88 <p>
89 On Athena, you can access a locker either as its full AFS path, if you know it (e.g. <tt>/afs/athena.mit.edu/course/6/6.01</tt>), or under <tt>/mit</tt> if it is "attached." Though you can always use the full path, you often want to attach lockers because it is easier to refer to them and software is set up to run with a path under <tt>/mit</tt>. There are a few ways to attach a locker: 
90
91 </p>
92 <ul><li>If you are running on a <a href="https://debathena.mit.edu">Debathena</a> machine, such as <a href="http://linerva.mit.edu">linerva.mit.edu</a>, then simply <tt>cd /mit/&lt;locker&gt;</tt> and it will be auto-attached.
93 </li><li>If you are on another Athena machine and don't want to run software out of the locker, than simply type <tt>attach &lt;locker&gt;</tt> and then <tt>cd</tt> to it.
94
95 </li><li>If, however, you want to use software in the locker, you will be better served by running <tt>add &lt;locker&gt;</tt> (e.g. <tt>add ruby-lang</tt>). This will attach the locker at <tt>/mit/&lt;locker&gt;</tt> and will add the <tt>bin</tt> directory (for your architecture) of that locker to your PATH and the <tt>man</tt> directory to your MANPATH. What this means is that you should be able to run any program located in that locker by simply typing the name of the program at the command line.
96 <ul><li>If you frequently use the same locker, it may be helpful for you to add the <tt>add &lt;locker&gt;</tt> command to your <tt>.environment</tt> file. To do this simply from the Athena command line, type <tt>echo "add lockername" &gt; ~/.environment</tt> or <tt>echo "add lockername &gt;&gt; ~/.environment</tt>.
97
98 </li></ul></li></ul><h3 id="FromtheWeb">From the Web</h3>
99 <p>
100 Generally any locker that you would access on Athena as <tt>/mit/&lt;locker&gt;</tt> is accessible on the web as <tt>https://web.mit.edu/&lt;locker&gt;</tt>. For example, the barnowl locker is at <a href="https://web.mit.edu/barnowl">https://web.mit.edu/barnowl</a>. As you can see, if there is no index.html (see below), the files in the directory are listed. By default, however, none of the contents are readable except in the <tt>www</tt> and <tt>Public</tt> folders.
101
102 </p>
103 <p>
104 Also, you may access something in one of the MIT AFS cells by typing its full AFS path after web.mit.edu (<a href="https://web.mit.edu/afs/athena.mit.edu/activity/c/chess-club">https://web.mit.edu/afs/athena.mit.edu/activity/c/chess-club</a>). (That link also shows that if you have a text file named README readable, as a link to Public/README for example, its contents will be displayed below the directory listing).
105
106 Note that when accessed from web.mit.edu (or www.mit.edu), only static files may be shown. If you are interested in serving dynamic content (such as a blog or wiki using PHP, Perl, Python, Ruby, etc.), you should check out SIPB's Scripts dynamic web service. See <a href="https://scripts.mit.edu">https://scripts.mit.edu</a> for more information.
107 </p>
108 <h2 id="CheckingQuota">Checking Quota</h2>
109 <p>
110 You are only allocated a certain amount of disk space by MIT. To check the quota of the locker you are presently in run <tt>fs listquota</tt>. You will see output similar to the following:
111 </p>
112 <pre>user@host:/mit/chess-club$ fs listquota
113 Volume Name                   Quota      Used %Used   Partition
114 activity.chess-club         1500000     13163    1%         90% 
115 </pre><p>
116 If this information is good enough for you, then you are done. If not, read on.
117 </p>
118
119 <h2 id="CommonTasks">Common Tasks</h2>
120 <h2 id="ControllingWhocanAccessFiles">Controlling Who can Access Files</h2>
121 <p>
122 You may be familiar with Unix permissions. Sad to say, but that knowledge is more or less useless here. While Unix permissions are per-file, AFS permissions are controlled by <strong>Access Control List</strong>s (<strong>ACL</strong>s) on a per-directory basis. (AFS does however, attend to the e<stong>x</strong>ecute Unix permission on a file. )
123 </p>
124 <p>
125 To view the ACL for a given directory (where you have permission to do so), run <tt>fs listacl</tt>, or <tt>fs la</tt> for short. For a typical user locker, the ACL in the top level will look like this 
126
127 </p>
128 <pre>user@host:~$ fs listacl
129 Access list for . is
130 Normal rights:
131   system:expunge ld
132   system:anyuser l
133   user rlidwka
134 </pre><p>
135 This is a list of users or <a href="#CreatinganAFSGroup">AFS groups</a> and their permissions in this directory (and subdirectories that don't have their own ACL modifications). In AFS there are seven permissions as follows
136 </p>
137 <blockquote>
138 <table style="align: center;">
139 <tr><td><strong>r</strong></td><td>  read   </td><td>   user or members of group can read files in the directory    (i.e. see the contents of files)                  
140 </td></tr><tr><td><strong>l</strong></td><td>  list   </td><td>   user or members of group can list files in the directory (i.e. see the names of files), they can also list the permissions of the directory.                   
141
142 </td></tr><tr><td><strong>i</strong></td><td>  insert </td><td>   user or members of group can create files (or subdirectories) in the directory                                
143 </td></tr><tr><td><strong>d</strong></td><td>  delete </td><td>   user or members of group can delete files in the directory                                                    
144 </td></tr><tr><td><strong>w</strong></td><td>  write  </td><td>   user or members of group can modify files in the directory  (i.e. change the contents of files)               
145 </td></tr><tr><td><strong>k</strong></td><td>  lock   </td><td>   user or members of group can lock files in the directory   (you will likely never use this)                   
146
147 </td></tr><tr><td><strong>a</strong></td><td>  admin  </td><td>   user or members of group can change permissions of this directory (though not existing subdirectories, unless they have the <strong>a</strong> permission in those too. They will have admin powers in newly created subdirectories.)
148 </td></tr>
149 <tr><td><strong>A</strong>,<strong>B</strong>,&hellip;,<strong>H</strong></td><td>site-specific</td><td>Site-specific permissions that are meaningless to AFS but may be used by other software (or special versions of AFS).</td></tr></table>
150 </blockquote>
151 <p>
152 To add a user or group to the ACL for a given directory simply run <tt>fs setacl</tt> or <tt>fs sa</tt> as follows:
153
154 </p>
155 <pre>fs setacl -dir &lt;directory&gt; [&lt;directory&gt;]* -acl &lt;user or group&gt; &lt;permissions&gt; [&lt;user or group&gt; &lt;permissions&gt;]*
156 </pre><dl><dt><tt>&lt;directory&gt;</tt></dt><dd>
157 can be an absolute or relative path, usually you will want <tt>.</tt>
158 </dd><dt><tt>&lt;user or group&gt;</tt></dt><dd>
159 can be any user or group. Some you probably want to know: system:anyuser means EVERYONE (the entire AFS-using world plus the entire world wide web), system:expunge is the daemon for MIT's delete/lsdel/undelete utilities to work in a given directory.
160 </dd><dt><tt>&lt;permissions&gt;</tt></dt><dd>
161
162 can be a string of the above letters (in any order) or any of the words <tt>read</tt>, <tt>write</tt>, <tt>all</tt> and <tt>none</tt> which are equivalent to <tt>rl</tt>, <tt>rlidwk</tt>, <tt>rlidwka</tt> and the empty string, respectively 
163
164 </dd></dl>
165 <p>
166 For example, if <tt>user</tt> wants his friends <tt>sipbtest</tt> and <tt>jarandom</tt> to be able to read and write files and anyone to be able to read files in his <tt>awesome_project</tt> directory, he might have a session that looks like this
167 </p>
168 <pre>user@host:~$ cd awesome_project/
169 user@host:~/awesome_project$ fs setacl -dir . -acl system:anyuser read
170 user@host:~/awesome_project$ fs setacl -dir . -acl jarandom write
171 user@host:~/awesome_project$ fs setacl -dir . -acl sipbtest write
172 user@host:~/awesome_project$ #alternatively: fs setacl -dir . -acl system:anyuser read jarandom write sipbtest write
173 user@host:~/awesome_project$ fs listacl
174 Access list for . is
175 Normal rights:
176   system:expunge ld
177   system:anyuser rl
178   sipbtest rlidwk
179   jarandom rlidwk
180   user rlidwka
181 user@host:~/awesome_project$
182
183 </pre><p>
184 See also: <tt>man 1 fs</tt>, <tt>fs help &lt;command&gt;</tt>, <tt>man fs_listacl</tt>.
185
186 There is also such thing as negative permissions to deny rights to certain members of a larger group to which positive permissions are granted. In the words of the fs_setacl manpage, however, <blockquote>Setting negative permissions is generally unnecessary and not recommended. Simply omitting a user or group from the "Normal rights" section of the ACL is normally adequate to prevent access. In particular, note that it is futile to deny permissions that are granted to members of the system:anyuser group on the same ACL; the user needs only to issue the unlog command to receive the denied permissions.</blockquote> For an example of negative permissions used on Athena run <tt>fs listacl /afs/athena.mit.edu/contrib/games/</tt>.
187
188
189 </p>
190 <h2 id="CreatinganAFSGroup">Creating an AFS Group</h2>
191 <p>
192 The "normal" way to make an AFS group would be with a command similar to <tt>pts creategroup &lt;your user name&gt;:&lt;group name&gt;</tt> and then add people with <tt>pts adduser &lt;user&gt; &lt;full group name&gt;</tt>(e.g. If Donald Guy wanted to created a group for people to edit his www directory (including <tt>sipbtest</tt> and <tt>jflorey</tt>, he might use the following chain of commands <tt>pts creategroup fawkes:www; pts adduser sipbtest fawkes:www; pts adduser jflorey fawkes:www; fs setacl -dir /mit/fawkes/www -acl fawkes:www write</tt>
193 </p>
194 <p>
195 You can see general information about a group by running <tt>pts examine &lt;group&gt;</tt> and see the membership of a group by running <tt>pts membership &lt;group&gt;</tt>. In the above example:
196 <pre>
197 fawkes@dr-wily:~$ pts examine fawkes:www
198 Name: fawkes:www, id: -33555072, owner: fawkes, creator: fawkes,
199   membership: 2, flags: S-M--, group quota: 0.
200 fawkes@dr-wily:~$ pts membership fawkes:www
201 Members of fawkes:www (id: -33555072) are:
202   jflorey
203   sipbtest
204 fawkes@dr-wily:~$ 
205 </pre>
206 </p>
207
208 <p>
209 This method will work, but at MIT, it is much more common to use moira lists as groups. To create a new list, use the web interface at <a href="http://wserv.mit.edu/lc">http://wserv.mit.edu/lc</a> to create a moira list, NOT A MAILMAN LIST and be sure to check the box for "Is this list an AFS group?" (to make an already existing moira list into an AFS group simply run <tt>blanche -G &lt;list&gt;</tt> on athena). After the servers update (which may take anywhere between 1 second and 10 minutes depending on the number of similar requests), the AFS group system:&lt;list name&gt; will exist in the athena.mit.edu cell. 
210 </p>
211 <p>To check the membership of a moira list simply run <tt>blance &lt;list name&gt;</tt>. Note that the name of the list does not have the system: that is in the string. (e.g. to view the membership of the list gnu aka the group system:gnu, run <tt>blanche gnu</tt>).
212
213 <p>
214 This is useful because one often wants the same certain people who can operate on files in a folder to be a mailing list. Thus, for example, it is possible to send mail to gnu@mit.edu and use system:gnu as an AFS group on ACLs. (it is also possible to make moira lists that are AFS groups, but not mailing lists).
215 </p>
216 <p>
217 see also: <tt>man 1 pts</tt>
218
219 </p>
220 <h2 id="ControllingAccessfromtheWeb">Controlling Access from the Web</h2>
221 <p>
222 If you make a directory listable and readable by system:anyuser then it can be viewed by any user on the web via the URLs mentioned <a href="#FromtheWeb">above</a>
223 </p>
224 <p>
225 Unfortunately, adding specific users to an AFS ACL does not mean they can see the folder when they access it from the web. IS&amp;T, however, does provide a solution to this. First, make sure that the wanted directory is not readable by system:anyuser. Create a file named <tt>.htaccess.mit</tt> in that directory. In that file you can do one of three things, 
226
227 </p>
228 <ul><li>You can require that the user have valid certificates:
229 <pre>require valid-user
230 </pre></li></ul><ul><li>You can require the reader be (a) specific user(s), for example:
231 <pre>require user fawkes jflorey sipbtest jarandom
232 </pre></li><li>You can require that the reader be a member of one of certain moira groups (notice these are <strong>moira</strong> groups, there is no "system:". For example:
233 <pre>require group sipb-staff sipb-prospectives
234 </pre></li></ul><p>
235 <p>Note that you cannot mix users and groups in the same directory.</p>
236
237 <p>Finally <tt>fs setacl -dir &lt;dir&gt; -acl system:htaccess.mit read</tt>.</p>
238         
239 Thereafter, the users should be able to get to the folders at <tt>http<b>s</b>://web.mit.edu/&lt;locker&gt;/&lt;path to folder&gt;</tt> if they have certificates and no one should be able to reach it via http. Make sure to add yourself if you are going to be accessing it.
240
241 </p>
242 <p>
243 see also: <a href="https://ist.mit.edu/services/web/reference/web-resources/https">https://ist.mit.edu/services/web/reference/web-resources/https</a>
244 </p>
245 <h2 id="Troubleshooting">Troubleshooting</h2>
246 <h3 id="ImtryingtoaccessmyfilesfslasaysIshouldhavepermissionsherebutitstillsays">I'm trying to access my files, <tt>fs litacl</tt> says I should have permissions here, but it still says <tt>: Permission denied</tt></h3>
247 <p>
248 There are two likely possibilities. First, its likely that your tokens may have expired. You can check this by running <tt>tokens</tt>. If they are, in fact, expired (or missing) get new tokens as follows: first, make sure you have valid kerberos tickets and then run <tt>aklog</tt>. Another possibility is that you have tokens but not for the correct cell. <tt>tokens</tt> will tell you what tokens you already have. In all likelihood, if you are reading this, you probably want <tt>aklog athena sipb</tt>. Finally, a third possibility is that your group membership has changed since you acquired tokens. Try running <tt>aklog -force</tt>
249
250 </p>
251 <h3 id="IdreallypreferthatnoteveryonecouldlistmyfileshowshouldIstopthis">I'd really prefer that not everyone could list my files, how should I stop this?</h3>
252 <p>
253 What you <strong>don't</strong> want to do is take away the l permission from <tt>system:anyuser</tt> because then no one will be able to get to your <tt>Public</tt> or <tt>www</tt> which is probably not what you want want. All told, there is no way to stop people on Athena from listing your files (unless you keep everything under <tt>Private</tt> or a similarly restricted directory). It is rather trivial to stop web users, however. A solution I recommend, if you have a website in <tt>www</tt>, is to make a <tt>redirect.html</tt> (or similar) with the contents like:
254
255 </p>
256 <pre>&lt;html&gt;
257 &lt;head&gt;
258   &lt;meta http-equiv="Refresh" content="0; url=https://web.mit.edu/&lt;lockername&gt;/www"&gt;
259 &lt;/head&gt;
260 &lt;body&gt;
261   &lt;p&gt;Please go to my &lt;a href="https://web.mit.edu/&lt;lockername&gt;/www"&gt;www&lt;/a&gt;!&lt;/p&gt;
262
263 &lt;/body&gt;
264 &lt;/html&gt;
265 </pre><p>
266 and then doing a <tt>ln -s www/redirect.html index.html</tt> in the top level of the locker. Alternatively you can link index.html to a blank file in your <tt>Public</tt> or <tt>www</tt> (you can't simply put it in the top level because it's not readable there; this will result in a 403 Forbidden error).
267 </p>
268 <h3 id="Itwasaround6amonaSundaymorningandsuddenlyIcouldntaccessmyfiles">It was around 6am on a Sunday morning and suddenly I couldn't access my files</h3>
269
270 <p>
271 Most AFS servers restart weekly at 6 AM on Sunday.
272 </p>
273 <h3 id="ItisntSundayandIcantgettomyfiles">It isn't Sunday and I can't get to my files</h3>
274 <p>
275 There may be a non-scheduled AFS outage. Check <a href="https://3down.mit.edu">3down</a>, hopefully it will be back up soon :-(. You can check up on the AFS servers by running <tt>fs checkservers</tt> (or <tt>fs checks</tt>). If there is no reported outage and you can't access the AFS servers (but can access the rest of the net), contact <a href="https://ist.mit.edu/services/athena/olh">OLC</a>.
276 </p>
277 <h2 id="AdvancedTasks">Advanced Tasks</h2>
278 <h2 id="PuttingSoftwareinaLocker">Putting Software in a Locker</h2>
279 <p>
280 The Athena environment was designed to allow software to run on several architectures on the same network. On modern Athena, this means 32-bit x86s running Linux, 64-bit x86s running Linux, and SPARCs running Solaris. To accommodate these these various architectures AFS (at least on Athena) has a notion of what systems are compatible with the operating system. You can find these by running <tt>fs sysname</tt>.
281
282 </p>
283 <p>
284 The special variable @sys in an AFS path corresponds to the first of these that matches. When a user runs <tt>add</tt>, <tt>/mit/&lt;locker&gt;/arch/@sys/bin</tt> is added to their PATH and <tt>/mit/&lt;locker&gt;/man</tt> or <tt>/mit/&lt;locker&gt;/arch/@sys/man</tt> is added to their MANPATH.
285
286 </p>
287 <p>
288 Primarily because of this fact, a typical locker might be set up with the following sort of layout:
289 </p>
290 <pre>user@host:/mit/&lt;some locker&gt;$ tree -dL 2
291 .
292 |-- arch
293 |   |-- i386_linux24
294 |   |-- i386_rh9 -&gt; i386_linux24
295 |   |-- i386_rhel4
296 |   |-- sgi_65
297 |   |-- sun4x_58
298 |   |-- sun4x_59 -&gt; sun4x_518/
299 |   `-- sun4x_510 -&gt; sun4x_59
300 |-- bin -&gt; arch/@sys/bin
301 |-- include -&gt; arch/@sys/include
302 |-- info
303 |-- lib -&gt; arch/@sys/lib
304 |-- man
305    `-- man1
306
307 </pre><p>
308 Please note that the @sys variable should really be used ONLY in these convenience symlinks. To make the folder in arch you usually want to either pick a more general architecture and set it up yourself or simply use the following command in the top level of the locker:
309 <tt>mkdir -p arch/$ATHENA_SYS/{bin,lib,include</tt>}. After making this folder, make the shortcut symlinks with commands similar to <tt>ln -s arch/@sys/bin bin</tt> (again, this is the <i>ONLY</i> time you should use @sys yourself). Other than that, it's mainly just a matter of making sure to run configure with options like <tt>--prefix=/mit/&lt;lockername&gt;</tt> and <tt>--with-manpath=/mit/&lt;lockername&gt;/man</tt>. 
310
311 </p>
312 <p>
313 See also: <tt>man lockers</tt>
314 </p>
315
316 <h2 id="Acquiringanewlocker">Acquiring a new locker</h2>
317 <p>
318 While it is easily possible to make an AFS group for yourself, it is harder to get a new locker. If you want a locker for something official like a student group or a piece of software, send an email to <a href="mailto:accounts@mit.edu">accounts@mit.edu</a> explaining what you need it for and someone at IS&amp;T will let you know. If you feel it is something less official or you would just rather consider it a SIPB project (perhaps get other SIPB people involved) send an email to <a href="mailto:sipb-afsreq@mit.edu">sipb-afsreq@mit.edu</a> instead. In either case, if a mount point under <tt>/mit</tt> fails to get set up for you, let <a href="mailto:hesreq@mit.edu">hesreq@mit.edu</a> know.
319 </p>
320
321 <h2 id="Findouttechnicalinformationaboutmylocker">Find out technical information about my locker</h2>
322 <p>Figure out the volume name of the locker. One way to do this is to run <tt>fs listquota .</tt> in the directory and look in the left column. Once you have the volume name, run <tt>vos examine &lt;volume name&gt;</tt>. This will tell you information such as what server it is located on, its ID numbers, when it was last accessed, when it was last backed up, etc. For example:
323 <pre>
324 $ vos examine user.sipbtest
325 user.sipbtest                     537058147 RW      69785 K  On-line
326     PHLEGETHON.MIT.EDU /vicepa 
327     RWrite  537058147 ROnly          0 Backup  537058149 
328     MaxQuota    2000000 K 
329     Creation    Sat Nov  2 21:29:46 1996
330     Copy        Fri Dec  4 19:38:29 2009
331     Backup      Sat Mar 20 02:07:55 2010
332     Last Update Wed Mar  3 00:22:34 2010
333     35 accesses in the past day (i.e., vnode references)
334
335     RWrite: 537058147     Backup: 537058149 
336     number of sites -> 1
337        server PHLEGETHON.MIT.EDU partition /vicepa RW Site
338 </pre>
339
340 <tt>vos</tt> has many other commands, but most of them are only useful to administrators.
341 </p>
342    
343 <h2 id="SeeAlso">See  Also</h2>   
344 <p>SIPB's older guide, <a href="https://stuff.mit.edu/afs/sipb.mit.edu/project/doc/afs/html/afs-new.html">Inessential AFS</a>  <br /> OpenAFS documentation  at <a href="https://www.openafs.org/">https://www.openafs.org/</a>
345 </p> 
346