Differences
This shows you the differences between the selected revisions of the page.
| installation 2013-04-09 | installation 2024-04-24 (current) | ||
| Line 2: | Line 2: | ||
| //This article contains detailed description of downloading and installing WinSCP. You may want to see [[guide_install|simplified guide]] to the process instead.// | //This article contains detailed description of downloading and installing WinSCP. You may want to see [[guide_install|simplified guide]] to the process instead.// | ||
| - | You can use WinSCP executable as a [[portable|portable application]] with its [[config|settings stored in an INI file]] and no installation required. This configuration is best for using WinSCP from removable media. If possible, you should complete a full installation. | + | Most users will prefer installing WinSCP for an easy setup. |
| + | |||
| + | Though note that, if you prefer so, you can use WinSCP executable as a [[portable|portable application]] with its [[config|settings stored in an INI file]] and no installation required. This configuration is best for using WinSCP from a removable media. | ||
| ===== [[download]] Obtaining WinSCP ===== | ===== [[download]] Obtaining WinSCP ===== | ||
| You can obtain WinSCP from the [[&download|WinSCP download page]]. You should save the installer to an easily accessible location such as your Microsoft Windows desktop or your //My Documents// folder. | You can obtain WinSCP from the [[&download|WinSCP download page]]. You should save the installer to an easily accessible location such as your Microsoft Windows desktop or your //My Documents// folder. | ||
| - | ===== Running the WinSCP Installation Program ===== | + | WinSCP is also available from [[microsoft_store|Microsoft Store]]. |
| + | |||
| + | µsoft_store_badge | ||
| + | |||
| + | For corporate administrators, WinSCP is also available in a form of [[#msi|MSI package]]. | ||
| + | |||
| + | ===== [[running]] Running the WinSCP Installation Program ===== | ||
| - If you have WinSCP running, close it. The installer will not run if it finds any instance of WinSCP running. | - If you have WinSCP running, close it. The installer will not run if it finds any instance of WinSCP running. | ||
| - | - Open the installation program by double·clicking on its icon. | + | - Open the installation program by double-clicking on its icon. |
| - | - Select the installation [[languages|language]]. Your selection will also affect which language plugin will be selected by default for the installation. While you can change the language, the icons the installer creates will remain in the language selected for installation. Note that some beta releases are packaged with English language only, so you will not have a chance to choose a language. \\ \\ &screenshotpict(installer_lang) \\ \\ Only complete translations are distributed in package form. Incomplete translations must be [[languages#install|downloaded separately]].\\ | + | - The [[ui_installer|WinSCP installer]] starts. Follow its instructions. |
| - | - A //Welcome Screen// is shown at the beginning of setup procedure. To continue, click //Next//. | + | |
| - | - Review the section //License Agreement// and then click //Next//. You can access [[license|WinSCP License]] and [[privacy|WinSCP Privacy Policy]] anytime later on this site. | + | ===== [[upgrade]] Upgrading WinSCP ===== |
| - | - You will be prompted to select a setup type, with following options: | + | To upgrade WinSCP, [[#download|download]] the newer version, and then install it over your current version. The installation will preserve your configuration, and -- if necessary -- upgrade it.((The new WinSCP version will be installed in your language, unless this particular localization is abandoned for a long time. The installation package contains all the translations that are actively maintained at the time of its release. Otherwise you must [[languages#install|install the new translation]] manually, if available. Any translation from your previous WinSCP version will not work with the new version.)) |
| - | ···* //Typical installation// | + | |
| - | ······* Installs to default destination (typically ''C:\Program Files\WinSCP''). | + | When upgrading Portable executable, just replace the executable files with the new version. New version can always read configuration from the old version. |
| - | * Installs all components (but only selected language, to install all languages use //Custom installation//). | + | |
| - | * Performs most typical setup tasks: | + | You can check for [[incompatible_changes|rare backward incompatible changes]]. |
| - | ········* [[updates|Enables automatic check for application updates]] | + | |
| - | * [[integration#desktop_and_quick_launch_icons|Creates a desktop icon]] (for current user only, not available in Windows 7 and newer) | + | ===== [[downgrade]] Downgrading WinSCP ===== |
| - | ········* [[integration#send_to|Adds upload shortcut to Windows Explorer's 'Send to' context menu]] | + | In most cases, you may downgrade in the same way as upgrade (i.e. install the old version over the newer one). However safe way is to uninstall the newer version (while keeping your configuration) and only then install the old version. |
| - | * [[integration#url|Registers to handle sftp:// and scp:// addresses]] | + | |
| - | ······* If you select //Typical installation// you can skip to step 11. | + | Note that some of your configurations may be lost when downgrading. To make sure that you will be able to downgrade, you should backup your [[config|configuration]] before the upgrade. |
| - | * //Custom installation// | + | |
| - | ·····* Allows full selection of destination, components, and features. See steps 7 through 10. | + | ===== [[uninstalling]] Removing / Uninstalling WinSCP ===== |
| - | - You will be prompted for a //Destination//. Normally the default provided will be acceptable. Change the Destination folder if you like, and then click //Next// to proceed. | + | To remove WinSCP, go to //Control Panel > Programs > Uninstall a program//. &wincp &winvista &win7 &win8 This works for the classic installation only. [[microsoft_store|Microsoft Store installation]] cannot be removed this way. |
| - | - After selecting the destination folder, the //Component Selection screen// should appear. You should keep all components selected, however, if you do not intend to use some of the optional components, you may select another option here.\\ \\ &screenshotpict(installer_components)\\ \\ You can select to install the following components: | + | |
| - | * WinSCP application (mandatory) | + | On Windows 11 and Windows 10, you can also use //Settings > Apps > Apps & features//. &win10 &win11 This works for either type of installations. In case you [[microsoft_store#transitioning|have both installations]], to distinguish them, check the program name. The classic installation has a version number in its name (e.g. //"WinSCP &winscp_stable_version"//), while the Store installation does not (on the other hand, it shows the author name – //"Martin Prikryl"//, and has //Advanced options// link and //Move// command). |
| - | * [[dragext|Drag&drop shell extension]] (may require restart) | + | |
| - | ····* [[ui_pageant|Pageant]] (SSH authentication agent) | + | During the removal, the uninstaller of the classic installation will ask, if you want to remove [[ui_cleanup|WinSCP configuration and other data stored on your computer]]. When uninstalling the Store installation, its configuration is removed unconditionally (but not the configuration of any previous classic installation). |
| - | ····* [[ui_puttygen|PuTTYgen]] (key generator) | + | |
| - | * [[languages|Translations]] (if available in current release) | + | |
| - | - After selecting components, you will be prompted for a //Start Menu Folder//. You may change this from the default of "WinSCP", leave it as is, or click the //Don't Create a Start Menu Folder// check box. The start menu folder will include icons for all installed applications and links to important webpages about WinSCP. When you are satisfied with your selection click //Next// to proceed. | + | |
| - | ··- After selecting a //Start Menu Folder//, you will be prompted for //Additional Installation Tasks//. You can also perform most of these tasks later, after installation (follow each task for details).\\ \\ &screenshotpict(installer_tasks)\\ \\ You can select from following tasks: | + | |
| - | * [[updates|Enable automatic check for application updates]] (recommended) | + | |
| - | * [[integration#desktop_and_quick_launch_icons|Create a desktop icon]] (for current or all users) | + | |
| - | * [[integration#desktop_and_quick_launch_icons|Create a Quick Launch icon]] (for current user only) | + | |
| - | * [[integration#send_to|Add upload shortcut to Windows Explorer's 'Send to' context menu]] | + | |
| - | ····* [[integration#url|Register to handle sftp:// and scp:// addresses]] | + | |
| - | * [[integration#search_path|Add installation directory to search path (%PATH%)]] (administrators only) | + | |
| - | - After the //Additional Installation Tasks screen//, you will be prompted for //Initial User Settings//. Again, these can be easily changed later.\\ \\ &screenshotpict(installer_user)\\ \\ | + | |
| - | * [[interfaces|User interface style]] | + | |
| - | * [[ui_login|Show advanced login options]] (available with //Custom installation// only) | + | |
| - | - After you select the interface, a third party software recommendation screen may open. Review offered software and choose if you want to download and install this offer or not. Note that before deciding to install any third party application, you are required to agree to its separate and independent Terms of use and Privacy policy. | + | |
| - | ··- After you review the recommendation, the //Ready to Install screen// opens. On this screen, you can review the installation options you've selected. If you want to make changes, click //Back// until you return to the appropriate screen. If you do not want to make changes, click //Install// to start the installation. | + | |
| - | - A brief installation process will take place. | + | |
| - | * If you selected certain features such as drag&drop integration, installer may need to restart Windows Explorer, to make the features operational. If you choose not to restart, some WinSCP functions may not be available until you do so. | + | |
| - | ===== Automating Installation ===== | + | ===== [[automating]] Automating Installation and Uninstallation ===== |
| WinSCP uses [[&url(innosetup)|Inno Setup]] as installer. It lets you use optional command-line parameters to automate the installation. | WinSCP uses [[&url(innosetup)|Inno Setup]] as installer. It lets you use optional command-line parameters to automate the installation. | ||
| You can use following parameters to automate the installation: | You can use following parameters to automate the installation: | ||
| - | * ''/SILENT'' - Runs the installer without any prompts (with the exception of error messages, etc.). Default selections are used for destination folder, components, etc. | + | * ''/LANG=language'' -- Runs the installer using the specified language. For the ''language'', use the //Code// from [[this>../translations.php|translations page]]. |
| - | * ''/VERYSILENT'' - As ''/SILENT'', but without showing the progress window. | + | * ''/==SILENT=='' -- Runs the installer without any prompts (with the exception of installation mode selection and error messages). Default selections are used for destination folder, components, etc. To select the [[ui_installer#mode|installation mode]], use ''/ALLUSERS'' or ''/CURRENTUSER''. |
| - | * ''/NORESTART'' - Instructs installer not to reboot even if it's necessary. | + | * ''/VERYSILENT'' -- As ''/SILENT'', but without showing the progress window. |
| - | * ''/LOG="filename"'' - Causes Setup to create a log file. | + | * ''/ALLUSERS'' -- Instructs installer to install in administrative [[ui_installer#mode|install mode]]. |
| - | * ''/LOADINF="filename"'' - Instructs Setup to load the settings from the specified file after having checked the command line. This file can be prepared using the ''/SAVEINF'' parameter. | + | * ''/CURRENTUSER'' -- Instructs installer to install in non administrative install mode. |
| - | * ''/SAVEINF="filename"'' - Instructs Setup to save installation settings to the specified file. | + | * ''/NORESTART'' -- Instructs installer not to reboot even if it's necessary. |
| - | * ''/NOCANDY'' - Do not show advertisements from [[opencandy|OpenCandy]] advertising network during installation. ((Parameter ''/NOCANDY'' is specific to WinSCP installer, it is not a generic parameter of Inno Setup.)) | + | * ''/LOG=%%"filename"%%'' -- Causes Setup to create a log file. |
| + | * ''/LOADINF=%%"filename"%%'' -- Instructs Setup to load the settings from the specified file after having checked the command line. This file can be prepared using the ''/SAVEINF'' parameter. | ||
| + | * ''/SAVEINF=%%"filename"%%'' -- Instructs Setup to save installation settings to the specified file. | ||
| + | * ''/NOCLOSEAPPLICATIONS'' -- Prevents Setup from closing applications using files that need to be updated by Setup. | ||
| - | For full list of parameters, refer to [[&url(innosetuphelp)|Inno Setup help]] (chapter //Other Information > Setup Command Line Parameters//). | + | See full list of [[https://jrsoftware.org/ishelp/index.php?topic=setupcmdline|Inno Setup setup command line parameters]]. |
| + | |||
| + | WinSCP uninstaller (''unins000.exe'' in WinSCP installation directory) has the same parameters as above (except for ''/LOADINF'' and ''/SAVEINF''). | ||
| + | See full list of [[https://jrsoftware.org/ishelp/index.php?topic=uninstcmdline|Inno Setup uninstaller command line parameters]]. When running uninstaller silently, [[ui_cleanup|configuration and other data stored on your computer]] are not removed. | ||
| ===== Custom Distribution of WinSCP ===== | ===== Custom Distribution of WinSCP ===== | ||
| Line 68: | Line 65: | ||
| Learn how a system administrator can [[administration|restrict or enforce certain functionality]] of the application. | Learn how a system administrator can [[administration|restrict or enforce certain functionality]] of the application. | ||
| - | ===== [[upgrade]] Upgrading WinSCP ===== | + | ===== [[verifying]] Verifying Integrity of Installer ===== |
| - | To upgrade WinSCP, [[installation#download|download]] the newer version, and then install it. The installation will preserve your configuration, and--if necessary--upgrade it. | + | Optionally, as a security measure, you can verify an integrity of the WinSCP installer binary before installing. |
| - | Any [[languages|translation]] from your previous WinSCP version will not work with the new version. You must [[languages#install|install the new translation]]. | + | In Windows File Explorer display //Properties// of the installer and verify a signature on the //Digital Signatures// tab. The installer should be signed by "Martin Prikryl". |
| - | When upgrading Portable executable, just replace the executable files with the new version. New version can always read configuration from the old version. | + | * The EV certificate used to sign the latest installers is valid from 2022-11-24 to 2026-02-18 and has the following SHA-1 thumbprint (hash): ''0dee8f52d6b8d8c4b2c9573f4299fd97d707bab7''. |
| + | * The EV certificate used to sign the older installers is valid from 2020-02-10 to 2023-02-17 and has the following %%SHA-1%% thumbprint (hash): ''fb845245cfbb0ee97e76c775348caa31d74bec4c''. | ||
| - | ===== Downgrading WinSCP ===== | + | &screenshotpict(certificate) |
| - | In most cases, you may downgrade in the same way as upgrade (i.e. install the old version over the newer one). However safe way is to uninstall the newer version (while keeping your configuration) and only then install the old version. | + | |
| - | Note that some of your configurations may be lost when downgrading. To make sure that you will be able to downgrade, you should backup your [[config|configuration]] before the upgrade. | + | The certificate can also be displayed on the User Account Control prompt, when starting an [[ui_installer#mode|installation for all users]]. |
| + | |||
| + | You can also verify file integrity manually. Find ==checksums== of the installer binary in the release notes or on the [[this>../../download/WinSCP-&winscp_stable_version-Setup.exe/download|installer download page]]. You can cross-check the checksum against a [[https://sourceforge.net/projects/winscp/files/WinSCP/&winscp_stable_version/|copy of the release notes on the SourceForge server]]. Use the ''[[https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/certutil|certutil]]'' tool to calculate a SHA-256 checksum of the downloaded installer and compare it. | ||
| + | |||
| + | <code> | ||
| + | C:\...>certutil -hashfile WinSCP-&winscp_stable_version-Setup.exe SHA256 | ||
| + | SHA256 hash of WinSCP-&winscp_stable_version-Setup.exe: | ||
| + | &winscp_stable_setup_sha256 | ||
| + | CertUtil: -hashfile command completed successfully. | ||
| + | </code> | ||
| + | |||
| + | ===== [[msi]] MSI Installer ===== | ||
| + | |||
| + | For corporate administrators, WinSCP is also available in a form of [[&downloads#stable_msi|MSI installer]]. | ||
| + | |||
| + | The installer has no configuration options. It installs complete WinSCP, including all translations, tools and extensions. | ||
| - | ===== Removing WinSCP ===== | ||
| - | To remove WinSCP, use //Add/Remove Programs// function in Microsoft Windows' Control Panel. During the removal, WinSCP will ask if you want to remove [[ui_cleanup|WinSCP configuration and other data stored on your computer]]. | ||