How to Use the Command 'sshfs' (with Examples)

SSHFS (SSH Filesystem) is a powerful tool that allows the mounting of remote filesystems over SSH. By leveraging SSH, it provides a secure way to access files stored on a remote server as if they were on a local disk. Built on top of the FUSE (Filesystem in Userspace) interface, SSHFS does not require administrative privileges to run, making it a versatile option for a wide range of users. This article will illustrate various use cases for SSHFS and show how it can be utilized effectively.

Use case 1: Mount Remote Directory

Code:

sshfs username@remote_host:remote_directory mountpoint

Motivation:

Imagine you are working from a local computer and need quick access to files stored on a remote server. Rather than transferring files back and forth, using SSHFS allows you to interact with the remote directory seamlessly. It also enables working on the files in real-time, as they are locally available through the mount point.

Explanation:

• sshfs: The command to execute SSH-based file mounting.
• username: The username for the remote server’s login.
• remote_host: This is the IP address or domain name of the remote server.
• remote_directory: The directory path on the remote server you want to access.
• mountpoint: The local directory where you want the remote filesystem to be mounted.

Example output:

Once executed, accessing mountpoint on your local machine would display the contents of remote_directory on the remote server, allowing for direct file manipulation and access.

Use case 2: Unmount Remote Directory

Code:

umount mountpoint

Motivation:

After completing your tasks using the remote filesystem, it’s crucial to terminate the connection safely to ensure data consistency and security. Unmounting the filesystem frees up system resources and prevents unintended remote access.

Explanation:

• umount: A command to detach the filesystem mounted at the mountpoint.
• mountpoint: The local directory that was used to mount the remote filesystem and now needs to be unmounted.

Example output:

Running this command will clear the filesystem from the mountpoint, returning it to a regular local directory independent of any remote content.

Use case 3: Mount Remote Directory from Server with Specific Port

Code:

sshfs username@remote_host:remote_directory -p 2222

Motivation:

Often, remote servers may not use the default SSH port (22) due to security configurations or specific network setups. When a server uses a non-standard SSH port, explicitly specifying the port becomes necessary to establish a successful connection and mount the directory.

Explanation:

• sshfs: Command to mount a filesystem using SSH.
• username, remote_host, remote_directory: Refer to the same arguments as before.
• -p 2222: This option specifies that the SSH connection should use port 2222 instead of the default.

Example output:

Provided the port and all other credentials are correct, the designated mountpoint will reflect the contents of the remote_directory from the server operating on port 2222.

Use case 4: Use Compression

Code:

sshfs username@remote_host:remote_directory -C

Motivation:

When transferring data over WANs or slower networks, compressing files can significantly reduce the volume of data sent over the line. Although compression might induce a small processing overhead, it often results in faster data transfers and can be particularly beneficial for larger files or extensive directory structures.

Explanation:

• sshfs: Command to mount a filesystem using SSH.
• -C: This flag activates data compression during the SSH connection, thereby reducing network load.
• Other arguments remain the same as in previous examples.

Example output:

While visually there is no difference once the filesystem is mounted, users would notice improved transfer speeds especially when working with large files or slower network connections.

Use case 5: Follow Symbolic Links

Code:

sshfs -o follow_symlinks username@remote_host:remote_directory mountpoint

Motivation:

Symbolic links (symlinks) offer a way to reference either other files or directories from a specific path. By default, SSHFS treats symlinks as regular files. However, if you want to automatically resolve and access the linked locations, enabling symbolic link following becomes necessary, particularly in environments where symlinks are used extensively for navigation and file referencing.

Explanation:

• sshfs: The command to mount filesystems over SSH.
• -o follow_symlinks: Option to ensure that symbolic links in the remote directory are followed rather than being displayed as mere links.
• Remaining arguments username, remote_host, remote_directory, and mountpoint are similar to earlier examples.

Example output:

With this setup, navigating through directories containing symlinks will automatically follow them to their respective destinations, providing seamless traversal akin to using symlinks on local filesystems.

Conclusion:

SSHFS is an incredibly versatile tool that simplifies the integration between local and remote filesystems over SSH. As demonstrated through these varied use cases, users can adapt SSHFS for a multitude of scenarios—from simple directory access and efficient data transfer to managing non-standard network configurations. By grasping these command variations, users can enhance their remote work efficiencies and maintain rigorous security and performance standards.