Differences
This shows you the differences between the selected revisions of the page.
| installation 2005-05-09 | installation 2024-04-24 (current) | ||
| Line 1: | Line 1: | ||
| ====== Installation ====== | ====== Installation ====== | ||
| - | The WinSCP application can be used as a self contained application with its settings stored in an INI file and no installation required. This configuration is most suitable for using WinSCP from removable media. A full installation is recommended where practical. | + | //This article contains detailed description of downloading and installing WinSCP. You may want to see [[guide_install|simplified guide]] to the process instead.// |
| - | ===== Obtaining WinSCP ===== | + | Most users will prefer installing WinSCP for an easy setup. |
| - | You can obtain WinSCP directly from the [[&download|WinSCP download page]]. There are two packages available, English-only and multilanguage package. You | + | |
| - | may wish to save the installer to an easily accessed location such | + | |
| - | as the desktop or your //My Documents// folder. | + | |
| - | ===== Running the WinSCP Installation Program ===== | + | 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. |
| - | - If you have WinSCP running, close it. Installer will not run if it finds any instance of WinSCP running. | + | |
| - | - Open the installation program by double clicking on its icon. | + | |
| - | - If you have downloaded "Multilanguage installation package", you will have chance to select language for the installation. Your selection will affect also which language plugin will be selected by default for installation. Note that while you can change your language later, the icons the installer creates will remain in the language selected for installation.\\ &screenshotpict(installer_lang) | + | |
| - | - A //Welcome Screen// should appear. Click //Next// in order to continue. | + | |
| - | - The //License Agreement// should appear. Review the license carefully, and click //Next// to continue. | + | |
| - | - You will be prompted for a //Destination//. Normally the default provided will be acceptable. Change the Destination folder if you desire, and then click //Next// to proceed. | + | |
| - | - After selecting the destination folder, the //Component Selection screen// should appear. It is recommended that you choose a full installation, however, if you do not intend to use some of the optional components, or already have them installed, you may select another option here.\\ &screenshotpict(installer_components)\\ You can select to install following components: | + | |
| - | * WinSCP application (mandatory) | + | |
| - | * [[dragext|Drag&drop shell extension]] (may require restart) | + | |
| - | * [[integration_app#pageant|Pageant]] (SSH authentication agent) | + | |
| - | * PuTTYgen (key generator) | + | |
| - | * [[languages|Translations]] (multilanguage installation package only) | + | |
| - | - After selecting components, you will be prompted for a //Start Menu Folder//. You may change this from the default of "WinSCP3", 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#explorer_s_send_to_context_menu|Add upload shortcut to Explorer's 'Send to' context menu]] | + | |
| - | * [[integration#scp_and_sftp_protocols_url_addresses|Register to handle scp:// and sftp:// addresses]] | + | |
| - | * [[integration#search_path|Add installation directory to search path (%PATH%)]] | + | |
| - | - 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]] | + | |
| - | - Once you choose the interface to use, you'll arrive at the //Ready to Install screen//. On this screen, you can review a list of all selected installation options. If you wish to change anything, you may press the back button until you return to the appropriate screen. If everything appears to be in order, click //Install// and the actual installation process will start. | + | |
| - | - A brief installation process will take place. If certain options such as drag&drop integration were selected, you may be prompted to restart the computer. If necessary, choose whether or not to restart and then click finish. If you choose not to restart, some functionality of WinSCP may not be available until you do so. | + | |
| - | ===== Automating Installation ===== | + | ===== [[download]] Obtaining WinSCP ===== |
| - | WinSCP uses [[&url(innosetup)|Inno Setup]] as installer. It allows automation of the installation procedure using optional command-line parameters. | + | 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. |
| - | To automate the installation you can use following parameters: | + | WinSCP is also available from [[microsoft_store|Microsoft Store]]. |
| - | ··* ''/SILENT'' - Runs installer without any prompts (with exception of error messages, etc.). Default selections are used for destination folder, components, etc. | + | |
| - | * ''/VERYSILENT'' - As ''/SILENT'', but without showing the progress window. | + | |
| - | * ''/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. | + | |
| - | For full list of parameters refer to [[&url(innosetup)|Inno Setup]] help. | + | µsoft_store_badge |
| - | ===== Upgrading/Downgrading WinSCP ===== | + | For corporate administrators, WinSCP is also available in a form of [[#msi|MSI package]]. |
| - | To upgrade WinSCP to newer version, just install the newer version over the existing installation. Your configuration will be preserved (and upgraded when necessary). | + | |
| - | Note that the [[languages|translation]] from older version of WinSCP will not work with the newer one. You need to [[languages#obtaining_and_installing_translation|install new translation]] too. | + | ===== [[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. | ||
| + | - Open the installation program by double-clicking on its icon. | ||
| + | - The [[ui_installer|WinSCP installer]] starts. Follow its instructions. | ||
| - | In general you may downgrade in a same way too, but some configuration may be lost. | + | ===== [[upgrade]] Upgrading WinSCP ===== |
| - | To make sure that you will be able downgrade, you should backup your [[config|configuration]] before upgrade. | + | 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.)) |
| + | |||
| + | When upgrading Portable executable, just replace the executable files with the new version. New version can always read configuration from the old version. | ||
| + | |||
| + | You can check for [[incompatible_changes|rare backward incompatible changes]]. | ||
| + | |||
| + | ===== [[downgrade]] Downgrading WinSCP ===== | ||
| + | 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. | ||
| + | |||
| + | ===== [[uninstalling]] Removing / Uninstalling WinSCP ===== | ||
| + | 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. | ||
| + | |||
| + | 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). | ||
| + | |||
| + | 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). | ||
| + | |||
| + | ===== [[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. | ||
| + | |||
| + | You can use following parameters to automate the installation: | ||
| + | * ''/LANG=language'' -- Runs the installer using the specified language. For the ''language'', use the //Code// from [[this>../translations.php|translations page]]. | ||
| + | * ''/==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''. | ||
| + | * ''/VERYSILENT'' -- As ''/SILENT'', but without showing the progress window. | ||
| + | * ''/ALLUSERS'' -- Instructs installer to install in administrative [[ui_installer#mode|install mode]]. | ||
| + | * ''/CURRENTUSER'' -- Instructs installer to install in non administrative install mode. | ||
| + | * ''/NORESTART'' -- Instructs installer not to reboot even if it's necessary. | ||
| + | * ''/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. | ||
| + | |||
| + | 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 ===== | ||
| + | Learn how to create a [[custom_distribution|custom distribution of WinSCP]]. | ||
| + | |||
| + | ===== Administration Tasks ===== | ||
| + | Learn how a system administrator can [[administration|restrict or enforce certain functionality]] of the application. | ||
| + | |||
| + | ===== [[verifying]] Verifying Integrity of Installer ===== | ||
| + | Optionally, as a security measure, you can verify an integrity of the WinSCP installer binary before installing. | ||
| + | |||
| + | 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". | ||
| + | |||
| + | * 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''. | ||
| + | |||
| + | &screenshotpict(certificate) | ||
| + | |||
| + | 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. | ||
| - | ===== Uninstalling WinSCP ===== | ||
| - | To uninstall WinSCP use //Add/Remove Programs// function of Windows (//Start > Settings > Control Panel > Add/Remove Programs//). During uninstallation you will be asked if you want to remove [[ui_cleanup|WinSCP configuration and other data stored on your computer]]. | ||