Differences
This shows you the differences between the selected revisions of the page.
| 2026-05-08 | 2026-06-02 | ||
| no summary (124.43.69.1) (hidden) (untrusted) | 6.6.2 Using “username” and “hostname” as one word (martin) | ||
| Line 9: | Line 9: | ||
| ===== [[new_site]] New Site ===== | ===== [[new_site]] New Site ===== | ||
| - | To connect to a new site, select //New Site// node in the tree on the left. Then select [[protocols|protocol]], enter host name and your user name. Typically you will also need to enter your password. For details see below. | + | To connect to a new site, select //New Site// node in the tree on the left. Then select [[protocols|protocol]], enter hostname and your username. Typically you will also need to enter your password. For details see below. |
| To start ad-hoc connection, click //Login// button. | To start ad-hoc connection, click //Login// button. | ||
| Line 23: | Line 23: | ||
| When [[ftp|FTP protocol]] is selected, you can further specify to use basic unsecured variant (//No ==encryption==//) or one of [[ftps#methods|methods to invoke FTPS]]. When [[webdav|WebDAV]] or [[s3|S3]] protocol is selected, you can choose between basic unsecured variant and secure one.((With the S3 protocol, selecting the unsecure variant makes sense only, when connecting to 3rd party S3 server, as Amazon S3 does not support unsecure connections.)) | When [[ftp|FTP protocol]] is selected, you can further specify to use basic unsecured variant (//No ==encryption==//) or one of [[ftps#methods|methods to invoke FTPS]]. When [[webdav|WebDAV]] or [[s3|S3]] protocol is selected, you can choose between basic unsecured variant and secure one.((With the S3 protocol, selecting the unsecure variant makes sense only, when connecting to 3rd party S3 server, as Amazon S3 does not support unsecure connections.)) | ||
| - | 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|session URL]] here, it will be parsed. | + | The //Hostname// box is where you type the name, or the IP address, of the server you want to connect to. //Hostname// 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|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.((SSH protocol uses port number 22 by default. FTP protocol uses port number 21 by default. [[ftps|FTPS]] protocol with implicit encryption uses port number 990 by default. WebDAV protocol uses port number 80 by default. Secure WebDAV and Amazon S3 use port 443.)) Otherwise WinSCP selects the standard port number for you. | 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.((SSH protocol uses port number 22 by default. FTP protocol uses port number 21 by default. [[ftps|FTPS]] protocol with implicit encryption uses port number 990 by default. WebDAV protocol uses port number 80 by default. Secure WebDAV and Amazon S3 use port 443.)) 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 [[ui_authenticate#username|prompted for username]] then.((Except for special scenarios, such as authentication-less connection or [[ui_login_authentication#gssapi|GSSAPI authentication]].)) You can use environment variables in the value with syntax ''%NAME%''. For Amazon S3, use //[[guide_amazon_s3#connecting|Access key ID]]//. | + | The //Username// box is where you type your account name on the server. If you do not fill the username, you will be [[ui_authenticate#username|prompted for username]] then.((Except for special scenarios, such as authentication-less connection or [[ui_login_authentication#gssapi|GSSAPI authentication]].)) You can use environment variables in the value with syntax ''%NAME%''. For Amazon S3, use //[[guide_amazon_s3#connecting|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 [[session_configuration#site|save the site]]. If you decide to do so nevertheless, do not forget to force password storing on the //[[ui_login_save|Save session as dialog]]//. Also do not fill the password if you are going to use other [[ssh#authentication|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 [[ui_authenticate#password|prompted for password]] then. For Amazon %%S3%%, use //[[guide_amazon_s3#connecting|Secret access key]]//. | The //Password// box is for the password associated with the account. You are advised not to fill it in if you are going to [[session_configuration#site|save the site]]. If you decide to do so nevertheless, do not forget to force password storing on the //[[ui_login_save|Save session as dialog]]//. Also do not fill the password if you are going to use other [[ssh#authentication|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 [[ui_authenticate#password|prompted for password]] then. For Amazon %%S3%%, use //[[guide_amazon_s3#connecting|Secret access key]]//. | ||
| - | With [[ftp|FTP protocol]] you can use //Anonymous login//. It effectively sets the //User name// to ''anonymous'' and //Password// to ''anonymous@example.com''. | + | With [[ftp|FTP protocol]] you can use //Anonymous login//. It effectively sets the //Username// to ''anonymous'' and //Password// to ''anonymous@example.com''. |
| With [[s3|S3 protocol]] you can use ==?read_credentials== //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'' environment variables and the profiles in the default ''.aws\credentials'' and ''.aws\config'' configuration files are used in the same order as AWS tools do. You can choose specific profile in combo box next to the checkbox. | With [[s3|S3 protocol]] you can use ==?read_credentials== //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'' environment variables and the profiles in the default ''.aws\credentials'' and ''.aws\config'' configuration files are used in the same order as AWS tools do. You can choose specific profile in combo box next to the checkbox. | ||
| Line 46: | Line 46: | ||
| To open all sites in a site folder, select the folder and press 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 ==incremental==ly 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 (or in //Search// panel 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). | + | If you have many sites, you can ==incremental==ly 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 (or in //Search// panel 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, username and note). |
| ==== [[folders]] Site Folders ==== | ==== [[folders]] Site Folders ==== | ||
| Line 87: | Line 87: | ||
| ==== [[pasting]] Pasting Session URL ==== | ==== [[pasting]] Pasting Session URL ==== | ||
| - | Use the //Manage > Paste Session %%URL%%// or ''Ctrl+V'' to paste a [[session_url|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 > Paste Session %%URL%%// or ''Ctrl+V'' to paste a [[session_url|session URL]] from the clipboard. It gets parsed into //File protocol//, //Hostname//, //Username//, etc. The command is available only for //New Site// node or when editing site. |
| ==== Generating Session URL or Code ==== | ==== Generating Session URL or Code ==== | ||