Difference between revisions of "Sftpman"

From ArchWiki
Jump to: navigation, search
m (Fixed typo.)
Line 10: Line 10:
In order to use ''sftpman'' or it's GTK frontend ''sftpman-gtk'', you'll first need to have a working [[sshfs]] setup.
In order to use ''sftpman'' or it's GTK frontend ''sftpman-gtk'', you'll first need to have a working [[sshfs]] setup.
[[sshfs]] and [[fuse]] are installed as dependencies, so you may just need to add ''fuse'' to your module-list in {{Filename|/etc/[[rc.conf]]}} to auto-load at boot.
[[sshfs]] and [[fuse]] are installed as dependencies, so you may just need to add ''fuse'' to your module-list in {{ic|/etc/[[rc.conf]]}} to auto-load at boot.
== Installation ==
== Installation ==

Revision as of 19:57, 13 February 2012

This template has only maintenance purposes. For linking to local translations please use interlanguage links, see Help:i18n#Interlanguage links.

Local languages: Català – Dansk – English – Español – Esperanto – Hrvatski – Indonesia – Italiano – Lietuviškai – Magyar – Nederlands – Norsk Bokmål – Polski – Português – Slovenský – Česky – Ελληνικά – Български – Русский – Српски – Українська – עברית – العربية – ไทย – 日本語 – 正體中文 – 简体中文 – 한국어

External languages (all articles in these languages should be moved to the external wiki): Deutsch – Français – Română – Suomi – Svenska – Tiếng Việt – Türkçe – فارسی

You can use sftpman (an sshfs helper) to mount a remote system - accessible via SSH - to a local folder.

sftpman offers both a command-line tool (sftpman) and a GTK frontend (sftpman-gtk, see screenshot), each packaged separately.

With sftpman, you first setup (define) your remote filesystems and then you mount/unmount them easily (with one click/command).


In order to use sftpman or it's GTK frontend sftpman-gtk, you'll first need to have a working sshfs setup.

sshfs and fuse are installed as dependencies, so you may just need to add fuse to your module-list in /etc/rc.conf to auto-load at boot.


The sftpman and sftpman-gtk packages are available in the AUR.

sftpman provides the base library and the command-line application sftpman.

sftpman-gtk provides the sftpman-gtk application, a GTK frontend to sftpman.

Defining filesystems

Each filesystem managed by sftpman needs to have a unique name/id which will be used when managing the system and also in its mount path. A system with an id of my-machine will be mounted locally to /mnt/sshfs/my-machine.

Authentication with the remote filesystem during mounting can be performed using passwords or SSH Keys.

To define a new remote filesystem with password-based authentication using the command-line tool, do:

# sftpman setup --id "my-machine" --host "HOSTNAME_OR_IP" --user "USERNAME" \
--mount_point "/REMOTE_PATH" --auth_method=password

Or the equivalent in case you want to use authentication with SSH Keys (recommended):

# sftpman setup --id "my-machine" --host "HOSTNAME_OR_IP" --user "USERNAME" \
--mount_point "/REMOTE_PATH" --auth_method=publickey --ssh_key "PATH_TO_PRIVATE_KEY"

The above setup is the minimum you need to specify to define a new filesystem that sftpman can mount. Depending on your environment, you may need to use some more options (like --port, which defaults to 22). To see a full list of available options do:

# sftpman help

You can also use the GTK frontend to define new filesystems more easily.


Once you've defined several filesystems, you can mount them by using their ids.

To mount:

# sftpman mount my-machine

which mounts the filesystem to /mnt/sshfs/my-machine

To unmount:

# sftpman unmount my-machine
Note: In order for the GUI application to be able to ask you for a password when mounting, you'll need to install some form of an ssh askpass tool. See: SSH_Keys#Using_ssh-agent_and_x11-ssh-askpass

Removing defined filesystems

To remove a defined filesystem from sftpman's list do:

# sftpman rm machine-id

Learning more

To see a list of more commands and options that sftpman supports, consult the help:

# sftpman help


sftpman can perform some basic checks on the environment, which may catch some potential problems:

# sftpman preflight_check

If the GUI application does not ask you for a password while mounting (when using password-based authentication or for password-protected ssh keys), you will need to install an ssh askpass tool, see Sftpman#Mounting/Unmounting.

Note: If mounting a filesystem fails, sftpman will give you the full sshfs command and its output. You can then use that command and run it manually (possibly after adding some more debug options to it, so you would see some more output).

When doing authentication using keys, start small and make sure SSHing actually works by trying it manually, before trying to use sshfs. Some common problems can be solved by consulting Using_SSH_Keys#Troubleshooting.

Also see Sshfs#Troubleshooting.

Other Resources

sftpman - sftpman (source code, issue tracker) at github

sftpman-gtk - sftpman-gtk (source code, issue tracker) at github

PKGBUILDs - Package files (source code, issue tracker) for sftpman and sftpman-gtk at github

See also