]> sipb.mit.edu Git - wiki.git/blobdiff - doc/using-athena.mdwn
Minor edits to information already posted, and the addition of a new section.
[wiki.git] / doc / using-athena.mdwn
index 758085e3e77ddf85a6c1ce924828c609917bf1a9..324604ac84d8950b715dbaaef9f2c523ef5dda83 100644 (file)
@@ -1,10 +1,19 @@
 # Using Athena
 
-For this series of tutorials, we’re going to assume that you’re familiar with the basics of how to use the command line.
+**Intended Purpose:**
+
+* This article will help you answer the question “how can I have a website with an MIT domain”?
+* The website you’re making is static (otherwise [scripts](scripts.mit.edu) might be a better option!) 
+* To be below the level of [afs-and-you](https://sipb.mit.edu/doc/afs-and-you/)
+
+**Prerequisites:**
+
+* Familiarity with using a terminal (experimented with basic commands like cd, ls, mkdir, etc.)
+
 
 ## Connecting to Athena
 
-The use of SSH (Secure Shell) allows a computer to remotely login into another computer/server, while making use of adequate security features. Thankfully, most operating systems have an SSH program already built in and no additional installs are needed on your machine. You can SSH into Athena by following these steps.
+SSH (Secure Shell) allows a computer to remotely login into another computer/server while making use of adequate security features. Thankfully, most operating systems have an SSH program already built in and no additional installs are needed on your machine. You can SSH into Athena by following these steps.
 
 First, open your OS’s respective terminal. Then enter
 
@@ -12,81 +21,82 @@ First, open your OS’s respective terminal. Then enter
 ssh [kerberos]@athena.dialup.mit.edu
 ```
 
-but replacing `[kerberos]` with your Athena username. So, for example, if your username is `aphacker`, you would type into the terminal `ssh aphacker@athena.dialup.mit.edu`.
+but replacing `[kerberos]` with your kerberos/Athena username. So, for example, if your username is `aphacker`, you would type into the terminal `ssh aphacker@athena.dialup.mit.edu`.
 
-If successful, ssh will tell you (in your _first_ time):
+If successful, ssh will tell you (on your _first_ connecting):
 
 ```
-Host key not found from the list of known hosts.  
+Host key not found from the list of known hosts.
 Are you sure you want to continue connecting (yes/no)?
 ```
 
 Type `yes', and now it will respond:
 
-```
-Host 'athena.dialup.mit.edu' added to the list of known hosts.  
+ ```
+Host 'athena.dialup.mit.edu' added to the list of known hosts.
 aphacker's password:
 ```
 
-Type your password and press Enter. Note, you will not see any characters as you type your password; this is a security feature.
+Type your password and press Enter. Note, you will not see any characters appear as you type your password; this is a security feature.
 
 Now you’ll be prompted to complete two-factor authentication via Duo.
 
-```
-Enter a passcode or select one of the following options:  
- 1. Duo Push to XXX-XXX-0000  
- 2. Phone call to XXX-XXX-0000  
- 3. SMS passcodes to XXX-XXX-0000  
+```Enter a passcode or select one of the following options:
+
+ 1. Duo Push to XXX-XXX-1234
+ 2. Phone call to XXX-XXX-1234
+ 3. SMS passcodes to XXX-XXX-1234
+
 Passcode or option (1-3):
 ```
 
-Type an option number and press Enter. Do your two-factor authentication. With luck, the terminal will print a bunch of startup text, finally ending with a line like
+Type an option number and press Enter. Complete your two-factor authentication. With luck, the terminal will print a series of startup text, finally ending with a line that reads
 
 ```
 aphacker@scrubbing-bubbles:~$
 ```
 
-You have now been dropped into an Athena shell. Like the terminal on your computer, you can type commands and they will execute. For example, you can type `pwd` and see
+You have now been dropped into Athena! Like the terminal on your computer, you can type commands and they will execute. For example, you can type `pwd` and see
 
 ```
-aphacker@scrubbing-bubbles:~$ pwd  
+aphacker@scrubbing-bubbles:~$ pwd
 /afs/athena.mit.edu/user/a/p/aphacker
 ```
 
-**Note:** If your computer does not have `ssh`, you could also use shellinabox, an online terminal for using Athena that can be found [here](https://athena.dialup.mit.edu/). It’s not ideal, though, as it will log you off if you’re idle for a few minutes. (Which is probably not what you want when you’re following a guide like this.)
+**Note start:** If your computer does not have `ssh`, you could also use shellinabox, an online terminal for using Athena that can be found [here](https://athena.dialup.mit.edu/.) Though, it’s not ideal as it will log you off if you’re idle for a few minutes (which is probably not what you want when you’re following a guide like this). ** Note end.**
 
 ## Serving a website from AFS
 
-Now that you’re in Athena, you can access the files in AFS. Right now, you are in your home directory for AFS. There are several subdirectories in your home directory, but the important one to focus on right now is `~/www`.
+Now that you’re in Athena, you can access the files in MIT’S AFS. Right now, you are in your home directory for MIT’s AFS. There are several subdirectories in your home directory, but the important one to focus on right now is `~/www`.
 
-Files in your `~/www` directory are available on the internet through a URL, and more specifically of the form factor `https://web.mit.edu/aphacker/www/`. If you go to that URL right now though, you won’t see anything (besides a error). We can change that by making a small web page under that directory.
+Files in your `~/www` directory are available on the internet through a URL, specifically via the form factor of `https://web.mit.edu/aphacker/www/`. If you go to that URL right now though, you won’t see anything (besides an error). We can change that by populating that directory with the content that makes up a small web page.
 
 First, `cd` into the `www` directory.
 
 ```
-aphacker@scrubbing-bubbles:~$ cd www  
+aphacker@scrubbing-bubbles:~$ cd www
 aphacker@scrubbing-bubbles:~/www$
 ```
 
-Then, run the following command to make a file named `index.html` with a simple HTML5 template
+Then, run the following command to make a file named `index.html` with a simple HTML5 template like so
 
 ```
 aphacker@scrubbing-bubbles:~/www$ echo '<!DOCTYPE html><title>Hello World!</title>' > index.html
 ```
 
-If you now visit your URL at `https://web.mit.edu/aphacker/www/`, you will see the web page you made! It’s a blank page with the title “Hello World!”.
+If you now visit your URL at `https://web.mit.edu/aphacker/www/`, you will see the web page you made! It’s a blank page with the title “Hello World!”. Note, this change is sometimes not immediate and will take a few minutes, but never hours.
 
-You can edit the webpage you just made by running a text editor like nano or Vim.
+You can edit the webpage you just made by running a text editor like [nano or Vim](https://xkcd.com/378/).
 
 ```
 aphacker@scrubbing-bubbles:~/www$ nano index.html
 ```
 
-This should bring up a screen with the current contents of `index.html`, which you can now edit. You can read more about how to use nano elsewhere, but for now, it’s enough to know that pressing `<CTRL-O>` and then Enter will save the file, and `<CTRL-X>` will exit you from nano.
+This should bring up a screen with the current contents of `index.html`, which you can now edit. You can read more about how to use nano elsewhere, and edit your file as you wish.
 
 ## Using SCP
 
-Editing a file through a remote shell isn’t the best way of making a file, however. A program called SCP (Secure Copy), which is bundled with SSH, allows copying files from your computer to AFS.
+If you feel unready to strictly edit files via the remote shell, using a package called SCP (Secure Copy), which is bundled with SSH, might be of interest. It allows you to copy files from your computer to AFS and vice-versa.
 
 To copy a file from your computer to AFS, open your terminal and enter a command like
 
@@ -96,12 +106,22 @@ scp file.txt aphacker@athena.dialup.mit.edu:~
 
 This will copy a file called `file.txt` to your home directory in AFS. You’ll have to do two-factor authentication with Duo, similar to SSH.
 
-You can [read the documentation](https://linux.die.net/man/1/scp) for more information about how to use SCP.
+You can read SCP’s man page (on the terminal via `man scp` or online at [man7](https://man7.org/linux/man-pages/man1/scp.1.html)) or other reference sheets (like [tldr-pages](https://tldr.ostera.io/scp) for more information about how to use SCP.
 
 ## What next?
 
-For more information about what AFS is, see:
+### Additional readings
+
+For more information about what AFS is, visit:
+
+* [AFS at MIT - An Introduction](http://kb.mit.edu/confluence/display/istcontrib/AFS+at+MIT+-+An+Introduction)
+* [AFS and You](https://sipb.mit.edu/doc/afs-and-you/)
+* [AFS Locker Maintenance Guide](http://kb.mit.edu/confluence/display/istcontrib/AFS+Locker+Maintenance+Guide)
+
+### Tips/tricks
+
+To use Visual Studio Code (VSC) to interact with Athena, follow these steps:
 
-- [AFS at MIT - An Introduction](http://kb.mit.edu/confluence/display/istcontrib/AFS+at+MIT+-+An+Introduction)
-- [AFS and You](https://sipb.mit.edu/doc/afs-and-you/)
-- [AFS Locker Maintenance Guide](http://kb.mit.edu/confluence/display/istcontrib/AFS+Locker+Maintenance+Guide)
+1. In your machine’s VSC, install the [“official” ssh extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh)
+2. SSH into Athena and use your text editor to edit into `~\.bashrc`. Then, append this command at the end of the file (in a new line): `find ~/.vscode-server/ -name 'vscode-remote-lock.{kerberos}.*' -delete`. Here, you replace `{kerberos}` with your kerberos.
+3. Follow the extension’s steps for establishing a SSH connection.