From d5feb65d987cf1c37ecdce9af323fd5a0f13bedf Mon Sep 17 00:00:00 2001 From: soredake <5204968+soredake@users.noreply.github.com> Date: Wed, 22 Nov 2023 12:23:21 +0200 Subject: [PATCH] README: simplify winget installation --- README.md | 27 +++++++++++++++------------ 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index ee10c12..04ed3a9 100644 --- a/README.md +++ b/README.md @@ -38,14 +38,13 @@ SSHFS-Win is a minimal port of [SSHFS](https://github.com/libfuse/sshfs) to Wind Both can also be easily installed with [WinGet](https://github.com/microsoft/winget-cli): ```console -winget install -h -e --id "WinFsp.WinFsp" && winget install -h -e --id "SSHFS-Win.SSHFS-Win" +winget install -h sshfs-win ``` ## Basic Usage Once you have installed WinFsp and SSHFS-Win you can map a network drive to a directory on an SSHFS host using Windows Explorer or the `net use` command. - ### Windows Explorer In Windows Explorer select This PC > Map Network Drive and enter the desired drive letter and SSHFS path using the following UNC syntax: @@ -108,12 +107,12 @@ The complete UNC syntax is as follows: - `HOST` is the SSHFS host. - `PORT` is the remote port on the SSHFS host (optional; default is 22). - `PATH` is the remote path. This is interpreted as follows: - - The `sshfs` prefix maps to `HOST:~REMUSER/PATH` on the SSHFS host (i.e. relative to `REMUSER`'s home directory). - - The `sshfs.r` prefix maps to `HOST:/PATH` on the SSHFS host (i.e. relative to the `HOST`'s root directory). - - The `sshfs.k` prefix maps to `HOST:~REMUSER/PATH` and uses the ssh key in `%USERPROFILE%/.ssh/id_rsa` (where `%USERPROFILE%` is the home directory of the local Windows user). To specify a different specific key, define an alias of the HOST with the specific private ssh key you want to use in the ssh config. BEWARE: only keys without a pass phrase are supported. - - The `sshfs.kr` prefix maps to `HOST:/PATH` and uses the ssh key in `%USERPROFILE%/.ssh/id_rsa`. To specify a different specific key, define an alias of the HOST with the specific private ssh key you want to use in the ssh config. BEWARE: only keys without a pass phrase are supported. + - The `sshfs` prefix maps to `HOST:~REMUSER/PATH` on the SSHFS host (i.e. relative to `REMUSER`'s home directory). + - The `sshfs.r` prefix maps to `HOST:/PATH` on the SSHFS host (i.e. relative to the `HOST`'s root directory). + - The `sshfs.k` prefix maps to `HOST:~REMUSER/PATH` and uses the ssh key in `%USERPROFILE%/.ssh/id_rsa` (where `%USERPROFILE%` is the home directory of the local Windows user). To specify a different specific key, define an alias of the HOST with the specific private ssh key you want to use in the ssh config. BEWARE: only keys without a pass phrase are supported. + - The `sshfs.kr` prefix maps to `HOST:/PATH` and uses the ssh key in `%USERPROFILE%/.ssh/id_rsa`. To specify a different specific key, define an alias of the HOST with the specific private ssh key you want to use in the ssh config. BEWARE: only keys without a pass phrase are supported. - `LOCUSER` is the local Windows user (optional; `USERNAME` or `DOMAIN+USERNAME` format). - - Please note that this functionality is rarely necessary with latest versions of WinFsp. + - Please note that this functionality is rarely necessary with latest versions of WinFsp. ## GUI front ends @@ -143,12 +142,15 @@ SSHFS-Win-Manager supports: sshfs-win itself does not currently support ssh tunneling, but something similar can be achieved using the built-in openSSH of windows. - use openSSH t create a local port forward through the jump host to the target + ``` ssh -L :: ``` + All standard settings of the ssh config may be used in this step. Reference example ssh config: + ``` create the file C:\Users\\.ssh\config and/or add the following lines: @@ -158,13 +160,13 @@ sshfs-win itself does not currently support ssh tunneling, but something similar IdentityFile IdentitesOnly yes ``` + - connect to the target server using the following ``` \\sshfs\REMUSER@localhost! ``` or similar. - ## Advanced Usage It is possible to use the `sshfs-win.exe` and `sshfs.exe` programs directly for advanced usage scenarios. Both programs can be found in the `bin` subdirectory of the `SSHFS-Win` installation (usually `\Program Files\SSHFS-Win\bin`). @@ -223,10 +225,11 @@ You will also need: - FUSE for Cygwin. It is included with WinFsp and can be installed on a Cygwin installation by executing the command: - ``` - $ sh "$(cat /proc/registry32/HKEY_LOCAL_MACHINE/SOFTWARE/WinFsp/InstallDir | tr -d '\0')"/opt/cygfuse/install.sh - FUSE for Cygwin installed. - ``` + ``` + $ sh "$(cat /proc/registry32/HKEY_LOCAL_MACHINE/SOFTWARE/WinFsp/InstallDir | tr -d '\0')"/opt/cygfuse/install.sh + FUSE for Cygwin installed. + ``` + - [Wix toolset](http://wixtoolset.org). This is a native Windows package that is used to build the SSHFS-Win MSI installer. To build: