Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
student:utilities:sshfs [2020/02/04 14:37] – Add macOS details lam2mostudent:utilities:sshfs [2025/08/21 16:27] (current) – bernstdh
Line 1: Line 1:
 ===== Mounting a Remote Filesystem Locally ===== ===== Mounting a Remote Filesystem Locally =====
  
-It can often be beneficial to mount a remote filesystem locally to your computer, allowing you to treat the contents as if they were local to your machine. This would, for example, allow you to use a local IDE to edit/compile/run files hosted on stu.cs.jmu.edu. This article describes how to mount your JMUCS home directory from a Linux client using [[https://github.com/libfuse/sshfs|sshfs]]. Implementations also exist for [[http://osxfuse.github.io/|macOS]] (see below for details) and [[https://github.com/billziss-gh/sshfs-win|Windows]].+It can often be beneficial to mount a remote filesystem locally to your computer, allowing you to treat the contents as if they were local to your machine. This would, for example, allow you to use a local IDE to edit/compile/run files hosted on stu.cs.jmu.edu. This article describes how to mount your JMUCS home directory using sshfs.
  
 ==== Prerequisites ==== ==== Prerequisites ====
  
   - SSH access to the server hosting the filesystem you wish to mount. It can be helpful to set up [[student:utilities:start:keypairs|ssh keypairs]] as well.   - SSH access to the server hosting the filesystem you wish to mount. It can be helpful to set up [[student:utilities:start:keypairs|ssh keypairs]] as well.
-  - Install the [[https://github.com/libfuse/sshfs|sshfs]] client on your local machine. Most distributions package sshfs in their repositories and installing from there is far easier than compiling it yourself. For Ubuntu/Mint you could run ''apt-get install sshfs''.+  - Install the sshfs client on your local machine. See the appropriate section below for your Operating System. 
 + 
 +==== Linux ==== 
 + 
 +Most distributions package [[https://github.com/libfuse/sshfs|sshfs]] in their repositories and installing from there is far easier than compiling it yourself. For Ubuntu/Mint you could run ''apt-get install sshfs''.
        
-==== Mounting the remote filesystem ====+=== Mounting the remote filesystem ===
  
 You must create a local mountpoint before mounting the remote filesystem (this must be done only once). Then the filesystem can be mounted. You must create a local mountpoint before mounting the remote filesystem (this must be done only once). Then the filesystem can be mounted.
Line 17: Line 21:
 </code> </code>
  
-Where ''<eid>'' is your JMU username. The ''~/mnt/stu'' directory on your local machine now contains the contents of your JMUCS home directory. Changes made in one place will automatically be reflected in the other.+Where ''<eid>'' is your JMU username. The ''~/mnt/stu'' directory on your local machine now contains the contents of your JMUCS home directory. Changes made in one place will automatically be reflected in the other. See ''man sshfs'' for additional options.
  
-See ''man sshfs'' for additional options; in particular, the ''-o idmap=user'' option is necessary if your UIDs do not match between the client and the server (this is likely the case on personal machines). +=== Unmounting the filesystem ===
- +
-==== Unmounting the filesystem ====+
  
 When you are done using the remote filesystem you should unmount it using the ''fuermount'' command. When you are done using the remote filesystem you should unmount it using the ''fuermount'' command.
Line 33: Line 35:
 Download and install both the "FUSE for macOS" and "SSHFS" packages from [[http://osxfuse.github.io/|this page]], following the instructions as prompted. When prompted, enable the "FUSE for macOS Preference Pane" to facilitate future updates. You will also need to enable a system extension in your Security & Privacy System Preferences.'' Download and install both the "FUSE for macOS" and "SSHFS" packages from [[http://osxfuse.github.io/|this page]], following the instructions as prompted. When prompted, enable the "FUSE for macOS Preference Pane" to facilitate future updates. You will also need to enable a system extension in your Security & Privacy System Preferences.''
  
-{{:student:utilities:fuse01-pref_pane.png?600|}}+{{:student:utilities:fuse01-pref_pane.png?600|FUSE Preference Pane}} 
 + 
 +{{:student:utilities:fuse02-ext_blocked.png?400|Blocked}} 
 + 
 +{{:student:utilities:fuse03-enable_ext.png?600|Enabled}} 
 + 
 +After everything is installed correctly, you should be able to follow the same command-line instructions described in the Linux section above except that you should use the following command to unmount the remote filesystem: 
 + 
 +<code> 
 +umount ~/mnt/stu 
 +</code> 
 + 
 +**WARNING FOR EARLY ADOPTERS:** There are [[https://github.com/osxfuse/osxfuse/issues/705|known issues]] with OSXFUSE on macOS 11.0 ("Big Sur"). If you upgrade to Big Sur, you will need to re-install the latest version of OSXFUSE (v3.11.0) and you may experience performance degradation. 
 + 
 +==== Windows ====
  
-{{:student:utilities:fuse02-ext_blocked.png?400|}}+  - Download the latest release of WinFsp from here: https://github.com/billziss-gh/winfsp/releases 
 +  - Download the latest release of SSHFS-Win from here, picking your version's architecture (Likely x64): https://github.com/billziss-gh/sshfs-win/releases 
 +  - Install WinFsp. The default selection of components can be used. 
 +  - Install SSHFS-Win, the default options are fine. 
 +  - In file explorer, right click on computer (This PC), and: 
 +    * Select "Map Network Drive" 
 +    * Select a drive letter that is convenient. 
 +    * In the folder box, type in the following, substituting your EID: <code>\\sshfs\eid@stu.cs.jmu.edu</code> 
 +    * Click finish, and type in your EID password. 
 +  - You should now have your stu home directory mounted at the drive letter you specified
  
-{{:student:utilities:fuse03-enable_ext.png?600|}}+=== Unmounting the filesystem ===
  
-After everything is installed correctly, you should be able to follow the same command-line instructions described in the sections above.+When you are done using the remote filesystem you should unmount it by right clicking the Network drive and selecting "Disconnect"