Added troubleshooting advance and a couple other things. Consider my initial revision...
authorDonald Guy <fawkes@mit.edu>
Sun, 11 Jan 2009 05:36:32 +0000 (00:36 -0500)
committerTrac <sipb-www@mit.edu>
Sun, 1 Feb 2009 07:25:21 +0000 (02:25 -0500)
doc/AFSAndYou

index 95ecfa63f94a925636e3af99470450ee396f4633..f750ac221272f5f9756f39a940b0ed9715fe573c 100644 (file)
@@ -52,7 +52,19 @@ Generally any locker that you would access on Athena as {{{/mit/<locker>}}} is a
 
 Also, you may access something in one of the MIT AFS cells by taking its full AFS path after web.mit.edu ([http://web.mit.edu/afs/athena.mit.edu/activity/c/chess-club]). (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).
 
-If these options are good enough for you, then you are done. If not, read on.
+
+== Checking Quota ==
+
+You are only allocated a certain amount of disk space by MIT. To check the quota of the locker you are presently in run {{{fs listquota}}}. You will see output similar to the following:
+
+{{{
+user@host:/mit/chess-club$ fs listquota
+Volume Name                   Quota      Used %Used   Partition
+activity.chess-club         1500000     13163    1%         90% 
+}}}
+
+
+If this information is good enough for you, then you are done. If not, read on.
 
 = Common Tasks =
 
@@ -109,6 +121,9 @@ Normal rights:
 user@host:~/awesome_project$
 }}}
 
+
+See also: {{{man 1 fs}}}, {{{fs help <command>}}}
+
 == Creating an AFS Group ==
 The "normal" way to make an AFS group would be with a command similar to {{{pts creategroup <your user name>:<group name>}}} and then add people with {{{pts adduser <user> <full group name>}}}(e.g. If Donald Guy wanted to created a group for people to edit his www directory (including `sipbtest` and `jflorey`, he might use the following chain of commands {{{pts creategroup fawkes:www ; pts adduser sipbtest fawkes:www; pts adduser jflorey fawkes:www; fs sa ~/www fawkes:www write}}}
 
@@ -116,6 +131,8 @@ This method will work, but at MIT, it is much more common to use moira lists as
 
 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).  
 
+see also: {{{man 1 pts}}}
+
 == Controlling Access from the Web ==
 
 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 [#FromtheWeb above]
@@ -142,9 +159,76 @@ Unfortunately, just because you add specific users to an AFS ACL does not mean t
  </limit>
  }}}
 
+There after the users should be able to get to the folders at {{{http'''s'''://web.mit.edu/<locker>/<path to folder>}}} 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.
+
+see also: http://web.mit.edu/is/web/reference/web-resources/https.html
+
 
 = Troubleshooting =
 === I'm trying to access my files, {{{fs la}}} says I should have permissions here, but it still says {{{: Permission denied}}} ===
 There are two likely possibilities. First, its likely that your tokens may have expired. To get new tokens, make sure you have valid kerberos tickets and then run {{{aklog}}}. Another possibility is that you have tokens but not for the correct cell. {{{tokens}}} will tell you what tokens you already have. In all likelihood, if you are reading this, you probably want {{{aklog athena sipb}}}
 
+=== I'd really prefer that not everyone could list my files, how should I stop this? ===
+What you '''don't''' want to do is take away the l permission from {{{system:anyuser}}} because then no one will be able to get to your `Public` or `www` which you probably don't want. All told, there is no way to stop people on Athena from listing your files (unless you keep everything under `Private` or a similarly restricted directory). It is rather trivial to stop web users, however. A solution I recommend, if you have a website in `www`, is to make a page `redirect.html` (or similar) with the contents like:
+{{{
+<html>
+<head>
+  <meta http-equiv="Refresh" content="0; url=http://www.mit.edu/~<lockername>/">
+</head>
+<body>
+  <p>Please go to my <a href="http://www.mit.edu/~<lockername>/">www</a>!</p>
+</body>
+</html>
+}}}
+
+and then doing a {{{ln -s www/redirect.html index.html}}} in the top level of the locker. Alternatively you can link index.html to a blank file in your `Public` or `www` (you can't simply it in the top level because its not readable there, this will result in a 403 Forbidden error).
+
+===It was around 6am on a Sunday morning and suddenly I couldn't access my files ===
+Yea, IS&T restarts the AFS servers weekly around 6am.
+
+===It isn't Sunday and I can't get to my files ===
+There may be a non-scheduled AFS outage. Check [http://3down.mit.edu 3down], hopefully it will be back up soon :-(.
+
 = Advanced Tasks =
+
+
+== Putting Software in a Locker ==
+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 {{{fs sysname}}}.
+
+The special variable @sys in a path corresponds to the first of these that matches. When a user runs `add`, {{{/mit/<locker>/arch/@sys/bin}}} is added to their PATH and {{{/mit/<locker>/man}}} or {{{/mit/<locker>/arch/@sys/man}}} is added to their MANPATH.
+
+Primarily because of this fact, a typical locker is set up with the following sort of layout:
+{{{
+user@host:/mit/<some locker>$ tree -dL 2
+.
+|-- arch
+|   |-- i386_linux22
+|   |-- i386_linux24 -> i386_rhel4/
+|   |-- i386_rh9 -> i386_linux24
+|   |-- i386_rhel3 -> i386_rhel4
+|   |-- i386_rhel4
+|   |-- sgi_65
+|   |-- sun4x_510
+|   |-- sun4x_57
+|   |-- sun4x_58 -> sun4x_510/
+|   `-- sun4x_59 -> sun4x_58
+|-- bin -> arch/@sys/bin
+|-- include -> arch/@sys/include
+|-- info
+|-- lib -> arch/@sys/lib
+|-- man
+   `-- man1
+}}}
+
+Please note that the @sys variable should really be used ONLY in these convenience in 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:
+{{{mkdir -p arch/$ATHENA_SYS/{bin,lib,include}}}}. After making this folder, make the shortcut symlinks with commands similar to {{{ln -s arch/@sys/bin bin}}} (again, this is the ''ONLY'' time you should use @sys yourself). Other than that, its mainly just a matter of making sure to run configure with options like {{{--prefix=/mit/<lockername>}}} and {{{--with-manpath=/mit/<lockername>/man}}}. 
+
+See also: {{{man lockers}}}
+
+== Acquiring a new locker ==
+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 [mailto:accounts@mit.edu] explaining what you need it for and someone at IS&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 [mailto:sipb-afsreq@mit.edu] instead. In either case, if a mount point under {{{/mit}}} fails to get set up for you, let [mailto:hesreq@mit.edu] know.
+
+= See Also =
+SIPB's older guide, [http://stuff.mit.edu/afs/sipb.mit.edu/project/doc/afs/html/afs-new.html Inessential AFS]
+OpenAFS documentation at [http://www.openafs.org/]
+