This is an old revision of the document!

Documentation » Configuration »

Configuring Session (Login Dialog)

To configure your session, start WinSCP, and then use the Login dialog that opens. It can be invoked also later to open additional sessions.

Login dialog was redesigned in recent release. If you are using an older version of WinSCP, it won’t match with what this page describes.

Advertisement

New Site

To connect to a new site, select New Site node in the tree on the left. Then select protocol, enter hostname 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.

Advertisement

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.

Session Settings

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 three methods to invoke FTPS. When WebDAV protocol is selected, you can choose between basic unsecured variant and secure one (This feature is available only in the latest beta release.).

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%.

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.1 Otherwise WinSCP selected the protocol for you.

The Username 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.2 You can use environment variables in the value with syntax %NAME%.

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.

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

If you need to configure advanced settings, click Advanced button to open Advanced Site Settings dialog.

If there is a note associated with the site, it appears bellow Session box. To add or edit the site note go to Note page of Advanced Site Settings dialog. This feature is available only in the latest beta release.

Sites Sessions Management

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 any part of its name. Then you can use Tab (or Shift-Tab) to search next (previous) matching sites. Press Esc to cancel searching.

Site Folders

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

Advertisement

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.

Editing Existing Site

Use Edit button to start editing selected site. After you complete your changes, save them with Save button. You can also save 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.

Deleting

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

Renaming

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

Creating Shortcuts

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.

Renaming

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

Advanced Functions

Opening Site in PuTTY

You can open configured session or selected site in PuTTY SSH client instead of WinSCP. Use Manage > Open in PuTTY command.3

Default Session Settings

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

Pasting Session URL

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

Advertisement

Generating Session URL

Use the Manage > Generate Session URL to open Generate URL dialog for selected site. This feature is available only in the latest beta release.

Tools Menu

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

Some of these tools are available only on an initial Login dialog, not when opening additional sessions.

  1. SSH protocol uses port number 22 by default. FTP protocol uses port number 21 by default. FTPS protocol with implicit encryption uses port number 990 by default. WebDAV protocol uses port number 80 by default. Secure WebDAV uses port 443.Back
  2. Except for special scenarios, such as authentication-less connection or GSSAPI authentication.Back
  3. Hold down Shift key to open the site in PuTTY without closing WinSCP Login dialog.Back
  4. The command is disabled when WinSCP cannot find any site to import. Learn where WinSCP looks for sites.Back

Last modified: by martin