Differences
This shows you the differences between the selected revisions of the page.
2010-02-02 | 2010-04-28 | ||
not allowing translation of the docs yet (martin) | no summary (67.167.73.173) (hidden) | ||
Line 1: | Line 1: | ||
- | ====== WinSCP Technical Requirements ====== | + | hello |
- | + | ||
- | ===== Server Requirements ===== | + | |
- | Using WinSCP, you can connect to a [[SSH]] (Secure Shell) server with [[protocols#sftp|SFTP]] (SSH File Transfer Protocol) or [[protocols#scp|SCP]] (Secure Copy Protocol) service or to a [[protocols#ftp|FTP]] (File Transfer Protocol) server. | + | |
- | + | ||
- | SFTP is a standard part of SSH-2 package. SCP is a standard part of SSH-1 package. You can also run both protocols on the latter SSH version. WinSCP supports both SSH-1 and SSH-2. For authentication, you can use user name and password or [[public key]] (RSA or DSA). Other authorization types include TIS, Cryptocard, Keyboard-interactive, and Kerberos. | + | |
- | + | ||
- | For FTP, both basic unencrypted variant and [[ftps|FTPS]] are supported. Compressed transfers (Zlib) not supported. | + | |
- | + | ||
- | ===== [[sftp]] SFTP Requirements ===== | + | |
- | For SFTP, the only requirement beyond the server requirements above is to run SFTP on the server. It is best to run it as a SSH-2 subsystem. If you select SFTP-only on the login screen and the SFTP subsystem is not found, WinSCP will try to find the SFTP server in some common directories (''/usr/lib/sftp-server'', ''/usr/local/lib/sftp-server'', etc.). This way, it is possible to use SFTP even with SSH-1, which does not support subsystems. | + | |
- | + | ||
- | ===== [[scp]] SCP Requirements ===== | + | |
- | As the SCP protocol implements file transfers only, WinSCP must use other means to implement the additional functionality (like directory listing). WinSCP uses Unix-like shell commands to do that. This in turn means that when using SCP protocol, it can connect to servers that run Unix-like or its emulation only ((e.g. Cygwin on Windows. See [[faq_openssh_win|FAQ]] to learn how to use WinSCP with Windows server running OpenSSH on Cygwin.)). | + | |
- | + | ||
- | To transfer files, ''scp1'' is used (it is called from within ''scp''). If only ''scp2'' is allowed on your server, check the //[[ui_login_scp#other_options|Use scp2 with scp1 compatibility]]// option on the [[ui_login_scp|SCP/Shell tab]] in the Login dialog. | + | |
- | + | ||
- | For correct functionality, you must do the following. The ''bash'' shell is recommended for working with WinSCP. If your default shell doesn't work with WinSCP, you can make WinSCP use [[ui_login_scp#shell|other shell]]. | + | |
- | + | ||
- | For its operation, WinSCP needs several commands: ''cd'', ''chgrp'', ''chmod'', ''chown'', ''echo'', ''groups'', ''ls'', ''mkdir'', ''mv'', ''pwd'', ''scp'', ''rm'', ''ln'', ''unalias'' and ''unset''. These commands have to be placed in the path and user must have sufficient permissions to execute them. WinSCP expects "standard" behavior of these commands. You can avoid needing these commands by not using some of WinSCP functions (''mkdir'', ''chown'', ''ln'', etc.) or by changing some configuration options (''groups'', ''unalias'' and ''unset''). | + | |
- | + | ||
- | Just after establishing the connection with server, all [[ui_login_scp#other_options|aliases on the above commands are cleared]]. This helps avoid unexpected behavior. | + | |
- | + | ||
- | Another precondition is that the output of all commands is in English. This mostly concerns names of months in directory listings (''ls -la''). Because of this, WinSCP [[ui_login_scp#other_options|clears all user variables that govern command output]] after login. If command output also reflects some other server settings, it may be necessary to change this before WinSCP can be used. | + | |
- | + | ||
- | The last necessary condition is the proper output of ''ls -la'' command. Particularly standard number and ordering of the columns. If the default output does not satisfy WinSCP need, you can use //[[ui_login_scp#directory_listing|Listing command]]// option on the //SCP/Shell tab// in the Login dialog to modify it. | + | |
- | + | ||
- | WinSCP will attempt detect support for ''%%--full-time%%'' switch of the ''ls'' command. If the detection causes you problems, you can [[ui_login_scp#directory_listing|disable]] it. | + | |
- | + | ||
- | ===== Using WinSCP with Restricted Shell Environments ===== | + | |
- | A number of restricted shell environments exist for supporting | + | |
- | SFTP/SCP only accounts. These systems restrict the user to a small | + | |
- | subset of commands needed to manipulate files while denying the | + | |
- | ability to execute arbitrary commands. Some of these environments | + | |
- | create incompatibilities with WinSCP, particularly if using SCP. | + | |
- | + | ||
- | ===== Effect of Remote User Environment on WinSCP Sessions ===== | + | |
- | Most shells nowadays offer options to make the user experience better. Unfortunately many of these options make the shell incompatible with WinSCP. | + | |
- | + | ||
- | This mainly affects the SCP protocol. An example is colorized output with the ''ls'' command that outputs ANSI color sequences to the command output which WinSCP is | + | |
- | unable to parse. | + | |
- | + | ||
- | Also, the SFTP protocol can be affected. A typical example is where some message is | + | |
- | printed from a start-up script. WinSCP (and any other SFTP client) will attempt to parse the message as an SFTP packet, which will obviously fail. | + | |
- | + | ||
- | You should configure your start-up scripts to conform to non-interactive sessions (like WinSCP). Some shells call different profile/start-up scripts for interactive and non-interactive sessions. You can also use some environment variables, such as ''TERM'' to distinguish interactive and non-interactive sessions. | + | |
- | + | ||
- | ===== Client Requirements ===== | + | |
- | WinSCP should run on any system running Win32 system, which includes Windows 95, up to and including Windows 7. We know of no reason why WinSCP should not continue to work on future versions of Windows. | + | |
- | + | ||
- | WinSCP also runs on Linux platforms where Crossover 4.x or later is running. Crossover is the commercial development of the Wine project. | + | |
- | + | ||
- | WinSCP requires at most 10 MiB of free disk space. | + |