You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Nikolaus Rath c91eb9a9a9 Released 3.7.3 1 month ago
.github/ISSUE_TEMPLATE Fix script issues identified through shellcheck (#258) 10 months ago
compat Fix script issues identified through shellcheck (#258) 10 months ago
test Fixup whitespace and configure CI to keep it that way 10 months ago
utils Add support for mounting from /etc/fstab 5 years ago
.appveyor.yml Add AppVeyor CI for Cygwin 4 years ago
.dir-locals.el Added .dir-locals.el to setup correct indentation in Emacs 5 years ago
.git-blame-ignore-revs add .git-blame-ignore-revs (#261) 10 months ago
.gitignore Added build/ to gitignore. 3 years ago
.pre-commit-config.yaml Fixup whitespace and configure CI to keep it that way 10 months ago
.travis.yml Fixup whitespace and configure CI to keep it that way 10 months ago
AUTHORS Released 3.7.3 1 month ago
COPYING Update COPYING 11 years ago
ChangeLog.rst Released 3.7.3 1 month ago
README.rst Released 3.7.3 1 month ago
cache.c Fixup whitespace and configure CI to keep it that way 10 months ago
cache.h Switch to libfuse 3.0. 5 years ago
make_release_tarball.sh Fixup whitespace and configure CI to keep it that way 10 months ago
meson.build Released 3.7.3 1 month ago
sshfs.c Fix typo in ssh_opts (#269) 9 months ago
sshfs.rst Fix typo: occured -> occurred (#280) 4 months ago

README.rst

This Project is Orphaned

This project is no longer maintained or developed. Github issue tracking and pull requests have therefore been disabled. The mailing list (see below) is still available for use.

If you would like to take over this project, you are welcome to do so. Please fork it and develop the fork for a while. Once there has been 6 months of reasonable activity, please contact Nikolaus@rath.org and I'll be happy to give you ownership of this repository or replace with a pointer to the fork.

SSHFS

About

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.

Development Status

SSHFS is shipped by all major Linux distributions and has been in production use across a wide range of systems for many years. However, at present SSHFS does not have any active, regular contributors, and there are a number of known issues (see the bugtracker). The current maintainer continues to apply pull requests and makes regular releases, but unfortunately has no capacity to do any development beyond addressing high-impact issues. When reporting bugs, please understand that unless you are including a pull request or are reporting a critical issue, you will probably not get a response.

How to use

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 asks 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

Installation

First, download the latest SSHFS release from https://github.com/libfuse/sshfs/releases. You also need libfuse 3.1.0 or newer (or a similar library that provides a libfuse3 compatible interface for your operating system). 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

Getting Help

If you need help, please ask on the <fuse-sshfs@lists.sourceforge.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.