Differences
This shows you the differences between the selected revisions of the page.
| 2012-09-28 | 2012-09-28 | ||
| removed (219.89.231.19) (hidden) | Restored revision 1343113658. Undoing revision 1348865785. (Petr) (hidden) | ||
| Line 1: | Line 1: | ||
| + | ====== Installation ====== | ||
| + | //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. | ||
| + | |||
| + | ===== [[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. | ||
| + | |||
| + | ===== 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. | ||
| + | - 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]].\\ | ||
| + | - 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. | ||
| + | - You will be prompted to select a setup type, with following options: | ||
| + | * //Typical installation// | ||
| + | * Installs to default destination (typically ''C:\Program Files\WinSCP''). | ||
| + | * Installs all components (but only selected language, to install all languages use //Custom installation//). | ||
| + | * Performs most typical setup tasks: | ||
| + | * [[updates|Enables automatic check for application updates]] | ||
| + | * [[integration#desktop_and_quick_launch_icons|Creates a desktop icon]] (for current user only) | ||
| + | * [[integration#send_to|Adds upload shortcut to Windows Explorer's 'Send to' context menu]] | ||
| + | * [[integration#url|Registers to handle sftp:// and scp:// addresses]] | ||
| + | * If you select //Typical installation// you can skip to step 11. | ||
| + | * //Custom installation// | ||
| + | * Allows full selection of destination, components, and features. See steps 7 through 10. | ||
| + | - 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. | ||
| + | - 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) | ||
| + | * [[dragext|Drag&drop shell extension]] (may require restart) | ||
| + | * [[ui_pageant|Pageant]] (SSH authentication agent) | ||
| + | * [[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 options such as drag&drop integration, you may have to restart your computer. If you choose not to restart, some WinSCP functions may not be available until you do so. | ||
| + | |||
| + | ===== Automating 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: | ||
| + | * ''/SILENT'' - Runs the installer without any prompts (with the exception of error messages, etc.). Default selections are used for destination folder, components, etc. | ||
| + | * ''/VERYSILENT'' - As ''/SILENT'', but without showing the progress window. | ||
| + | * ''/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. | ||
| + | * ''/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.)) | ||
| + | |||
| + | For full list of parameters, refer to [[&url(innosetuphelp)|Inno Setup help]] (chapter //Other Information > Setup Command Line Parameters//). | ||
| + | |||
| + | ===== 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. | ||
| + | |||
| + | ===== [[upgrade]] Upgrading WinSCP ===== | ||
| + | To upgrade WinSCP, [[installation#download|download]] the newer version, and then install it. The installation will preserve your configuration, and--if necessary--upgrade it. | ||
| + | |||
| + | Any [[languages|translation]] from your previous WinSCP version will not work with the new version. You must [[languages#install|install the new translation]]. | ||
| + | |||
| + | When upgrading Portable executable, just replace the executable files with the new version. New version can always read configuration from the old version. | ||
| + | |||
| + | ===== 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. | ||
| + | |||
| + | ===== 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]]. | ||