sshfs  3.5.2
About: SSH Filesystem is based on the FUSE (Filesystem in Userspace) kernel module and uses the SSH File Transfer Protocol (SFTP) without requiring root privileges for mounting a remote filesystem.
  Fossies Dox: sshfs-3.5.2.tar.xz  ("inofficial" and yet experimental doxygen-generated source code documentation)  

Some Fossies usage hints in advance:

  1. To see the Doxygen generated documentation please click on one of the items in the "quick index" bar above or use the side panel at the left which displays a hierarchical tree-like index structure and is adjustable in width.
  2. If you want to search for something by keyword rather than browse for it you can use the client side search facility (using Javascript and DHTML) that provides live searching, i.e. the search results are presented and adapted as you type in the Search input field at the top right.
  3. Doxygen doesn't incorporate all member files but just a definable subset (basically the main project source code files that are written in a supported language). So to search and browse all member files you may visit the Fossies sshfs-3.5.2.tar.xz contents page and use the Fossies standard member browsing features (also with source code highlighting and additionally with optional code folding).
SSHFS

SSHFS allows you to mount a remote filesystem using SFTP. Most SSH servers support and enable this SFTP access by default, so SSHFS is very simple to use - there's nothing to do on the server-side.

Once sshfs is installed (see next section) running it is very simple:

sshfs [user@]hostname:[directory] mountpoint

It is recommended to run SSHFS as regular user (not as root). For this to work the mountpoint must be owned by the user. If username is omitted SSHFS will use the local username. If the directory is omitted, SSHFS will mount the (remote) home directory. If you need to enter a password sshfs will ask for it (actually it just runs ssh which ask for the password if needed).

Also many ssh options can be specified (see the manual pages for sftp(1) and ssh_config(5)), including the remote port number (-oport=PORT)

To unmount the filesystem:

fusermount -u mountpoint

On BSD and macOS, to unmount the filesystem:

umount mountpoint

First, download the latest SSHFS release from https://github.com/libfuse/sshfs/releases. On Linux and BSD, you will also need to install libfuse 3.1.0 or newer. On macOS, you need OSXFUSE instead. Finally, you need the Glib library with development headers (which should be available from your operating system's package manager).

To build and install, we recommend to use Meson (version 0.38 or newer) and Ninja. After extracting the sshfs tarball, create a (temporary) build directory and run Meson:

$ mkdir build; cd build
$ meson ..

Normally, the default build options will work fine. If you nevertheless want to adjust them, you can do so with the mesonconf command:

$ mesonconf                  # list options 
$ mesonconf -D strip=true    # set an option

To build, test and install SSHFS, you then use Ninja (running the tests requires the py.test Python module):

$ ninja
$ python3 -m pytest test/    # optional, but recommended
$ sudo ninja install

If you need help, please ask on the <fuse-.nosp@m.sshf.nosp@m.s@lis.nosp@m.ts.s.nosp@m.ource.nosp@m.forg.nosp@m.e.net> mailing list (subscribe at https://lists.sourceforge.net/lists/listinfo/fuse-sshfs).

Please report any bugs on the GitHub issue tracker at https://github.com/libfuse/libfuse/issues.

Professional support is offered via Rath Consulting.