Configuring Session (Login Dialog)

To connect to a new site, select New Site node in the tree on the left. Then select protocol, enter host name and your user name. Typically you will also need to enter your password. For details see below.

To start ad-hoc connection, click Login button.

If you plan to connect to the site often, you will want to save the site by clicking Save button.

You can base new site on existing one by using Manage > Clone to New Site command.

The File protocol selection lets you choose transfer protocol.

When FTP protocol is selected, you can further specify to use basic unsecured variant (No encryption) or one of methods to invoke FTPS. When WebDAV or S3 protocol is selected, you can choose between basic unsecured variant and secure one.1

The Host name box is where you type the name, or the IP address, of the server you want to connect to. Host name is the only mandatory box that must be filled for a session to open. You can use environment variables in the value with syntax %NAME%. If you enter a session URL here, it will be parsed.

The Port number box lets you specify which port number on the server to connect to. You need to specify it only in rare circumstances, when the server uses non standard protocol.2 Otherwise WinSCP selects the standard port number for you.

The User name box is where you type your account name on the server. If you do not fill the username, you will be prompted for username then.3 You can use environment variables in the value with syntax %NAME%. For Amazon S3, use Access key ID.

The Password box is for the password associated with the account. You are advised not to fill it in if you are going to save the site. If you decide to do so nevertheless, do not forget to force password storing on the Save session as dialog. Also do not fill the password if you are going to use other authentication method (like public key). If you do not fill the password and other authentication methods fail (password authentication has the lowest preference), you will be prompted for password then. For Amazon S3, use Secret access key.

With FTP protocol you can use Anonymous login. It effectively sets the User name to anonymous and Password to anonymous@example.com.

With S3 protocol you can use Credentials from AWS environment. The discovered credentials will show in the respective boxes, but they won’t be saved. They will be read again each time you login. The IAM role, AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_SESSION_TOKEN, AWS_CONFIG_FILE, AWS_PROFILE and AWS_SHARED_CREDENTIALS_FILE (latest beta version only) environment variables and the profiles in the default .aws\credentials and .aws\config (beta only) configuration files are used in the same order as AWS tools do. You can choose specific profile in combo box next to the checkbox.

If you need to configure advanced settings, click Advanced button to open Advanced Site Settings dialog. For settings not directly available in the interface and other special needs, use Advanced > Edit Raw Settings command to open Raw Site Settings dialog. For configuring transfer settings preset for the site, use Advanced > Transfer Settings Rule to open Transfer Settings Preset editor.

If there is a note associated with the site, it appears below Session box. To add or edit the site note go to Note page of Advanced Site Settings dialog.

The list on the left shows saved sites and workspaces. You should select from there a site, site folder, or workspace to work with before pressing one of the Login or Edit (sites only) buttons; or using Delete, Rename or other commands from the Manage menu button (also available from context menu).

Double-clicking a site or workspace opens it (as if you have clicked the Login button).

To open all sites in a site folder, select the folder and press the Login button.

If you have many sites, you can incrementally search for a site by typing part of its name. Then you can use Tab (or Shift-Tab) to search next (previous) matching sites. Press Esc to cancel searching. In the Incremental Search submenu of list context menu, you can select one of the search modes: Beginning of Site Name Only, Any Part of Site Name or All Major Site Fields (name, hostname, user name and note).

The sites can be organized into folders. Expand/collapse folder by double-clicking on its name.

Use the Manage > New folder command to create new site folder. To create subfolder, use path syntax “folder/subfolder” (Select the parent folder before pressing button to have the path prefilled). Note that empty folders are not preserved.

Use Edit button to start editing selected site. After you complete your changes, save them with Save button. You can also save a modified site under a new name using Save As command from drop-down menu of Save button.

Use Cancel button to rollback your changes.

Note that you cannot login to the site until you commit (or rollback) your changes.

If you want to change the same setting for many sites, you can use command-line parameter /batchsettings.

The Manage > Delete command (or Del key) deletes selected site, site folder or workspace. Deleting a site folder deletes all the sites it contains.

Use the Manage > Rename command to rename selected site, site folder or workspace.

Use Manage > Desktop Icon command to create a Desktop shortcut icons for selected site, site folder or workspace. For sites you can create also 'Send To’ shortcuts.

Note that if you delete the site the existing icons will not work anymore.

Use the Manage > Rename command to rename selected site, site folder or workspace.

Use Manage > Set Defaults set configured session settings or settings of selected site as default session settings.

Use the Manage > Paste Session URL or Ctrl+V to paste a session URL from the clipboard. It gets parsed into File protocol, Host name, Username, etc. The command is available only for New Site node or when editing site.

Use the Manage > Generate Session URL/Code to open Generate Session URL/Code dialog for selected site.

In addition to configuring the session, you can use the WinSCP Login dialog box to:

• Import sites from PuTTY or FileZilla;
• Import/Export configuration;
• Cleanup data stored on your computer by WinSCP;
• Run PuTTYgen or Pageant;
• Check for application updates (not available in Microsoft Store installation);
• Open Preferences dialog;
• Open About dialog.